Class: ClickSendClient::EmailMarketingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/email_marketing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailMarketingApi

Returns a new instance of EmailMarketingApi.



19
20
21
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#allowed_email_address_get(opts = {}) ⇒ String

Get all email addresses Get all email addresses

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 28

def allowed_email_address_get(opts = {})
  data, _status_code, _headers = allowed_email_address_get_with_http_info(opts)
  data
end

#allowed_email_address_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all email addresses Get all email addresses

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 39

def allowed_email_address_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.allowed_email_address_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EmailMarketingApi.allowed_email_address_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailMarketingApi.allowed_email_address_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email/addresses'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#allowed_email_address_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#allowed_email_address_post(opts = {}) ⇒ String

Create allowed Email Address Create allowed Email Address

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


89
90
91
92
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 89

def allowed_email_address_post(opts = {})
  data, _status_code, _headers = allowed_email_address_post_with_http_info(opts)
  data
end

#allowed_email_address_post_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create allowed Email Address Create allowed Email Address

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 99

def allowed_email_address_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.allowed_email_address_post ...'
  end
  # resource path
  local_var_path = '/email/addresses'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'email_address'])
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#allowed_email_address_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_email_campaign_put(email_campaign_id, opts = {}) ⇒ String

Cancel email campaign Cancel email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


139
140
141
142
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 139

def cancel_email_campaign_put(email_campaign_id, opts = {})
  data, _status_code, _headers = cancel_email_campaign_put_with_http_info(email_campaign_id, opts)
  data
end

#cancel_email_campaign_put_with_http_info(email_campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Cancel email campaign Cancel email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 149

