-
Notifications
You must be signed in to change notification settings - Fork 74
/
list.rb
205 lines (176 loc) · 6.48 KB
/
list.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
require 'createsend'
require 'json'
module CreateSend
# Represents a subscriber list and associated functionality.
class List
attr_reader :list_id, :title, :confirmed_opt_in, :unsubscribe_page, :confirmation_success_page
def initialize(list_id, api_key, with_details = false)
@list_id = list_id
@api_key = api_key
@create_send = CreateSend.new(@api_key)
details if with_details
end
# Creates a new list for a client.
def self.create(client_id, title, unsubscribe_page, confirmed_opt_in, confirmation_success_page, api_key)
options = { :body => {
:Title => title,
:UnsubscribePage => unsubscribe_page,
:ConfirmedOptIn => confirmed_opt_in,
:ConfirmationSuccessPage => confirmation_success_page }.to_json }
response = CreateSend.new(api_key).post "/lists/#{client_id}.json", options
response.parsed_response
end
# Deletes this list.
def delete
response = @create_send.delete "/lists/#{list_id}.json", {}
end
# Creates a new custom field for this list.
def create_custom_field(field_name, data_type, options=[])
options = { :body => {
:FieldName => field_name,
:DataType => data_type,
:Options => options }.to_json }
response = post "customfields", options
response.parsed_response
end
# Deletes a custom field associated with this list.
def delete_custom_field(custom_field_key)
custom_field_key = CGI.escape(custom_field_key)
response = @create_send.delete "/lists/#{list_id}/customfields/#{custom_field_key}.json", {}
end
# Updates the options of a multi-optioned custom field on this list.
def update_custom_field_options(custom_field_key, new_options, keep_existing_options)
custom_field_key = CGI.escape(custom_field_key)
options = { :body => {
:Options => new_options,
:KeepExistingOptions => keep_existing_options }.to_json }
response = put "customfields/#{custom_field_key}/options", options
end
# Gets the details of this list.
def details
response = @create_send.get "/lists/#{list_id}.json", {}
hash = Hashie::Mash.new(response)
hash.each do |k, v|
instance_variable_set :"@#{k.underscore}", v
end
hash
end
# Gets the custom fields for this list.
def custom_fields
response = get "customfields"
response.map{|item| Hashie::Mash.new(item)}
end
# Gets the segments for this list.
def segments
response = get "segments"
response.map{|item| Hashie::Mash.new(item)}
end
# Gets the stats for this list.
def stats
response = get "stats"
Hashie::Mash.new(response)
end
# Gets the active subscribers for this list.
def active(date, page=1, page_size=1000, order_field="email", order_direction="asc")
options = { :query => {
:date => date,
:page => page,
:pagesize => page_size,
:orderfield => order_field,
:orderdirection => order_direction } }
response = get "active", options
Hashie::Mash.new(response)
end
# Gets the bounced subscribers for this list.
def bounced(date, page=1, page_size=1000, order_field="email", order_direction="asc")
options = { :query => {
:date => date,
:page => page,
:pagesize => page_size,
:orderfield => order_field,
:orderdirection => order_direction } }
response = get "bounced", options
Hashie::Mash.new(response)
end
# Gets the unsubscribed subscribers for this list.
def unsubscribed(date, page=1, page_size=1000, order_field="email", order_direction="asc")
options = { :query => {
:date => date,
:page => page,
:pagesize => page_size,
:orderfield => order_field,
:orderdirection => order_direction } }
response = get "unsubscribed", options
Hashie::Mash.new(response)
end
# Gets the deleted subscribers for this list.
def deleted(date, page=1, page_size=1000, order_field="email", order_direction="asc")
options = { :query => {
:date => date,
:page => page,
:pagesize => page_size,
:orderfield => order_field,
:orderdirection => order_direction } }
response = get "deleted", options
Hashie::Mash.new(response)
end
# Updates this list.
def update(title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
options = { :body => {
:Title => title,
:UnsubscribePage => unsubscribe_page,
:ConfirmedOptIn => confirmed_opt_in,
:ConfirmationSuccessPage => confirmation_success_page }.to_json }
response = @create_send.put "/lists/#{list_id}.json", options
end
# Gets the webhooks for this list.
def webhooks
response = get "webhooks"
response.map{|item| Hashie::Mash.new(item)}
end
# Creates a new webhook for the specified events (an array of strings).
# Valid events are "Subscribe", "Deactivate", and "Update".
# Valid payload formats are "json", and "xml".
def create_webhook(events, url, payload_format)
options = { :body => {
:Events => events,
:Url => url,
:PayloadFormat => payload_format }.to_json }
response = post "webhooks", options
response.parsed_response
end
# Tests that a post can be made to the endpoint specified for the webhook
# identified by webhook_id.
def test_webhook(webhook_id)
response = get "webhooks/#{webhook_id}/test"
true # An exception will be raised if any error occurs
end
# Deletes a webhook associated with this list.
def delete_webhook(webhook_id)
response = @create_send.delete "/lists/#{list_id}/webhooks/#{webhook_id}.json", {}
end
# Activates a webhook associated with this list.
def activate_webhook(webhook_id)
options = { :body => '' }
response = put "webhooks/#{webhook_id}/activate", options
end
# De-activates a webhook associated with this list.
def deactivate_webhook(webhook_id)
options = { :body => '' }
response = put "webhooks/#{webhook_id}/deactivate", options
end
private
def get(action, options = {})
@create_send.get uri_for(action), options
end
def post(action, options = {})
@create_send.post uri_for(action), options
end
def put(action, options = {})
@create_send.put uri_for(action), options
end
def uri_for(action)
"/lists/#{list_id}/#{action}.json"
end
end
end