Class: CleverElements::Subscribers

Inherits:
Resource
  • Object
show all
Defined in:
lib/cleverelements/subscribers.rb

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from CleverElements::Resource

Instance Method Details

#create(attributes) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cleverelements/subscribers.rb', line 29

def create(attributes)
  # attributes = [
  #   {
  #     list_id: 335333,
  #     email: "[email protected]",
  #     custom_fields: [
  #       {field_id: 818718, field_value: 'Master'},
  #     ]
  #   },
  #   {
  #     list_id: 335333,
  #     email: "[email protected]",
  #     custom_fields: [
  #       {field_id: 818718, field_value: 'The Master'},
  #     ]
  #   }
  # ]
  @client.api_add_subscriber(build_subscriber_list(attributes)).body
end

#create_custom_field(name, type = 1) ⇒ Object 



21
22
23
 
# File 'lib/cleverelements/subscribers.rb', line 21

def create_custom_field(name, type = 1)
  @client.api_add_subscriber_field(customFieldName: name, customFieldType: type).body
end

#create_doi(attributes) ⇒ Object 



49
50
51
 
# File 'lib/cleverelements/subscribers.rb', line 49

def create_doi(attributes)
  @client.api_add_subscriber_doi(build_subscriber_list(attributes)).body
end

#custom_fields ⇒ Object 



17
18
19
 
# File 'lib/cleverelements/subscribers.rb', line 17

def custom_fields
  @client.api_get_subscriber_fields.body
end

#destroy(ids) ⇒ Object 



66
67
68
69
 
# File 'lib/cleverelements/subscribers.rb', line 66

def destroy(ids)
  # ids = [290099412, 290099401]
  @client.api_delete_subscriber(build_subscriber_id_list_short(ids)).body
end

#destroy_custom_field(id) ⇒ Object 



25
26
27
 
# File 'lib/cleverelements/subscribers.rb', line 25

def destroy_custom_field(id)
  @client.api_delete_subscriber_field(customFieldID: id).body
end

#find_by_email(email) ⇒ Object 



9
10
11
 
# File 'lib/cleverelements/subscribers.rb', line 9

def find_by_email(email)
  @client.api_get_subscriber_by_email({email: email}).body
end

#get_subscriptions(id) ⇒ Object 



13
14
15
 
# File 'lib/cleverelements/subscribers.rb', line 13

def get_subscriptions(id)
  @client.api_get_subscriber_subscriptions({subscriberID: id}).body
end

#history_for(id) ⇒ Object 



5
6
7
 
# File 'lib/cleverelements/subscribers.rb', line 5

def history_for(id)
  @client.api_get_subscriber_history({subscriberID: id}).body
end

#unsubscribe(subscriber_list) ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'lib/cleverelements/subscribers.rb', line 53

def unsubscribe(subscriber_list)
  # attributes = [
  #   {id: 290099412, list_id: 335333},
  #   {id: 290086837, list_id: 335333}
  # ]

  @client.api_unsubscribe_subscriber_from_list(build_subscriber_id_list(subscriber_list)).body
end

#unsubscribe_from_all(subscriber_list) ⇒ Object 



62
63
64
 
# File 'lib/cleverelements/subscribers.rb', line 62

def unsubscribe_from_all(subscriber_list)
  @client.api_unsubscribe_subscriber_from_all(build_subscriber_id_list(subscriber_list)).body
end