Class: MailchimpTransactional::TransactionalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailchimp_transactional/api/transactional_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionalApi

Returns a new instance of TransactionalApi.



19
20
21
 
# File 'lib/mailchimp_transactional/api/transactional_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/mailchimp_transactional/api/transactional_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#post_exports_activity(body, opts = {}) ⇒ InlineResponse2004

/exports/activity Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account’s activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 27

def post_exports_activity(body, opts = {})
  data, _status_code, _headers = post_exports_activity_with_http_info(body, opts)
  data
end

#post_exports_activity_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2004, Fixnum, Hash)>

/exports/activity Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account&#39;s activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2004 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 37

def post_exports_activity_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_exports_activity ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_exports_activity"
  end
  # resource path
  local_var_path = '/exports/activity'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2004')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_exports_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_exports_info(body, opts = {}) ⇒ InlineResponse200

/exports/info Returns information about an export job. If the export job’s state is ‘complete’, the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.

Parameters:

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 81

def post_exports_info(body, opts = {})
  data, _status_code, _headers = post_exports_info_with_http_info(body, opts)
  data
end

#post_exports_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

/exports/info Returns information about an export job. If the export job&#39;s state is &#39;complete&#39;, the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 91

def post_exports_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_exports_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_exports_info"
  end
  # resource path
  local_var_path = '/exports/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse200')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_exports_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_exports_list(body, opts = {}) ⇒ Array<InlineResponse2001>

/exports/list Returns a list of your exports.

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 135

def post_exports_list(body, opts = {})
  data, _status_code, _headers = post_exports_list_with_http_info(body, opts)
  data
end

#post_exports_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse2001>, Fixnum, Hash)>

/exports/list Returns a list of your exports.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse2001> data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 145

def post_exports_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_exports_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_exports_list"
  end
  # resource path
  local_var_path = '/exports/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse2001>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_exports_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_exports_rejects(body, opts = {}) ⇒ InlineResponse2002

/exports/rejects Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.

Parameters:

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 189

def post_exports_rejects(body, opts = {})
  data, _status_code, _headers = post_exports_rejects_with_http_info(body, opts)
  data
end

#post_exports_rejects_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2002, Fixnum, Hash)>

/exports/rejects Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2002 data, response status code and response headers



199
200
201
202
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
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 199

def post_exports_rejects_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_exports_rejects ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_exports_rejects"
  end
  # resource path
  local_var_path = '/exports/rejects'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2002')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_exports_rejects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_exports_whitelist(body, opts = {}) ⇒ InlineResponse2003

/exports/whitelist Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.

Parameters:

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 243

def post_exports_whitelist(body, opts = {})
  data, _status_code, _headers = post_exports_whitelist_with_http_info(body, opts)
  data
end

#post_exports_whitelist_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2003, Fixnum, Hash)>

/exports/whitelist Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2003 data, response status code and response headers



253
254
255
256
257
258
259
260
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
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 253

def post_exports_whitelist_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_exports_whitelist ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_exports_whitelist"
  end
  # resource path
  local_var_path = '/exports/whitelist'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2003')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_exports_whitelist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_add_domain(body, opts = {}) ⇒ InlineResponse2006

/inbound/add-domain Add a new template

Parameters:

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 297

def post_inbound_add_domain(body, opts = {})
  data, _status_code, _headers = post_inbound_add_domain_with_http_info(body, opts)
  data
end

#post_inbound_add_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2006, Fixnum, Hash)>

/inbound/add-domain Add a new template

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2006 data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 307

def post_inbound_add_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_add_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_add_domain"
  end
  # resource path
  local_var_path = '/inbound/add-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2006')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_add_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_add_route(body, opts = {}) ⇒ InlineResponse20010

/inbound/add-route Add a new mailbox route to an inbound domain

Parameters:

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 351

def post_inbound_add_route(body, opts = {})
  data, _status_code, _headers = post_inbound_add_route_with_http_info(body, opts)
  data
end

#post_inbound_add_route_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

/inbound/add-route Add a new mailbox route to an inbound domain

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20010 data, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 361

def post_inbound_add_route_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_add_route ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_add_route"
  end
  # resource path
  local_var_path = '/inbound/add-route'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20010')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_add_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_check_domain(body, opts = {}) ⇒ InlineResponse2007

/inbound/check-domain Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call

Parameters:

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

    the optional parameters

Returns:



405
406
407
408
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 405

def post_inbound_check_domain(body, opts = {})
  data, _status_code, _headers = post_inbound_check_domain_with_http_info(body, opts)
  data
end

#post_inbound_check_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>

/inbound/check-domain Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2007 data, response status code and response headers



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 415

def post_inbound_check_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_check_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_check_domain"
  end
  # resource path
  local_var_path = '/inbound/check-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2007')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_check_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_delete_domain(body, opts = {}) ⇒ InlineResponse2008

/inbound/delete-domain Delete an inbound domain from the account. All mail will stop routing for this domain immediately.

Parameters:

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

    the optional parameters

Returns:



459
460
461
462
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 459

def post_inbound_delete_domain(body, opts = {})
  data, _status_code, _headers = post_inbound_delete_domain_with_http_info(body, opts)
  data
end

#post_inbound_delete_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2008, Fixnum, Hash)>

/inbound/delete-domain Delete an inbound domain from the account. All mail will stop routing for this domain immediately.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2008 data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 469

def post_inbound_delete_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_delete_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_delete_domain"
  end
  # resource path
  local_var_path = '/inbound/delete-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse2008')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_delete_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_delete_route(body, opts = {}) ⇒ InlineResponse20012

/inbound/delete-route Delete an existing inbound mailbox route

Parameters:

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 513

def post_inbound_delete_route(body, opts = {})
  data, _status_code, _headers = post_inbound_delete_route_with_http_info(body, opts)
  data
end

#post_inbound_delete_route_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20012, Fixnum, Hash)>

/inbound/delete-route Delete an existing inbound mailbox route

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20012 data, response status code and response headers



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 523

def post_inbound_delete_route_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_delete_route ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_delete_route"
  end
  # resource path
  local_var_path = '/inbound/delete-route'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20012')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_delete_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_domains(body, opts = {}) ⇒ Array<InlineResponse2005>

/inbound/domains Add an inbound domain to your account

Parameters:

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

    the optional parameters

Returns:



567
568
569
570
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 567

def post_inbound_domains(body, opts = {})
  data, _status_code, _headers = post_inbound_domains_with_http_info(body, opts)
  data
end

#post_inbound_domains_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse2005>, Fixnum, Hash)>

/inbound/domains Add an inbound domain to your account

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse2005> data, response status code and response headers



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
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 577

def post_inbound_domains_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_domains ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_domains"
  end
  # resource path
  local_var_path = '/inbound/domains'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse2005>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_routes(body, opts = {}) ⇒ Array<InlineResponse2009>

/inbound/routes List the mailbox routes defined for an inbound domain

Parameters:

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

    the optional parameters

Returns:



621
622
623
624
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 621

def post_inbound_routes(body, opts = {})
  data, _status_code, _headers = post_inbound_routes_with_http_info(body, opts)
  data
end

#post_inbound_routes_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse2009>, Fixnum, Hash)>

/inbound/routes List the mailbox routes defined for an inbound domain

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse2009> data, response status code and response headers



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
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 631

