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
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Marcelo Menezes
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
|
2
|
+
== THIS GEM IS UNDER DEVELOPMENT
|
3
|
+
|
4
|
+
= campaigning
|
5
|
+
|
6
|
+
This RubyGem provides access to the CampaignMonitor API(www.campaignmonitor.com/api) using SOAP.
|
7
|
+
|
8
|
+
== Dependencies
|
9
|
+
This gem requires the following gem's:
|
10
|
+
-Soap4r (1.5.8)
|
11
|
+
-Jeweler
|
12
|
+
|
13
|
+
== Copyright
|
14
|
+
|
15
|
+
Copyright (c) 2009 Marcelo Menezes. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "campaigning"
|
8
|
+
gem.summary = %Q{TODO}
|
9
|
+
gem.email = "gnumarcelo@gmail.com"
|
10
|
+
gem.homepage = "http://github.com/gnumarcelo/campaigning"
|
11
|
+
gem.authors = ["Marcelo Menezes"]
|
12
|
+
gem.add_dependency('soap4r', '~> 1.5.0')
|
13
|
+
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
rescue LoadError
|
17
|
+
puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
|
18
|
+
end
|
19
|
+
|
20
|
+
require 'rake/testtask'
|
21
|
+
Rake::TestTask.new(:test) do |test|
|
22
|
+
test.libs << 'lib' << 'test'
|
23
|
+
test.pattern = 'test/**/*_test.rb'
|
24
|
+
test.verbose = true
|
25
|
+
end
|
26
|
+
|
27
|
+
begin
|
28
|
+
require 'rcov/rcovtask'
|
29
|
+
Rcov::RcovTask.new do |test|
|
30
|
+
test.libs << 'test'
|
31
|
+
test.pattern = 'test/**/*_test.rb'
|
32
|
+
test.verbose = true
|
33
|
+
end
|
34
|
+
rescue LoadError
|
35
|
+
task :rcov do
|
36
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
|
41
|
+
task :default => :test
|
42
|
+
|
43
|
+
require 'rake/rdoctask'
|
44
|
+
Rake::RDocTask.new do |rdoc|
|
45
|
+
if File.exist?('VERSION.yml')
|
46
|
+
config = YAML.load(File.read('VERSION.yml'))
|
47
|
+
version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
|
48
|
+
else
|
49
|
+
version = ""
|
50
|
+
end
|
51
|
+
|
52
|
+
rdoc.rdoc_dir = 'rdoc'
|
53
|
+
rdoc.title = "campaigning #{version}"
|
54
|
+
rdoc.rdoc_files.include('README*')
|
55
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
56
|
+
end
|
57
|
+
|
data/VERSION.yml
ADDED
data/lib/campaigning.rb
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
require 'soap/wsdlDriver'
|
2
|
+
require 'net/http'
|
3
|
+
|
4
|
+
require File.join(File.dirname(__FILE__), 'campaigning/client.rb')
|
5
|
+
|
6
|
+
class Campaigning
|
7
|
+
|
8
|
+
attr_reader :api_key, :api_url
|
9
|
+
|
10
|
+
# Replace this API key with your own (http://www.campaignmonitor.com/api/)
|
11
|
+
def initialize(api_key=CAMPAIGN_MONITOR_API_KEY)
|
12
|
+
@api_key = api_key
|
13
|
+
@api_url = 'http://api.createsend.com/api/api.asmx'
|
14
|
+
end
|
15
|
+
|
16
|
+
|
17
|
+
def clients
|
18
|
+
response = soap do |driver|
|
19
|
+
driver.GetClients(:ApiKey => @api_key)
|
20
|
+
end
|
21
|
+
#response.user_GetClientsResult.client.each{ |c| Client.new(c["ClientID"], c["Name"])}
|
22
|
+
if(response.user_GetClientsResult.client.is_a?(Array))
|
23
|
+
response.user_GetClientsResult.client.each{ |c| Client.new(c["ClientID"], c["Name"])}
|
24
|
+
elsif !response.empty?
|
25
|
+
[Client.new(response.user_GetClientsResult.client.clientID, response.user_GetClientsResult.client.name)]
|
26
|
+
else
|
27
|
+
[]
|
28
|
+
end
|
29
|
+
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
def lists(client_id)
|
34
|
+
response = soap do |driver|
|
35
|
+
driver.GetClientLists(:ApiKey => @api_key, :ClientID => client_id)
|
36
|
+
end
|
37
|
+
#response.client_GetListsResult.list.each{ |l| puts "quanto???"}
|
38
|
+
if(response.client_GetListsResult.list.is_a?(Array))
|
39
|
+
puts "retornou um monte de listas!"
|
40
|
+
else
|
41
|
+
puts "retornou soh uma lista"
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
|
46
|
+
def soap
|
47
|
+
driver = wsdl_driver_factory.create_rpc_driver
|
48
|
+
response = yield(driver)
|
49
|
+
driver.reset_stream
|
50
|
+
|
51
|
+
response
|
52
|
+
end
|
53
|
+
|
54
|
+
protected
|
55
|
+
|
56
|
+
def wsdl_driver_factory
|
57
|
+
SOAP::WSDLDriverFactory.new("#{api_url}?wsdl")
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,1927 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'defaultDriver.rb'
|
3
|
+
|
4
|
+
endpoint_url = ARGV.shift
|
5
|
+
obj = ApiSoap.new(endpoint_url)
|
6
|
+
|
7
|
+
# run ruby with -d to see SOAP wiredumps.
|
8
|
+
obj.wiredump_dev = STDERR if $DEBUG
|
9
|
+
|
10
|
+
# SYNOPSIS
|
11
|
+
# AddSubscriberWithCustomFields(parameters)
|
12
|
+
#
|
13
|
+
# ARGS
|
14
|
+
# parameters SubscriberAddWithCustomFields - {http://api.createsend.com/api/}Subscriber.AddWithCustomFields
|
15
|
+
#
|
16
|
+
# RETURNS
|
17
|
+
# parameters SubscriberAddWithCustomFieldsResponse - {http://api.createsend.com/api/}Subscriber.AddWithCustomFieldsResponse
|
18
|
+
#
|
19
|
+
parameters = nil
|
20
|
+
puts obj.addSubscriberWithCustomFields(parameters)
|
21
|
+
|
22
|
+
# SYNOPSIS
|
23
|
+
# AddAndResubscribeWithCustomFields(parameters)
|
24
|
+
#
|
25
|
+
# ARGS
|
26
|
+
# parameters SubscriberAddAndResubscribeWithCustomFields - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFields
|
27
|
+
#
|
28
|
+
# RETURNS
|
29
|
+
# parameters SubscriberAddAndResubscribeWithCustomFieldsResponse - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFieldsResponse
|
30
|
+
#
|
31
|
+
parameters = nil
|
32
|
+
puts obj.addAndResubscribeWithCustomFields(parameters)
|
33
|
+
|
34
|
+
# SYNOPSIS
|
35
|
+
# AddSubscriber(parameters)
|
36
|
+
#
|
37
|
+
# ARGS
|
38
|
+
# parameters SubscriberAdd - {http://api.createsend.com/api/}Subscriber.Add
|
39
|
+
#
|
40
|
+
# RETURNS
|
41
|
+
# parameters SubscriberAddResponse - {http://api.createsend.com/api/}Subscriber.AddResponse
|
42
|
+
#
|
43
|
+
parameters = nil
|
44
|
+
puts obj.addSubscriber(parameters)
|
45
|
+
|
46
|
+
# SYNOPSIS
|
47
|
+
# AddAndResubscribe(parameters)
|
48
|
+
#
|
49
|
+
# ARGS
|
50
|
+
# parameters SubscriberAddAndResubscribe - {http://api.createsend.com/api/}Subscriber.AddAndResubscribe
|
51
|
+
#
|
52
|
+
# RETURNS
|
53
|
+
# parameters SubscriberAddAndResubscribeResponse - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeResponse
|
54
|
+
#
|
55
|
+
parameters = nil
|
56
|
+
puts obj.addAndResubscribe(parameters)
|
57
|
+
|
58
|
+
# SYNOPSIS
|
59
|
+
# Unsubscribe(parameters)
|
60
|
+
#
|
61
|
+
# ARGS
|
62
|
+
# parameters SubscriberUnsubscribe - {http://api.createsend.com/api/}Subscriber.Unsubscribe
|
63
|
+
#
|
64
|
+
# RETURNS
|
65
|
+
# parameters SubscriberUnsubscribeResponse - {http://api.createsend.com/api/}Subscriber.UnsubscribeResponse
|
66
|
+
#
|
67
|
+
parameters = nil
|
68
|
+
puts obj.unsubscribe(parameters)
|
69
|
+
|
70
|
+
# SYNOPSIS
|
71
|
+
# GetSubscribers(parameters)
|
72
|
+
#
|
73
|
+
# ARGS
|
74
|
+
# parameters SubscribersGetActive - {http://api.createsend.com/api/}Subscribers.GetActive
|
75
|
+
#
|
76
|
+
# RETURNS
|
77
|
+
# parameters SubscribersGetActiveResponse - {http://api.createsend.com/api/}Subscribers.GetActiveResponse
|
78
|
+
#
|
79
|
+
parameters = nil
|
80
|
+
puts obj.getSubscribers(parameters)
|
81
|
+
|
82
|
+
# SYNOPSIS
|
83
|
+
# GetUnsubscribed(parameters)
|
84
|
+
#
|
85
|
+
# ARGS
|
86
|
+
# parameters SubscribersGetUnsubscribed - {http://api.createsend.com/api/}Subscribers.GetUnsubscribed
|
87
|
+
#
|
88
|
+
# RETURNS
|
89
|
+
# parameters SubscribersGetUnsubscribedResponse - {http://api.createsend.com/api/}Subscribers.GetUnsubscribedResponse
|
90
|
+
#
|
91
|
+
parameters = nil
|
92
|
+
puts obj.getUnsubscribed(parameters)
|
93
|
+
|
94
|
+
# SYNOPSIS
|
95
|
+
# GetBounced(parameters)
|
96
|
+
#
|
97
|
+
# ARGS
|
98
|
+
# parameters SubscribersGetBounced - {http://api.createsend.com/api/}Subscribers.GetBounced
|
99
|
+
#
|
100
|
+
# RETURNS
|
101
|
+
# parameters SubscribersGetBouncedResponse - {http://api.createsend.com/api/}Subscribers.GetBouncedResponse
|
102
|
+
#
|
103
|
+
parameters = nil
|
104
|
+
puts obj.getBounced(parameters)
|
105
|
+
|
106
|
+
# SYNOPSIS
|
107
|
+
# GetSingleSubscriber(parameters)
|
108
|
+
#
|
109
|
+
# ARGS
|
110
|
+
# parameters SubscribersGetSingleSubscriber - {http://api.createsend.com/api/}Subscribers.GetSingleSubscriber
|
111
|
+
#
|
112
|
+
# RETURNS
|
113
|
+
# parameters SubscribersGetSingleSubscriberResponse - {http://api.createsend.com/api/}Subscribers.GetSingleSubscriberResponse
|
114
|
+
#
|
115
|
+
parameters = nil
|
116
|
+
puts obj.getSingleSubscriber(parameters)
|
117
|
+
|
118
|
+
# SYNOPSIS
|
119
|
+
# GetIsSubscribed(parameters)
|
120
|
+
#
|
121
|
+
# ARGS
|
122
|
+
# parameters SubscribersGetIsSubscribed - {http://api.createsend.com/api/}Subscribers.GetIsSubscribed
|
123
|
+
#
|
124
|
+
# RETURNS
|
125
|
+
# parameters SubscribersGetIsSubscribedResponse - {http://api.createsend.com/api/}Subscribers.GetIsSubscribedResponse
|
126
|
+
#
|
127
|
+
parameters = nil
|
128
|
+
puts obj.getIsSubscribed(parameters)
|
129
|
+
|
130
|
+
# SYNOPSIS
|
131
|
+
# CreateList(parameters)
|
132
|
+
#
|
133
|
+
# ARGS
|
134
|
+
# parameters ListCreate - {http://api.createsend.com/api/}List.Create
|
135
|
+
#
|
136
|
+
# RETURNS
|
137
|
+
# parameters ListCreateResponse - {http://api.createsend.com/api/}List.CreateResponse
|
138
|
+
#
|
139
|
+
parameters = nil
|
140
|
+
puts obj.createList(parameters)
|
141
|
+
|
142
|
+
# SYNOPSIS
|
143
|
+
# UpdateList(parameters)
|
144
|
+
#
|
145
|
+
# ARGS
|
146
|
+
# parameters ListUpdate - {http://api.createsend.com/api/}List.Update
|
147
|
+
#
|
148
|
+
# RETURNS
|
149
|
+
# parameters ListUpdateResponse - {http://api.createsend.com/api/}List.UpdateResponse
|
150
|
+
#
|
151
|
+
parameters = nil
|
152
|
+
puts obj.updateList(parameters)
|
153
|
+
|
154
|
+
# SYNOPSIS
|
155
|
+
# GetListDetail(parameters)
|
156
|
+
#
|
157
|
+
# ARGS
|
158
|
+
# parameters ListGetDetail - {http://api.createsend.com/api/}List.GetDetail
|
159
|
+
#
|
160
|
+
# RETURNS
|
161
|
+
# parameters ListGetDetailResponse - {http://api.createsend.com/api/}List.GetDetailResponse
|
162
|
+
#
|
163
|
+
parameters = nil
|
164
|
+
puts obj.getListDetail(parameters)
|
165
|
+
|
166
|
+
# SYNOPSIS
|
167
|
+
# DeleteList(parameters)
|
168
|
+
#
|
169
|
+
# ARGS
|
170
|
+
# parameters ListDelete - {http://api.createsend.com/api/}List.Delete
|
171
|
+
#
|
172
|
+
# RETURNS
|
173
|
+
# parameters ListDeleteResponse - {http://api.createsend.com/api/}List.DeleteResponse
|
174
|
+
#
|
175
|
+
parameters = nil
|
176
|
+
puts obj.deleteList(parameters)
|
177
|
+
|
178
|
+
# SYNOPSIS
|
179
|
+
# GetListCustomFields(parameters)
|
180
|
+
#
|
181
|
+
# ARGS
|
182
|
+
# parameters ListGetCustomFields - {http://api.createsend.com/api/}List.GetCustomFields
|
183
|
+
#
|
184
|
+
# RETURNS
|
185
|
+
# parameters ListGetCustomFieldsResponse - {http://api.createsend.com/api/}List.GetCustomFieldsResponse
|
186
|
+
#
|
187
|
+
parameters = nil
|
188
|
+
puts obj.getListCustomFields(parameters)
|
189
|
+
|
190
|
+
# SYNOPSIS
|
191
|
+
# DeleteListCustomField(parameters)
|
192
|
+
#
|
193
|
+
# ARGS
|
194
|
+
# parameters ListDeleteCustomField - {http://api.createsend.com/api/}List.DeleteCustomField
|
195
|
+
#
|
196
|
+
# RETURNS
|
197
|
+
# parameters ListDeleteCustomFieldResponse - {http://api.createsend.com/api/}List.DeleteCustomFieldResponse
|
198
|
+
#
|
199
|
+
parameters = nil
|
200
|
+
puts obj.deleteListCustomField(parameters)
|
201
|
+
|
202
|
+
# SYNOPSIS
|
203
|
+
# CreateListCustomField(parameters)
|
204
|
+
#
|
205
|
+
# ARGS
|
206
|
+
# parameters ListCreateCustomField - {http://api.createsend.com/api/}List.CreateCustomField
|
207
|
+
#
|
208
|
+
# RETURNS
|
209
|
+
# parameters ListCreateCustomFieldResponse - {http://api.createsend.com/api/}List.CreateCustomFieldResponse
|
210
|
+
#
|
211
|
+
parameters = nil
|
212
|
+
puts obj.createListCustomField(parameters)
|
213
|
+
|
214
|
+
# SYNOPSIS
|
215
|
+
# GetClientCampaigns(parameters)
|
216
|
+
#
|
217
|
+
# ARGS
|
218
|
+
# parameters ClientGetCampaigns - {http://api.createsend.com/api/}Client.GetCampaigns
|
219
|
+
#
|
220
|
+
# RETURNS
|
221
|
+
# parameters ClientGetCampaignsResponse - {http://api.createsend.com/api/}Client.GetCampaignsResponse
|
222
|
+
#
|
223
|
+
parameters = nil
|
224
|
+
puts obj.getClientCampaigns(parameters)
|
225
|
+
|
226
|
+
# SYNOPSIS
|
227
|
+
# GetClientLists(parameters)
|
228
|
+
#
|
229
|
+
# ARGS
|
230
|
+
# parameters ClientGetLists - {http://api.createsend.com/api/}Client.GetLists
|
231
|
+
#
|
232
|
+
# RETURNS
|
233
|
+
# parameters ClientGetListsResponse - {http://api.createsend.com/api/}Client.GetListsResponse
|
234
|
+
#
|
235
|
+
parameters = nil
|
236
|
+
puts obj.getClientLists(parameters)
|
237
|
+
|
238
|
+
# SYNOPSIS
|
239
|
+
# GetClientSegments(parameters)
|
240
|
+
#
|
241
|
+
# ARGS
|
242
|
+
# parameters ClientGetSegments - {http://api.createsend.com/api/}Client.GetSegments
|
243
|
+
#
|
244
|
+
# RETURNS
|
245
|
+
# parameters ClientGetSegmentsResponse - {http://api.createsend.com/api/}Client.GetSegmentsResponse
|
246
|
+
#
|
247
|
+
parameters = nil
|
248
|
+
puts obj.getClientSegments(parameters)
|
249
|
+
|
250
|
+
# SYNOPSIS
|
251
|
+
# GetClientSuppressionList(parameters)
|
252
|
+
#
|
253
|
+
# ARGS
|
254
|
+
# parameters ClientGetSuppressionList - {http://api.createsend.com/api/}Client.GetSuppressionList
|
255
|
+
#
|
256
|
+
# RETURNS
|
257
|
+
# parameters ClientGetSuppressionListResponse - {http://api.createsend.com/api/}Client.GetSuppressionListResponse
|
258
|
+
#
|
259
|
+
parameters = nil
|
260
|
+
puts obj.getClientSuppressionList(parameters)
|
261
|
+
|
262
|
+
# SYNOPSIS
|
263
|
+
# CreateClient(parameters)
|
264
|
+
#
|
265
|
+
# ARGS
|
266
|
+
# parameters ClientCreate - {http://api.createsend.com/api/}Client.Create
|
267
|
+
#
|
268
|
+
# RETURNS
|
269
|
+
# parameters ClientCreateResponse - {http://api.createsend.com/api/}Client.CreateResponse
|
270
|
+
#
|
271
|
+
parameters = nil
|
272
|
+
puts obj.createClient(parameters)
|
273
|
+
|
274
|
+
# SYNOPSIS
|
275
|
+
# UpdateClientBasics(parameters)
|
276
|
+
#
|
277
|
+
# ARGS
|
278
|
+
# parameters ClientUpdateBasics - {http://api.createsend.com/api/}Client.UpdateBasics
|
279
|
+
#
|
280
|
+
# RETURNS
|
281
|
+
# parameters ClientUpdateBasicsResponse - {http://api.createsend.com/api/}Client.UpdateBasicsResponse
|
282
|
+
#
|
283
|
+
parameters = nil
|
284
|
+
puts obj.updateClientBasics(parameters)
|
285
|
+
|
286
|
+
# SYNOPSIS
|
287
|
+
# UpdateClientAccessAndBilling(parameters)
|
288
|
+
#
|
289
|
+
# ARGS
|
290
|
+
# parameters ClientUpdateAccessAndBilling - {http://api.createsend.com/api/}Client.UpdateAccessAndBilling
|
291
|
+
#
|
292
|
+
# RETURNS
|
293
|
+
# parameters ClientUpdateAccessAndBillingResponse - {http://api.createsend.com/api/}Client.UpdateAccessAndBillingResponse
|
294
|
+
#
|
295
|
+
parameters = nil
|
296
|
+
puts obj.updateClientAccessAndBilling(parameters)
|
297
|
+
|
298
|
+
# SYNOPSIS
|
299
|
+
# GetClientDetail(parameters)
|
300
|
+
#
|
301
|
+
# ARGS
|
302
|
+
# parameters ClientGetDetail - {http://api.createsend.com/api/}Client.GetDetail
|
303
|
+
#
|
304
|
+
# RETURNS
|
305
|
+
# parameters ClientGetDetailResponse - {http://api.createsend.com/api/}Client.GetDetailResponse
|
306
|
+
#
|
307
|
+
parameters = nil
|
308
|
+
puts obj.getClientDetail(parameters)
|
309
|
+
|
310
|
+
# SYNOPSIS
|
311
|
+
# DeleteClient(parameters)
|
312
|
+
#
|
313
|
+
# ARGS
|
314
|
+
# parameters ClientDelete - {http://api.createsend.com/api/}Client.Delete
|
315
|
+
#
|
316
|
+
# RETURNS
|
317
|
+
# parameters ClientDeleteResponse - {http://api.createsend.com/api/}Client.DeleteResponse
|
318
|
+
#
|
319
|
+
parameters = nil
|
320
|
+
puts obj.deleteClient(parameters)
|
321
|
+
|
322
|
+
# SYNOPSIS
|
323
|
+
# GetSubscriberClicks(parameters)
|
324
|
+
#
|
325
|
+
# ARGS
|
326
|
+
# parameters CampaignGetSubscriberClicks - {http://api.createsend.com/api/}Campaign.GetSubscriberClicks
|
327
|
+
#
|
328
|
+
# RETURNS
|
329
|
+
# parameters CampaignGetSubscriberClicksResponse - {http://api.createsend.com/api/}Campaign.GetSubscriberClicksResponse
|
330
|
+
#
|
331
|
+
parameters = nil
|
332
|
+
puts obj.getSubscriberClicks(parameters)
|
333
|
+
|
334
|
+
# SYNOPSIS
|
335
|
+
# GetCampaignOpens(parameters)
|
336
|
+
#
|
337
|
+
# ARGS
|
338
|
+
# parameters CampaignGetOpens - {http://api.createsend.com/api/}Campaign.GetOpens
|
339
|
+
#
|
340
|
+
# RETURNS
|
341
|
+
# parameters CampaignGetOpensResponse - {http://api.createsend.com/api/}Campaign.GetOpensResponse
|
342
|
+
#
|
343
|
+
parameters = nil
|
344
|
+
puts obj.getCampaignOpens(parameters)
|
345
|
+
|
346
|
+
# SYNOPSIS
|
347
|
+
# GetCampaignBounces(parameters)
|
348
|
+
#
|
349
|
+
# ARGS
|
350
|
+
# parameters CampaignGetBounces - {http://api.createsend.com/api/}Campaign.GetBounces
|
351
|
+
#
|
352
|
+
# RETURNS
|
353
|
+
# parameters CampaignGetBouncesResponse - {http://api.createsend.com/api/}Campaign.GetBouncesResponse
|
354
|
+
#
|
355
|
+
parameters = nil
|
356
|
+
puts obj.getCampaignBounces(parameters)
|
357
|
+
|
358
|
+
# SYNOPSIS
|
359
|
+
# GetCampaignUnsubscribes(parameters)
|
360
|
+
#
|
361
|
+
# ARGS
|
362
|
+
# parameters CampaignGetUnsubscribes - {http://api.createsend.com/api/}Campaign.GetUnsubscribes
|
363
|
+
#
|
364
|
+
# RETURNS
|
365
|
+
# parameters CampaignGetUnsubscribesResponse - {http://api.createsend.com/api/}Campaign.GetUnsubscribesResponse
|
366
|
+
#
|
367
|
+
parameters = nil
|
368
|
+
puts obj.getCampaignUnsubscribes(parameters)
|
369
|
+
|
370
|
+
# SYNOPSIS
|
371
|
+
# GetCampaignSummary(parameters)
|
372
|
+
#
|
373
|
+
# ARGS
|
374
|
+
# parameters CampaignGetSummary - {http://api.createsend.com/api/}Campaign.GetSummary
|
375
|
+
#
|
376
|
+
# RETURNS
|
377
|
+
# parameters CampaignGetSummaryResponse - {http://api.createsend.com/api/}Campaign.GetSummaryResponse
|
378
|
+
#
|
379
|
+
parameters = nil
|
380
|
+
puts obj.getCampaignSummary(parameters)
|
381
|
+
|
382
|
+
# SYNOPSIS
|
383
|
+
# GetCampaignLists(parameters)
|
384
|
+
#
|
385
|
+
# ARGS
|
386
|
+
# parameters CampaignGetLists - {http://api.createsend.com/api/}Campaign.GetLists
|
387
|
+
#
|
388
|
+
# RETURNS
|
389
|
+
# parameters CampaignGetListsResponse - {http://api.createsend.com/api/}Campaign.GetListsResponse
|
390
|
+
#
|
391
|
+
parameters = nil
|
392
|
+
puts obj.getCampaignLists(parameters)
|
393
|
+
|
394
|
+
# SYNOPSIS
|
395
|
+
# GetClients(parameters)
|
396
|
+
#
|
397
|
+
# ARGS
|
398
|
+
# parameters UserGetClients - {http://api.createsend.com/api/}User.GetClients
|
399
|
+
#
|
400
|
+
# RETURNS
|
401
|
+
# parameters UserGetClientsResponse - {http://api.createsend.com/api/}User.GetClientsResponse
|
402
|
+
#
|
403
|
+
parameters = nil
|
404
|
+
puts obj.getClients(parameters)
|
405
|
+
|
406
|
+
# SYNOPSIS
|
407
|
+
# GetSystemDate(parameters)
|
408
|
+
#
|
409
|
+
# ARGS
|
410
|
+
# parameters UserGetSystemDate - {http://api.createsend.com/api/}User.GetSystemDate
|
411
|
+
#
|
412
|
+
# RETURNS
|
413
|
+
# parameters UserGetSystemDateResponse - {http://api.createsend.com/api/}User.GetSystemDateResponse
|
414
|
+
#
|
415
|
+
parameters = nil
|
416
|
+
puts obj.getSystemDate(parameters)
|
417
|
+
|
418
|
+
# SYNOPSIS
|
419
|
+
# GetTimezones(parameters)
|
420
|
+
#
|
421
|
+
# ARGS
|
422
|
+
# parameters UserGetTimezones - {http://api.createsend.com/api/}User.GetTimezones
|
423
|
+
#
|
424
|
+
# RETURNS
|
425
|
+
# parameters UserGetTimezonesResponse - {http://api.createsend.com/api/}User.GetTimezonesResponse
|
426
|
+
#
|
427
|
+
parameters = nil
|
428
|
+
puts obj.getTimezones(parameters)
|
429
|
+
|
430
|
+
# SYNOPSIS
|
431
|
+
# GetCountries(parameters)
|
432
|
+
#
|
433
|
+
# ARGS
|
434
|
+
# parameters UserGetCountries - {http://api.createsend.com/api/}User.GetCountries
|
435
|
+
#
|
436
|
+
# RETURNS
|
437
|
+
# parameters UserGetCountriesResponse - {http://api.createsend.com/api/}User.GetCountriesResponse
|
438
|
+
#
|
439
|
+
parameters = nil
|
440
|
+
puts obj.getCountries(parameters)
|
441
|
+
|
442
|
+
# SYNOPSIS
|
443
|
+
# CreateCampaign(parameters)
|
444
|
+
#
|
445
|
+
# ARGS
|
446
|
+
# parameters CampaignCreate - {http://api.createsend.com/api/}Campaign.Create
|
447
|
+
#
|
448
|
+
# RETURNS
|
449
|
+
# parameters CampaignCreateResponse - {http://api.createsend.com/api/}Campaign.CreateResponse
|
450
|
+
#
|
451
|
+
parameters = nil
|
452
|
+
puts obj.createCampaign(parameters)
|
453
|
+
|
454
|
+
# SYNOPSIS
|
455
|
+
# SendCampaign(parameters)
|
456
|
+
#
|
457
|
+
# ARGS
|
458
|
+
# parameters CampaignSend - {http://api.createsend.com/api/}Campaign.Send
|
459
|
+
#
|
460
|
+
# RETURNS
|
461
|
+
# parameters CampaignSendResponse - {http://api.createsend.com/api/}Campaign.SendResponse
|
462
|
+
#
|
463
|
+
parameters = nil
|
464
|
+
puts obj.sendCampaign(parameters)
|
465
|
+
|
466
|
+
|
467
|
+
endpoint_url = ARGV.shift
|
468
|
+
obj = ApiSoap.new(endpoint_url)
|
469
|
+
|
470
|
+
# run ruby with -d to see SOAP wiredumps.
|
471
|
+
obj.wiredump_dev = STDERR if $DEBUG
|
472
|
+
|
473
|
+
# SYNOPSIS
|
474
|
+
# AddSubscriberWithCustomFields(parameters)
|
475
|
+
#
|
476
|
+
# ARGS
|
477
|
+
# parameters SubscriberAddWithCustomFields - {http://api.createsend.com/api/}Subscriber.AddWithCustomFields
|
478
|
+
#
|
479
|
+
# RETURNS
|
480
|
+
# parameters SubscriberAddWithCustomFieldsResponse - {http://api.createsend.com/api/}Subscriber.AddWithCustomFieldsResponse
|
481
|
+
#
|
482
|
+
parameters = nil
|
483
|
+
puts obj.addSubscriberWithCustomFields(parameters)
|
484
|
+
|
485
|
+
# SYNOPSIS
|
486
|
+
# AddAndResubscribeWithCustomFields(parameters)
|
487
|
+
#
|
488
|
+
# ARGS
|
489
|
+
# parameters SubscriberAddAndResubscribeWithCustomFields - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFields
|
490
|
+
#
|
491
|
+
# RETURNS
|
492
|
+
# parameters SubscriberAddAndResubscribeWithCustomFieldsResponse - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeWithCustomFieldsResponse
|
493
|
+
#
|
494
|
+
parameters = nil
|
495
|
+
puts obj.addAndResubscribeWithCustomFields(parameters)
|
496
|
+
|
497
|
+
# SYNOPSIS
|
498
|
+
# AddSubscriber(parameters)
|
499
|
+
#
|
500
|
+
# ARGS
|
501
|
+
# parameters SubscriberAdd - {http://api.createsend.com/api/}Subscriber.Add
|
502
|
+
#
|
503
|
+
# RETURNS
|
504
|
+
# parameters SubscriberAddResponse - {http://api.createsend.com/api/}Subscriber.AddResponse
|
505
|
+
#
|
506
|
+
parameters = nil
|
507
|
+
puts obj.addSubscriber(parameters)
|
508
|
+
|
509
|
+
# SYNOPSIS
|
510
|
+
# AddAndResubscribe(parameters)
|
511
|
+
#
|
512
|
+
# ARGS
|
513
|
+
# parameters SubscriberAddAndResubscribe - {http://api.createsend.com/api/}Subscriber.AddAndResubscribe
|
514
|
+
#
|
515
|
+
# RETURNS
|
516
|
+
# parameters SubscriberAddAndResubscribeResponse - {http://api.createsend.com/api/}Subscriber.AddAndResubscribeResponse
|
517
|
+
#
|
518
|
+
parameters = nil
|
519
|
+
puts obj.addAndResubscribe(parameters)
|
520
|
+
|
521
|
+
# SYNOPSIS
|
522
|
+
# Unsubscribe(parameters)
|
523
|
+
#
|
524
|
+
# ARGS
|
525
|
+
# parameters SubscriberUnsubscribe - {http://api.createsend.com/api/}Subscriber.Unsubscribe
|
526
|
+
#
|
527
|
+
# RETURNS
|
528
|
+
# parameters SubscriberUnsubscribeResponse - {http://api.createsend.com/api/}Subscriber.UnsubscribeResponse
|
529
|
+
#
|
530
|
+
parameters = nil
|
531
|
+
puts obj.unsubscribe(parameters)
|
532
|
+
|
533
|
+
# SYNOPSIS
|
534
|
+
# GetSubscribers(parameters)
|
535
|
+
#
|
536
|
+
# ARGS
|
537
|
+
# parameters SubscribersGetActive - {http://api.createsend.com/api/}Subscribers.GetActive
|
538
|
+
#
|
539
|
+
# RETURNS
|
540
|
+
# parameters SubscribersGetActiveResponse - {http://api.createsend.com/api/}Subscribers.GetActiveResponse
|
541
|
+
#
|
542
|
+
parameters = nil
|
543
|
+
puts obj.getSubscribers(parameters)
|
544
|
+
|
545
|
+
# SYNOPSIS
|
546
|
+
# GetUnsubscribed(parameters)
|
547
|
+
#
|
548
|
+
# ARGS
|
549
|
+
# parameters SubscribersGetUnsubscribed - {http://api.createsend.com/api/}Subscribers.GetUnsubscribed
|
550
|
+
#
|
551
|
+
# RETURNS
|
552
|
+
# parameters SubscribersGetUnsubscribedResponse - {http://api.createsend.com/api/}Subscribers.GetUnsubscribedResponse
|
553
|
+
#
|
554
|
+
parameters = nil
|
555
|
+
puts obj.getUnsubscribed(parameters)
|
556
|
+
|
557
|
+
# SYNOPSIS
|
558
|
+
# GetBounced(parameters)
|
559
|
+
#
|
560
|
+
# ARGS
|
561
|
+
# parameters SubscribersGetBounced - {http://api.createsend.com/api/}Subscribers.GetBounced
|
562
|
+
#
|
563
|
+
# RETURNS
|
564
|
+
# parameters SubscribersGetBouncedResponse - {http://api.createsend.com/api/}Subscribers.GetBouncedResponse
|
565
|
+
#
|
566
|
+
parameters = nil
|
567
|
+
puts obj.getBounced(parameters)
|
568
|
+
|
569
|
+
# SYNOPSIS
|
570
|
+
# GetSingleSubscriber(parameters)
|
571
|
+
#
|
572
|
+
# ARGS
|
573
|
+
# parameters SubscribersGetSingleSubscriber - {http://api.createsend.com/api/}Subscribers.GetSingleSubscriber
|
574
|
+
#
|
575
|
+
# RETURNS
|
576
|
+
# parameters SubscribersGetSingleSubscriberResponse - {http://api.createsend.com/api/}Subscribers.GetSingleSubscriberResponse
|
577
|
+
#
|
578
|
+
parameters = nil
|
579
|
+
puts obj.getSingleSubscriber(parameters)
|
580
|
+
|
581
|
+
# SYNOPSIS
|
582
|
+
# GetIsSubscribed(parameters)
|
583
|
+
#
|
584
|
+
# ARGS
|
585
|
+
# parameters SubscribersGetIsSubscribed - {http://api.createsend.com/api/}Subscribers.GetIsSubscribed
|
586
|
+
#
|
587
|
+
# RETURNS
|
588
|
+
# parameters SubscribersGetIsSubscribedResponse - {http://api.createsend.com/api/}Subscribers.GetIsSubscribedResponse
|
589
|
+
#
|
590
|
+
parameters = nil
|
591
|
+
puts obj.getIsSubscribed(parameters)
|
592
|
+
|
593
|
+
# SYNOPSIS
|
594
|
+
# CreateList(parameters)
|
595
|
+
#
|
596
|
+
# ARGS
|
597
|
+
# parameters ListCreate - {http://api.createsend.com/api/}List.Create
|
598
|
+
#
|
599
|
+
# RETURNS
|
600
|
+
# parameters ListCreateResponse - {http://api.createsend.com/api/}List.CreateResponse
|
601
|
+
#
|
602
|
+
parameters = nil
|
603
|
+
puts obj.createList(parameters)
|
604
|
+
|
605
|
+
# SYNOPSIS
|
606
|
+
# UpdateList(parameters)
|
607
|
+
#
|
608
|
+
# ARGS
|
609
|
+
# parameters ListUpdate - {http://api.createsend.com/api/}List.Update
|
610
|
+
#
|
611
|
+
# RETURNS
|
612
|
+
# parameters ListUpdateResponse - {http://api.createsend.com/api/}List.UpdateResponse
|
613
|
+
#
|
614
|
+
parameters = nil
|
615
|
+
puts obj.updateList(parameters)
|
616
|
+
|
617
|
+
# SYNOPSIS
|
618
|
+
# GetListDetail(parameters)
|
619
|
+
#
|
620
|
+
# ARGS
|
621
|
+
# parameters ListGetDetail - {http://api.createsend.com/api/}List.GetDetail
|
622
|
+
#
|
623
|
+
# RETURNS
|
624
|
+
# parameters ListGetDetailResponse - {http://api.createsend.com/api/}List.GetDetailResponse
|
625
|
+
#
|
626
|
+
parameters = nil
|
627
|
+
puts obj.getListDetail(parameters)
|
628
|
+
|
629
|
+
# SYNOPSIS
|
630
|
+
# DeleteList(parameters)
|
631
|
+
#
|
632
|
+
# ARGS
|
633
|
+
# parameters ListDelete - {http://api.createsend.com/api/}List.Delete
|
634
|
+
#
|
635
|
+
# RETURNS
|
636
|
+
# parameters ListDeleteResponse - {http://api.createsend.com/api/}List.DeleteResponse
|
637
|
+
#
|
638
|
+
parameters = nil
|
639
|
+
puts obj.deleteList(parameters)
|
640
|
+
|
641
|
+
# SYNOPSIS
|
642
|
+
# GetListCustomFields(parameters)
|
643
|
+
#
|
644
|
+
# ARGS
|
645
|
+
# parameters ListGetCustomFields - {http://api.createsend.com/api/}List.GetCustomFields
|
646
|
+
#
|
647
|
+
# RETURNS
|
648
|
+
# parameters ListGetCustomFieldsResponse - {http://api.createsend.com/api/}List.GetCustomFieldsResponse
|
649
|
+
#
|
650
|
+
parameters = nil
|
651
|
+
puts obj.getListCustomFields(parameters)
|
652
|
+
|
653
|
+
# SYNOPSIS
|
654
|
+
# DeleteListCustomField(parameters)
|
655
|
+
#
|
656
|
+
# ARGS
|
657
|
+
# parameters ListDeleteCustomField - {http://api.createsend.com/api/}List.DeleteCustomField
|
658
|
+
#
|
659
|
+
# RETURNS
|
660
|
+
# parameters ListDeleteCustomFieldResponse - {http://api.createsend.com/api/}List.DeleteCustomFieldResponse
|
661
|
+
#
|
662
|
+
parameters = nil
|
663
|
+
puts obj.deleteListCustomField(parameters)
|
664
|
+
|
665
|
+
# SYNOPSIS
|
666
|
+
# CreateListCustomField(parameters)
|
667
|
+
#
|
668
|
+
# ARGS
|
669
|
+
# parameters ListCreateCustomField - {http://api.createsend.com/api/}List.CreateCustomField
|
670
|
+
#
|
671
|
+
# RETURNS
|
672
|
+
# parameters ListCreateCustomFieldResponse - {http://api.createsend.com/api/}List.CreateCustomFieldResponse
|
673
|
+
#
|
674
|
+
parameters = nil
|
675
|
+
puts obj.createListCustomField(parameters)
|
676
|
+
|
677
|
+
# SYNOPSIS
|
678
|
+
# GetClientCampaigns(parameters)
|
679
|
+
#
|
680
|
+
# ARGS
|
681
|
+
# parameters ClientGetCampaigns - {http://api.createsend.com/api/}Client.GetCampaigns
|
682
|
+
#
|
683
|
+
# RETURNS
|
684
|
+
# parameters ClientGetCampaignsResponse - {http://api.createsend.com/api/}Client.GetCampaignsResponse
|
685
|
+
#
|
686
|
+
parameters = nil
|
687
|
+
puts obj.getClientCampaigns(parameters)
|
688
|
+
|
689
|
+
# SYNOPSIS
|
690
|
+
# GetClientLists(parameters)
|
691
|
+
#
|
692
|
+
# ARGS
|
693
|
+
# parameters ClientGetLists - {http://api.createsend.com/api/}Client.GetLists
|
694
|
+
#
|
695
|
+
# RETURNS
|
696
|
+
# parameters ClientGetListsResponse - {http://api.createsend.com/api/}Client.GetListsResponse
|
697
|
+
#
|
698
|
+
parameters = nil
|
699
|
+
puts obj.getClientLists(parameters)
|
700
|
+
|
701
|
+
# SYNOPSIS
|
702
|
+
# GetClientSegments(parameters)
|
703
|
+
#
|
704
|
+
# ARGS
|
705
|
+
# parameters ClientGetSegments - {http://api.createsend.com/api/}Client.GetSegments
|
706
|
+
#
|
707
|
+
# RETURNS
|
708
|
+
# parameters ClientGetSegmentsResponse - {http://api.createsend.com/api/}Client.GetSegmentsResponse
|
709
|
+
#
|
710
|
+
parameters = nil
|
711
|
+
puts obj.getClientSegments(parameters)
|
712
|
+
|
713
|
+
# SYNOPSIS
|
714
|
+
# GetClientSuppressionList(parameters)
|
715
|
+
#
|
716
|
+
# ARGS
|
717
|
+
# parameters ClientGetSuppressionList - {http://api.createsend.com/api/}Client.GetSuppressionList
|
718
|
+
#
|
719
|
+
# RETURNS
|
720
|
+
# parameters ClientGetSuppressionListResponse - {http://api.createsend.com/api/}Client.GetSuppressionListResponse
|
721
|
+
#
|
722
|
+
parameters = nil
|
723
|
+
puts obj.getClientSuppressionList(parameters)
|
724
|
+
|
725
|
+
# SYNOPSIS
|
726
|
+
# CreateClient(parameters)
|
727
|
+
#
|
728
|
+
# ARGS
|
729
|
+
# parameters ClientCreate - {http://api.createsend.com/api/}Client.Create
|
730
|
+
#
|
731
|
+
# RETURNS
|
732
|
+
# parameters ClientCreateResponse - {http://api.createsend.com/api/}Client.CreateResponse
|
733
|
+
#
|
734
|
+
parameters = nil
|
735
|
+
puts obj.createClient(parameters)
|
736
|
+
|
737
|
+
# SYNOPSIS
|
738
|
+
# UpdateClientBasics(parameters)
|
739
|
+
#
|
740
|
+
# ARGS
|
741
|
+
# parameters ClientUpdateBasics - {http://api.createsend.com/api/}Client.UpdateBasics
|
742
|
+
#
|
743
|
+
# RETURNS
|
744
|
+
# parameters ClientUpdateBasicsResponse - {http://api.createsend.com/api/}Client.UpdateBasicsResponse
|
745
|
+
#
|
746
|
+
parameters = nil
|
747
|
+
puts obj.updateClientBasics(parameters)
|
748
|
+
|
749
|
+
# SYNOPSIS
|
750
|
+
# UpdateClientAccessAndBilling(parameters)
|
751
|
+
#
|
752
|
+
# ARGS
|
753
|
+
# parameters ClientUpdateAccessAndBilling - {http://api.createsend.com/api/}Client.UpdateAccessAndBilling
|
754
|
+
#
|
755
|
+
# RETURNS
|
756
|
+
# parameters ClientUpdateAccessAndBillingResponse - {http://api.createsend.com/api/}Client.UpdateAccessAndBillingResponse
|
757
|
+
#
|
758
|
+
parameters = nil
|
759
|
+
puts obj.updateClientAccessAndBilling(parameters)
|
760
|
+
|
761
|
+
# SYNOPSIS
|
762
|
+
# GetClientDetail(parameters)
|
763
|
+
#
|
764
|
+
# ARGS
|
765
|
+
# parameters ClientGetDetail - {http://api.createsend.com/api/}Client.GetDetail
|
766
|
+
#
|
767
|
+
# RETURNS
|
768
|
+
# parameters ClientGetDetailResponse - {http://api.createsend.com/api/}Client.GetDetailResponse
|
769
|
+
#
|
770
|
+
parameters = nil
|
771
|
+
puts obj.getClientDetail(parameters)
|
772
|
+
|
773
|
+
# SYNOPSIS
|
774
|
+
# DeleteClient(parameters)
|
775
|
+
#
|
776
|
+
# ARGS
|
777
|
+
# parameters ClientDelete - {http://api.createsend.com/api/}Client.Delete
|
778
|
+
#
|
779
|
+
# RETURNS
|
780
|
+
# parameters ClientDeleteResponse - {http://api.createsend.com/api/}Client.DeleteResponse
|
781
|
+
#
|
782
|
+
parameters = nil
|
783
|
+
puts obj.deleteClient(parameters)
|
784
|
+
|
785
|
+
# SYNOPSIS
|
786
|
+
# GetSubscriberClicks(parameters)
|
787
|
+
#
|
788
|
+
# ARGS
|
789
|
+
# parameters CampaignGetSubscriberClicks - {http://api.createsend.com/api/}Campaign.GetSubscriberClicks
|
790
|
+
#
|
791
|
+
# RETURNS
|
792
|
+
# parameters CampaignGetSubscriberClicksResponse - {http://api.createsend.com/api/}Campaign.GetSubscriberClicksResponse
|
793
|
+
#
|
794
|
+
parameters = nil
|
795
|
+
puts obj.getSubscriberClicks(parameters)
|
796
|
+
|
797
|
+
# SYNOPSIS
|
798
|
+
# GetCampaignOpens(parameters)
|
799
|
+
#
|
800
|
+
# ARGS
|
801
|
+
# parameters CampaignGetOpens - {http://api.createsend.com/api/}Campaign.GetOpens
|
802
|
+
#
|
803
|
+
# RETURNS
|
804
|
+
# parameters CampaignGetOpensResponse - {http://api.createsend.com/api/}Campaign.GetOpensResponse
|
805
|
+
#
|
806
|
+
parameters = nil
|
807
|
+
puts obj.getCampaignOpens(parameters)
|
808
|
+
|
809
|
+
# SYNOPSIS
|
810
|
+
# GetCampaignBounces(parameters)
|
811
|
+
#
|
812
|
+
# ARGS
|
813
|
+
# parameters CampaignGetBounces - {http://api.createsend.com/api/}Campaign.GetBounces
|
814
|
+
#
|
815
|
+
# RETURNS
|
816
|
+
# parameters CampaignGetBouncesResponse - {http://api.createsend.com/api/}Campaign.GetBouncesResponse
|
817
|
+
#
|
818
|
+
parameters = nil
|
819
|
+
puts obj.getCampaignBounces(parameters)
|
820
|
+
|
821
|
+
# SYNOPSIS
|
822
|
+
# GetCampaignUnsubscribes(parameters)
|
823
|
+
#
|
824
|
+
# ARGS
|
825
|
+
# parameters CampaignGetUnsubscribes - {http://api.createsend.com/api/}Campaign.GetUnsubscribes
|
826
|
+
#
|
827
|
+
# RETURNS
|
828
|
+
# parameters CampaignGetUnsubscribesResponse - {http://api.createsend.com/api/}Campaign.GetUnsubscribesResponse
|
829
|
+
#
|
830
|
+
parameters = nil
|
831
|
+
puts obj.getCampaignUnsubscribes(parameters)
|
832
|
+
|
833
|
+
# SYNOPSIS
|
834
|
+
# GetCampaignSummary(parameters)
|
835
|
+
#
|
836
|
+
# ARGS
|
837
|
+
# parameters CampaignGetSummary - {http://api.createsend.com/api/}Campaign.GetSummary
|
838
|
+
#
|
839
|
+
# RETURNS
|
840
|
+
# parameters CampaignGetSummaryResponse - {http://api.createsend.com/api/}Campaign.GetSummaryResponse
|
841
|
+
#
|
842
|
+
parameters = nil
|
843
|
+
puts obj.getCampaignSummary(parameters)
|
844
|
+
|
845
|
+
# SYNOPSIS
|
846
|
+
# GetCampaignLists(parameters)
|
847
|
+
#
|
848
|
+
# ARGS
|
849
|
+
# parameters CampaignGetLists - {http://api.createsend.com/api/}Campaign.GetLists
|
850
|
+
#
|
851
|
+
# RETURNS
|
852
|
+
# parameters CampaignGetListsResponse - {http://api.createsend.com/api/}Campaign.GetListsResponse
|
853
|
+
#
|
854
|
+
parameters = nil
|
855
|
+
puts obj.getCampaignLists(parameters)
|
856
|
+
|
857
|
+
# SYNOPSIS
|
858
|
+
# GetClients(parameters)
|
859
|
+
#
|
860
|
+
# ARGS
|
861
|
+
# parameters UserGetClients - {http://api.createsend.com/api/}User.GetClients
|
862
|
+
#
|
863
|
+
# RETURNS
|
864
|
+
# parameters UserGetClientsResponse - {http://api.createsend.com/api/}User.GetClientsResponse
|
865
|
+
#
|
866
|
+
parameters = nil
|
867
|
+
puts obj.getClients(parameters)
|
868
|
+
|
869
|
+
# SYNOPSIS
|
870
|
+
# GetSystemDate(parameters)
|
871
|
+
#
|
872
|
+
# ARGS
|
873
|
+
# parameters UserGetSystemDate - {http://api.createsend.com/api/}User.GetSystemDate
|
874
|
+
#
|
875
|
+
# RETURNS
|
876
|
+
# parameters UserGetSystemDateResponse - {http://api.createsend.com/api/}User.GetSystemDateResponse
|
877
|
+
#
|
878
|
+
parameters = nil
|
879
|
+
puts obj.getSystemDate(parameters)
|
880
|
+
|
881
|
+
# SYNOPSIS
|
882
|
+
# GetTimezones(parameters)
|
883
|
+
#
|
884
|
+
# ARGS
|
885
|
+
# parameters UserGetTimezones - {http://api.createsend.com/api/}User.GetTimezones
|
886
|
+
#
|
887
|
+
# RETURNS
|
888
|
+
# parameters UserGetTimezonesResponse - {http://api.createsend.com/api/}User.GetTimezonesResponse
|
889
|
+
#
|
890
|
+
parameters = nil
|
891
|
+
puts obj.getTimezones(parameters)
|
892
|
+
|
893
|
+
# SYNOPSIS
|
894
|
+
# GetCountries(parameters)
|
895
|
+
#
|
896
|
+
# ARGS
|
897
|
+
# parameters UserGetCountries - {http://api.createsend.com/api/}User.GetCountries
|
898
|
+
#
|
899
|
+
# RETURNS
|
900
|
+
# parameters UserGetCountriesResponse - {http://api.createsend.com/api/}User.GetCountriesResponse
|
901
|
+
#
|
902
|
+
parameters = nil
|
903
|
+
puts obj.getCountries(parameters)
|
904
|
+
|
905
|
+
# SYNOPSIS
|
906
|
+
# CreateCampaign(parameters)
|
907
|
+
#
|
908
|
+
# ARGS
|
909
|
+
# parameters CampaignCreate - {http://api.createsend.com/api/}Campaign.Create
|
910
|
+
#
|
911
|
+
# RETURNS
|
912
|
+
# parameters CampaignCreateResponse - {http://api.createsend.com/api/}Campaign.CreateResponse
|
913
|
+
#
|
914
|
+
parameters = nil
|
915
|
+
puts obj.createCampaign(parameters)
|
916
|
+
|
917
|
+
# SYNOPSIS
|
918
|
+
# SendCampaign(parameters)
|
919
|
+
#
|
920
|
+
# ARGS
|
921
|
+
# parameters CampaignSend - {http://api.createsend.com/api/}Campaign.Send
|
922
|
+
#
|
923
|
+
# RETURNS
|
924
|
+
# parameters CampaignSendResponse - {http://api.createsend.com/api/}Campaign.SendResponse
|
925
|
+
#
|
926
|
+
parameters = nil
|
927
|
+
puts obj.sendCampaign(parameters)
|
928
|
+
|
929
|
+
|
930
|
+
endpoint_url = ARGV.shift
|
931
|
+
obj = ApiHttpGet.new(endpoint_url)
|
932
|
+
|
933
|
+
# run ruby with -d to see SOAP wiredumps.
|
934
|
+
obj.wiredump_dev = STDERR if $DEBUG
|
935
|
+
|
936
|
+
# SYNOPSIS
|
937
|
+
# AddSubscriber(apiKey, listID, email, name)
|
938
|
+
#
|
939
|
+
# ARGS
|
940
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
941
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
942
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
943
|
+
# name C_String - {http://www.w3.org/2001/XMLSchema}string
|
944
|
+
#
|
945
|
+
# RETURNS
|
946
|
+
# body Result - {http://api.createsend.com/api/}Result
|
947
|
+
#
|
948
|
+
apiKey = listID = email = name = nil
|
949
|
+
puts obj.addSubscriber(apiKey, listID, email, name)
|
950
|
+
|
951
|
+
# SYNOPSIS
|
952
|
+
# AddAndResubscribe(apiKey, listID, email, name)
|
953
|
+
#
|
954
|
+
# ARGS
|
955
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
956
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
957
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
958
|
+
# name C_String - {http://www.w3.org/2001/XMLSchema}string
|
959
|
+
#
|
960
|
+
# RETURNS
|
961
|
+
# body Result - {http://api.createsend.com/api/}Result
|
962
|
+
#
|
963
|
+
apiKey = listID = email = name = nil
|
964
|
+
puts obj.addAndResubscribe(apiKey, listID, email, name)
|
965
|
+
|
966
|
+
# SYNOPSIS
|
967
|
+
# Unsubscribe(apiKey, listID, email)
|
968
|
+
#
|
969
|
+
# ARGS
|
970
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
971
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
972
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
973
|
+
#
|
974
|
+
# RETURNS
|
975
|
+
# body Result - {http://api.createsend.com/api/}Result
|
976
|
+
#
|
977
|
+
apiKey = listID = email = nil
|
978
|
+
puts obj.unsubscribe(apiKey, listID, email)
|
979
|
+
|
980
|
+
# SYNOPSIS
|
981
|
+
# GetSubscribers(apiKey, listID, date)
|
982
|
+
#
|
983
|
+
# ARGS
|
984
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
985
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
986
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
987
|
+
#
|
988
|
+
# RETURNS
|
989
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
990
|
+
#
|
991
|
+
apiKey = listID = date = nil
|
992
|
+
puts obj.getSubscribers(apiKey, listID, date)
|
993
|
+
|
994
|
+
# SYNOPSIS
|
995
|
+
# GetUnsubscribed(apiKey, listID, date)
|
996
|
+
#
|
997
|
+
# ARGS
|
998
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
999
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1000
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
1001
|
+
#
|
1002
|
+
# RETURNS
|
1003
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1004
|
+
#
|
1005
|
+
apiKey = listID = date = nil
|
1006
|
+
puts obj.getUnsubscribed(apiKey, listID, date)
|
1007
|
+
|
1008
|
+
# SYNOPSIS
|
1009
|
+
# GetBounced(apiKey, listID, date)
|
1010
|
+
#
|
1011
|
+
# ARGS
|
1012
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1013
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1014
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
1015
|
+
#
|
1016
|
+
# RETURNS
|
1017
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1018
|
+
#
|
1019
|
+
apiKey = listID = date = nil
|
1020
|
+
puts obj.getBounced(apiKey, listID, date)
|
1021
|
+
|
1022
|
+
# SYNOPSIS
|
1023
|
+
# GetSingleSubscriber(apiKey, listID, emailAddress)
|
1024
|
+
#
|
1025
|
+
# ARGS
|
1026
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1027
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1028
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1029
|
+
#
|
1030
|
+
# RETURNS
|
1031
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1032
|
+
#
|
1033
|
+
apiKey = listID = emailAddress = nil
|
1034
|
+
puts obj.getSingleSubscriber(apiKey, listID, emailAddress)
|
1035
|
+
|
1036
|
+
# SYNOPSIS
|
1037
|
+
# GetIsSubscribed(apiKey, listID, email)
|
1038
|
+
#
|
1039
|
+
# ARGS
|
1040
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1041
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1042
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
1043
|
+
#
|
1044
|
+
# RETURNS
|
1045
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1046
|
+
#
|
1047
|
+
apiKey = listID = email = nil
|
1048
|
+
puts obj.getIsSubscribed(apiKey, listID, email)
|
1049
|
+
|
1050
|
+
# SYNOPSIS
|
1051
|
+
# CreateList(apiKey, clientID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1052
|
+
#
|
1053
|
+
# ARGS
|
1054
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1055
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1056
|
+
# title C_String - {http://www.w3.org/2001/XMLSchema}string
|
1057
|
+
# unsubscribePage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1058
|
+
# confirmOptIn C_String - {http://www.w3.org/2001/XMLSchema}string
|
1059
|
+
# confirmationSuccessPage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1060
|
+
#
|
1061
|
+
# RETURNS
|
1062
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1063
|
+
#
|
1064
|
+
apiKey = clientID = title = unsubscribePage = confirmOptIn = confirmationSuccessPage = nil
|
1065
|
+
puts obj.createList(apiKey, clientID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1066
|
+
|
1067
|
+
# SYNOPSIS
|
1068
|
+
# UpdateList(apiKey, listID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1069
|
+
#
|
1070
|
+
# ARGS
|
1071
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1072
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1073
|
+
# title C_String - {http://www.w3.org/2001/XMLSchema}string
|
1074
|
+
# unsubscribePage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1075
|
+
# confirmOptIn C_String - {http://www.w3.org/2001/XMLSchema}string
|
1076
|
+
# confirmationSuccessPage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1077
|
+
#
|
1078
|
+
# RETURNS
|
1079
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1080
|
+
#
|
1081
|
+
apiKey = listID = title = unsubscribePage = confirmOptIn = confirmationSuccessPage = nil
|
1082
|
+
puts obj.updateList(apiKey, listID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1083
|
+
|
1084
|
+
# SYNOPSIS
|
1085
|
+
# GetListDetail(apiKey, listID)
|
1086
|
+
#
|
1087
|
+
# ARGS
|
1088
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1089
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1090
|
+
#
|
1091
|
+
# RETURNS
|
1092
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1093
|
+
#
|
1094
|
+
apiKey = listID = nil
|
1095
|
+
puts obj.getListDetail(apiKey, listID)
|
1096
|
+
|
1097
|
+
# SYNOPSIS
|
1098
|
+
# DeleteList(apiKey, listID)
|
1099
|
+
#
|
1100
|
+
# ARGS
|
1101
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1102
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1103
|
+
#
|
1104
|
+
# RETURNS
|
1105
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1106
|
+
#
|
1107
|
+
apiKey = listID = nil
|
1108
|
+
puts obj.deleteList(apiKey, listID)
|
1109
|
+
|
1110
|
+
# SYNOPSIS
|
1111
|
+
# GetListCustomFields(apiKey, listID)
|
1112
|
+
#
|
1113
|
+
# ARGS
|
1114
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1115
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1116
|
+
#
|
1117
|
+
# RETURNS
|
1118
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1119
|
+
#
|
1120
|
+
apiKey = listID = nil
|
1121
|
+
puts obj.getListCustomFields(apiKey, listID)
|
1122
|
+
|
1123
|
+
# SYNOPSIS
|
1124
|
+
# DeleteListCustomField(apiKey, listID, key)
|
1125
|
+
#
|
1126
|
+
# ARGS
|
1127
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1128
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1129
|
+
# key C_String - {http://www.w3.org/2001/XMLSchema}string
|
1130
|
+
#
|
1131
|
+
# RETURNS
|
1132
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1133
|
+
#
|
1134
|
+
apiKey = listID = key = nil
|
1135
|
+
puts obj.deleteListCustomField(apiKey, listID, key)
|
1136
|
+
|
1137
|
+
# SYNOPSIS
|
1138
|
+
# CreateListCustomField(apiKey, listID, fieldName, dataType, options)
|
1139
|
+
#
|
1140
|
+
# ARGS
|
1141
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1142
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1143
|
+
# fieldName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1144
|
+
# dataType C_String - {http://www.w3.org/2001/XMLSchema}string
|
1145
|
+
# options C_String - {http://www.w3.org/2001/XMLSchema}string
|
1146
|
+
#
|
1147
|
+
# RETURNS
|
1148
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1149
|
+
#
|
1150
|
+
apiKey = listID = fieldName = dataType = options = nil
|
1151
|
+
puts obj.createListCustomField(apiKey, listID, fieldName, dataType, options)
|
1152
|
+
|
1153
|
+
# SYNOPSIS
|
1154
|
+
# GetClientCampaigns(apiKey, clientID)
|
1155
|
+
#
|
1156
|
+
# ARGS
|
1157
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1158
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1159
|
+
#
|
1160
|
+
# RETURNS
|
1161
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1162
|
+
#
|
1163
|
+
apiKey = clientID = nil
|
1164
|
+
puts obj.getClientCampaigns(apiKey, clientID)
|
1165
|
+
|
1166
|
+
# SYNOPSIS
|
1167
|
+
# GetClientLists(apiKey, clientID)
|
1168
|
+
#
|
1169
|
+
# ARGS
|
1170
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1171
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1172
|
+
#
|
1173
|
+
# RETURNS
|
1174
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1175
|
+
#
|
1176
|
+
apiKey = clientID = nil
|
1177
|
+
puts obj.getClientLists(apiKey, clientID)
|
1178
|
+
|
1179
|
+
# SYNOPSIS
|
1180
|
+
# GetClientSegments(apiKey, clientID)
|
1181
|
+
#
|
1182
|
+
# ARGS
|
1183
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1184
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1185
|
+
#
|
1186
|
+
# RETURNS
|
1187
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1188
|
+
#
|
1189
|
+
apiKey = clientID = nil
|
1190
|
+
puts obj.getClientSegments(apiKey, clientID)
|
1191
|
+
|
1192
|
+
# SYNOPSIS
|
1193
|
+
# GetClientSuppressionList(apiKey, clientID)
|
1194
|
+
#
|
1195
|
+
# ARGS
|
1196
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1197
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1198
|
+
#
|
1199
|
+
# RETURNS
|
1200
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1201
|
+
#
|
1202
|
+
apiKey = clientID = nil
|
1203
|
+
puts obj.getClientSuppressionList(apiKey, clientID)
|
1204
|
+
|
1205
|
+
# SYNOPSIS
|
1206
|
+
# CreateClient(apiKey, companyName, contactName, emailAddress, country, timezone)
|
1207
|
+
#
|
1208
|
+
# ARGS
|
1209
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1210
|
+
# companyName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1211
|
+
# contactName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1212
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1213
|
+
# country C_String - {http://www.w3.org/2001/XMLSchema}string
|
1214
|
+
# timezone C_String - {http://www.w3.org/2001/XMLSchema}string
|
1215
|
+
#
|
1216
|
+
# RETURNS
|
1217
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1218
|
+
#
|
1219
|
+
apiKey = companyName = contactName = emailAddress = country = timezone = nil
|
1220
|
+
puts obj.createClient(apiKey, companyName, contactName, emailAddress, country, timezone)
|
1221
|
+
|
1222
|
+
# SYNOPSIS
|
1223
|
+
# UpdateClientBasics(apiKey, clientID, companyName, contactName, emailAddress, country, timezone)
|
1224
|
+
#
|
1225
|
+
# ARGS
|
1226
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1227
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1228
|
+
# companyName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1229
|
+
# contactName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1230
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1231
|
+
# country C_String - {http://www.w3.org/2001/XMLSchema}string
|
1232
|
+
# timezone C_String - {http://www.w3.org/2001/XMLSchema}string
|
1233
|
+
#
|
1234
|
+
# RETURNS
|
1235
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1236
|
+
#
|
1237
|
+
apiKey = clientID = companyName = contactName = emailAddress = country = timezone = nil
|
1238
|
+
puts obj.updateClientBasics(apiKey, clientID, companyName, contactName, emailAddress, country, timezone)
|
1239
|
+
|
1240
|
+
# SYNOPSIS
|
1241
|
+
# UpdateClientAccessAndBilling(apiKey, clientID, accessLevel, username, password, billingType, currency, deliveryFee, costPerRecipient, designAndSpamTestFee)
|
1242
|
+
#
|
1243
|
+
# ARGS
|
1244
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1245
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1246
|
+
# accessLevel C_String - {http://www.w3.org/2001/XMLSchema}string
|
1247
|
+
# username C_String - {http://www.w3.org/2001/XMLSchema}string
|
1248
|
+
# password C_String - {http://www.w3.org/2001/XMLSchema}string
|
1249
|
+
# billingType C_String - {http://www.w3.org/2001/XMLSchema}string
|
1250
|
+
# currency C_String - {http://www.w3.org/2001/XMLSchema}string
|
1251
|
+
# deliveryFee C_String - {http://www.w3.org/2001/XMLSchema}string
|
1252
|
+
# costPerRecipient C_String - {http://www.w3.org/2001/XMLSchema}string
|
1253
|
+
# designAndSpamTestFee C_String - {http://www.w3.org/2001/XMLSchema}string
|
1254
|
+
#
|
1255
|
+
# RETURNS
|
1256
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1257
|
+
#
|
1258
|
+
apiKey = clientID = accessLevel = username = password = billingType = currency = deliveryFee = costPerRecipient = designAndSpamTestFee = nil
|
1259
|
+
puts obj.updateClientAccessAndBilling(apiKey, clientID, accessLevel, username, password, billingType, currency, deliveryFee, costPerRecipient, designAndSpamTestFee)
|
1260
|
+
|
1261
|
+
# SYNOPSIS
|
1262
|
+
# GetClientDetail(apiKey, clientID)
|
1263
|
+
#
|
1264
|
+
# ARGS
|
1265
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1266
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1267
|
+
#
|
1268
|
+
# RETURNS
|
1269
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1270
|
+
#
|
1271
|
+
apiKey = clientID = nil
|
1272
|
+
puts obj.getClientDetail(apiKey, clientID)
|
1273
|
+
|
1274
|
+
# SYNOPSIS
|
1275
|
+
# DeleteClient(apiKey, clientID)
|
1276
|
+
#
|
1277
|
+
# ARGS
|
1278
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1279
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1280
|
+
#
|
1281
|
+
# RETURNS
|
1282
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1283
|
+
#
|
1284
|
+
apiKey = clientID = nil
|
1285
|
+
puts obj.deleteClient(apiKey, clientID)
|
1286
|
+
|
1287
|
+
# SYNOPSIS
|
1288
|
+
# GetSubscriberClicks(apiKey, campaignID)
|
1289
|
+
#
|
1290
|
+
# ARGS
|
1291
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1292
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1293
|
+
#
|
1294
|
+
# RETURNS
|
1295
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1296
|
+
#
|
1297
|
+
apiKey = campaignID = nil
|
1298
|
+
puts obj.getSubscriberClicks(apiKey, campaignID)
|
1299
|
+
|
1300
|
+
# SYNOPSIS
|
1301
|
+
# GetCampaignOpens(apiKey, campaignID)
|
1302
|
+
#
|
1303
|
+
# ARGS
|
1304
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1305
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1306
|
+
#
|
1307
|
+
# RETURNS
|
1308
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1309
|
+
#
|
1310
|
+
apiKey = campaignID = nil
|
1311
|
+
puts obj.getCampaignOpens(apiKey, campaignID)
|
1312
|
+
|
1313
|
+
# SYNOPSIS
|
1314
|
+
# GetCampaignBounces(apiKey, campaignID)
|
1315
|
+
#
|
1316
|
+
# ARGS
|
1317
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1318
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1319
|
+
#
|
1320
|
+
# RETURNS
|
1321
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1322
|
+
#
|
1323
|
+
apiKey = campaignID = nil
|
1324
|
+
puts obj.getCampaignBounces(apiKey, campaignID)
|
1325
|
+
|
1326
|
+
# SYNOPSIS
|
1327
|
+
# GetCampaignUnsubscribes(apiKey, campaignID)
|
1328
|
+
#
|
1329
|
+
# ARGS
|
1330
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1331
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1332
|
+
#
|
1333
|
+
# RETURNS
|
1334
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1335
|
+
#
|
1336
|
+
apiKey = campaignID = nil
|
1337
|
+
puts obj.getCampaignUnsubscribes(apiKey, campaignID)
|
1338
|
+
|
1339
|
+
# SYNOPSIS
|
1340
|
+
# GetCampaignSummary(apiKey, campaignID)
|
1341
|
+
#
|
1342
|
+
# ARGS
|
1343
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1344
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1345
|
+
#
|
1346
|
+
# RETURNS
|
1347
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1348
|
+
#
|
1349
|
+
apiKey = campaignID = nil
|
1350
|
+
puts obj.getCampaignSummary(apiKey, campaignID)
|
1351
|
+
|
1352
|
+
# SYNOPSIS
|
1353
|
+
# GetCampaignLists(apiKey, campaignID)
|
1354
|
+
#
|
1355
|
+
# ARGS
|
1356
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1357
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1358
|
+
#
|
1359
|
+
# RETURNS
|
1360
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1361
|
+
#
|
1362
|
+
apiKey = campaignID = nil
|
1363
|
+
puts obj.getCampaignLists(apiKey, campaignID)
|
1364
|
+
|
1365
|
+
# SYNOPSIS
|
1366
|
+
# GetClients(apiKey)
|
1367
|
+
#
|
1368
|
+
# ARGS
|
1369
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1370
|
+
#
|
1371
|
+
# RETURNS
|
1372
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1373
|
+
#
|
1374
|
+
apiKey = nil
|
1375
|
+
puts obj.getClients(apiKey)
|
1376
|
+
|
1377
|
+
# SYNOPSIS
|
1378
|
+
# GetSystemDate(apiKey)
|
1379
|
+
#
|
1380
|
+
# ARGS
|
1381
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1382
|
+
#
|
1383
|
+
# RETURNS
|
1384
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1385
|
+
#
|
1386
|
+
apiKey = nil
|
1387
|
+
puts obj.getSystemDate(apiKey)
|
1388
|
+
|
1389
|
+
# SYNOPSIS
|
1390
|
+
# GetTimezones(apiKey)
|
1391
|
+
#
|
1392
|
+
# ARGS
|
1393
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1394
|
+
#
|
1395
|
+
# RETURNS
|
1396
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1397
|
+
#
|
1398
|
+
apiKey = nil
|
1399
|
+
puts obj.getTimezones(apiKey)
|
1400
|
+
|
1401
|
+
# SYNOPSIS
|
1402
|
+
# GetCountries(apiKey)
|
1403
|
+
#
|
1404
|
+
# ARGS
|
1405
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1406
|
+
#
|
1407
|
+
# RETURNS
|
1408
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1409
|
+
#
|
1410
|
+
apiKey = nil
|
1411
|
+
puts obj.getCountries(apiKey)
|
1412
|
+
|
1413
|
+
# SYNOPSIS
|
1414
|
+
# SendCampaign(apiKey, campaignID, confirmationEmail, sendDate)
|
1415
|
+
#
|
1416
|
+
# ARGS
|
1417
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1418
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1419
|
+
# confirmationEmail C_String - {http://www.w3.org/2001/XMLSchema}string
|
1420
|
+
# sendDate C_String - {http://www.w3.org/2001/XMLSchema}string
|
1421
|
+
#
|
1422
|
+
# RETURNS
|
1423
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1424
|
+
#
|
1425
|
+
apiKey = campaignID = confirmationEmail = sendDate = nil
|
1426
|
+
puts obj.sendCampaign(apiKey, campaignID, confirmationEmail, sendDate)
|
1427
|
+
|
1428
|
+
|
1429
|
+
endpoint_url = ARGV.shift
|
1430
|
+
obj = ApiHttpPost.new(endpoint_url)
|
1431
|
+
|
1432
|
+
# run ruby with -d to see SOAP wiredumps.
|
1433
|
+
obj.wiredump_dev = STDERR if $DEBUG
|
1434
|
+
|
1435
|
+
# SYNOPSIS
|
1436
|
+
# AddSubscriber(apiKey, listID, email, name)
|
1437
|
+
#
|
1438
|
+
# ARGS
|
1439
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1440
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1441
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
1442
|
+
# name C_String - {http://www.w3.org/2001/XMLSchema}string
|
1443
|
+
#
|
1444
|
+
# RETURNS
|
1445
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1446
|
+
#
|
1447
|
+
apiKey = listID = email = name = nil
|
1448
|
+
puts obj.addSubscriber(apiKey, listID, email, name)
|
1449
|
+
|
1450
|
+
# SYNOPSIS
|
1451
|
+
# AddAndResubscribe(apiKey, listID, email, name)
|
1452
|
+
#
|
1453
|
+
# ARGS
|
1454
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1455
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1456
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
1457
|
+
# name C_String - {http://www.w3.org/2001/XMLSchema}string
|
1458
|
+
#
|
1459
|
+
# RETURNS
|
1460
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1461
|
+
#
|
1462
|
+
apiKey = listID = email = name = nil
|
1463
|
+
puts obj.addAndResubscribe(apiKey, listID, email, name)
|
1464
|
+
|
1465
|
+
# SYNOPSIS
|
1466
|
+
# Unsubscribe(apiKey, listID, email)
|
1467
|
+
#
|
1468
|
+
# ARGS
|
1469
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1470
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1471
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
1472
|
+
#
|
1473
|
+
# RETURNS
|
1474
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1475
|
+
#
|
1476
|
+
apiKey = listID = email = nil
|
1477
|
+
puts obj.unsubscribe(apiKey, listID, email)
|
1478
|
+
|
1479
|
+
# SYNOPSIS
|
1480
|
+
# GetSubscribers(apiKey, listID, date)
|
1481
|
+
#
|
1482
|
+
# ARGS
|
1483
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1484
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1485
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
1486
|
+
#
|
1487
|
+
# RETURNS
|
1488
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1489
|
+
#
|
1490
|
+
apiKey = listID = date = nil
|
1491
|
+
puts obj.getSubscribers(apiKey, listID, date)
|
1492
|
+
|
1493
|
+
# SYNOPSIS
|
1494
|
+
# GetUnsubscribed(apiKey, listID, date)
|
1495
|
+
#
|
1496
|
+
# ARGS
|
1497
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1498
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1499
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
1500
|
+
#
|
1501
|
+
# RETURNS
|
1502
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1503
|
+
#
|
1504
|
+
apiKey = listID = date = nil
|
1505
|
+
puts obj.getUnsubscribed(apiKey, listID, date)
|
1506
|
+
|
1507
|
+
# SYNOPSIS
|
1508
|
+
# GetBounced(apiKey, listID, date)
|
1509
|
+
#
|
1510
|
+
# ARGS
|
1511
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1512
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1513
|
+
# date C_String - {http://www.w3.org/2001/XMLSchema}string
|
1514
|
+
#
|
1515
|
+
# RETURNS
|
1516
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1517
|
+
#
|
1518
|
+
apiKey = listID = date = nil
|
1519
|
+
puts obj.getBounced(apiKey, listID, date)
|
1520
|
+
|
1521
|
+
# SYNOPSIS
|
1522
|
+
# GetSingleSubscriber(apiKey, listID, emailAddress)
|
1523
|
+
#
|
1524
|
+
# ARGS
|
1525
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1526
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1527
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1528
|
+
#
|
1529
|
+
# RETURNS
|
1530
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1531
|
+
#
|
1532
|
+
apiKey = listID = emailAddress = nil
|
1533
|
+
puts obj.getSingleSubscriber(apiKey, listID, emailAddress)
|
1534
|
+
|
1535
|
+
# SYNOPSIS
|
1536
|
+
# GetIsSubscribed(apiKey, listID, email)
|
1537
|
+
#
|
1538
|
+
# ARGS
|
1539
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1540
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1541
|
+
# email C_String - {http://www.w3.org/2001/XMLSchema}string
|
1542
|
+
#
|
1543
|
+
# RETURNS
|
1544
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1545
|
+
#
|
1546
|
+
apiKey = listID = email = nil
|
1547
|
+
puts obj.getIsSubscribed(apiKey, listID, email)
|
1548
|
+
|
1549
|
+
# SYNOPSIS
|
1550
|
+
# CreateList(apiKey, clientID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1551
|
+
#
|
1552
|
+
# ARGS
|
1553
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1554
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1555
|
+
# title C_String - {http://www.w3.org/2001/XMLSchema}string
|
1556
|
+
# unsubscribePage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1557
|
+
# confirmOptIn C_String - {http://www.w3.org/2001/XMLSchema}string
|
1558
|
+
# confirmationSuccessPage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1559
|
+
#
|
1560
|
+
# RETURNS
|
1561
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1562
|
+
#
|
1563
|
+
apiKey = clientID = title = unsubscribePage = confirmOptIn = confirmationSuccessPage = nil
|
1564
|
+
puts obj.createList(apiKey, clientID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1565
|
+
|
1566
|
+
# SYNOPSIS
|
1567
|
+
# UpdateList(apiKey, listID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1568
|
+
#
|
1569
|
+
# ARGS
|
1570
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1571
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1572
|
+
# title C_String - {http://www.w3.org/2001/XMLSchema}string
|
1573
|
+
# unsubscribePage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1574
|
+
# confirmOptIn C_String - {http://www.w3.org/2001/XMLSchema}string
|
1575
|
+
# confirmationSuccessPage C_String - {http://www.w3.org/2001/XMLSchema}string
|
1576
|
+
#
|
1577
|
+
# RETURNS
|
1578
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1579
|
+
#
|
1580
|
+
apiKey = listID = title = unsubscribePage = confirmOptIn = confirmationSuccessPage = nil
|
1581
|
+
puts obj.updateList(apiKey, listID, title, unsubscribePage, confirmOptIn, confirmationSuccessPage)
|
1582
|
+
|
1583
|
+
# SYNOPSIS
|
1584
|
+
# GetListDetail(apiKey, listID)
|
1585
|
+
#
|
1586
|
+
# ARGS
|
1587
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1588
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1589
|
+
#
|
1590
|
+
# RETURNS
|
1591
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1592
|
+
#
|
1593
|
+
apiKey = listID = nil
|
1594
|
+
puts obj.getListDetail(apiKey, listID)
|
1595
|
+
|
1596
|
+
# SYNOPSIS
|
1597
|
+
# DeleteList(apiKey, listID)
|
1598
|
+
#
|
1599
|
+
# ARGS
|
1600
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1601
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1602
|
+
#
|
1603
|
+
# RETURNS
|
1604
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1605
|
+
#
|
1606
|
+
apiKey = listID = nil
|
1607
|
+
puts obj.deleteList(apiKey, listID)
|
1608
|
+
|
1609
|
+
# SYNOPSIS
|
1610
|
+
# GetListCustomFields(apiKey, listID)
|
1611
|
+
#
|
1612
|
+
# ARGS
|
1613
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1614
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1615
|
+
#
|
1616
|
+
# RETURNS
|
1617
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1618
|
+
#
|
1619
|
+
apiKey = listID = nil
|
1620
|
+
puts obj.getListCustomFields(apiKey, listID)
|
1621
|
+
|
1622
|
+
# SYNOPSIS
|
1623
|
+
# DeleteListCustomField(apiKey, listID, key)
|
1624
|
+
#
|
1625
|
+
# ARGS
|
1626
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1627
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1628
|
+
# key C_String - {http://www.w3.org/2001/XMLSchema}string
|
1629
|
+
#
|
1630
|
+
# RETURNS
|
1631
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1632
|
+
#
|
1633
|
+
apiKey = listID = key = nil
|
1634
|
+
puts obj.deleteListCustomField(apiKey, listID, key)
|
1635
|
+
|
1636
|
+
# SYNOPSIS
|
1637
|
+
# CreateListCustomField(apiKey, listID, fieldName, dataType, options)
|
1638
|
+
#
|
1639
|
+
# ARGS
|
1640
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1641
|
+
# listID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1642
|
+
# fieldName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1643
|
+
# dataType C_String - {http://www.w3.org/2001/XMLSchema}string
|
1644
|
+
# options C_String - {http://www.w3.org/2001/XMLSchema}string
|
1645
|
+
#
|
1646
|
+
# RETURNS
|
1647
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1648
|
+
#
|
1649
|
+
apiKey = listID = fieldName = dataType = options = nil
|
1650
|
+
puts obj.createListCustomField(apiKey, listID, fieldName, dataType, options)
|
1651
|
+
|
1652
|
+
# SYNOPSIS
|
1653
|
+
# GetClientCampaigns(apiKey, clientID)
|
1654
|
+
#
|
1655
|
+
# ARGS
|
1656
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1657
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1658
|
+
#
|
1659
|
+
# RETURNS
|
1660
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1661
|
+
#
|
1662
|
+
apiKey = clientID = nil
|
1663
|
+
puts obj.getClientCampaigns(apiKey, clientID)
|
1664
|
+
|
1665
|
+
# SYNOPSIS
|
1666
|
+
# GetClientLists(apiKey, clientID)
|
1667
|
+
#
|
1668
|
+
# ARGS
|
1669
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1670
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1671
|
+
#
|
1672
|
+
# RETURNS
|
1673
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1674
|
+
#
|
1675
|
+
apiKey = clientID = nil
|
1676
|
+
puts obj.getClientLists(apiKey, clientID)
|
1677
|
+
|
1678
|
+
# SYNOPSIS
|
1679
|
+
# GetClientSegments(apiKey, clientID)
|
1680
|
+
#
|
1681
|
+
# ARGS
|
1682
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1683
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1684
|
+
#
|
1685
|
+
# RETURNS
|
1686
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1687
|
+
#
|
1688
|
+
apiKey = clientID = nil
|
1689
|
+
puts obj.getClientSegments(apiKey, clientID)
|
1690
|
+
|
1691
|
+
# SYNOPSIS
|
1692
|
+
# GetClientSuppressionList(apiKey, clientID)
|
1693
|
+
#
|
1694
|
+
# ARGS
|
1695
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1696
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1697
|
+
#
|
1698
|
+
# RETURNS
|
1699
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1700
|
+
#
|
1701
|
+
apiKey = clientID = nil
|
1702
|
+
puts obj.getClientSuppressionList(apiKey, clientID)
|
1703
|
+
|
1704
|
+
# SYNOPSIS
|
1705
|
+
# CreateClient(apiKey, companyName, contactName, emailAddress, country, timezone)
|
1706
|
+
#
|
1707
|
+
# ARGS
|
1708
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1709
|
+
# companyName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1710
|
+
# contactName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1711
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1712
|
+
# country C_String - {http://www.w3.org/2001/XMLSchema}string
|
1713
|
+
# timezone C_String - {http://www.w3.org/2001/XMLSchema}string
|
1714
|
+
#
|
1715
|
+
# RETURNS
|
1716
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1717
|
+
#
|
1718
|
+
apiKey = companyName = contactName = emailAddress = country = timezone = nil
|
1719
|
+
puts obj.createClient(apiKey, companyName, contactName, emailAddress, country, timezone)
|
1720
|
+
|
1721
|
+
# SYNOPSIS
|
1722
|
+
# UpdateClientBasics(apiKey, clientID, companyName, contactName, emailAddress, country, timezone)
|
1723
|
+
#
|
1724
|
+
# ARGS
|
1725
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1726
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1727
|
+
# companyName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1728
|
+
# contactName C_String - {http://www.w3.org/2001/XMLSchema}string
|
1729
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
1730
|
+
# country C_String - {http://www.w3.org/2001/XMLSchema}string
|
1731
|
+
# timezone C_String - {http://www.w3.org/2001/XMLSchema}string
|
1732
|
+
#
|
1733
|
+
# RETURNS
|
1734
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1735
|
+
#
|
1736
|
+
apiKey = clientID = companyName = contactName = emailAddress = country = timezone = nil
|
1737
|
+
puts obj.updateClientBasics(apiKey, clientID, companyName, contactName, emailAddress, country, timezone)
|
1738
|
+
|
1739
|
+
# SYNOPSIS
|
1740
|
+
# UpdateClientAccessAndBilling(apiKey, clientID, accessLevel, username, password, billingType, currency, deliveryFee, costPerRecipient, designAndSpamTestFee)
|
1741
|
+
#
|
1742
|
+
# ARGS
|
1743
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1744
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1745
|
+
# accessLevel C_String - {http://www.w3.org/2001/XMLSchema}string
|
1746
|
+
# username C_String - {http://www.w3.org/2001/XMLSchema}string
|
1747
|
+
# password C_String - {http://www.w3.org/2001/XMLSchema}string
|
1748
|
+
# billingType C_String - {http://www.w3.org/2001/XMLSchema}string
|
1749
|
+
# currency C_String - {http://www.w3.org/2001/XMLSchema}string
|
1750
|
+
# deliveryFee C_String - {http://www.w3.org/2001/XMLSchema}string
|
1751
|
+
# costPerRecipient C_String - {http://www.w3.org/2001/XMLSchema}string
|
1752
|
+
# designAndSpamTestFee C_String - {http://www.w3.org/2001/XMLSchema}string
|
1753
|
+
#
|
1754
|
+
# RETURNS
|
1755
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1756
|
+
#
|
1757
|
+
apiKey = clientID = accessLevel = username = password = billingType = currency = deliveryFee = costPerRecipient = designAndSpamTestFee = nil
|
1758
|
+
puts obj.updateClientAccessAndBilling(apiKey, clientID, accessLevel, username, password, billingType, currency, deliveryFee, costPerRecipient, designAndSpamTestFee)
|
1759
|
+
|
1760
|
+
# SYNOPSIS
|
1761
|
+
# GetClientDetail(apiKey, clientID)
|
1762
|
+
#
|
1763
|
+
# ARGS
|
1764
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1765
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1766
|
+
#
|
1767
|
+
# RETURNS
|
1768
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1769
|
+
#
|
1770
|
+
apiKey = clientID = nil
|
1771
|
+
puts obj.getClientDetail(apiKey, clientID)
|
1772
|
+
|
1773
|
+
# SYNOPSIS
|
1774
|
+
# DeleteClient(apiKey, clientID)
|
1775
|
+
#
|
1776
|
+
# ARGS
|
1777
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1778
|
+
# clientID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1779
|
+
#
|
1780
|
+
# RETURNS
|
1781
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1782
|
+
#
|
1783
|
+
apiKey = clientID = nil
|
1784
|
+
puts obj.deleteClient(apiKey, clientID)
|
1785
|
+
|
1786
|
+
# SYNOPSIS
|
1787
|
+
# GetSubscriberClicks(apiKey, campaignID)
|
1788
|
+
#
|
1789
|
+
# ARGS
|
1790
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1791
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1792
|
+
#
|
1793
|
+
# RETURNS
|
1794
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1795
|
+
#
|
1796
|
+
apiKey = campaignID = nil
|
1797
|
+
puts obj.getSubscriberClicks(apiKey, campaignID)
|
1798
|
+
|
1799
|
+
# SYNOPSIS
|
1800
|
+
# GetCampaignOpens(apiKey, campaignID)
|
1801
|
+
#
|
1802
|
+
# ARGS
|
1803
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1804
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1805
|
+
#
|
1806
|
+
# RETURNS
|
1807
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1808
|
+
#
|
1809
|
+
apiKey = campaignID = nil
|
1810
|
+
puts obj.getCampaignOpens(apiKey, campaignID)
|
1811
|
+
|
1812
|
+
# SYNOPSIS
|
1813
|
+
# GetCampaignBounces(apiKey, campaignID)
|
1814
|
+
#
|
1815
|
+
# ARGS
|
1816
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1817
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1818
|
+
#
|
1819
|
+
# RETURNS
|
1820
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1821
|
+
#
|
1822
|
+
apiKey = campaignID = nil
|
1823
|
+
puts obj.getCampaignBounces(apiKey, campaignID)
|
1824
|
+
|
1825
|
+
# SYNOPSIS
|
1826
|
+
# GetCampaignUnsubscribes(apiKey, campaignID)
|
1827
|
+
#
|
1828
|
+
# ARGS
|
1829
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1830
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1831
|
+
#
|
1832
|
+
# RETURNS
|
1833
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1834
|
+
#
|
1835
|
+
apiKey = campaignID = nil
|
1836
|
+
puts obj.getCampaignUnsubscribes(apiKey, campaignID)
|
1837
|
+
|
1838
|
+
# SYNOPSIS
|
1839
|
+
# GetCampaignSummary(apiKey, campaignID)
|
1840
|
+
#
|
1841
|
+
# ARGS
|
1842
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1843
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1844
|
+
#
|
1845
|
+
# RETURNS
|
1846
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1847
|
+
#
|
1848
|
+
apiKey = campaignID = nil
|
1849
|
+
puts obj.getCampaignSummary(apiKey, campaignID)
|
1850
|
+
|
1851
|
+
# SYNOPSIS
|
1852
|
+
# GetCampaignLists(apiKey, campaignID)
|
1853
|
+
#
|
1854
|
+
# ARGS
|
1855
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1856
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1857
|
+
#
|
1858
|
+
# RETURNS
|
1859
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1860
|
+
#
|
1861
|
+
apiKey = campaignID = nil
|
1862
|
+
puts obj.getCampaignLists(apiKey, campaignID)
|
1863
|
+
|
1864
|
+
# SYNOPSIS
|
1865
|
+
# GetClients(apiKey)
|
1866
|
+
#
|
1867
|
+
# ARGS
|
1868
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1869
|
+
#
|
1870
|
+
# RETURNS
|
1871
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1872
|
+
#
|
1873
|
+
apiKey = nil
|
1874
|
+
puts obj.getClients(apiKey)
|
1875
|
+
|
1876
|
+
# SYNOPSIS
|
1877
|
+
# GetSystemDate(apiKey)
|
1878
|
+
#
|
1879
|
+
# ARGS
|
1880
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1881
|
+
#
|
1882
|
+
# RETURNS
|
1883
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1884
|
+
#
|
1885
|
+
apiKey = nil
|
1886
|
+
puts obj.getSystemDate(apiKey)
|
1887
|
+
|
1888
|
+
# SYNOPSIS
|
1889
|
+
# GetTimezones(apiKey)
|
1890
|
+
#
|
1891
|
+
# ARGS
|
1892
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1893
|
+
#
|
1894
|
+
# RETURNS
|
1895
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1896
|
+
#
|
1897
|
+
apiKey = nil
|
1898
|
+
puts obj.getTimezones(apiKey)
|
1899
|
+
|
1900
|
+
# SYNOPSIS
|
1901
|
+
# GetCountries(apiKey)
|
1902
|
+
#
|
1903
|
+
# ARGS
|
1904
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1905
|
+
#
|
1906
|
+
# RETURNS
|
1907
|
+
# body AnyType - {http://api.createsend.com/api/}anyType
|
1908
|
+
#
|
1909
|
+
apiKey = nil
|
1910
|
+
puts obj.getCountries(apiKey)
|
1911
|
+
|
1912
|
+
# SYNOPSIS
|
1913
|
+
# SendCampaign(apiKey, campaignID, confirmationEmail, sendDate)
|
1914
|
+
#
|
1915
|
+
# ARGS
|
1916
|
+
# apiKey C_String - {http://www.w3.org/2001/XMLSchema}string
|
1917
|
+
# campaignID C_String - {http://www.w3.org/2001/XMLSchema}string
|
1918
|
+
# confirmationEmail C_String - {http://www.w3.org/2001/XMLSchema}string
|
1919
|
+
# sendDate C_String - {http://www.w3.org/2001/XMLSchema}string
|
1920
|
+
#
|
1921
|
+
# RETURNS
|
1922
|
+
# body Result - {http://api.createsend.com/api/}Result
|
1923
|
+
#
|
1924
|
+
apiKey = campaignID = confirmationEmail = sendDate = nil
|
1925
|
+
puts obj.sendCampaign(apiKey, campaignID, confirmationEmail, sendDate)
|
1926
|
+
|
1927
|
+
|