Class: Sendara::Resources::Lists

Inherits:
Sendara::Resource show all
Defined in:
lib/sendara/resources/lists.rb

Instance Method Summary collapse

Methods inherited from Sendara::Resource

#initialize

Constructor Details

This class inherits a constructor from Sendara::Resource

Instance Method Details

#add_member(id, contact_id) ⇒ Object 



39
40
41
42
 
# File 'lib/sendara/resources/lists.rb', line 39

def add_member(id, contact_id)
  request(:post, "/v1/contacts/lists/#{encode(id)}/members",
          body: { "contact_id" => contact_id }) || {}
end

#create(name:, list_type: nil, segment_rules: nil) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/sendara/resources/lists.rb', line 17

def create(name:, list_type: nil, segment_rules: nil)
  body = compact_params(
    "name" => name,
    "list_type" => list_type,
    "segment_rules" => segment_rules
  )
  request(:post, "/v1/contacts/lists", body: body) || {}
end

#delete(id) ⇒ Object 



34
35
36
37
 
# File 'lib/sendara/resources/lists.rb', line 34

def delete(id)
  request(:delete, "/v1/contacts/lists/#{encode(id)}")
  nil
end

#get(id) ⇒ Object 



13
14
15
 
# File 'lib/sendara/resources/lists.rb', line 13

def get(id)
  request(:get, "/v1/contacts/lists/#{encode(id)}") || {}
end

#list(limit: nil, offset: nil) ⇒ Object 



6
7
8
9
10
11
 
# File 'lib/sendara/resources/lists.rb', line 6

def list(limit: nil, offset: nil)
  query = compact_params("limit" => limit, "offset" => offset)
  response = request(:get, "/v1/contacts/lists", query: query) || {}
  lists = response["lists"]
  lists.is_a?(Array) ? lists : []
end

#members(id) ⇒ Object 



49
50
51
52
53
 
# File 'lib/sendara/resources/lists.rb', line 49

def members(id)
  response = request(:get, "/v1/contacts/lists/#{encode(id)}/members") || {}
  members = response["members"]
  members.is_a?(Array) ? members : []
end

#remove_member(id, contact_id) ⇒ Object 



44
45
46
47
 
# File 'lib/sendara/resources/lists.rb', line 44

def remove_member(id, contact_id)
  request(:delete, "/v1/contacts/lists/#{encode(id)}/members/#{encode(contact_id)}")
  nil
end

#update(id, name: nil, segment_rules: nil) ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/sendara/resources/lists.rb', line 26

def update(id, name: nil, segment_rules: nil)
  body = compact_params(
    "name" => name,
    "segment_rules" => segment_rules
  )
  request(:put, "/v1/contacts/lists/#{encode(id)}", body: body) || {}
end