def post_inbound_routes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_routes ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_routes"
  end
  # resource path
  local_var_path = '/inbound/routes'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse2009>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_send_raw(body, opts = {}) ⇒ Array<InlineResponse20013>

/inbound/send-raw Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP

Parameters:

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

    the optional parameters

Returns:



675
676
677
678
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 675

def post_inbound_send_raw(body, opts = {})
  data, _status_code, _headers = post_inbound_send_raw_with_http_info(body, opts)
  data
end

#post_inbound_send_raw_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20013>, Fixnum, Hash)>

/inbound/send-raw Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20013> data, response status code and response headers



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
714
715
716
717
718
719
720
721
722
723
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 685

def post_inbound_send_raw_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_send_raw ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_send_raw"
  end
  # resource path
  local_var_path = '/inbound/send-raw'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20013>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_send_raw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_inbound_update_route(body, opts = {}) ⇒ InlineResponse20011

/inbound/update-route Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.

Parameters:

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

    the optional parameters

Returns:



729
730
731
732
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 729

def post_inbound_update_route(body, opts = {})
  data, _status_code, _headers = post_inbound_update_route_with_http_info(body, opts)
  data
end

#post_inbound_update_route_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20011, Fixnum, Hash)>

/inbound/update-route Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20011 data, response status code and response headers



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
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 739

def post_inbound_update_route_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_inbound_update_route ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_inbound_update_route"
  end
  # resource path
  local_var_path = '/inbound/update-route'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_inbound_update_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_cancel_warmup(body, opts = {}) ⇒ InlineResponse20017

/ips/cancel-warmup Cancels the warmup process for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:



783
784
785
786
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 783

def post_ips_cancel_warmup(body, opts = {})
  data, _status_code, _headers = post_ips_cancel_warmup_with_http_info(body, opts)
  data
end

#post_ips_cancel_warmup_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

/ips/cancel-warmup Cancels the warmup process for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20017 data, response status code and response headers



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
828
829
830
831
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 793

def post_ips_cancel_warmup_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_cancel_warmup ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_cancel_warmup"
  end
  # resource path
  local_var_path = '/ips/cancel-warmup'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20017')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_cancel_warmup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_check_custom_dns(body, opts = {}) ⇒ InlineResponse20023

/ips/check-custom-dns Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:



837
838
839
840
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 837

def post_ips_check_custom_dns(body, opts = {})
  data, _status_code, _headers = post_ips_check_custom_dns_with_http_info(body, opts)
  data
end

#post_ips_check_custom_dns_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

/ips/check-custom-dns Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20023 data, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 847

def post_ips_check_custom_dns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_check_custom_dns ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_check_custom_dns"
  end
  # resource path
  local_var_path = '/ips/check-custom-dns'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20023')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_check_custom_dns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_create_pool(body, opts = {}) ⇒ InlineResponse20021

/ips/create-pool Creates a pool and returns it. If a pool already exists with this name, no action will be performed.

Parameters:

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

    the optional parameters

Returns:



891
892
893
894
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 891

def post_ips_create_pool(body, opts = {})
  data, _status_code, _headers = post_ips_create_pool_with_http_info(body, opts)
  data
end

#post_ips_create_pool_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20021, Fixnum, Hash)>

/ips/create-pool Creates a pool and returns it. If a pool already exists with this name, no action will be performed.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20021 data, response status code and response headers



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 901

def post_ips_create_pool_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_create_pool ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_create_pool"
  end
  # resource path
  local_var_path = '/ips/create-pool'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20021')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_create_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_delete(body, opts = {}) ⇒ InlineResponse20019

/ips/delete Deletes a dedicated IP. This is permanent and cannot be undone.

Parameters:

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

    the optional parameters

Returns:



945
946
947
948
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 945

def post_ips_delete(body, opts = {})
  data, _status_code, _headers = post_ips_delete_with_http_info(body, opts)
  data
end

#post_ips_delete_pool(body, opts = {}) ⇒ InlineResponse20022

/ips/delete-pool Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.

Parameters:

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

    the optional parameters

Returns:



999
1000
1001
1002
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 999

def post_ips_delete_pool(body, opts = {})
  data, _status_code, _headers = post_ips_delete_pool_with_http_info(body, opts)
  data
end

#post_ips_delete_pool_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20022, Fixnum, Hash)>

/ips/delete-pool Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20022 data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1009

def post_ips_delete_pool_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_delete_pool ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_delete_pool"
  end
  # resource path
  local_var_path = '/ips/delete-pool'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20022')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_delete_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20019, Fixnum, Hash)>

/ips/delete Deletes a dedicated IP. This is permanent and cannot be undone.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20019 data, response status code and response headers



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 955

def post_ips_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_delete"
  end
  # resource path
  local_var_path = '/ips/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20019')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_info(body, opts = {}) ⇒ InlineResponse20015

/ips/info Retrieves information about a single dedicated ip.

Parameters:

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

    the optional parameters

Returns:



1053
1054
1055
1056
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1053

def post_ips_info(body, opts = {})
  data, _status_code, _headers = post_ips_info_with_http_info(body, opts)
  data
end

#post_ips_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20015, Fixnum, Hash)>

/ips/info Retrieves information about a single dedicated ip.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20015 data, response status code and response headers



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1063

def post_ips_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_info"
  end
  # resource path
  local_var_path = '/ips/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_list(body, opts = {}) ⇒ Array<InlineResponse20014>

/ips/list Lists your dedicated IPs.

Parameters:

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

    the optional parameters

Returns:



1107
1108
1109
1110
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1107

def post_ips_list(body, opts = {})
  data, _status_code, _headers = post_ips_list_with_http_info(body, opts)
  data
end

#post_ips_list_pools(body, opts = {}) ⇒ Array<InlineResponse20020>

/ips/list-pools Lists your dedicated IP pools.

Parameters:

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

    the optional parameters

Returns:



1161
1162
1163
1164
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1161

def post_ips_list_pools(body, opts = {})
  data, _status_code, _headers = post_ips_list_pools_with_http_info(body, opts)
  data
end

#post_ips_list_pools_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20020>, Fixnum, Hash)>

/ips/list-pools Lists your dedicated IP pools.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20020> data, response status code and response headers



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1171

def post_ips_list_pools_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_list_pools ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_list_pools"
  end
  # resource path
  local_var_path = '/ips/list-pools'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20020>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_list_pools\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20014>, Fixnum, Hash)>

/ips/list Lists your dedicated IPs.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20014> data, response status code and response headers



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1117

def post_ips_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_list"
  end
  # resource path
  local_var_path = '/ips/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20014>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_pool_info(body, opts = {}) ⇒ InlineResponse20021

/ips/pool-info Describes a single dedicated IP pool.

Parameters:

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

    the optional parameters

Returns:



1215
1216
1217
1218
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1215

def post_ips_pool_info(body, opts = {})
  data, _status_code, _headers = post_ips_pool_info_with_http_info(body, opts)
  data
end

#post_ips_pool_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20021, Fixnum, Hash)>

/ips/pool-info Describes a single dedicated IP pool.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20021 data, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1225

def post_ips_pool_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_pool_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_pool_info"
  end
  # resource path
  local_var_path = '/ips/pool-info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20021')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_pool_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_provision(body, opts = {}) ⇒ InlineResponse20016

/ips/provision Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.

Parameters:

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

    the optional parameters

Returns:



1269
1270
1271
1272
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1269

def post_ips_provision(body, opts = {})
  data, _status_code, _headers = post_ips_provision_with_http_info(body, opts)
  data
end

#post_ips_provision_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20016, Fixnum, Hash)>

/ips/provision Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20016 data, response status code and response headers



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1279

def post_ips_provision_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_provision ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_provision"
  end
  # resource path
  local_var_path = '/ips/provision'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20016')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_provision\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_set_custom_dns(body, opts = {}) ⇒ InlineResponse20024

/ips/set-custom-dns Configures the custom DNS name for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:



1323
1324
1325
1326
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1323

def post_ips_set_custom_dns(body, opts = {})
  data, _status_code, _headers = post_ips_set_custom_dns_with_http_info(body, opts)
  data
end

#post_ips_set_custom_dns_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20024, Fixnum, Hash)>

/ips/set-custom-dns Configures the custom DNS name for a dedicated IP.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20024 data, response status code and response headers



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1333

def post_ips_set_custom_dns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_set_custom_dns ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_set_custom_dns"
  end
  # resource path
  local_var_path = '/ips/set-custom-dns'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20024')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_set_custom_dns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_set_pool(body, opts = {}) ⇒ InlineResponse20018

/ips/set-pool Moves a dedicated IP to a different pool.

Parameters:

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

    the optional parameters

Returns:



1377
1378
1379
1380
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1377

def post_ips_set_pool(body, opts = {})
  data, _status_code, _headers = post_ips_set_pool_with_http_info(body, opts)
  data
end

#post_ips_set_pool_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20018, Fixnum, Hash)>

/ips/set-pool Moves a dedicated IP to a different pool.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20018 data, response status code and response headers



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1387

def post_ips_set_pool_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_set_pool ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_set_pool"
  end
  # resource path
  local_var_path = '/ips/set-pool'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20018')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_set_pool\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ips_start_warmup(body, opts = {}) ⇒ InlineResponse20017

/ips/start-warmup Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.

Parameters:

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

    the optional parameters

Returns:



1431
1432
1433
1434
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1431

def post_ips_start_warmup(body, opts = {})
  data, _status_code, _headers = post_ips_start_warmup_with_http_info(body, opts)
  data
end

#post_ips_start_warmup_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

/ips/start-warmup Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20017 data, response status code and response headers



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1441

def post_ips_start_warmup_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_ips_start_warmup ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_ips_start_warmup"
  end
  # resource path
  local_var_path = '/ips/start-warmup'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20017')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_ips_start_warmup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_cancel_scheduled(body, opts = {}) ⇒ Array<InlineResponse20032>

/messages/cancel-scheduled Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:



1485
1486
1487
1488
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1485

def post_messages_cancel_scheduled(body, opts = {})
  data, _status_code, _headers = post_messages_cancel_scheduled_with_http_info(body, opts)
  data
end

#post_messages_cancel_scheduled_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20032>, Fixnum, Hash)>

/messages/cancel-scheduled Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20032> data, response status code and response headers



1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1495

def post_messages_cancel_scheduled_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_cancel_scheduled ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_cancel_scheduled"
  end
  # resource path
  local_var_path = '/messages/cancel-scheduled'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20032>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_cancel_scheduled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_content(body, opts = {}) ⇒ InlineResponse20030

/messages/content Get the full content of a recently sent message

Parameters:

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

    the optional parameters

Returns:



1539
1540
1541
1542
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1539

def post_messages_content(body, opts = {})
  data, _status_code, _headers = post_messages_content_with_http_info(body, opts)
  data
end

#post_messages_content_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

/messages/content Get the full content of a recently sent message

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20030 data, response status code and response headers



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1549

def post_messages_content_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_content ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_content"
  end
  # resource path
  local_var_path = '/messages/content'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20030')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_info(body, opts = {}) ⇒ InlineResponse20029

/messages/info Get the information for a single recently sent message

Parameters:

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

    the optional parameters

Returns:



1593
1594
1595
1596
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1593

def post_messages_info(body, opts = {})
  data, _status_code, _headers = post_messages_info_with_http_info(body, opts)
  data
end

#post_messages_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20029, Fixnum, Hash)>

/messages/info Get the information for a single recently sent message

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20029 data, response status code and response headers



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1603

def post_messages_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_info"
  end
  # resource path
  local_var_path = '/messages/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20029')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_list_scheduled(body, opts = {}) ⇒ Array<InlineResponse20032>

/messages/list-scheduled Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:



1647
1648
1649
1650
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1647

def post_messages_list_scheduled(body, opts = {})
  data, _status_code, _headers = post_messages_list_scheduled_with_http_info(body, opts)
  data
end

#post_messages_list_scheduled_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20032>, Fixnum, Hash)>

/messages/list-scheduled Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20032> data, response status code and response headers



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1657

def post_messages_list_scheduled_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_list_scheduled ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_list_scheduled"
  end
  # resource path
  local_var_path = '/messages/list-scheduled'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20032>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_list_scheduled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_parse(body, opts = {}) ⇒ InlineResponse20031

/messages/parse Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces

Parameters:

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

    the optional parameters

Returns:



1701
1702
1703
1704
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1701

def post_messages_parse(body, opts = {})
  data, _status_code, _headers = post_messages_parse_with_http_info(body, opts)
  data
end

#post_messages_parse_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

/messages/parse Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20031 data, response status code and response headers



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1711

def post_messages_parse_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_parse ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_parse"
  end
  # resource path
  local_var_path = '/messages/parse'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_parse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_reschedule(body, opts = {}) ⇒ Array<InlineResponse20032>

/messages/reschedule Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:



1755
1756
1757
1758
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1755

def post_messages_reschedule(body, opts = {})
  data, _status_code, _headers = post_messages_reschedule_with_http_info(body, opts)
  data
end

#post_messages_reschedule_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20032>, Fixnum, Hash)>

/messages/reschedule Queries your scheduled emails.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20032> data, response status code and response headers



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1765

def post_messages_reschedule_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_reschedule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_reschedule"
  end
  # resource path
  local_var_path = '/messages/reschedule'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20032>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_reschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_search(body, opts = {}) ⇒ Array<InlineResponse20027>

/messages/search Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.

Parameters:

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

    the optional parameters

Returns:



1809
1810
1811
1812
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1809

def post_messages_search(body, opts = {})
  data, _status_code, _headers = post_messages_search_with_http_info(body, opts)
  data
end

#post_messages_search_time_series(body, opts = {}) ⇒ Array<InlineResponse20028>

/messages/search-time-series Search the content of recently sent messages and return the aggregated hourly stats for matching messages

Parameters:

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

    the optional parameters

Returns:



1863
1864
1865
1866
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1863

def post_messages_search_time_series(body, opts = {})
  data, _status_code, _headers = post_messages_search_time_series_with_http_info(body, opts)
  data
end

#post_messages_search_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20028>, Fixnum, Hash)>

/messages/search-time-series Search the content of recently sent messages and return the aggregated hourly stats for matching messages

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20028> data, response status code and response headers



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1873

def post_messages_search_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_search_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_search_time_series"
  end
  # resource path
  local_var_path = '/messages/search-time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20028>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_search_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_search_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20027>, Fixnum, Hash)>

/messages/search Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20027> data, response status code and response headers



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1819