def cancel_email_campaign_put_with_http_info(email_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.cancel_email_campaign_put ...'
  end
  # verify the required parameter 'email_campaign_id' is set
  if @api_client.config.client_side_validation && email_campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling EmailMarketingApi.cancel_email_campaign_put"
  end
  # resource path
  local_var_path = '/email-campaigns/{email_campaign_id}/cancel'.sub('{' + 'email_campaign_id' + '}', email_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#cancel_email_campaign_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_get(email_campaign_id, opts = {}) ⇒ String

Get specific email campaign Get specific email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


193
194
195
196
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 193

def email_campaign_get(email_campaign_id, opts = {})
  data, _status_code, _headers = email_campaign_get_with_http_info(email_campaign_id, opts)
  data
end

#email_campaign_get_with_http_info(email_campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific email campaign Get specific email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 203

def email_campaign_get_with_http_info(email_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_get ...'
  end
  # verify the required parameter 'email_campaign_id' is set
  if @api_client.config.client_side_validation && email_campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling EmailMarketingApi.email_campaign_get"
  end
  # resource path
  local_var_path = '/email-campaigns/{email_campaign_id}'.sub('{' + 'email_campaign_id' + '}', email_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_history_export_get(email_campaign_id, opts = {}) ⇒ String

Export specific email campaign history Export specific email campaign history

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

Returns:

  • (String) 


249
250
251
252
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 249

def email_campaign_history_export_get(email_campaign_id, opts = {})
  data, _status_code, _headers = email_campaign_history_export_get_with_http_info(email_campaign_id, opts)
  data
end

#email_campaign_history_export_get_with_http_info(email_campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Export specific email campaign history Export specific email campaign history

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 261

def email_campaign_history_export_get_with_http_info(email_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_history_export_get ...'
  end
  # verify the required parameter 'email_campaign_id' is set
  if @api_client.config.client_side_validation && email_campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling EmailMarketingApi.email_campaign_history_export_get"
  end
  # resource path
  local_var_path = '/email-campaigns/{email_campaign_id}/history/export'.sub('{' + 'email_campaign_id' + '}', email_campaign_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_history_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_history_get(email_campaign_id, opts = {}) ⇒ String

Get specific email campaign history Get specific email campaign history

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


311
312
313
314
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 311

def email_campaign_history_get(email_campaign_id, opts = {})
  data, _status_code, _headers = email_campaign_history_get_with_http_info(email_campaign_id, opts)
  data
end

#email_campaign_history_get_with_http_info(email_campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific email campaign history Get specific email campaign history

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Start date

  • :date_to (Integer) —

    End date

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 325

def email_campaign_history_get_with_http_info(email_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_history_get ...'
  end
  # verify the required parameter 'email_campaign_id' is set
  if @api_client.config.client_side_validation && email_campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling EmailMarketingApi.email_campaign_history_get"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EmailMarketingApi.email_campaign_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailMarketingApi.email_campaign_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email-campaigns/{email_campaign_id}/history'.sub('{' + 'email_campaign_id' + '}', email_campaign_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_post(email_campaign, opts = {}) ⇒ String

Send email campaign Send email campaign

Parameters:

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


381
382
383
384
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 381

def email_campaign_post(email_campaign, opts = {})
  data, _status_code, _headers = email_campaign_post_with_http_info(email_campaign, opts)
  data
end

#email_campaign_post_with_http_info(email_campaign, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send email campaign Send email campaign

Parameters:

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 391

def email_campaign_post_with_http_info(email_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_post ...'
  end
  # verify the required parameter 'email_campaign' is set
  if @api_client.config.client_side_validation && email_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign' when calling EmailMarketingApi.email_campaign_post"
  end
  # resource path
  local_var_path = '/email-campaigns/send'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_price_post(email_campaign, opts = {}) ⇒ String

Calculate email campaign price Calculate email campaign price

Parameters:

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


435
436
437
438
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 435

def email_campaign_price_post(email_campaign, opts = {})
  data, _status_code, _headers = email_campaign_price_post_with_http_info(email_campaign, opts)
  data
end

#email_campaign_price_post_with_http_info(email_campaign, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Calculate email campaign price Calculate email campaign price

Parameters:

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 445

def email_campaign_price_post_with_http_info(email_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_price_post ...'
  end
  # verify the required parameter 'email_campaign' is set
  if @api_client.config.client_side_validation && email_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign' when calling EmailMarketingApi.email_campaign_price_post"
  end
  # resource path
  local_var_path = '/email-campaigns/price'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaign_put(email_campaign_id, email_campaign, opts = {}) ⇒ String

Edit email campaign Edit email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


490
491
492
493
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 490

def email_campaign_put(email_campaign_id, email_campaign, opts = {})
  data, _status_code, _headers = email_campaign_put_with_http_info(email_campaign_id, email_campaign, opts)
  data
end

#email_campaign_put_with_http_info(email_campaign_id, email_campaign, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Edit email campaign Edit email campaign

Parameters:

  • email_campaign_id —

    Allowed email campaign id

  • email_campaign —

    Email model

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 501

def email_campaign_put_with_http_info(email_campaign_id, email_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaign_put ...'
  end
  # verify the required parameter 'email_campaign_id' is set
  if @api_client.config.client_side_validation && email_campaign_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling EmailMarketingApi.email_campaign_put"
  end
  # verify the required parameter 'email_campaign' is set
  if @api_client.config.client_side_validation && email_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign' when calling EmailMarketingApi.email_campaign_put"
  end
  # resource path
  local_var_path = '/email-campaigns/{email_campaign_id}'.sub('{' + 'email_campaign_id' + '}', email_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaign_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_campaigns_get(opts = {}) ⇒ String

Get all email campaigns Get all email campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


550
551
552
553
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 550

def email_campaigns_get(opts = {})
  data, _status_code, _headers = email_campaigns_get_with_http_info(opts)
  data
end

#email_campaigns_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all email campaigns Get all email campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 561

def email_campaigns_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.email_campaigns_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EmailMarketingApi.email_campaigns_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailMarketingApi.email_campaigns_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/email-campaigns'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#email_campaigns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_verification_token_get(email_address_id, opts = {}) ⇒ String

Send verification token Send verification token

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


611
612
613
614
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 611

def send_verification_token_get(email_address_id, opts = {})
  data, _status_code, _headers = send_verification_token_get_with_http_info(email_address_id, opts)
  data
end

#send_verification_token_get_with_http_info(email_address_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send verification token Send verification token

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 621

def send_verification_token_get_with_http_info(email_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.send_verification_token_get ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailMarketingApi.send_verification_token_get"
  end
  # resource path
  local_var_path = '/email/address-verify/{email_address_id}/send'.sub('{' + 'email_address_id' + '}', email_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#send_verification_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#specific_allowed_email_address_delete(email_address_id, opts = {}) ⇒ String

Delete specific email address Delete specific email address

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


665
666
667
668
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 665

def specific_allowed_email_address_delete(email_address_id, opts = {})
  data, _status_code, _headers = specific_allowed_email_address_delete_with_http_info(email_address_id, opts)
  data
end

#specific_allowed_email_address_delete_with_http_info(email_address_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete specific email address Delete specific email address

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 675

def specific_allowed_email_address_delete_with_http_info(email_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.specific_allowed_email_address_delete ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailMarketingApi.specific_allowed_email_address_delete"
  end
  # resource path
  local_var_path = '/email/addresses/{email_address_id}'.sub('{' + 'email_address_id' + '}', email_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#specific_allowed_email_address_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#specific_allowed_email_address_get(email_address_id, opts = {}) ⇒ String

Get specific email address Get specific email address

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


719
720
721
722
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 719

def specific_allowed_email_address_get(email_address_id, opts = {})
  data, _status_code, _headers = specific_allowed_email_address_get_with_http_info(email_address_id, opts)
  data
end

#specific_allowed_email_address_get_with_http_info(email_address_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific email address Get specific email address

Parameters:

  • email_address_id —

    Allowed email address id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 729

def specific_allowed_email_address_get_with_http_info(email_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.specific_allowed_email_address_get ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailMarketingApi.specific_allowed_email_address_get"
  end
  # resource path
  local_var_path = '/email/addresses/{email_address_id}'.sub('{' + 'email_address_id' + '}', email_address_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#specific_allowed_email_address_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_allowed_email_address_get(email_address_id, activation_token, opts = {}) ⇒ String

Verify email address using verification token Verify email address using verification token

Parameters:

  • email_address_id —

    Allowed email address id

  • activation_token —

    Your activation token.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


774
775
776
777
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 774

def verify_allowed_email_address_get(email_address_id, activation_token, opts = {})
  data, _status_code, _headers = verify_allowed_email_address_get_with_http_info(email_address_id, activation_token, opts)
  data
end

#verify_allowed_email_address_get_with_http_info(email_address_id, activation_token, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Verify email address using verification token Verify email address using verification token

Parameters:

  • email_address_id —

    Allowed email address id

  • activation_token —

    Your activation token.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'lib/clicksend_client/api/email_marketing_api.rb', line 785

def verify_allowed_email_address_get_with_http_info(email_address_id, activation_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailMarketingApi.verify_allowed_email_address_get ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailMarketingApi.verify_allowed_email_address_get"
  end
  # verify the required parameter 'activation_token' is set
  if @api_client.config.client_side_validation && activation_token.nil?
    fail ArgumentError, "Missing the required parameter 'activation_token' when calling EmailMarketingApi.verify_allowed_email_address_get"
  end
  # resource path
  local_var_path = '/email/address-verify/{email_address_id}/verify/{activation_token}'.sub('{' + 'email_address_id' + '}', email_address_id.to_s).sub('{' + 'activation_token' + '}', activation_token.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailMarketingApi#verify_allowed_email_address_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end