gnumarcelo-campaigning 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +20 -0
- data/README.rdoc +15 -0
- data/Rakefile +57 -0
- data/VERSION.yml +4 -0
- data/lib/campaigning.rb +59 -0
- data/lib/campaigning/Result.rb +12 -0
- data/lib/campaigning/apiClient.rb +1927 -0
- data/lib/campaigning/client.rb +12 -0
- data/lib/campaigning/default.rb +1393 -0
- data/test/campaigning_test.rb +16 -0
- data/test/test_helper.rb +9 -0
- metadata +74 -0
@@ -0,0 +1,12 @@
|
|
1
|
+
# {http://api.createsend.com/api/}Client
|
2
|
+
# clientID - SOAP::SOAPString
|
3
|
+
# name - SOAP::SOAPString
|
4
|
+
class Client
|
5
|
+
attr_accessor :clientID
|
6
|
+
attr_accessor :name
|
7
|
+
|
8
|
+
def initialize(clientID = nil, name = nil)
|
9
|
+
@clientID = clientID
|
10
|
+
@name = name
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,1393 @@
|
|
1
|
+
require 'xsd/qname'
|
2
|
+
|
3
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberCustomField
|
4
|
+
class ArrayOfSubscriberCustomField < ::Array
|
5
|
+
end
|
6
|
+
|
7
|
+
# {http://api.createsend.com/api/}SubscriberCustomField
|
8
|
+
# key - SOAP::SOAPString
|
9
|
+
# value - SOAP::SOAPString
|
10
|
+
class SubscriberCustomField
|
11
|
+
attr_accessor :key
|
12
|
+
attr_accessor :value
|
13
|
+
|
14
|
+
def initialize(key = nil, value = nil)
|
15
|
+
@key = key
|
16
|
+
@value = value
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
# {http://api.createsend.com/api/}Result
|
21
|
+
# code - SOAP::SOAPInt
|
22
|
+
# message - SOAP::SOAPString
|
23
|
+
class Result
|
24
|
+
attr_accessor :code
|
25
|
+
attr_accessor :message
|
26
|
+
|
27
|
+
def initialize(code = nil, message = nil)
|
28
|
+
@code = code
|
29
|
+
@message = message
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
# {http://api.createsend.com/api/}Client
|
34
|
+
# clientID - SOAP::SOAPString
|
35
|
+
# name - SOAP::SOAPString
|
36
|
+
class Client
|
37
|
+
attr_accessor :clientID
|
38
|
+
attr_accessor :name
|
39
|
+
|
40
|
+
def initialize(clientID = nil, name = nil)
|
41
|
+
@clientID = clientID
|
42
|
+
@name = name
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# {http://api.createsend.com/api/}CampaignSummary
|
47
|
+
# recipients - SOAP::SOAPInt
|
48
|
+
# totalOpened - SOAP::SOAPInt
|
49
|
+
# clicks - SOAP::SOAPInt
|
50
|
+
# unsubscribed - SOAP::SOAPInt
|
51
|
+
# bounced - SOAP::SOAPInt
|
52
|
+
class CampaignSummary
|
53
|
+
attr_accessor :recipients
|
54
|
+
attr_accessor :totalOpened
|
55
|
+
attr_accessor :clicks
|
56
|
+
attr_accessor :unsubscribed
|
57
|
+
attr_accessor :bounced
|
58
|
+
|
59
|
+
def initialize(recipients = nil, totalOpened = nil, clicks = nil, unsubscribed = nil, bounced = nil)
|
60
|
+
@recipients = recipients
|
61
|
+
@totalOpened = totalOpened
|
62
|
+
@clicks = clicks
|
63
|
+
@unsubscribed = unsubscribed
|
64
|
+
@bounced = bounced
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
# {http://api.createsend.com/api/}SubscriberUnsubscribe
|
69
|
+
# emailAddress - SOAP::SOAPString
|
70
|
+
# listID - SOAP::SOAPString
|
71
|
+
class SubscriberUnsubscribe
|
72
|
+
attr_accessor :emailAddress
|
73
|
+
attr_accessor :listID
|
74
|
+
|
75
|
+
def initialize(emailAddress = nil, listID = nil)
|
76
|
+
@emailAddress = emailAddress
|
77
|
+
@listID = listID
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
# {http://api.createsend.com/api/}SubscriberBounce
|
82
|
+
# emailAddress - SOAP::SOAPString
|
83
|
+
# listID - SOAP::SOAPString
|
84
|
+
# bounceType - SOAP::SOAPString
|
85
|
+
class SubscriberBounce
|
86
|
+
attr_accessor :emailAddress
|
87
|
+
attr_accessor :listID
|
88
|
+
attr_accessor :bounceType
|
89
|
+
|
90
|
+
def initialize(emailAddress = nil, listID = nil, bounceType = nil)
|
91
|
+
@emailAddress = emailAddress
|
92
|
+
@listID = listID
|
93
|
+
@bounceType = bounceType
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
# {http://api.createsend.com/api/}SubscriberOpen
|
98
|
+
# emailAddress - SOAP::SOAPString
|
99
|
+
# listID - SOAP::SOAPString
|
100
|
+
# numberOfOpens - SOAP::SOAPInt
|
101
|
+
class SubscriberOpen
|
102
|
+
attr_accessor :emailAddress
|
103
|
+
attr_accessor :listID
|
104
|
+
attr_accessor :numberOfOpens
|
105
|
+
|
106
|
+
def initialize(emailAddress = nil, listID = nil, numberOfOpens = nil)
|
107
|
+
@emailAddress = emailAddress
|
108
|
+
@listID = listID
|
109
|
+
@numberOfOpens = numberOfOpens
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# {http://api.createsend.com/api/}SubscriberClick
|
114
|
+
# emailAddress - SOAP::SOAPString
|
115
|
+
# listID - SOAP::SOAPString
|
116
|
+
# clickedLinks - ArrayOfSubscriberClickedLink
|
117
|
+
class SubscriberClick
|
118
|
+
attr_accessor :emailAddress
|
119
|
+
attr_accessor :listID
|
120
|
+
attr_accessor :clickedLinks
|
121
|
+
|
122
|
+
def initialize(emailAddress = nil, listID = nil, clickedLinks = nil)
|
123
|
+
@emailAddress = emailAddress
|
124
|
+
@listID = listID
|
125
|
+
@clickedLinks = clickedLinks
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberClickedLink
|
130
|
+
class ArrayOfSubscriberClickedLink < ::Array
|
131
|
+
end
|
132
|
+
|
133
|
+
# {http://api.createsend.com/api/}SubscriberClickedLink
|
134
|
+
# link - SOAP::SOAPString
|
135
|
+
# clicks - SOAP::SOAPString
|
136
|
+
class SubscriberClickedLink
|
137
|
+
attr_accessor :link
|
138
|
+
attr_accessor :clicks
|
139
|
+
|
140
|
+
def initialize(link = nil, clicks = nil)
|
141
|
+
@link = link
|
142
|
+
@clicks = clicks
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
146
|
+
# {http://api.createsend.com/api/}ClientDetail
|
147
|
+
# basicDetails - ClientBasicDetails
|
148
|
+
# accessAndBilling - ClientAccessAndBilling
|
149
|
+
class ClientDetail
|
150
|
+
attr_accessor :basicDetails
|
151
|
+
attr_accessor :accessAndBilling
|
152
|
+
|
153
|
+
def initialize(basicDetails = nil, accessAndBilling = nil)
|
154
|
+
@basicDetails = basicDetails
|
155
|
+
@accessAndBilling = accessAndBilling
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# {http://api.createsend.com/api/}ClientBasicDetails
|
160
|
+
# clientID - SOAP::SOAPString
|
161
|
+
# companyName - SOAP::SOAPString
|
162
|
+
# contactName - SOAP::SOAPString
|
163
|
+
# emailAddress - SOAP::SOAPString
|
164
|
+
# country - SOAP::SOAPString
|
165
|
+
# timezone - SOAP::SOAPString
|
166
|
+
class ClientBasicDetails
|
167
|
+
attr_accessor :clientID
|
168
|
+
attr_accessor :companyName
|
169
|
+
attr_accessor :contactName
|
170
|
+
attr_accessor :emailAddress
|
171
|
+
attr_accessor :country
|
172
|
+
attr_accessor :timezone
|
173
|
+
|
174
|
+
def initialize(clientID = nil, companyName = nil, contactName = nil, emailAddress = nil, country = nil, timezone = nil)
|
175
|
+
@clientID = clientID
|
176
|
+
@companyName = companyName
|
177
|
+
@contactName = contactName
|
178
|
+
@emailAddress = emailAddress
|
179
|
+
@country = country
|
180
|
+
@timezone = timezone
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
# {http://api.createsend.com/api/}ClientAccessAndBilling
|
185
|
+
# username - SOAP::SOAPString
|
186
|
+
# password - SOAP::SOAPString
|
187
|
+
# billingType - SOAP::SOAPString
|
188
|
+
# currency - SOAP::SOAPString
|
189
|
+
# deliveryFee - SOAP::SOAPString
|
190
|
+
# costPerRecipient - SOAP::SOAPString
|
191
|
+
# designAndSpamTestFee - SOAP::SOAPString
|
192
|
+
# accessLevel - SOAP::SOAPInt
|
193
|
+
class ClientAccessAndBilling
|
194
|
+
attr_accessor :username
|
195
|
+
attr_accessor :password
|
196
|
+
attr_accessor :billingType
|
197
|
+
attr_accessor :currency
|
198
|
+
attr_accessor :deliveryFee
|
199
|
+
attr_accessor :costPerRecipient
|
200
|
+
attr_accessor :designAndSpamTestFee
|
201
|
+
attr_accessor :accessLevel
|
202
|
+
|
203
|
+
def initialize(username = nil, password = nil, billingType = nil, currency = nil, deliveryFee = nil, costPerRecipient = nil, designAndSpamTestFee = nil, accessLevel = nil)
|
204
|
+
@username = username
|
205
|
+
@password = password
|
206
|
+
@billingType = billingType
|
207
|
+
@currency = currency
|
208
|
+
@deliveryFee = deliveryFee
|
209
|
+
@costPerRecipient = costPerRecipient
|
210
|
+
@designAndSpamTestFee = designAndSpamTestFee
|
211
|
+
@accessLevel = accessLevel
|
212
|
+
end
|
213
|
+
end
|
214
|
+
|
215
|
+
# {http://api.createsend.com/api/}List
|
216
|
+
# listID - SOAP::SOAPString
|
217
|
+
# name - SOAP::SOAPString
|
218
|
+
class List
|
219
|
+
attr_accessor :listID
|
220
|
+
attr_accessor :name
|
221
|
+
|
222
|
+
def initialize(listID = nil, name = nil)
|
223
|
+
@listID = listID
|
224
|
+
@name = name
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
# {http://api.createsend.com/api/}Campaign
|
229
|
+
# campaignID - SOAP::SOAPString
|
230
|
+
# subject - SOAP::SOAPString
|
231
|
+
# sentDate - SOAP::SOAPString
|
232
|
+
# totalRecipients - SOAP::SOAPInt
|
233
|
+
class Campaign
|
234
|
+
attr_accessor :campaignID
|
235
|
+
attr_accessor :subject
|
236
|
+
attr_accessor :sentDate
|
237
|
+
attr_accessor :totalRecipients
|
238
|
+
|
239
|
+
def initialize(campaignID = nil, subject = nil, sentDate = nil, totalRecipients = nil)
|
240
|
+
@campaignID = campaignID
|
241
|
+
@subject = subject
|
242
|
+
@sentDate = sentDate
|
243
|
+
@totalRecipients = totalRecipients
|
244
|
+
end
|
245
|
+
end
|
246
|
+
|
247
|
+
# {http://api.createsend.com/api/}ListCustomField
|
248
|
+
# fieldName - SOAP::SOAPString
|
249
|
+
# key - SOAP::SOAPString
|
250
|
+
# dataType - SubscriberFieldDataType
|
251
|
+
# fieldOptions - ArrayOfString
|
252
|
+
class ListCustomField
|
253
|
+
attr_accessor :fieldName
|
254
|
+
attr_accessor :key
|
255
|
+
attr_accessor :dataType
|
256
|
+
attr_accessor :fieldOptions
|
257
|
+
|
258
|
+
def initialize(fieldName = nil, key = nil, dataType = nil, fieldOptions = nil)
|
259
|
+
@fieldName = fieldName
|
260
|
+
@key = key
|
261
|
+
@dataType = dataType
|
262
|
+
@fieldOptions = fieldOptions
|
263
|
+
end
|
264
|
+
end
|
265
|
+
|
266
|
+
# {http://api.createsend.com/api/}ArrayOfString
|
267
|
+
class ArrayOfString < ::Array
|
268
|
+
end
|
269
|
+
|
270
|
+
# {http://api.createsend.com/api/}ListDetail
|
271
|
+
# listID - SOAP::SOAPString
|
272
|
+
# title - SOAP::SOAPString
|
273
|
+
# unsubscribePage - SOAP::SOAPString
|
274
|
+
# confirmOptIn - SOAP::SOAPBoolean
|
275
|
+
# confirmationSuccessPage - SOAP::SOAPString
|
276
|
+
class ListDetail
|
277
|
+
attr_accessor :listID
|
278
|
+
attr_accessor :title
|
279
|
+
attr_accessor :unsubscribePage
|
280
|
+
attr_accessor :confirmOptIn
|
281
|
+
attr_accessor :confirmationSuccessPage
|
282
|
+
|
283
|
+
def initialize(listID = nil, title = nil, unsubscribePage = nil, confirmOptIn = nil, confirmationSuccessPage = nil)
|
284
|
+
@listID = listID
|
285
|
+
@title = title
|
286
|
+
@unsubscribePage = unsubscribePage
|
287
|
+
@confirmOptIn = confirmOptIn
|
288
|
+
@confirmationSuccessPage = confirmationSuccessPage
|
289
|
+
end
|
290
|
+
end
|
291
|
+
|
292
|
+
# {http://api.createsend.com/api/}Subscriber
|
293
|
+
# emailAddress - SOAP::SOAPString
|
294
|
+
# name - SOAP::SOAPString
|
295
|
+
# date - SOAP::SOAPString
|
296
|
+
# state - SOAP::SOAPString
|
297
|
+
# customFields - ArrayOfSubscriberCustomField
|
298
|
+
class Subscriber
|
299
|
+
attr_accessor :emailAddress
|
300
|
+
attr_accessor :name
|
301
|
+
attr_accessor :date
|
302
|
+
attr_accessor :state
|
303
|
+
attr_accessor :customFields
|
304
|
+
|
305
|
+
def initialize(emailAddress = nil, name = nil, date = nil, state = nil, customFields = nil)
|
306
|
+
@emailAddress = emailAddress
|
307
|
+
@name = name
|
308
|
+
@date = date
|
309
|
+
@state = state
|
310
|
+
@customFields = customFields
|
311
|
+
end
|
312
|
+
end
|
313
|
+
|
314
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriber
|
315
|
+
class ArrayOfSubscriber < ::Array
|
316
|
+
end
|
317
|
+
|
318
|
+
# {http://api.createsend.com/api/}ArrayOfListCustomField
|
319
|
+
class ArrayOfListCustomField < ::Array
|
320
|
+
end
|
321
|
+
|
322
|
+
# {http://api.createsend.com/api/}ArrayOfCampaign
|
323
|
+
class ArrayOfCampaign < ::Array
|
324
|
+
end
|
325
|
+
|
326
|
+
# {http://api.createsend.com/api/}ArrayOfList
|
327
|
+
class ArrayOfList < ::Array
|
328
|
+
end
|
329
|
+
|
330
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberClick
|
331
|
+
class ArrayOfSubscriberClick < ::Array
|
332
|
+
end
|
333
|
+
|
334
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberOpen
|
335
|
+
class ArrayOfSubscriberOpen < ::Array
|
336
|
+
end
|
337
|
+
|
338
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberBounce
|
339
|
+
class ArrayOfSubscriberBounce < ::Array
|
340
|
+
end
|
341
|
+
|
342
|
+
# {http://api.createsend.com/api/}ArrayOfSubscriberUnsubscribe
|
343
|
+
class ArrayOfSubscriberUnsubscribe < ::Array
|
344
|
+
end
|
345
|
+
|
346
|
+
# {http://api.createsend.com/api/}ArrayOfClient
|
347
|
+
class ArrayOfClient < ::Array
|
348
|
+
end
|
349
|
+
|
350
|
+
# {http://api.createsend.com/api/}SubscriberFieldDataType
|
351
|
+
class SubscriberFieldDataType < ::String
|
352
|
+
MultiSelectMany = SubscriberFieldDataType.new("MultiSelectMany")
|
353
|
+
MultiSelectOne = SubscriberFieldDataType.new("MultiSelectOne")
|
354
|
+
Number = SubscriberFieldDataType.new("Number")
|
355
|
+
Text = SubscriberFieldDataType.new("Text")
|
356
|
+
end
|
357
|
+
|
358
|
+
# {http://api.createsend.com/api/}Subscriber.AddWithCustomFields
|
359
|
+
# apiKey - SOAP::SOAPString
|
360
|
+
# listID - SOAP::SOAPString
|
361
|
+
# email - SOAP::SOAPString
|
362
|
+
# name - SOAP::SOAPString
|
363
|
+
# customFields - ArrayOfSubscriberCustomField
|
364
|
+
class SubscriberAddWithCustomFields
|
365
|
+
attr_accessor :apiKey
|
366
|
+
attr_accessor :listID
|
367
|
+
attr_accessor :email
|
368
|
+
attr_accessor :name
|
369
|
+
attr_accessor :customFields
|
370
|
+
|
371
|
+
def initialize(apiKey = nil, listID = nil, email = nil, name = nil, customFields = nil)
|
372
|
+
@apiKey = apiKey
|
373
|
+
@listID = listID
|
374
|
+
@email = email
|
375
|
+
@name = name
|
376
|
+
@customFields = customFields
|
377
|
+
end
|
378
|
+
end
|
379
|
+
|
380
|
+
# {http://api.createsend.com/api/}Subscriber.AddWithCustomFieldsResponse
|
381
|
+
# subscriber_AddWithCustomFieldsResult - Result
|
382
|
+
class SubscriberAddWithCustomFieldsResponse
|
383
|
+
attr_accessor :subscriber_AddWithCustomFieldsResult
|
384
|
+
|
385
|
+
def initialize(subscriber_AddWithCustomFieldsResult = nil)
|
386
|
+
@subscriber_AddWithCustomFieldsResult = subscriber_AddWithCustomFieldsResult
|
387
|
+
end
|
388
|
+
end
|
389
|
+
|
390
|
+
# {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFields
|
391
|
+
# apiKey - SOAP::SOAPString
|
392
|
+
# listID - SOAP::SOAPString
|
393
|
+
# email - SOAP::SOAPString
|
394
|
+
# name - SOAP::SOAPString
|
395
|
+
# customFields - ArrayOfSubscriberCustomField
|
396
|
+
class SubscriberAddAndResubscribeWithCustomFields
|
397
|
+
attr_accessor :apiKey
|
398
|
+
attr_accessor :listID
|
399
|
+
attr_accessor :email
|
400
|
+
attr_accessor :name
|
401
|
+
attr_accessor :customFields
|
402
|
+
|
403
|
+
def initialize(apiKey = nil, listID = nil, email = nil, name = nil, customFields = nil)
|
404
|
+
@apiKey = apiKey
|
405
|
+
@listID = listID
|
406
|
+
@email = email
|
407
|
+
@name = name
|
408
|
+
@customFields = customFields
|
409
|
+
end
|
410
|
+
end
|
411
|
+
|
412
|
+
# {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFieldsResponse
|
413
|
+
# subscriber_AddAndResubscribeWithCustomFieldsResult - Result
|
414
|
+
class SubscriberAddAndResubscribeWithCustomFieldsResponse
|
415
|
+
attr_accessor :subscriber_AddAndResubscribeWithCustomFieldsResult
|
416
|
+
|
417
|
+
def initialize(subscriber_AddAndResubscribeWithCustomFieldsResult = nil)
|
418
|
+
@subscriber_AddAndResubscribeWithCustomFieldsResult = subscriber_AddAndResubscribeWithCustomFieldsResult
|
419
|
+
end
|
420
|
+
end
|
421
|
+
|
422
|
+
# {http://api.createsend.com/api/}Subscriber.Add
|
423
|
+
# apiKey - SOAP::SOAPString
|
424
|
+
# listID - SOAP::SOAPString
|
425
|
+
# email - SOAP::SOAPString
|
426
|
+
# name - SOAP::SOAPString
|
427
|
+
class SubscriberAdd
|
428
|
+
attr_accessor :apiKey
|
429
|
+
attr_accessor :listID
|
430
|
+
attr_accessor :email
|
431
|
+
attr_accessor :name
|
432
|
+
|
433
|
+
def initialize(apiKey = nil, listID = nil, email = nil, name = nil)
|
434
|
+
@apiKey = apiKey
|
435
|
+
@listID = listID
|
436
|
+
@email = email
|
437
|
+
@name = name
|
438
|
+
end
|
439
|
+
end
|
440
|
+
|
441
|
+
# {http://api.createsend.com/api/}Subscriber.AddResponse
|
442
|
+
# subscriber_AddResult - Result
|
443
|
+
class SubscriberAddResponse
|
444
|
+
attr_accessor :subscriber_AddResult
|
445
|
+
|
446
|
+
def initialize(subscriber_AddResult = nil)
|
447
|
+
@subscriber_AddResult = subscriber_AddResult
|
448
|
+
end
|
449
|
+
end
|
450
|
+
|
451
|
+
# {http://api.createsend.com/api/}Subscriber.AddAndResubscribe
|
452
|
+
# apiKey - SOAP::SOAPString
|
453
|
+
# listID - SOAP::SOAPString
|
454
|
+
# email - SOAP::SOAPString
|
455
|
+
# name - SOAP::SOAPString
|
456
|
+
class SubscriberAddAndResubscribe
|
457
|
+
attr_accessor :apiKey
|
458
|
+
attr_accessor :listID
|
459
|
+
attr_accessor :email
|
460
|
+
attr_accessor :name
|
461
|
+
|
462
|
+
def initialize(apiKey = nil, listID = nil, email = nil, name = nil)
|
463
|
+
@apiKey = apiKey
|
464
|
+
@listID = listID
|
465
|
+
@email = email
|
466
|
+
@name = name
|
467
|
+
end
|
468
|
+
end
|
469
|
+
|
470
|
+
# {http://api.createsend.com/api/}Subscriber.AddAndResubscribeResponse
|
471
|
+
# subscriber_AddAndResubscribeResult - Result
|
472
|
+
class SubscriberAddAndResubscribeResponse
|
473
|
+
attr_accessor :subscriber_AddAndResubscribeResult
|
474
|
+
|
475
|
+
def initialize(subscriber_AddAndResubscribeResult = nil)
|
476
|
+
@subscriber_AddAndResubscribeResult = subscriber_AddAndResubscribeResult
|
477
|
+
end
|
478
|
+
end
|
479
|
+
|
480
|
+
# {http://api.createsend.com/api/}Subscriber.Unsubscribe
|
481
|
+
# apiKey - SOAP::SOAPString
|
482
|
+
# listID - SOAP::SOAPString
|
483
|
+
# email - SOAP::SOAPString
|
484
|
+
class SubscriberUnsubscribe_
|
485
|
+
attr_accessor :apiKey
|
486
|
+
attr_accessor :listID
|
487
|
+
attr_accessor :email
|
488
|
+
|
489
|
+
def initialize(apiKey = nil, listID = nil, email = nil)
|
490
|
+
@apiKey = apiKey
|
491
|
+
@listID = listID
|
492
|
+
@email = email
|
493
|
+
end
|
494
|
+
end
|
495
|
+
|
496
|
+
# {http://api.createsend.com/api/}Subscriber.UnsubscribeResponse
|
497
|
+
# subscriber_UnsubscribeResult - Result
|
498
|
+
class SubscriberUnsubscribeResponse
|
499
|
+
attr_accessor :subscriber_UnsubscribeResult
|
500
|
+
|
501
|
+
def initialize(subscriber_UnsubscribeResult = nil)
|
502
|
+
@subscriber_UnsubscribeResult = subscriber_UnsubscribeResult
|
503
|
+
end
|
504
|
+
end
|
505
|
+
|
506
|
+
# {http://api.createsend.com/api/}Subscribers.GetActive
|
507
|
+
# apiKey - SOAP::SOAPString
|
508
|
+
# listID - SOAP::SOAPString
|
509
|
+
# date - SOAP::SOAPString
|
510
|
+
class SubscribersGetActive
|
511
|
+
attr_accessor :apiKey
|
512
|
+
attr_accessor :listID
|
513
|
+
attr_accessor :date
|
514
|
+
|
515
|
+
def initialize(apiKey = nil, listID = nil, date = nil)
|
516
|
+
@apiKey = apiKey
|
517
|
+
@listID = listID
|
518
|
+
@date = date
|
519
|
+
end
|
520
|
+
end
|
521
|
+
|
522
|
+
# {http://api.createsend.com/api/}Subscribers.GetActiveResponse
|
523
|
+
# subscribers_GetActiveResult - (any)
|
524
|
+
class SubscribersGetActiveResponse
|
525
|
+
attr_accessor :subscribers_GetActiveResult
|
526
|
+
|
527
|
+
def initialize(subscribers_GetActiveResult = nil)
|
528
|
+
@subscribers_GetActiveResult = subscribers_GetActiveResult
|
529
|
+
end
|
530
|
+
end
|
531
|
+
|
532
|
+
# {http://api.createsend.com/api/}Subscribers.GetUnsubscribed
|
533
|
+
# apiKey - SOAP::SOAPString
|
534
|
+
# listID - SOAP::SOAPString
|
535
|
+
# date - SOAP::SOAPString
|
536
|
+
class SubscribersGetUnsubscribed
|
537
|
+
attr_accessor :apiKey
|
538
|
+
attr_accessor :listID
|
539
|
+
attr_accessor :date
|
540
|
+
|
541
|
+
def initialize(apiKey = nil, listID = nil, date = nil)
|
542
|
+
@apiKey = apiKey
|
543
|
+
@listID = listID
|
544
|
+
@date = date
|
545
|
+
end
|
546
|
+
end
|
547
|
+
|
548
|
+
# {http://api.createsend.com/api/}Subscribers.GetUnsubscribedResponse
|
549
|
+
# subscribers_GetUnsubscribedResult - (any)
|
550
|
+
class SubscribersGetUnsubscribedResponse
|
551
|
+
attr_accessor :subscribers_GetUnsubscribedResult
|
552
|
+
|
553
|
+
def initialize(subscribers_GetUnsubscribedResult = nil)
|
554
|
+
@subscribers_GetUnsubscribedResult = subscribers_GetUnsubscribedResult
|
555
|
+
end
|
556
|
+
end
|
557
|
+
|
558
|
+
# {http://api.createsend.com/api/}Subscribers.GetBounced
|
559
|
+
# apiKey - SOAP::SOAPString
|
560
|
+
# listID - SOAP::SOAPString
|
561
|
+
# date - SOAP::SOAPString
|
562
|
+
class SubscribersGetBounced
|
563
|
+
attr_accessor :apiKey
|
564
|
+
attr_accessor :listID
|
565
|
+
attr_accessor :date
|
566
|
+
|
567
|
+
def initialize(apiKey = nil, listID = nil, date = nil)
|
568
|
+
@apiKey = apiKey
|
569
|
+
@listID = listID
|
570
|
+
@date = date
|
571
|
+
end
|
572
|
+
end
|
573
|
+
|
574
|
+
# {http://api.createsend.com/api/}Subscribers.GetBouncedResponse
|
575
|
+
# subscribers_GetBouncedResult - (any)
|
576
|
+
class SubscribersGetBouncedResponse
|
577
|
+
attr_accessor :subscribers_GetBouncedResult
|
578
|
+
|
579
|
+
def initialize(subscribers_GetBouncedResult = nil)
|
580
|
+
@subscribers_GetBouncedResult = subscribers_GetBouncedResult
|
581
|
+
end
|
582
|
+
end
|
583
|
+
|
584
|
+
# {http://api.createsend.com/api/}Subscribers.GetSingleSubscriber
|
585
|
+
# apiKey - SOAP::SOAPString
|
586
|
+
# listID - SOAP::SOAPString
|
587
|
+
# emailAddress - SOAP::SOAPString
|
588
|
+
class SubscribersGetSingleSubscriber
|
589
|
+
attr_accessor :apiKey
|
590
|
+
attr_accessor :listID
|
591
|
+
attr_accessor :emailAddress
|
592
|
+
|
593
|
+
def initialize(apiKey = nil, listID = nil, emailAddress = nil)
|
594
|
+
@apiKey = apiKey
|
595
|
+
@listID = listID
|
596
|
+
@emailAddress = emailAddress
|
597
|
+
end
|
598
|
+
end
|
599
|
+
|
600
|
+
# {http://api.createsend.com/api/}Subscribers.GetSingleSubscriberResponse
|
601
|
+
# subscribers_GetSingleSubscriberResult - (any)
|
602
|
+
class SubscribersGetSingleSubscriberResponse
|
603
|
+
attr_accessor :subscribers_GetSingleSubscriberResult
|
604
|
+
|
605
|
+
def initialize(subscribers_GetSingleSubscriberResult = nil)
|
606
|
+
@subscribers_GetSingleSubscriberResult = subscribers_GetSingleSubscriberResult
|
607
|
+
end
|
608
|
+
end
|
609
|
+
|
610
|
+
# {http://api.createsend.com/api/}Subscribers.GetIsSubscribed
|
611
|
+
# apiKey - SOAP::SOAPString
|
612
|
+
# listID - SOAP::SOAPString
|
613
|
+
# email - SOAP::SOAPString
|
614
|
+
class SubscribersGetIsSubscribed
|
615
|
+
attr_accessor :apiKey
|
616
|
+
attr_accessor :listID
|
617
|
+
attr_accessor :email
|
618
|
+
|
619
|
+
def initialize(apiKey = nil, listID = nil, email = nil)
|
620
|
+
@apiKey = apiKey
|
621
|
+
@listID = listID
|
622
|
+
@email = email
|
623
|
+
end
|
624
|
+
end
|
625
|
+
|
626
|
+
# {http://api.createsend.com/api/}Subscribers.GetIsSubscribedResponse
|
627
|
+
# subscribers_GetIsSubscribedResult - (any)
|
628
|
+
class SubscribersGetIsSubscribedResponse
|
629
|
+
attr_accessor :subscribers_GetIsSubscribedResult
|
630
|
+
|
631
|
+
def initialize(subscribers_GetIsSubscribedResult = nil)
|
632
|
+
@subscribers_GetIsSubscribedResult = subscribers_GetIsSubscribedResult
|
633
|
+
end
|
634
|
+
end
|
635
|
+
|
636
|
+
# {http://api.createsend.com/api/}List.Create
|
637
|
+
# apiKey - SOAP::SOAPString
|
638
|
+
# clientID - SOAP::SOAPString
|
639
|
+
# title - SOAP::SOAPString
|
640
|
+
# unsubscribePage - SOAP::SOAPString
|
641
|
+
# confirmOptIn - SOAP::SOAPBoolean
|
642
|
+
# confirmationSuccessPage - SOAP::SOAPString
|
643
|
+
class ListCreate
|
644
|
+
attr_accessor :apiKey
|
645
|
+
attr_accessor :clientID
|
646
|
+
attr_accessor :title
|
647
|
+
attr_accessor :unsubscribePage
|
648
|
+
attr_accessor :confirmOptIn
|
649
|
+
attr_accessor :confirmationSuccessPage
|
650
|
+
|
651
|
+
def initialize(apiKey = nil, clientID = nil, title = nil, unsubscribePage = nil, confirmOptIn = nil, confirmationSuccessPage = nil)
|
652
|
+
@apiKey = apiKey
|
653
|
+
@clientID = clientID
|
654
|
+
@title = title
|
655
|
+
@unsubscribePage = unsubscribePage
|
656
|
+
@confirmOptIn = confirmOptIn
|
657
|
+
@confirmationSuccessPage = confirmationSuccessPage
|
658
|
+
end
|
659
|
+
end
|
660
|
+
|
661
|
+
# {http://api.createsend.com/api/}List.CreateResponse
|
662
|
+
# list_CreateResult - (any)
|
663
|
+
class ListCreateResponse
|
664
|
+
attr_accessor :list_CreateResult
|
665
|
+
|
666
|
+
def initialize(list_CreateResult = nil)
|
667
|
+
@list_CreateResult = list_CreateResult
|
668
|
+
end
|
669
|
+
end
|
670
|
+
|
671
|
+
# {http://api.createsend.com/api/}List.Update
|
672
|
+
# apiKey - SOAP::SOAPString
|
673
|
+
# listID - SOAP::SOAPString
|
674
|
+
# title - SOAP::SOAPString
|
675
|
+
# unsubscribePage - SOAP::SOAPString
|
676
|
+
# confirmOptIn - SOAP::SOAPBoolean
|
677
|
+
# confirmationSuccessPage - SOAP::SOAPString
|
678
|
+
class ListUpdate
|
679
|
+
attr_accessor :apiKey
|
680
|
+
attr_accessor :listID
|
681
|
+
attr_accessor :title
|
682
|
+
attr_accessor :unsubscribePage
|
683
|
+
attr_accessor :confirmOptIn
|
684
|
+
attr_accessor :confirmationSuccessPage
|
685
|
+
|
686
|
+
def initialize(apiKey = nil, listID = nil, title = nil, unsubscribePage = nil, confirmOptIn = nil, confirmationSuccessPage = nil)
|
687
|
+
@apiKey = apiKey
|
688
|
+
@listID = listID
|
689
|
+
@title = title
|
690
|
+
@unsubscribePage = unsubscribePage
|
691
|
+
@confirmOptIn = confirmOptIn
|
692
|
+
@confirmationSuccessPage = confirmationSuccessPage
|
693
|
+
end
|
694
|
+
end
|
695
|
+
|
696
|
+
# {http://api.createsend.com/api/}List.UpdateResponse
|
697
|
+
# list_UpdateResult - Result
|
698
|
+
class ListUpdateResponse
|
699
|
+
attr_accessor :list_UpdateResult
|
700
|
+
|
701
|
+
def initialize(list_UpdateResult = nil)
|
702
|
+
@list_UpdateResult = list_UpdateResult
|
703
|
+
end
|
704
|
+
end
|
705
|
+
|
706
|
+
# {http://api.createsend.com/api/}List.GetDetail
|
707
|
+
# apiKey - SOAP::SOAPString
|
708
|
+
# listID - SOAP::SOAPString
|
709
|
+
class ListGetDetail
|
710
|
+
attr_accessor :apiKey
|
711
|
+
attr_accessor :listID
|
712
|
+
|
713
|
+
def initialize(apiKey = nil, listID = nil)
|
714
|
+
@apiKey = apiKey
|
715
|
+
@listID = listID
|
716
|
+
end
|
717
|
+
end
|
718
|
+
|
719
|
+
# {http://api.createsend.com/api/}List.GetDetailResponse
|
720
|
+
# list_GetDetailResult - (any)
|
721
|
+
class ListGetDetailResponse
|
722
|
+
attr_accessor :list_GetDetailResult
|
723
|
+
|
724
|
+
def initialize(list_GetDetailResult = nil)
|
725
|
+
@list_GetDetailResult = list_GetDetailResult
|
726
|
+
end
|
727
|
+
end
|
728
|
+
|
729
|
+
# {http://api.createsend.com/api/}List.Delete
|
730
|
+
# apiKey - SOAP::SOAPString
|
731
|
+
# listID - SOAP::SOAPString
|
732
|
+
class ListDelete
|
733
|
+
attr_accessor :apiKey
|
734
|
+
attr_accessor :listID
|
735
|
+
|
736
|
+
def initialize(apiKey = nil, listID = nil)
|
737
|
+
@apiKey = apiKey
|
738
|
+
@listID = listID
|
739
|
+
end
|
740
|
+
end
|
741
|
+
|
742
|
+
# {http://api.createsend.com/api/}List.DeleteResponse
|
743
|
+
# list_DeleteResult - Result
|
744
|
+
class ListDeleteResponse
|
745
|
+
attr_accessor :list_DeleteResult
|
746
|
+
|
747
|
+
def initialize(list_DeleteResult = nil)
|
748
|
+
@list_DeleteResult = list_DeleteResult
|
749
|
+
end
|
750
|
+
end
|
751
|
+
|
752
|
+
# {http://api.createsend.com/api/}List.GetCustomFields
|
753
|
+
# apiKey - SOAP::SOAPString
|
754
|
+
# listID - SOAP::SOAPString
|
755
|
+
class ListGetCustomFields
|
756
|
+
attr_accessor :apiKey
|
757
|
+
attr_accessor :listID
|
758
|
+
|
759
|
+
def initialize(apiKey = nil, listID = nil)
|
760
|
+
@apiKey = apiKey
|
761
|
+
@listID = listID
|
762
|
+
end
|
763
|
+
end
|
764
|
+
|
765
|
+
# {http://api.createsend.com/api/}List.GetCustomFieldsResponse
|
766
|
+
# list_GetCustomFieldsResult - (any)
|
767
|
+
class ListGetCustomFieldsResponse
|
768
|
+
attr_accessor :list_GetCustomFieldsResult
|
769
|
+
|
770
|
+
def initialize(list_GetCustomFieldsResult = nil)
|
771
|
+
@list_GetCustomFieldsResult = list_GetCustomFieldsResult
|
772
|
+
end
|
773
|
+
end
|
774
|
+
|
775
|
+
# {http://api.createsend.com/api/}List.DeleteCustomField
|
776
|
+
# apiKey - SOAP::SOAPString
|
777
|
+
# listID - SOAP::SOAPString
|
778
|
+
# key - SOAP::SOAPString
|
779
|
+
class ListDeleteCustomField
|
780
|
+
attr_accessor :apiKey
|
781
|
+
attr_accessor :listID
|
782
|
+
attr_accessor :key
|
783
|
+
|
784
|
+
def initialize(apiKey = nil, listID = nil, key = nil)
|
785
|
+
@apiKey = apiKey
|
786
|
+
@listID = listID
|
787
|
+
@key = key
|
788
|
+
end
|
789
|
+
end
|
790
|
+
|
791
|
+
# {http://api.createsend.com/api/}List.DeleteCustomFieldResponse
|
792
|
+
# list_DeleteCustomFieldResult - Result
|
793
|
+
class ListDeleteCustomFieldResponse
|
794
|
+
attr_accessor :list_DeleteCustomFieldResult
|
795
|
+
|
796
|
+
def initialize(list_DeleteCustomFieldResult = nil)
|
797
|
+
@list_DeleteCustomFieldResult = list_DeleteCustomFieldResult
|
798
|
+
end
|
799
|
+
end
|
800
|
+
|
801
|
+
# {http://api.createsend.com/api/}List.CreateCustomField
|
802
|
+
# apiKey - SOAP::SOAPString
|
803
|
+
# listID - SOAP::SOAPString
|
804
|
+
# fieldName - SOAP::SOAPString
|
805
|
+
# dataType - SubscriberFieldDataType
|
806
|
+
# options - SOAP::SOAPString
|
807
|
+
class ListCreateCustomField
|
808
|
+
attr_accessor :apiKey
|
809
|
+
attr_accessor :listID
|
810
|
+
attr_accessor :fieldName
|
811
|
+
attr_accessor :dataType
|
812
|
+
attr_accessor :options
|
813
|
+
|
814
|
+
def initialize(apiKey = nil, listID = nil, fieldName = nil, dataType = nil, options = nil)
|
815
|
+
@apiKey = apiKey
|
816
|
+
@listID = listID
|
817
|
+
@fieldName = fieldName
|
818
|
+
@dataType = dataType
|
819
|
+
@options = options
|
820
|
+
end
|
821
|
+
end
|
822
|
+
|
823
|
+
# {http://api.createsend.com/api/}List.CreateCustomFieldResponse
|
824
|
+
# list_CreateCustomFieldResult - Result
|
825
|
+
class ListCreateCustomFieldResponse
|
826
|
+
attr_accessor :list_CreateCustomFieldResult
|
827
|
+
|
828
|
+
def initialize(list_CreateCustomFieldResult = nil)
|
829
|
+
@list_CreateCustomFieldResult = list_CreateCustomFieldResult
|
830
|
+
end
|
831
|
+
end
|
832
|
+
|
833
|
+
# {http://api.createsend.com/api/}Client.GetCampaigns
|
834
|
+
# apiKey - SOAP::SOAPString
|
835
|
+
# clientID - SOAP::SOAPString
|
836
|
+
class ClientGetCampaigns
|
837
|
+
attr_accessor :apiKey
|
838
|
+
attr_accessor :clientID
|
839
|
+
|
840
|
+
def initialize(apiKey = nil, clientID = nil)
|
841
|
+
@apiKey = apiKey
|
842
|
+
@clientID = clientID
|
843
|
+
end
|
844
|
+
end
|
845
|
+
|
846
|
+
# {http://api.createsend.com/api/}Client.GetCampaignsResponse
|
847
|
+
# client_GetCampaignsResult - (any)
|
848
|
+
class ClientGetCampaignsResponse
|
849
|
+
attr_accessor :client_GetCampaignsResult
|
850
|
+
|
851
|
+
def initialize(client_GetCampaignsResult = nil)
|
852
|
+
@client_GetCampaignsResult = client_GetCampaignsResult
|
853
|
+
end
|
854
|
+
end
|
855
|
+
|
856
|
+
# {http://api.createsend.com/api/}Client.GetLists
|
857
|
+
# apiKey - SOAP::SOAPString
|
858
|
+
# clientID - SOAP::SOAPString
|
859
|
+
class ClientGetLists
|
860
|
+
attr_accessor :apiKey
|
861
|
+
attr_accessor :clientID
|
862
|
+
|
863
|
+
def initialize(apiKey = nil, clientID = nil)
|
864
|
+
@apiKey = apiKey
|
865
|
+
@clientID = clientID
|
866
|
+
end
|
867
|
+
end
|
868
|
+
|
869
|
+
# {http://api.createsend.com/api/}Client.GetListsResponse
|
870
|
+
# client_GetListsResult - (any)
|
871
|
+
class ClientGetListsResponse
|
872
|
+
attr_accessor :client_GetListsResult
|
873
|
+
|
874
|
+
def initialize(client_GetListsResult = nil)
|
875
|
+
@client_GetListsResult = client_GetListsResult
|
876
|
+
end
|
877
|
+
end
|
878
|
+
|
879
|
+
# {http://api.createsend.com/api/}Client.GetSegments
|
880
|
+
# apiKey - SOAP::SOAPString
|
881
|
+
# clientID - SOAP::SOAPString
|
882
|
+
class ClientGetSegments
|
883
|
+
attr_accessor :apiKey
|
884
|
+
attr_accessor :clientID
|
885
|
+
|
886
|
+
def initialize(apiKey = nil, clientID = nil)
|
887
|
+
@apiKey = apiKey
|
888
|
+
@clientID = clientID
|
889
|
+
end
|
890
|
+
end
|
891
|
+
|
892
|
+
# {http://api.createsend.com/api/}Client.GetSegmentsResponse
|
893
|
+
# client_GetSegmentsResult - (any)
|
894
|
+
class ClientGetSegmentsResponse
|
895
|
+
attr_accessor :client_GetSegmentsResult
|
896
|
+
|
897
|
+
def initialize(client_GetSegmentsResult = nil)
|
898
|
+
@client_GetSegmentsResult = client_GetSegmentsResult
|
899
|
+
end
|
900
|
+
end
|
901
|
+
|
902
|
+
# {http://api.createsend.com/api/}Client.GetSuppressionList
|
903
|
+
# apiKey - SOAP::SOAPString
|
904
|
+
# clientID - SOAP::SOAPString
|
905
|
+
class ClientGetSuppressionList
|
906
|
+
attr_accessor :apiKey
|
907
|
+
attr_accessor :clientID
|
908
|
+
|
909
|
+
def initialize(apiKey = nil, clientID = nil)
|
910
|
+
@apiKey = apiKey
|
911
|
+
@clientID = clientID
|
912
|
+
end
|
913
|
+
end
|
914
|
+
|
915
|
+
# {http://api.createsend.com/api/}Client.GetSuppressionListResponse
|
916
|
+
# client_GetSuppressionListResult - (any)
|
917
|
+
class ClientGetSuppressionListResponse
|
918
|
+
attr_accessor :client_GetSuppressionListResult
|
919
|
+
|
920
|
+
def initialize(client_GetSuppressionListResult = nil)
|
921
|
+
@client_GetSuppressionListResult = client_GetSuppressionListResult
|
922
|
+
end
|
923
|
+
end
|
924
|
+
|
925
|
+
# {http://api.createsend.com/api/}Client.Create
|
926
|
+
# apiKey - SOAP::SOAPString
|
927
|
+
# companyName - SOAP::SOAPString
|
928
|
+
# contactName - SOAP::SOAPString
|
929
|
+
# emailAddress - SOAP::SOAPString
|
930
|
+
# country - SOAP::SOAPString
|
931
|
+
# timezone - SOAP::SOAPString
|
932
|
+
class ClientCreate
|
933
|
+
attr_accessor :apiKey
|
934
|
+
attr_accessor :companyName
|
935
|
+
attr_accessor :contactName
|
936
|
+
attr_accessor :emailAddress
|
937
|
+
attr_accessor :country
|
938
|
+
attr_accessor :timezone
|
939
|
+
|
940
|
+
def initialize(apiKey = nil, companyName = nil, contactName = nil, emailAddress = nil, country = nil, timezone = nil)
|
941
|
+
@apiKey = apiKey
|
942
|
+
@companyName = companyName
|
943
|
+
@contactName = contactName
|
944
|
+
@emailAddress = emailAddress
|
945
|
+
@country = country
|
946
|
+
@timezone = timezone
|
947
|
+
end
|
948
|
+
end
|
949
|
+
|
950
|
+
# {http://api.createsend.com/api/}Client.CreateResponse
|
951
|
+
# client_CreateResult - (any)
|
952
|
+
class ClientCreateResponse
|
953
|
+
attr_accessor :client_CreateResult
|
954
|
+
|
955
|
+
def initialize(client_CreateResult = nil)
|
956
|
+
@client_CreateResult = client_CreateResult
|
957
|
+
end
|
958
|
+
end
|
959
|
+
|
960
|
+
# {http://api.createsend.com/api/}Client.UpdateBasics
|
961
|
+
# apiKey - SOAP::SOAPString
|
962
|
+
# clientID - SOAP::SOAPString
|
963
|
+
# companyName - SOAP::SOAPString
|
964
|
+
# contactName - SOAP::SOAPString
|
965
|
+
# emailAddress - SOAP::SOAPString
|
966
|
+
# country - SOAP::SOAPString
|
967
|
+
# timezone - SOAP::SOAPString
|
968
|
+
class ClientUpdateBasics
|
969
|
+
attr_accessor :apiKey
|
970
|
+
attr_accessor :clientID
|
971
|
+
attr_accessor :companyName
|
972
|
+
attr_accessor :contactName
|
973
|
+
attr_accessor :emailAddress
|
974
|
+
attr_accessor :country
|
975
|
+
attr_accessor :timezone
|
976
|
+
|
977
|
+
def initialize(apiKey = nil, clientID = nil, companyName = nil, contactName = nil, emailAddress = nil, country = nil, timezone = nil)
|
978
|
+
@apiKey = apiKey
|
979
|
+
@clientID = clientID
|
980
|
+
@companyName = companyName
|
981
|
+
@contactName = contactName
|
982
|
+
@emailAddress = emailAddress
|
983
|
+
@country = country
|
984
|
+
@timezone = timezone
|
985
|
+
end
|
986
|
+
end
|
987
|
+
|
988
|
+
# {http://api.createsend.com/api/}Client.UpdateBasicsResponse
|
989
|
+
# client_UpdateBasicsResult - (any)
|
990
|
+
class ClientUpdateBasicsResponse
|
991
|
+
attr_accessor :client_UpdateBasicsResult
|
992
|
+
|
993
|
+
def initialize(client_UpdateBasicsResult = nil)
|
994
|
+
@client_UpdateBasicsResult = client_UpdateBasicsResult
|
995
|
+
end
|
996
|
+
end
|
997
|
+
|
998
|
+
# {http://api.createsend.com/api/}Client.UpdateAccessAndBilling
|
999
|
+
# apiKey - SOAP::SOAPString
|
1000
|
+
# clientID - SOAP::SOAPString
|
1001
|
+
# accessLevel - SOAP::SOAPInt
|
1002
|
+
# username - SOAP::SOAPString
|
1003
|
+
# password - SOAP::SOAPString
|
1004
|
+
# billingType - SOAP::SOAPString
|
1005
|
+
# currency - SOAP::SOAPString
|
1006
|
+
# deliveryFee - SOAP::SOAPString
|
1007
|
+
# costPerRecipient - SOAP::SOAPString
|
1008
|
+
# designAndSpamTestFee - SOAP::SOAPString
|
1009
|
+
class ClientUpdateAccessAndBilling
|
1010
|
+
attr_accessor :apiKey
|
1011
|
+
attr_accessor :clientID
|
1012
|
+
attr_accessor :accessLevel
|
1013
|
+
attr_accessor :username
|
1014
|
+
attr_accessor :password
|
1015
|
+
attr_accessor :billingType
|
1016
|
+
attr_accessor :currency
|
1017
|
+
attr_accessor :deliveryFee
|
1018
|
+
attr_accessor :costPerRecipient
|
1019
|
+
attr_accessor :designAndSpamTestFee
|
1020
|
+
|
1021
|
+
def initialize(apiKey = nil, clientID = nil, accessLevel = nil, username = nil, password = nil, billingType = nil, currency = nil, deliveryFee = nil, costPerRecipient = nil, designAndSpamTestFee = nil)
|
1022
|
+
@apiKey = apiKey
|
1023
|
+
@clientID = clientID
|
1024
|
+
@accessLevel = accessLevel
|
1025
|
+
@username = username
|
1026
|
+
@password = password
|
1027
|
+
@billingType = billingType
|
1028
|
+
@currency = currency
|
1029
|
+
@deliveryFee = deliveryFee
|
1030
|
+
@costPerRecipient = costPerRecipient
|
1031
|
+
@designAndSpamTestFee = designAndSpamTestFee
|
1032
|
+
end
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# {http://api.createsend.com/api/}Client.UpdateAccessAndBillingResponse
|
1036
|
+
# client_UpdateAccessAndBillingResult - Result
|
1037
|
+
class ClientUpdateAccessAndBillingResponse
|
1038
|
+
attr_accessor :client_UpdateAccessAndBillingResult
|
1039
|
+
|
1040
|
+
def initialize(client_UpdateAccessAndBillingResult = nil)
|
1041
|
+
@client_UpdateAccessAndBillingResult = client_UpdateAccessAndBillingResult
|
1042
|
+
end
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
# {http://api.createsend.com/api/}Client.GetDetail
|
1046
|
+
# apiKey - SOAP::SOAPString
|
1047
|
+
# clientID - SOAP::SOAPString
|
1048
|
+
class ClientGetDetail
|
1049
|
+
attr_accessor :apiKey
|
1050
|
+
attr_accessor :clientID
|
1051
|
+
|
1052
|
+
def initialize(apiKey = nil, clientID = nil)
|
1053
|
+
@apiKey = apiKey
|
1054
|
+
@clientID = clientID
|
1055
|
+
end
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# {http://api.createsend.com/api/}Client.GetDetailResponse
|
1059
|
+
# client_GetDetailResult - (any)
|
1060
|
+
class ClientGetDetailResponse
|
1061
|
+
attr_accessor :client_GetDetailResult
|
1062
|
+
|
1063
|
+
def initialize(client_GetDetailResult = nil)
|
1064
|
+
@client_GetDetailResult = client_GetDetailResult
|
1065
|
+
end
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# {http://api.createsend.com/api/}Client.Delete
|
1069
|
+
# apiKey - SOAP::SOAPString
|
1070
|
+
# clientID - SOAP::SOAPString
|
1071
|
+
class ClientDelete
|
1072
|
+
attr_accessor :apiKey
|
1073
|
+
attr_accessor :clientID
|
1074
|
+
|
1075
|
+
def initialize(apiKey = nil, clientID = nil)
|
1076
|
+
@apiKey = apiKey
|
1077
|
+
@clientID = clientID
|
1078
|
+
end
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# {http://api.createsend.com/api/}Client.DeleteResponse
|
1082
|
+
# client_DeleteResult - Result
|
1083
|
+
class ClientDeleteResponse
|
1084
|
+
attr_accessor :client_DeleteResult
|
1085
|
+
|
1086
|
+
def initialize(client_DeleteResult = nil)
|
1087
|
+
@client_DeleteResult = client_DeleteResult
|
1088
|
+
end
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
# {http://api.createsend.com/api/}Campaign.GetSubscriberClicks
|
1092
|
+
# apiKey - SOAP::SOAPString
|
1093
|
+
# campaignID - SOAP::SOAPString
|
1094
|
+
class CampaignGetSubscriberClicks
|
1095
|
+
attr_accessor :apiKey
|
1096
|
+
attr_accessor :campaignID
|
1097
|
+
|
1098
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1099
|
+
@apiKey = apiKey
|
1100
|
+
@campaignID = campaignID
|
1101
|
+
end
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
# {http://api.createsend.com/api/}Campaign.GetSubscriberClicksResponse
|
1105
|
+
# campaign_GetSubscriberClicksResult - (any)
|
1106
|
+
class CampaignGetSubscriberClicksResponse
|
1107
|
+
attr_accessor :campaign_GetSubscriberClicksResult
|
1108
|
+
|
1109
|
+
def initialize(campaign_GetSubscriberClicksResult = nil)
|
1110
|
+
@campaign_GetSubscriberClicksResult = campaign_GetSubscriberClicksResult
|
1111
|
+
end
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
# {http://api.createsend.com/api/}Campaign.GetOpens
|
1115
|
+
# apiKey - SOAP::SOAPString
|
1116
|
+
# campaignID - SOAP::SOAPString
|
1117
|
+
class CampaignGetOpens
|
1118
|
+
attr_accessor :apiKey
|
1119
|
+
attr_accessor :campaignID
|
1120
|
+
|
1121
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1122
|
+
@apiKey = apiKey
|
1123
|
+
@campaignID = campaignID
|
1124
|
+
end
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# {http://api.createsend.com/api/}Campaign.GetOpensResponse
|
1128
|
+
# campaign_GetOpensResult - (any)
|
1129
|
+
class CampaignGetOpensResponse
|
1130
|
+
attr_accessor :campaign_GetOpensResult
|
1131
|
+
|
1132
|
+
def initialize(campaign_GetOpensResult = nil)
|
1133
|
+
@campaign_GetOpensResult = campaign_GetOpensResult
|
1134
|
+
end
|
1135
|
+
end
|
1136
|
+
|
1137
|
+
# {http://api.createsend.com/api/}Campaign.GetBounces
|
1138
|
+
# apiKey - SOAP::SOAPString
|
1139
|
+
# campaignID - SOAP::SOAPString
|
1140
|
+
class CampaignGetBounces
|
1141
|
+
attr_accessor :apiKey
|
1142
|
+
attr_accessor :campaignID
|
1143
|
+
|
1144
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1145
|
+
@apiKey = apiKey
|
1146
|
+
@campaignID = campaignID
|
1147
|
+
end
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# {http://api.createsend.com/api/}Campaign.GetBouncesResponse
|
1151
|
+
# campaign_GetBouncesResult - (any)
|
1152
|
+
class CampaignGetBouncesResponse
|
1153
|
+
attr_accessor :campaign_GetBouncesResult
|
1154
|
+
|
1155
|
+
def initialize(campaign_GetBouncesResult = nil)
|
1156
|
+
@campaign_GetBouncesResult = campaign_GetBouncesResult
|
1157
|
+
end
|
1158
|
+
end
|
1159
|
+
|
1160
|
+
# {http://api.createsend.com/api/}Campaign.GetUnsubscribes
|
1161
|
+
# apiKey - SOAP::SOAPString
|
1162
|
+
# campaignID - SOAP::SOAPString
|
1163
|
+
class CampaignGetUnsubscribes
|
1164
|
+
attr_accessor :apiKey
|
1165
|
+
attr_accessor :campaignID
|
1166
|
+
|
1167
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1168
|
+
@apiKey = apiKey
|
1169
|
+
@campaignID = campaignID
|
1170
|
+
end
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# {http://api.createsend.com/api/}Campaign.GetUnsubscribesResponse
|
1174
|
+
# campaign_GetUnsubscribesResult - (any)
|
1175
|
+
class CampaignGetUnsubscribesResponse
|
1176
|
+
attr_accessor :campaign_GetUnsubscribesResult
|
1177
|
+
|
1178
|
+
def initialize(campaign_GetUnsubscribesResult = nil)
|
1179
|
+
@campaign_GetUnsubscribesResult = campaign_GetUnsubscribesResult
|
1180
|
+
end
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# {http://api.createsend.com/api/}Campaign.GetSummary
|
1184
|
+
# apiKey - SOAP::SOAPString
|
1185
|
+
# campaignID - SOAP::SOAPString
|
1186
|
+
class CampaignGetSummary
|
1187
|
+
attr_accessor :apiKey
|
1188
|
+
attr_accessor :campaignID
|
1189
|
+
|
1190
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1191
|
+
@apiKey = apiKey
|
1192
|
+
@campaignID = campaignID
|
1193
|
+
end
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# {http://api.createsend.com/api/}Campaign.GetSummaryResponse
|
1197
|
+
# campaign_GetSummaryResult - (any)
|
1198
|
+
class CampaignGetSummaryResponse
|
1199
|
+
attr_accessor :campaign_GetSummaryResult
|
1200
|
+
|
1201
|
+
def initialize(campaign_GetSummaryResult = nil)
|
1202
|
+
@campaign_GetSummaryResult = campaign_GetSummaryResult
|
1203
|
+
end
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# {http://api.createsend.com/api/}Campaign.GetLists
|
1207
|
+
# apiKey - SOAP::SOAPString
|
1208
|
+
# campaignID - SOAP::SOAPString
|
1209
|
+
class CampaignGetLists
|
1210
|
+
attr_accessor :apiKey
|
1211
|
+
attr_accessor :campaignID
|
1212
|
+
|
1213
|
+
def initialize(apiKey = nil, campaignID = nil)
|
1214
|
+
@apiKey = apiKey
|
1215
|
+
@campaignID = campaignID
|
1216
|
+
end
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# {http://api.createsend.com/api/}Campaign.GetListsResponse
|
1220
|
+
# campaign_GetListsResult - (any)
|
1221
|
+
class CampaignGetListsResponse
|
1222
|
+
attr_accessor :campaign_GetListsResult
|
1223
|
+
|
1224
|
+
def initialize(campaign_GetListsResult = nil)
|
1225
|
+
@campaign_GetListsResult = campaign_GetListsResult
|
1226
|
+
end
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
# {http://api.createsend.com/api/}User.GetClients
|
1230
|
+
# apiKey - SOAP::SOAPString
|
1231
|
+
class UserGetClients
|
1232
|
+
attr_accessor :apiKey
|
1233
|
+
|
1234
|
+
def initialize(apiKey = nil)
|
1235
|
+
@apiKey = apiKey
|
1236
|
+
end
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# {http://api.createsend.com/api/}User.GetClientsResponse
|
1240
|
+
# user_GetClientsResult - (any)
|
1241
|
+
class UserGetClientsResponse
|
1242
|
+
attr_accessor :user_GetClientsResult
|
1243
|
+
|
1244
|
+
def initialize(user_GetClientsResult = nil)
|
1245
|
+
@user_GetClientsResult = user_GetClientsResult
|
1246
|
+
end
|
1247
|
+
end
|
1248
|
+
|
1249
|
+
# {http://api.createsend.com/api/}User.GetSystemDate
|
1250
|
+
# apiKey - SOAP::SOAPString
|
1251
|
+
class UserGetSystemDate
|
1252
|
+
attr_accessor :apiKey
|
1253
|
+
|
1254
|
+
def initialize(apiKey = nil)
|
1255
|
+
@apiKey = apiKey
|
1256
|
+
end
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# {http://api.createsend.com/api/}User.GetSystemDateResponse
|
1260
|
+
# user_GetSystemDateResult - (any)
|
1261
|
+
class UserGetSystemDateResponse
|
1262
|
+
attr_accessor :user_GetSystemDateResult
|
1263
|
+
|
1264
|
+
def initialize(user_GetSystemDateResult = nil)
|
1265
|
+
@user_GetSystemDateResult = user_GetSystemDateResult
|
1266
|
+
end
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# {http://api.createsend.com/api/}User.GetTimezones
|
1270
|
+
# apiKey - SOAP::SOAPString
|
1271
|
+
class UserGetTimezones
|
1272
|
+
attr_accessor :apiKey
|
1273
|
+
|
1274
|
+
def initialize(apiKey = nil)
|
1275
|
+
@apiKey = apiKey
|
1276
|
+
end
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# {http://api.createsend.com/api/}User.GetTimezonesResponse
|
1280
|
+
# user_GetTimezonesResult - (any)
|
1281
|
+
class UserGetTimezonesResponse
|
1282
|
+
attr_accessor :user_GetTimezonesResult
|
1283
|
+
|
1284
|
+
def initialize(user_GetTimezonesResult = nil)
|
1285
|
+
@user_GetTimezonesResult = user_GetTimezonesResult
|
1286
|
+
end
|
1287
|
+
end
|
1288
|
+
|
1289
|
+
# {http://api.createsend.com/api/}User.GetCountries
|
1290
|
+
# apiKey - SOAP::SOAPString
|
1291
|
+
class UserGetCountries
|
1292
|
+
attr_accessor :apiKey
|
1293
|
+
|
1294
|
+
def initialize(apiKey = nil)
|
1295
|
+
@apiKey = apiKey
|
1296
|
+
end
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# {http://api.createsend.com/api/}User.GetCountriesResponse
|
1300
|
+
# user_GetCountriesResult - (any)
|
1301
|
+
class UserGetCountriesResponse
|
1302
|
+
attr_accessor :user_GetCountriesResult
|
1303
|
+
|
1304
|
+
def initialize(user_GetCountriesResult = nil)
|
1305
|
+
@user_GetCountriesResult = user_GetCountriesResult
|
1306
|
+
end
|
1307
|
+
end
|
1308
|
+
|
1309
|
+
# {http://api.createsend.com/api/}Campaign.Create
|
1310
|
+
# apiKey - SOAP::SOAPString
|
1311
|
+
# clientID - SOAP::SOAPString
|
1312
|
+
# campaignName - SOAP::SOAPString
|
1313
|
+
# campaignSubject - SOAP::SOAPString
|
1314
|
+
# fromName - SOAP::SOAPString
|
1315
|
+
# fromEmail - SOAP::SOAPString
|
1316
|
+
# replyTo - SOAP::SOAPString
|
1317
|
+
# htmlUrl - SOAP::SOAPString
|
1318
|
+
# textUrl - SOAP::SOAPString
|
1319
|
+
# subscriberListIDs - ArrayOfString
|
1320
|
+
# listSegments - ArrayOfList
|
1321
|
+
class CampaignCreate
|
1322
|
+
attr_accessor :apiKey
|
1323
|
+
attr_accessor :clientID
|
1324
|
+
attr_accessor :campaignName
|
1325
|
+
attr_accessor :campaignSubject
|
1326
|
+
attr_accessor :fromName
|
1327
|
+
attr_accessor :fromEmail
|
1328
|
+
attr_accessor :replyTo
|
1329
|
+
attr_accessor :htmlUrl
|
1330
|
+
attr_accessor :textUrl
|
1331
|
+
attr_accessor :subscriberListIDs
|
1332
|
+
attr_accessor :listSegments
|
1333
|
+
|
1334
|
+
def initialize(apiKey = nil, clientID = nil, campaignName = nil, campaignSubject = nil, fromName = nil, fromEmail = nil, replyTo = nil, htmlUrl = nil, textUrl = nil, subscriberListIDs = nil, listSegments = nil)
|
1335
|
+
@apiKey = apiKey
|
1336
|
+
@clientID = clientID
|
1337
|
+
@campaignName = campaignName
|
1338
|
+
@campaignSubject = campaignSubject
|
1339
|
+
@fromName = fromName
|
1340
|
+
@fromEmail = fromEmail
|
1341
|
+
@replyTo = replyTo
|
1342
|
+
@htmlUrl = htmlUrl
|
1343
|
+
@textUrl = textUrl
|
1344
|
+
@subscriberListIDs = subscriberListIDs
|
1345
|
+
@listSegments = listSegments
|
1346
|
+
end
|
1347
|
+
end
|
1348
|
+
|
1349
|
+
# {http://api.createsend.com/api/}Campaign.CreateResponse
|
1350
|
+
# campaign_CreateResult - (any)
|
1351
|
+
class CampaignCreateResponse
|
1352
|
+
attr_accessor :campaign_CreateResult
|
1353
|
+
|
1354
|
+
def initialize(campaign_CreateResult = nil)
|
1355
|
+
@campaign_CreateResult = campaign_CreateResult
|
1356
|
+
end
|
1357
|
+
end
|
1358
|
+
|
1359
|
+
# {http://api.createsend.com/api/}Campaign.Send
|
1360
|
+
# apiKey - SOAP::SOAPString
|
1361
|
+
# campaignID - SOAP::SOAPString
|
1362
|
+
# confirmationEmail - SOAP::SOAPString
|
1363
|
+
# sendDate - SOAP::SOAPString
|
1364
|
+
class CampaignSend
|
1365
|
+
attr_accessor :apiKey
|
1366
|
+
attr_accessor :campaignID
|
1367
|
+
attr_accessor :confirmationEmail
|
1368
|
+
attr_accessor :sendDate
|
1369
|
+
|
1370
|
+
def initialize(apiKey = nil, campaignID = nil, confirmationEmail = nil, sendDate = nil)
|
1371
|
+
@apiKey = apiKey
|
1372
|
+
@campaignID = campaignID
|
1373
|
+
@confirmationEmail = confirmationEmail
|
1374
|
+
@sendDate = sendDate
|
1375
|
+
end
|
1376
|
+
end
|
1377
|
+
|
1378
|
+
# {http://api.createsend.com/api/}Campaign.SendResponse
|
1379
|
+
# campaign_SendResult - Result
|
1380
|
+
class CampaignSendResponse
|
1381
|
+
attr_accessor :campaign_SendResult
|
1382
|
+
|
1383
|
+
def initialize(campaign_SendResult = nil)
|
1384
|
+
@campaign_SendResult = campaign_SendResult
|
1385
|
+
end
|
1386
|
+
end
|
1387
|
+
|
1388
|
+
# {http://api.createsend.com/api/}anyType
|
1389
|
+
class AnyType < ::String
|
1390
|
+
def initialize(*arg)
|
1391
|
+
super
|
1392
|
+
end
|
1393
|
+
end
|