def post_messages_search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_search ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_search"
  end
  # resource path
  local_var_path = '/messages/search'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20027>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_send(body, opts = {}) ⇒ Array<InlineResponse20025>

/messages/send Send a new transactional message through Mandrill

Parameters:

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

    the optional parameters

Returns:



1917
1918
1919
1920
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1917

def post_messages_send(body, opts = {})
  data, _status_code, _headers = post_messages_send_with_http_info(body, opts)
  data
end

#post_messages_send_raw(body, opts = {}) ⇒ Object

/messages/send-raw Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill’s SMTP servers

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


1971
1972
1973
1974
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1971

def post_messages_send_raw(body, opts = {})
  data, _status_code, _headers = post_messages_send_raw_with_http_info(body, opts)
  data
end

#post_messages_send_raw_with_http_info(body, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

/messages/send-raw Take a raw MIME document for a message, and send it exactly as if it were sent through Mandrill&#39;s SMTP servers

Parameters:

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1981

def post_messages_send_raw_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_send_raw ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_send_raw"
  end
  # resource path
  local_var_path = '/messages/send-raw'

  # 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(body)
  auth_names = []
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_send_raw\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_send_template(body, opts = {}) ⇒ Array<InlineResponse20026>

/messages/send-template Send a new transactional message through Mandrill

Parameters:

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

    the optional parameters

Returns:



2025
2026
2027
2028
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2025

def post_messages_send_template(body, opts = {})
  data, _status_code, _headers = post_messages_send_template_with_http_info(body, opts)
  data
end

#post_messages_send_template_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20026>, Fixnum, Hash)>

/messages/send-template Send a new transactional message through Mandrill

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20026> data, response status code and response headers



2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2035

def post_messages_send_template_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_send_template ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_send_template"
  end
  # resource path
  local_var_path = '/messages/send-template'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20026>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_send_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_messages_send_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20025>, Fixnum, Hash)>

/messages/send Send a new transactional message through Mandrill

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20025> data, response status code and response headers



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 1927

def post_messages_send_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_messages_send ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_messages_send"
  end
  # resource path
  local_var_path = '/messages/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(body)
  auth_names = []
  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 => 'Array<InlineResponse20025>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_messages_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_metadata_add(body, opts = {}) ⇒ InlineResponse20034

/metadata/add Add a new custom metadata field to be indexed for the account.

Parameters:

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

    the optional parameters

Returns:



2079
2080
2081
2082
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2079

def post_metadata_add(body, opts = {})
  data, _status_code, _headers = post_metadata_add_with_http_info(body, opts)
  data
end

#post_metadata_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20034, Fixnum, Hash)>

/metadata/add Add a new custom metadata field to be indexed for the account.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20034 data, response status code and response headers



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2089

def post_metadata_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_metadata_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_metadata_add"
  end
  # resource path
  local_var_path = '/metadata/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20034')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_metadata_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_metadata_delete(body, opts = {}) ⇒ InlineResponse20036

/metadata/delete Delete an existing custom metadata field. Deletion isn’t instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Parameters:

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

    the optional parameters

Returns:



2133
2134
2135
2136
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2133

def post_metadata_delete(body, opts = {})
  data, _status_code, _headers = post_metadata_delete_with_http_info(body, opts)
  data
end

#post_metadata_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20036, Fixnum, Hash)>

/metadata/delete Delete an existing custom metadata field. Deletion isn&#39;t instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20036 data, response status code and response headers



2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2143

def post_metadata_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_metadata_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_metadata_delete"
  end
  # resource path
  local_var_path = '/metadata/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20036')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_metadata_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_metadata_list(body, opts = {}) ⇒ Array<InlineResponse20033>

/metadata/list Get the list of custom metadata fields indexed for the account.

Parameters:

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

    the optional parameters

Returns:



2187
2188
2189
2190
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2187

def post_metadata_list(body, opts = {})
  data, _status_code, _headers = post_metadata_list_with_http_info(body, opts)
  data
end

#post_metadata_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20033>, Fixnum, Hash)>

/metadata/list Get the list of custom metadata fields indexed for the account.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20033> data, response status code and response headers



2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2197

def post_metadata_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_metadata_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_metadata_list"
  end
  # resource path
  local_var_path = '/metadata/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20033>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_metadata_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_metadata_update(body, opts = {}) ⇒ InlineResponse20035

/metadata/update Delete an existing custom metadata field. Deletion isn’t instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Parameters:

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

    the optional parameters

Returns:



2241
2242
2243
2244
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2241

def post_metadata_update(body, opts = {})
  data, _status_code, _headers = post_metadata_update_with_http_info(body, opts)
  data
end

#post_metadata_update_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20035, Fixnum, Hash)>

/metadata/update Delete an existing custom metadata field. Deletion isn&#39;t instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20035 data, response status code and response headers



2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2251

def post_metadata_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_metadata_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_metadata_update"
  end
  # resource path
  local_var_path = '/metadata/update'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20035')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_metadata_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_rejects_add(body, opts = {}) ⇒ InlineResponse20037

/rejects/add Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.

Parameters:

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

    the optional parameters

Returns:



2295
2296
2297
2298
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2295

def post_rejects_add(body, opts = {})
  data, _status_code, _headers = post_rejects_add_with_http_info(body, opts)
  data
end

#post_rejects_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20037, Fixnum, Hash)>

/rejects/add Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20037 data, response status code and response headers



2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2305

def post_rejects_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_rejects_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_rejects_add"
  end
  # resource path
  local_var_path = '/rejects/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20037')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_rejects_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_rejects_delete(body, opts = {}) ⇒ InlineResponse20039

/rejects/delete Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.

Parameters:

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

    the optional parameters

Returns:



2349
2350
2351
2352
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2349

def post_rejects_delete(body, opts = {})
  data, _status_code, _headers = post_rejects_delete_with_http_info(body, opts)
  data
end

#post_rejects_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20039, Fixnum, Hash)>

/rejects/delete Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20039 data, response status code and response headers



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2359

def post_rejects_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_rejects_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_rejects_delete"
  end
  # resource path
  local_var_path = '/rejects/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20039')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_rejects_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_rejects_list(body, opts = {}) ⇒ Array<InlineResponse20038>

/rejects/list Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.

Parameters:

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

    the optional parameters

Returns:



2403
2404
2405
2406
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2403

def post_rejects_list(body, opts = {})
  data, _status_code, _headers = post_rejects_list_with_http_info(body, opts)
  data
end

#post_rejects_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20038>, Fixnum, Hash)>

/rejects/list Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20038> data, response status code and response headers



2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2413

def post_rejects_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_rejects_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_rejects_list"
  end
  # resource path
  local_var_path = '/rejects/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20038>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_rejects_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_add_domain(body, opts = {}) ⇒ InlineResponse20042

/senders/add-domain Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.

Parameters:

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

    the optional parameters

Returns:



2457
2458
2459
2460
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2457

def post_senders_add_domain(body, opts = {})
  data, _status_code, _headers = post_senders_add_domain_with_http_info(body, opts)
  data
end

#post_senders_add_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20042, Fixnum, Hash)>

/senders/add-domain Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20042 data, response status code and response headers



2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2467

def post_senders_add_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_add_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_add_domain"
  end
  # resource path
  local_var_path = '/senders/add-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20042')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_add_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_check_domain(body, opts = {}) ⇒ InlineResponse20043

/senders/check-domain Checks the SPF and DKIM settings for a domain. If you haven’t already added this domain to your account, it will be added automatically.

Parameters:

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

    the optional parameters

Returns:



2511
2512
2513
2514
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2511

def post_senders_check_domain(body, opts = {})
  data, _status_code, _headers = post_senders_check_domain_with_http_info(body, opts)
  data
end

#post_senders_check_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20043, Fixnum, Hash)>

/senders/check-domain Checks the SPF and DKIM settings for a domain. If you haven&#39;t already added this domain to your account, it will be added automatically.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20043 data, response status code and response headers



2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2521

def post_senders_check_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_check_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_check_domain"
  end
  # resource path
  local_var_path = '/senders/check-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20043')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_check_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_domains(body, opts = {}) ⇒ Array<InlineResponse20041>

/senders/domains Returns the sender domains that have been added to this account

Parameters:

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

    the optional parameters

Returns:



2565
2566
2567
2568
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2565

def post_senders_domains(body, opts = {})
  data, _status_code, _headers = post_senders_domains_with_http_info(body, opts)
  data
end

#post_senders_domains_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20041>, Fixnum, Hash)>

/senders/domains Returns the sender domains that have been added to this account

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20041> data, response status code and response headers



2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2575

def post_senders_domains_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_domains ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_domains"
  end
  # resource path
  local_var_path = '/senders/domains'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20041>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_info(body, opts = {}) ⇒ InlineResponse20045

/senders/info Return more detailed information about a single sender, including aggregates of recent stats

Parameters:

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

    the optional parameters

Returns:



2619
2620
2621
2622
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2619

def post_senders_info(body, opts = {})
  data, _status_code, _headers = post_senders_info_with_http_info(body, opts)
  data
end

#post_senders_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20045, Fixnum, Hash)>

/senders/info Return more detailed information about a single sender, including aggregates of recent stats

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20045 data, response status code and response headers



2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2629

def post_senders_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_info"
  end
  # resource path
  local_var_path = '/senders/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20045')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_list(body, opts = {}) ⇒ Array<InlineResponse20040>

/senders/list Return the senders that have tried to use this account

Parameters:

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

    the optional parameters

Returns:



2673
2674
2675
2676
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2673

def post_senders_list(body, opts = {})
  data, _status_code, _headers = post_senders_list_with_http_info(body, opts)
  data
end

#post_senders_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20040>, Fixnum, Hash)>

/senders/list Return the senders that have tried to use this account

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20040> data, response status code and response headers



2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2683

def post_senders_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_list"
  end
  # resource path
  local_var_path = '/senders/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20040>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_time_series(body, opts = {}) ⇒ Array<InlineResponse20046>

/senders/time-series Return the recent history (hourly stats for the last 30 days) for a sender

Parameters:

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

    the optional parameters

Returns:



2727
2728
2729
2730
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2727

def post_senders_time_series(body, opts = {})
  data, _status_code, _headers = post_senders_time_series_with_http_info(body, opts)
  data
end

#post_senders_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20046>, Fixnum, Hash)>

/senders/time-series Return the recent history (hourly stats for the last 30 days) for a sender

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20046> data, response status code and response headers



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2737

def post_senders_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_time_series"
  end
  # resource path
  local_var_path = '/senders/time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20046>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_senders_verify_domain(body, opts = {}) ⇒ InlineResponse20044

/senders/verify-domain Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.

Parameters:

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

    the optional parameters

Returns:



2781
2782
2783
2784
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2781

def post_senders_verify_domain(body, opts = {})
  data, _status_code, _headers = post_senders_verify_domain_with_http_info(body, opts)
  data
end

#post_senders_verify_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20044, Fixnum, Hash)>

/senders/verify-domain Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20044 data, response status code and response headers



2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2791

def post_senders_verify_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_senders_verify_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_senders_verify_domain"
  end
  # resource path
  local_var_path = '/senders/verify-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20044')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_senders_verify_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_add(body, opts = {}) ⇒ InlineResponse20048

/subaccounts/add Add a new subaccount

Parameters:

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

    the optional parameters

Returns:



2835
2836
2837
2838
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2835

def post_subaccounts_add(body, opts = {})
  data, _status_code, _headers = post_subaccounts_add_with_http_info(body, opts)
  data
end

#post_subaccounts_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20048, Fixnum, Hash)>

/subaccounts/add Add a new subaccount

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20048 data, response status code and response headers



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2845

def post_subaccounts_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_add"
  end
  # resource path
  local_var_path = '/subaccounts/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20048')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_delete(body, opts = {}) ⇒ InlineResponse20051

/subaccounts/delete Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.

Parameters:

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

    the optional parameters

Returns:



2889
2890
2891
2892
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2889

def post_subaccounts_delete(body, opts = {})
  data, _status_code, _headers = post_subaccounts_delete_with_http_info(body, opts)
  data
end

#post_subaccounts_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20051, Fixnum, Hash)>

/subaccounts/delete Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20051 data, response status code and response headers



2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2899

def post_subaccounts_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_delete"
  end
  # resource path
  local_var_path = '/subaccounts/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20051')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_info(body, opts = {}) ⇒ InlineResponse20049

/subaccounts/info Given the ID of an existing subaccount, return the data about it

Parameters:

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

    the optional parameters

Returns:



2943
2944
2945
2946
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2943

def post_subaccounts_info(body, opts = {})
  data, _status_code, _headers = post_subaccounts_info_with_http_info(body, opts)
  data
end

#post_subaccounts_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20049, Fixnum, Hash)>

/subaccounts/info Given the ID of an existing subaccount, return the data about it

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20049 data, response status code and response headers



2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2953

def post_subaccounts_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_info"
  end
  # resource path
  local_var_path = '/subaccounts/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20049')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_list(body, opts = {}) ⇒ Array<InlineResponse20047>

/subaccounts/list Get the list of subaccounts defined for the account, optionally filtered by a prefix

Parameters:

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

    the optional parameters

Returns:



2997
2998
2999
3000
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 2997

def post_subaccounts_list(body, opts = {})
  data, _status_code, _headers = post_subaccounts_list_with_http_info(body, opts)
  data
end

#post_subaccounts_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20047>, Fixnum, Hash)>

/subaccounts/list Get the list of subaccounts defined for the account, optionally filtered by a prefix

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20047> data, response status code and response headers



3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3007

def post_subaccounts_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_list"
  end
  # resource path
  local_var_path = '/subaccounts/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20047>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_pause(body, opts = {}) ⇒ InlineResponse20052

/subaccounts/pause Pause a subaccount’s sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.

Parameters:

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

    the optional parameters

Returns:



3051
3052
3053
3054
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3051

def post_subaccounts_pause(body, opts = {})
  data, _status_code, _headers = post_subaccounts_pause_with_http_info(body, opts)
  data
end

#post_subaccounts_pause_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20052, Fixnum, Hash)>

/subaccounts/pause Pause a subaccount&#39;s sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20052 data, response status code and response headers



3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3061

def post_subaccounts_pause_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_pause ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_pause"
  end
  # resource path
  local_var_path = '/subaccounts/pause'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20052')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_pause\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_resume(body, opts = {}) ⇒ InlineResponse20053

/subaccounts/resume Resume a paused subaccount’s sending

Parameters:

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

    the optional parameters

Returns:



3105
3106
3107
3108
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3105

def post_subaccounts_resume(body, opts = {})
  data, _status_code, _headers = post_subaccounts_resume_with_http_info(body, opts)
  data
end

#post_subaccounts_resume_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20053, Fixnum, Hash)>

/subaccounts/resume Resume a paused subaccount&#39;s sending

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20053 data, response status code and response headers



3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3115

def post_subaccounts_resume_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_resume ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_resume"
  end
  # resource path
  local_var_path = '/subaccounts/resume'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20053')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_resume\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_subaccounts_update(body, opts = {}) ⇒ InlineResponse20050

/subaccounts/update Update an existing subaccount

Parameters:

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

    the optional parameters

Returns:



3159
3160
3161
3162
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3159

def post_subaccounts_update(body, opts = {})
  data, _status_code, _headers = post_subaccounts_update_with_http_info(body, opts)
  data
end

#post_subaccounts_update_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20050, Fixnum, Hash)>

/subaccounts/update Update an existing subaccount

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20050 data, response status code and response headers



3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3169

def post_subaccounts_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_subaccounts_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_subaccounts_update"
  end
  # resource path
  local_var_path = '/subaccounts/update'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20050')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_subaccounts_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_tags_all_time_series(body, opts = {}) ⇒ Array<InlineResponse20028>

/tags/all-time-series Return the recent history (hourly stats for the last 30 days) for all tags

Parameters:

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

    the optional parameters

Returns:



3213
3214
3215
3216
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3213

def post_tags_all_time_series(body, opts = {})
  data, _status_code, _headers = post_tags_all_time_series_with_http_info(body, opts)
  data
end

#post_tags_all_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20028>, Fixnum, Hash)>

/tags/all-time-series Return the recent history (hourly stats for the last 30 days) for all tags

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20028> data, response status code and response headers



3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3223

def post_tags_all_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_tags_all_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_tags_all_time_series"
  end
  # resource path
  local_var_path = '/tags/all-time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20028>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_tags_all_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_tags_delete(body, opts = {}) ⇒ InlineResponse20055

/tags/delete Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag’s stats. There is no way to undo this operation, so use it carefully.

Parameters:

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

    the optional parameters

Returns:



3267
3268
3269
3270
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3267

def post_tags_delete(body, opts = {})
  data, _status_code, _headers = post_tags_delete_with_http_info(body, opts)
  data
end

#post_tags_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20055, Fixnum, Hash)>

/tags/delete Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag&#39;s stats. There is no way to undo this operation, so use it carefully.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20055 data, response status code and response headers



3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3277

def post_tags_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_tags_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_tags_delete"
  end
  # resource path
  local_var_path = '/tags/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20055')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_tags_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_tags_info(body, opts = {}) ⇒ InlineResponse20056

/tags/info Return more detailed information about a single tag, including aggregates of recent stats

Parameters:

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

    the optional parameters

Returns:



3321
3322
3323
3324
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3321

def post_tags_info(body, opts = {})
  data, _status_code, _headers = post_tags_info_with_http_info(body, opts)
  data
end

#post_tags_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20056, Fixnum, Hash)>

/tags/info Return more detailed information about a single tag, including aggregates of recent stats

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20056 data, response status code and response headers



3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3331

def post_tags_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_tags_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_tags_info"
  end
  # resource path
  local_var_path = '/tags/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20056')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_tags_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_tags_list(body, opts = {}) ⇒ Array<InlineResponse20054>

/tags/list Return all of the user-defined tag information

Parameters:

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

    the optional parameters

Returns:



3375
3376
3377
3378
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3375

def post_tags_list(body, opts = {})
  data, _status_code, _headers = post_tags_list_with_http_info(body, opts)
  data
end

#post_tags_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20054>, Fixnum, Hash)>

/tags/list Return all of the user-defined tag information

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20054> data, response status code and response headers



3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3385

def post_tags_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_tags_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_tags_list"
  end
  # resource path
  local_var_path = '/tags/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20054>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_tags_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_tags_time_series(body, opts = {}) ⇒ Array<InlineResponse20028>

/tags/time-series Return the recent history (hourly stats for the last 30 days) for a tag

Parameters:

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

    the optional parameters

Returns:



3429
3430
3431
3432
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3429

def post_tags_time_series(body, opts = {})
  data, _status_code, _headers = post_tags_time_series_with_http_info(body, opts)
  data
end

#post_tags_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20028>, Fixnum, Hash)>

/tags/time-series Return the recent history (hourly stats for the last 30 days) for a tag

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20028> data, response status code and response headers



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3439

def post_tags_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_tags_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_tags_time_series"
  end
  # resource path
  local_var_path = '/tags/time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20028>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_tags_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_add(body, opts = {}) ⇒ InlineResponse20057

/templates/add Add a new template

Parameters:

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

    the optional parameters

Returns:



3483
3484
3485
3486
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3483

def post_templates_add(body, opts = {})
  data, _status_code, _headers = post_templates_add_with_http_info(body, opts)
  data
end

#post_templates_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20057, Fixnum, Hash)>

/templates/add Add a new template

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20057 data, response status code and response headers



3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3493

def post_templates_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_add"
  end
  # resource path
  local_var_path = '/templates/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20057')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_delete(body, opts = {}) ⇒ InlineResponse20061

/templates/delete Delete a template

Parameters:

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

    the optional parameters

Returns:



3537
3538
3539
3540
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3537

def post_templates_delete(body, opts = {})
  data, _status_code, _headers = post_templates_delete_with_http_info(body, opts)
  data
end

#post_templates_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20061, Fixnum, Hash)>

/templates/delete Delete a template

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20061 data, response status code and response headers



3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3547

def post_templates_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_delete"
  end
  # resource path
  local_var_path = '/templates/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20061')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_info(body, opts = {}) ⇒ InlineResponse20058

/templates/info Get the information for an existing template

Parameters:

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

    the optional parameters

Returns:



3591
3592
3593
3594
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3591

def post_templates_info(body, opts = {})
  data, _status_code, _headers = post_templates_info_with_http_info(body, opts)
  data
end

#post_templates_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20058, Fixnum, Hash)>

/templates/info Get the information for an existing template

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20058 data, response status code and response headers



3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3601

def post_templates_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_info"
  end
  # resource path
  local_var_path = '/templates/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20058')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_list(body, opts = {}) ⇒ Array<InlineResponse20062>

/templates/list Return a list of all the templates available to this user

Parameters:

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

    the optional parameters

Returns:



3645
3646
3647
3648
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3645

def post_templates_list(body, opts = {})
  data, _status_code, _headers = post_templates_list_with_http_info(body, opts)
  data
end

#post_templates_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20062>, Fixnum, Hash)>

/templates/list Return a list of all the templates available to this user

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20062> data, response status code and response headers



3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3655

def post_templates_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_list"
  end
  # resource path
  local_var_path = '/templates/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20062>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_publish(body, opts = {}) ⇒ InlineResponse20060

/templates/publish Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.

Parameters:

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

    the optional parameters

Returns:



3699
3700
3701
3702
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3699

def post_templates_publish(body, opts = {})
  data, _status_code, _headers = post_templates_publish_with_http_info(body, opts)
  data
end

#post_templates_publish_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20060, Fixnum, Hash)>

/templates/publish Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20060 data, response status code and response headers



3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3709

def post_templates_publish_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_publish ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_publish"
  end
  # resource path
  local_var_path = '/templates/publish'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20060')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_render(body, opts = {}) ⇒ InlineResponse20063

/templates/render Inject content and optionally merge fields into a template, returning the HTML that results

Parameters:

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

    the optional parameters

Returns:



3753
3754
3755
3756
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3753

def post_templates_render(body, opts = {})
  data, _status_code, _headers = post_templates_render_with_http_info(body, opts)
  data
end

#post_templates_render_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20063, Fixnum, Hash)>

/templates/render Inject content and optionally merge fields into a template, returning the HTML that results

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20063 data, response status code and response headers



3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3763

def post_templates_render_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_render ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_render"
  end
  # resource path
  local_var_path = '/templates/render'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20063')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_time_series(body, opts = {}) ⇒ Array<InlineResponse20046>

/templates/time-series Return the recent history (hourly stats for the last 30 days) for a template

Parameters:

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

    the optional parameters

Returns:



3807
3808
3809
3810
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3807

def post_templates_time_series(body, opts = {})
  data, _status_code, _headers = post_templates_time_series_with_http_info(body, opts)
  data
end

#post_templates_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20046>, Fixnum, Hash)>

/templates/time-series Return the recent history (hourly stats for the last 30 days) for a template

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20046> data, response status code and response headers



3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3817

def post_templates_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_time_series"
  end
  # resource path
  local_var_path = '/templates/time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20046>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_templates_update(body, opts = {}) ⇒ InlineResponse20059

/templates/update Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.

Parameters:

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

    the optional parameters

Returns:



3861
3862
3863
3864
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3861

def post_templates_update(body, opts = {})
  data, _status_code, _headers = post_templates_update_with_http_info(body, opts)
  data
end

#post_templates_update_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20059, Fixnum, Hash)>

/templates/update Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20059 data, response status code and response headers



3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3871

def post_templates_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_templates_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_templates_update"
  end
  # resource path
  local_var_path = '/templates/update'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20059')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_templates_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_add_tracking_domain(body, opts = {}) ⇒ InlineResponse20068

/urls/add-tracking-domain Add a tracking domain to your account

Parameters:

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

    the optional parameters

Returns:



3915
3916
3917
3918
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3915

def post_urls_add_tracking_domain(body, opts = {})
  data, _status_code, _headers = post_urls_add_tracking_domain_with_http_info(body, opts)
  data
end

#post_urls_add_tracking_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20068, Fixnum, Hash)>

/urls/add-tracking-domain Add a tracking domain to your account

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20068 data, response status code and response headers



3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3925

def post_urls_add_tracking_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_add_tracking_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_add_tracking_domain"
  end
  # resource path
  local_var_path = '/urls/add-tracking-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20068')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_add_tracking_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_check_tracking_domain(body, opts = {}) ⇒ InlineResponse20068

/urls/check-tracking-domain Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call

Parameters:

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

    the optional parameters

Returns:



3969
3970
3971
3972
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3969

def post_urls_check_tracking_domain(body, opts = {})
  data, _status_code, _headers = post_urls_check_tracking_domain_with_http_info(body, opts)
  data
end

#post_urls_check_tracking_domain_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20068, Fixnum, Hash)>

/urls/check-tracking-domain Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20068 data, response status code and response headers



3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 3979

def post_urls_check_tracking_domain_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_check_tracking_domain ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_check_tracking_domain"
  end
  # resource path
  local_var_path = '/urls/check-tracking-domain'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20068')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_check_tracking_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_list(body, opts = {}) ⇒ Array<InlineResponse20064>

/urls/list Get the 100 most clicked URLs

Parameters:

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

    the optional parameters

Returns:



4023
4024
4025
4026
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4023

def post_urls_list(body, opts = {})
  data, _status_code, _headers = post_urls_list_with_http_info(body, opts)
  data
end

#post_urls_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20064>, Fixnum, Hash)>

/urls/list Get the 100 most clicked URLs

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20064> data, response status code and response headers



4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4033

def post_urls_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_list"
  end
  # resource path
  local_var_path = '/urls/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20064>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_search_deprecated(body, opts = {}) ⇒ Array<InlineResponse20065>

/urls/search (deprecated) Return the 100 most clicked URLs that match the search query given

Parameters:

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

    the optional parameters

Returns:



4077
4078
4079
4080
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4077

def post_urls_search_deprecated(body, opts = {})
  data, _status_code, _headers = post_urls_search_deprecated_with_http_info(body, opts)
  data
end

#post_urls_search_deprecated_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20065>, Fixnum, Hash)>

/urls/search (deprecated) Return the 100 most clicked URLs that match the search query given

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20065> data, response status code and response headers



4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4087

def post_urls_search_deprecated_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_search_deprecated ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_search_deprecated"
  end
  # resource path
  local_var_path = '/urls/search'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20065>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_search_deprecated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_time_series(body, opts = {}) ⇒ Array<InlineResponse20066>

/urls/time-series Return the recent history (hourly stats for the last 30 days) for a url

Parameters:

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

    the optional parameters

Returns:



4131
4132
4133
4134
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4131

def post_urls_time_series(body, opts = {})
  data, _status_code, _headers = post_urls_time_series_with_http_info(body, opts)
  data
end

#post_urls_time_series_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20066>, Fixnum, Hash)>

/urls/time-series Return the recent history (hourly stats for the last 30 days) for a url

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20066> data, response status code and response headers



4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4141

def post_urls_time_series_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_time_series ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_time_series"
  end
  # resource path
  local_var_path = '/urls/time-series'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20066>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_time_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_urls_tracking_domains(body, opts = {}) ⇒ Array<InlineResponse20067>

/urls/tracking-domains Get the list of tracking domains set up for this account

Parameters:

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

    the optional parameters

Returns:



4185
4186
4187
4188
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4185

def post_urls_tracking_domains(body, opts = {})
  data, _status_code, _headers = post_urls_tracking_domains_with_http_info(body, opts)
  data
end

#post_urls_tracking_domains_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20067>, Fixnum, Hash)>

/urls/tracking-domains Get the list of tracking domains set up for this account

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20067> data, response status code and response headers



4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4195

def post_urls_tracking_domains_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_urls_tracking_domains ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_urls_tracking_domains"
  end
  # resource path
  local_var_path = '/urls/tracking-domains'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20067>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_urls_tracking_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_users_info(body, opts = {}) ⇒ InlineResponse20069

/users/info Return the information about the API-connected user

Parameters:

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

    the optional parameters

Returns:



4239
4240
4241
4242
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4239

def post_users_info(body, opts = {})
  data, _status_code, _headers = post_users_info_with_http_info(body, opts)
  data
end

#post_users_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20069, Fixnum, Hash)>

/users/info Return the information about the API-connected user

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20069 data, response status code and response headers



4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4249

def post_users_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_users_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_users_info"
  end
  # resource path
  local_var_path = '/users/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20069')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_users_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_users_ping(body, opts = {}) ⇒ String

/users/ping Validate an API key and respond to a ping

Parameters:

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

    the optional parameters

Returns:

  • (String) 


4293
4294
4295
4296
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4293

def post_users_ping(body, opts = {})
  data, _status_code, _headers = post_users_ping_with_http_info(body, opts)
  data
end

#post_users_ping2(body, opts = {}) ⇒ InlineResponse20070

/users/ping2 Validate an API key and respond to a ping (anal JSON parser version)

Parameters:

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

    the optional parameters

Returns:



4347
4348
4349
4350
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4347

def post_users_ping2(body, opts = {})
  data, _status_code, _headers = post_users_ping2_with_http_info(body, opts)
  data
end

#post_users_ping2_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20070, Fixnum, Hash)>

/users/ping2 Validate an API key and respond to a ping (anal JSON parser version)

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20070 data, response status code and response headers



4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4357

def post_users_ping2_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_users_ping2 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_users_ping2"
  end
  # resource path
  local_var_path = '/users/ping2'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20070')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_users_ping2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

/users/ping Validate an API key and respond to a ping

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4303

def post_users_ping_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_users_ping ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_users_ping"
  end
  # resource path
  local_var_path = '/users/ping'

  # 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(body)
  auth_names = []
  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: TransactionalApi#post_users_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_users_senders(body, opts = {}) ⇒ Array<InlineResponse20040>

/users/senders Return the senders that have tried to use this account, both verified and unverified

Parameters:

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

    the optional parameters

Returns:



4401
4402
4403
4404
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4401

def post_users_senders(body, opts = {})
  data, _status_code, _headers = post_users_senders_with_http_info(body, opts)
  data
end

#post_users_senders_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20040>, Fixnum, Hash)>

/users/senders Return the senders that have tried to use this account, both verified and unverified

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20040> data, response status code and response headers



4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4411

def post_users_senders_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_users_senders ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_users_senders"
  end
  # resource path
  local_var_path = '/users/senders'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20040>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_users_senders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_webhooks_add(body, opts = {}) ⇒ InlineResponse20072

/webhooks/add Add a new webhook

Parameters:

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

    the optional parameters

Returns:



4455
4456
4457
4458
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4455

def post_webhooks_add(body, opts = {})
  data, _status_code, _headers = post_webhooks_add_with_http_info(body, opts)
  data
end

#post_webhooks_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20072, Fixnum, Hash)>

/webhooks/add Add a new webhook

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20072 data, response status code and response headers



4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4465

def post_webhooks_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_webhooks_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_webhooks_add"
  end
  # resource path
  local_var_path = '/webhooks/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20072')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_webhooks_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_webhooks_delete(body, opts = {}) ⇒ InlineResponse20075

/webhooks/delete Delete an existing webhook

Parameters:

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

    the optional parameters

Returns:



4509
4510
4511
4512
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4509

def post_webhooks_delete(body, opts = {})
  data, _status_code, _headers = post_webhooks_delete_with_http_info(body, opts)
  data
end

#post_webhooks_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20075, Fixnum, Hash)>

/webhooks/delete Delete an existing webhook

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20075 data, response status code and response headers



4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4519

def post_webhooks_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_webhooks_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_webhooks_delete"
  end
  # resource path
  local_var_path = '/webhooks/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20075')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_webhooks_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_webhooks_info(body, opts = {}) ⇒ InlineResponse20073

/webhooks/info Given the ID of an existing webhook, return the data about it

Parameters:

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

    the optional parameters

Returns:



4563
4564
4565
4566
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4563

def post_webhooks_info(body, opts = {})
  data, _status_code, _headers = post_webhooks_info_with_http_info(body, opts)
  data
end

#post_webhooks_info_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20073, Fixnum, Hash)>

/webhooks/info Given the ID of an existing webhook, return the data about it

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20073 data, response status code and response headers



4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4573

def post_webhooks_info_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_webhooks_info ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_webhooks_info"
  end
  # resource path
  local_var_path = '/webhooks/info'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20073')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_webhooks_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_webhooks_list(body, opts = {}) ⇒ Array<InlineResponse20071>

/webhooks/list Get the list of all webhooks defined on the account

Parameters:

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

    the optional parameters

Returns:



4617
4618
4619
4620
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4617

def post_webhooks_list(body, opts = {})
  data, _status_code, _headers = post_webhooks_list_with_http_info(body, opts)
  data
end

#post_webhooks_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20071>, Fixnum, Hash)>

/webhooks/list Get the list of all webhooks defined on the account

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20071> data, response status code and response headers



4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4627

def post_webhooks_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_webhooks_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_webhooks_list"
  end
  # resource path
  local_var_path = '/webhooks/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20071>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_webhooks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_webhooks_update(body, opts = {}) ⇒ InlineResponse20074

/webhooks/update Update an existing webhook

Parameters:

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

    the optional parameters

Returns:



4671
4672
4673
4674
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4671

def post_webhooks_update(body, opts = {})
  data, _status_code, _headers = post_webhooks_update_with_http_info(body, opts)
  data
end

#post_webhooks_update_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20074, Fixnum, Hash)>

/webhooks/update Update an existing webhook

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20074 data, response status code and response headers



4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4681

def post_webhooks_update_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_webhooks_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_webhooks_update"
  end
  # resource path
  local_var_path = '/webhooks/update'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20074')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_webhooks_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_whitelists_add(body, opts = {}) ⇒ InlineResponse20076

/whitelists/add Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.

Parameters:

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

    the optional parameters

Returns:



4725
4726
4727
4728
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4725

def post_whitelists_add(body, opts = {})
  data, _status_code, _headers = post_whitelists_add_with_http_info(body, opts)
  data
end

#post_whitelists_add_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20076, Fixnum, Hash)>

/whitelists/add Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20076 data, response status code and response headers



4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4735

def post_whitelists_add_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_whitelists_add ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_whitelists_add"
  end
  # resource path
  local_var_path = '/whitelists/add'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20076')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_whitelists_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_whitelists_delete(body, opts = {}) ⇒ InlineResponse20078

/whitelists/delete Removes an email address from the whitelist.

Parameters:

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

    the optional parameters

Returns:



4779
4780
4781
4782
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4779

def post_whitelists_delete(body, opts = {})
  data, _status_code, _headers = post_whitelists_delete_with_http_info(body, opts)
  data
end

#post_whitelists_delete_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse20078, Fixnum, Hash)>

/whitelists/delete Removes an email address from the whitelist.

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse20078 data, response status code and response headers



4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4789

def post_whitelists_delete_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_whitelists_delete ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_whitelists_delete"
  end
  # resource path
  local_var_path = '/whitelists/delete'

  # 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(body)
  auth_names = []
  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 => 'InlineResponse20078')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_whitelists_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_whitelists_list(body, opts = {}) ⇒ Array<InlineResponse20077>

/whitelists/list Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.

Parameters:

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

    the optional parameters

Returns:



4833
4834
4835
4836
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4833

def post_whitelists_list(body, opts = {})
  data, _status_code, _headers = post_whitelists_list_with_http_info(body, opts)
  data
end

#post_whitelists_list_with_http_info(body, opts = {}) ⇒ Array<(Array<InlineResponse20077>, Fixnum, Hash)>

/whitelists/list Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.

Parameters:

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

    the optional parameters

Returns:

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

    Array<InlineResponse20077> data, response status code and response headers



4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
 
# File 'lib/mailchimp_transactional/api/transactional_api.rb', line 4843

def post_whitelists_list_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionalApi.post_whitelists_list ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TransactionalApi.post_whitelists_list"
  end
  # resource path
  local_var_path = '/whitelists/list'

  # 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(body)
  auth_names = []
  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 => 'Array<InlineResponse20077>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionalApi#post_whitelists_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end