class MailchimpTransactional::TransactionalApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/mailchimp_transactional/api/transactional_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

post_exports_activity(body, opts = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse2004]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2004, Fixnum, Hash)>] InlineResponse2004 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse200]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers

# 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 = {}) click to toggle source

/exports/list Returns a list of your exports. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse2001>]

# 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 = {}) click to toggle source

/exports/list Returns a list of your exports. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse2001>, Fixnum, Hash)>] Array<InlineResponse2001> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse2002]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse2003]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/add-domain Add a new template @param body @param [Hash] opts the optional parameters @return [InlineResponse2006]

# 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 = {}) click to toggle source

/inbound/add-domain Add a new template @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2006, Fixnum, Hash)>] InlineResponse2006 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/add-route Add a new mailbox route to an inbound domain @param body @param [Hash] opts the optional parameters @return [InlineResponse20010]

# 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 = {}) click to toggle source

/inbound/add-route Add a new mailbox route to an inbound domain @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20010, Fixnum, Hash)>] InlineResponse20010 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/check-domain Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call @param body @param [Hash] opts the optional parameters @return [InlineResponse2007]

# 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 = {}) click to toggle source

/inbound/check-domain Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2007, Fixnum, Hash)>] InlineResponse2007 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/delete-domain Delete an inbound domain from the account. All mail will stop routing for this domain immediately. @param body @param [Hash] opts the optional parameters @return [InlineResponse2008]

# 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 = {}) click to toggle source

/inbound/delete-domain Delete an inbound domain from the account. All mail will stop routing for this domain immediately. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse2008, Fixnum, Hash)>] InlineResponse2008 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/delete-route Delete an existing inbound mailbox route @param body @param [Hash] opts the optional parameters @return [InlineResponse20012]

# 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 = {}) click to toggle source

/inbound/delete-route Delete an existing inbound mailbox route @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20012, Fixnum, Hash)>] InlineResponse20012 data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/domains Add an inbound domain to your account @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse2005>]

# 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 = {}) click to toggle source

/inbound/domains Add an inbound domain to your account @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse2005>, Fixnum, Hash)>] Array<InlineResponse2005> data, response status code and response headers

# 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 = {}) click to toggle source

/inbound/routes List the mailbox routes defined for an inbound domain @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse2009>]

# 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 = {}) click to toggle source

/inbound/routes List the mailbox routes defined for an inbound domain @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse2009>, Fixnum, Hash)>] Array<InlineResponse2009> data, response status code and response headers

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20013>]

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20013>, Fixnum, Hash)>] Array<InlineResponse20013> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20011]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20011, Fixnum, Hash)>] InlineResponse20011 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/cancel-warmup Cancels the warmup process for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [InlineResponse20017]

# 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 = {}) click to toggle source

/ips/cancel-warmup Cancels the warmup process for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20017, Fixnum, Hash)>] InlineResponse20017 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/check-custom-dns Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [InlineResponse20023]

# 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 = {}) click to toggle source

/ips/check-custom-dns Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20023, Fixnum, Hash)>] InlineResponse20023 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/create-pool Creates a pool and returns it. If a pool already exists with this name, no action will be performed. @param body @param [Hash] opts the optional parameters @return [InlineResponse20021]

# 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 = {}) click to toggle source

/ips/create-pool Creates a pool and returns it. If a pool already exists with this name, no action will be performed. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20021, Fixnum, Hash)>] InlineResponse20021 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/delete Deletes a dedicated IP. This is permanent and cannot be undone. @param body @param [Hash] opts the optional parameters @return [InlineResponse20019]

# 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 = {}) click to toggle source

/ips/delete-pool Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. @param body @param [Hash] opts the optional parameters @return [InlineResponse20022]

# 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 = {}) click to toggle source

/ips/delete-pool Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20022, Fixnum, Hash)>] InlineResponse20022 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/delete Deletes a dedicated IP. This is permanent and cannot be undone. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20019, Fixnum, Hash)>] InlineResponse20019 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/info Retrieves information about a single dedicated ip. @param body @param [Hash] opts the optional parameters @return [InlineResponse20015]

# 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 = {}) click to toggle source

/ips/info Retrieves information about a single dedicated ip. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20015, Fixnum, Hash)>] InlineResponse20015 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/list Lists your dedicated IPs. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20014>]

# 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 = {}) click to toggle source

/ips/list-pools Lists your dedicated IP pools. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20020>]

# 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 = {}) click to toggle source

/ips/list-pools Lists your dedicated IP pools. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20020>, Fixnum, Hash)>] Array<InlineResponse20020> data, response status code and response headers

# 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 = {}) click to toggle source

/ips/list Lists your dedicated IPs. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20014>, Fixnum, Hash)>] Array<InlineResponse20014> data, response status code and response headers

# 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 = {}) click to toggle source

/ips/pool-info Describes a single dedicated IP pool. @param body @param [Hash] opts the optional parameters @return [InlineResponse20021]

# 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 = {}) click to toggle source

/ips/pool-info Describes a single dedicated IP pool. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20021, Fixnum, Hash)>] InlineResponse20021 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20016]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20016, Fixnum, Hash)>] InlineResponse20016 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/set-custom-dns Configures the custom DNS name for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [InlineResponse20024]

# 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 = {}) click to toggle source

/ips/set-custom-dns Configures the custom DNS name for a dedicated IP. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20024, Fixnum, Hash)>] InlineResponse20024 data, response status code and response headers

# 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 = {}) click to toggle source

/ips/set-pool Moves a dedicated IP to a different pool. @param body @param [Hash] opts the optional parameters @return [InlineResponse20018]

# 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 = {}) click to toggle source

/ips/set-pool Moves a dedicated IP to a different pool. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20018, Fixnum, Hash)>] InlineResponse20018 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20017]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20017, Fixnum, Hash)>] InlineResponse20017 data, response status code and response headers

# 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 = {}) click to toggle source

/messages/cancel-scheduled Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20032>]

# 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 = {}) click to toggle source

/messages/cancel-scheduled Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20032>, Fixnum, Hash)>] Array<InlineResponse20032> data, response status code and response headers

# 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 = {}) click to toggle source

/messages/content Get the full content of a recently sent message @param body @param [Hash] opts the optional parameters @return [InlineResponse20030]

# 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 = {}) click to toggle source

/messages/content Get the full content of a recently sent message @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20030, Fixnum, Hash)>] InlineResponse20030 data, response status code and response headers

# 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 = {}) click to toggle source

/messages/info Get the information for a single recently sent message @param body @param [Hash] opts the optional parameters @return [InlineResponse20029]

# 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 = {}) click to toggle source

/messages/info Get the information for a single recently sent message @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20029, Fixnum, Hash)>] InlineResponse20029 data, response status code and response headers

# 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 = {}) click to toggle source

/messages/list-scheduled Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20032>]

# 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 = {}) click to toggle source

/messages/list-scheduled Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20032>, Fixnum, Hash)>] Array<InlineResponse20032> data, response status code and response headers

# 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 = {}) click to toggle source

/messages/parse Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces @param body @param [Hash] opts the optional parameters @return [InlineResponse20031]

# 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 = {}) click to toggle source

/messages/parse Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20031, Fixnum, Hash)>] InlineResponse20031 data, response status code and response headers

# 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 = {}) click to toggle source

/messages/reschedule Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20032>]

# 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 = {}) click to toggle source

/messages/reschedule Queries your scheduled emails. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20032>, Fixnum, Hash)>] Array<InlineResponse20032> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20027>]

# 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 = {}) click to toggle source

/messages/search-time-series Search the content of recently sent messages and return the aggregated hourly stats for matching messages @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20028>]

# 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 = {}) click to toggle source

/messages/search-time-series Search the content of recently sent messages and return the aggregated hourly stats for matching messages @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20028>, Fixnum, Hash)>] Array<InlineResponse20028> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20027>, Fixnum, Hash)>] Array<InlineResponse20027> data, response status code and response headers

# 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 = {}) click to toggle source

/messages/send Send a new transactional message through Mandrill @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20025>]

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [Object]

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# 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 = {}) click to toggle source

/messages/send-template Send a new transactional message through Mandrill @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20026>]

# 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 = {}) click to toggle source

/messages/send-template Send a new transactional message through Mandrill @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20026>, Fixnum, Hash)>] Array<InlineResponse20026> data, response status code and response headers

# 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 = {}) click to toggle source

/messages/send Send a new transactional message through Mandrill @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20025>, Fixnum, Hash)>] Array<InlineResponse20025> data, response status code and response headers

# 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 = {}) click to toggle source

/metadata/add Add a new custom metadata field to be indexed for the account. @param body @param [Hash] opts the optional parameters @return [InlineResponse20034]

# 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 = {}) click to toggle source

/metadata/add Add a new custom metadata field to be indexed for the account. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20034, Fixnum, Hash)>] InlineResponse20034 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20036]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20036, Fixnum, Hash)>] InlineResponse20036 data, response status code and response headers

# 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 = {}) click to toggle source

/metadata/list Get the list of custom metadata fields indexed for the account. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20033>]

# 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 = {}) click to toggle source

/metadata/list Get the list of custom metadata fields indexed for the account. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20033>, Fixnum, Hash)>] Array<InlineResponse20033> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20035]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20035, Fixnum, Hash)>] InlineResponse20035 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20037]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20037, Fixnum, Hash)>] InlineResponse20037 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20039]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20039, Fixnum, Hash)>] InlineResponse20039 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20038>]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20038>, Fixnum, Hash)>] Array<InlineResponse20038> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20042]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20042, Fixnum, Hash)>] InlineResponse20042 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20043]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20043, Fixnum, Hash)>] InlineResponse20043 data, response status code and response headers

# 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 = {}) click to toggle source

/senders/domains Returns the sender domains that have been added to this account @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20041>]

# 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 = {}) click to toggle source

/senders/domains Returns the sender domains that have been added to this account @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20041>, Fixnum, Hash)>] Array<InlineResponse20041> data, response status code and response headers

# 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 = {}) click to toggle source

/senders/info Return more detailed information about a single sender, including aggregates of recent stats @param body @param [Hash] opts the optional parameters @return [InlineResponse20045]

# 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 = {}) click to toggle source

/senders/info Return more detailed information about a single sender, including aggregates of recent stats @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20045, Fixnum, Hash)>] InlineResponse20045 data, response status code and response headers

# 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 = {}) click to toggle source

/senders/list Return the senders that have tried to use this account @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20040>]

# 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 = {}) click to toggle source

/senders/list Return the senders that have tried to use this account @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20040>, Fixnum, Hash)>] Array<InlineResponse20040> data, response status code and response headers

# 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 = {}) click to toggle source

/senders/time-series Return the recent history (hourly stats for the last 30 days) for a sender @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20046>]

# 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 = {}) click to toggle source

/senders/time-series Return the recent history (hourly stats for the last 30 days) for a sender @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20046>, Fixnum, Hash)>] Array<InlineResponse20046> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20044]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20044, Fixnum, Hash)>] InlineResponse20044 data, response status code and response headers

# 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 = {}) click to toggle source

/subaccounts/add Add a new subaccount @param body @param [Hash] opts the optional parameters @return [InlineResponse20048]

# 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 = {}) click to toggle source

/subaccounts/add Add a new subaccount @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20048, Fixnum, Hash)>] InlineResponse20048 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20051]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20051, Fixnum, Hash)>] InlineResponse20051 data, response status code and response headers

# 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 = {}) click to toggle source

/subaccounts/info Given the ID of an existing subaccount, return the data about it @param body @param [Hash] opts the optional parameters @return [InlineResponse20049]

# 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 = {}) click to toggle source

/subaccounts/info Given the ID of an existing subaccount, return the data about it @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20049, Fixnum, Hash)>] InlineResponse20049 data, response status code and response headers

# 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 = {}) click to toggle source

/subaccounts/list Get the list of subaccounts defined for the account, optionally filtered by a prefix @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20047>]

# 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 = {}) click to toggle source

/subaccounts/list Get the list of subaccounts defined for the account, optionally filtered by a prefix @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20047>, Fixnum, Hash)>] Array<InlineResponse20047> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20052]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20052, Fixnum, Hash)>] InlineResponse20052 data, response status code and response headers

# 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 = {}) click to toggle source

/subaccounts/resume Resume a paused subaccount's sending @param body @param [Hash] opts the optional parameters @return [InlineResponse20053]

# 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 = {}) click to toggle source

/subaccounts/resume Resume a paused subaccount&#39;s sending @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20053, Fixnum, Hash)>] InlineResponse20053 data, response status code and response headers

# 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 = {}) click to toggle source

/subaccounts/update Update an existing subaccount @param body @param [Hash] opts the optional parameters @return [InlineResponse20050]

# 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 = {}) click to toggle source

/subaccounts/update Update an existing subaccount @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20050, Fixnum, Hash)>] InlineResponse20050 data, response status code and response headers

# 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 = {}) click to toggle source

/tags/all-time-series Return the recent history (hourly stats for the last 30 days) for all tags @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20028>]

# 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 = {}) click to toggle source

/tags/all-time-series Return the recent history (hourly stats for the last 30 days) for all tags @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20028>, Fixnum, Hash)>] Array<InlineResponse20028> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20055]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20055, Fixnum, Hash)>] InlineResponse20055 data, response status code and response headers

# 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 = {}) click to toggle source

/tags/info Return more detailed information about a single tag, including aggregates of recent stats @param body @param [Hash] opts the optional parameters @return [InlineResponse20056]

# 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 = {}) click to toggle source

/tags/info Return more detailed information about a single tag, including aggregates of recent stats @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20056, Fixnum, Hash)>] InlineResponse20056 data, response status code and response headers

# 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 = {}) click to toggle source

/tags/list Return all of the user-defined tag information @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20054>]

# 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 = {}) click to toggle source

/tags/list Return all of the user-defined tag information @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20054>, Fixnum, Hash)>] Array<InlineResponse20054> data, response status code and response headers

# 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 = {}) click to toggle source

/tags/time-series Return the recent history (hourly stats for the last 30 days) for a tag @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20028>]

# 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 = {}) click to toggle source

/tags/time-series Return the recent history (hourly stats for the last 30 days) for a tag @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20028>, Fixnum, Hash)>] Array<InlineResponse20028> data, response status code and response headers

# 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 = {}) click to toggle source

/templates/add Add a new template @param body @param [Hash] opts the optional parameters @return [InlineResponse20057]

# 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 = {}) click to toggle source

/templates/add Add a new template @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20057, Fixnum, Hash)>] InlineResponse20057 data, response status code and response headers

# 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 = {}) click to toggle source

/templates/delete Delete a template @param body @param [Hash] opts the optional parameters @return [InlineResponse20061]

# 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 = {}) click to toggle source

/templates/delete Delete a template @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20061, Fixnum, Hash)>] InlineResponse20061 data, response status code and response headers

# 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 = {}) click to toggle source

/templates/info Get the information for an existing template @param body @param [Hash] opts the optional parameters @return [InlineResponse20058]

# 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 = {}) click to toggle source

/templates/info Get the information for an existing template @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20058, Fixnum, Hash)>] InlineResponse20058 data, response status code and response headers

# 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 = {}) click to toggle source

/templates/list Return a list of all the templates available to this user @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20062>]

# 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 = {}) click to toggle source

/templates/list Return a list of all the templates available to this user @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20062>, Fixnum, Hash)>] Array<InlineResponse20062> data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20060]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20060, Fixnum, Hash)>] InlineResponse20060 data, response status code and response headers

# 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 = {}) click to toggle source

/templates/render Inject content and optionally merge fields into a template, returning the HTML that results @param body @param [Hash] opts the optional parameters @return [InlineResponse20063]

# 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 = {}) click to toggle source

/templates/render Inject content and optionally merge fields into a template, returning the HTML that results @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20063, Fixnum, Hash)>] InlineResponse20063 data, response status code and response headers

# 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 = {}) click to toggle source

/templates/time-series Return the recent history (hourly stats for the last 30 days) for a template @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20046>]

# 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 = {}) click to toggle source

/templates/time-series Return the recent history (hourly stats for the last 30 days) for a template @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20046>, Fixnum, Hash)>] Array<InlineResponse20046> data, response status code and response headers

# 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 = {}) click to toggle source

/templates/update Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. @param body @param [Hash] opts the optional parameters @return [InlineResponse20059]

# 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 = {}) click to toggle source

/templates/update Update the code for an existing template. If null is provided for any fields, the values will remain unchanged. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20059, Fixnum, Hash)>] InlineResponse20059 data, response status code and response headers

# 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 = {}) click to toggle source

/urls/add-tracking-domain Add a tracking domain to your account @param body @param [Hash] opts the optional parameters @return [InlineResponse20068]

# 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 = {}) click to toggle source

/urls/add-tracking-domain Add a tracking domain to your account @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20068, Fixnum, Hash)>] InlineResponse20068 data, response status code and response headers

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [InlineResponse20068]

# 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 = {}) click to toggle source

/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 @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20068, Fixnum, Hash)>] InlineResponse20068 data, response status code and response headers

# 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 = {}) click to toggle source

/urls/list Get the 100 most clicked URLs @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20064>]

# 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 = {}) click to toggle source

/urls/list Get the 100 most clicked URLs @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20064>, Fixnum, Hash)>] Array<InlineResponse20064> data, response status code and response headers

# 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 = {}) click to toggle source

/urls/search (deprecated) Return the 100 most clicked URLs that match the search query given @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20065>]

# 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 = {}) click to toggle source

/urls/search (deprecated) Return the 100 most clicked URLs that match the search query given @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20065>, Fixnum, Hash)>] Array<InlineResponse20065> data, response status code and response headers

# 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 = {}) click to toggle source

/urls/time-series Return the recent history (hourly stats for the last 30 days) for a url @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20066>]

# 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 = {}) click to toggle source

/urls/time-series Return the recent history (hourly stats for the last 30 days) for a url @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20066>, Fixnum, Hash)>] Array<InlineResponse20066> data, response status code and response headers

# 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 = {}) click to toggle source

/urls/tracking-domains Get the list of tracking domains set up for this account @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20067>]

# 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 = {}) click to toggle source

/urls/tracking-domains Get the list of tracking domains set up for this account @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20067>, Fixnum, Hash)>] Array<InlineResponse20067> data, response status code and response headers

# 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 = {}) click to toggle source

/users/info Return the information about the API-connected user @param body @param [Hash] opts the optional parameters @return [InlineResponse20069]

# 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 = {}) click to toggle source

/users/info Return the information about the API-connected user @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20069, Fixnum, Hash)>] InlineResponse20069 data, response status code and response headers

# 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 = {}) click to toggle source

/users/ping Validate an API key and respond to a ping @param body @param [Hash] opts the optional parameters @return [String]

# 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 = {}) click to toggle source

/users/ping2 Validate an API key and respond to a ping (anal JSON parser version) @param body @param [Hash] opts the optional parameters @return [InlineResponse20070]

# 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 = {}) click to toggle source

/users/ping2 Validate an API key and respond to a ping (anal JSON parser version) @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20070, Fixnum, Hash)>] InlineResponse20070 data, response status code and response headers

# 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 = {}) click to toggle source

/users/ping Validate an API key and respond to a ping @param body @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# 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 = {}) click to toggle source

/users/senders Return the senders that have tried to use this account, both verified and unverified @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20040>]

# 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 = {}) click to toggle source

/users/senders Return the senders that have tried to use this account, both verified and unverified @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20040>, Fixnum, Hash)>] Array<InlineResponse20040> data, response status code and response headers

# 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 = {}) click to toggle source

/webhooks/add Add a new webhook @param body @param [Hash] opts the optional parameters @return [InlineResponse20072]

# 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 = {}) click to toggle source

/webhooks/add Add a new webhook @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20072, Fixnum, Hash)>] InlineResponse20072 data, response status code and response headers

# 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 = {}) click to toggle source

/webhooks/delete Delete an existing webhook @param body @param [Hash] opts the optional parameters @return [InlineResponse20075]

# 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 = {}) click to toggle source

/webhooks/delete Delete an existing webhook @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20075, Fixnum, Hash)>] InlineResponse20075 data, response status code and response headers

# 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 = {}) click to toggle source

/webhooks/info Given the ID of an existing webhook, return the data about it @param body @param [Hash] opts the optional parameters @return [InlineResponse20073]

# 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 = {}) click to toggle source

/webhooks/info Given the ID of an existing webhook, return the data about it @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20073, Fixnum, Hash)>] InlineResponse20073 data, response status code and response headers

# 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 = {}) click to toggle source

/webhooks/list Get the list of all webhooks defined on the account @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20071>]

# 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 = {}) click to toggle source

/webhooks/list Get the list of all webhooks defined on the account @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20071>, Fixnum, Hash)>] Array<InlineResponse20071> data, response status code and response headers

# 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 = {}) click to toggle source

/webhooks/update Update an existing webhook @param body @param [Hash] opts the optional parameters @return [InlineResponse20074]

# 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 = {}) click to toggle source

/webhooks/update Update an existing webhook @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20074, Fixnum, Hash)>] InlineResponse20074 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [InlineResponse20076]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20076, Fixnum, Hash)>] InlineResponse20076 data, response status code and response headers

# 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 = {}) click to toggle source

/whitelists/delete Removes an email address from the whitelist. @param body @param [Hash] opts the optional parameters @return [InlineResponse20078]

# 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 = {}) click to toggle source

/whitelists/delete Removes an email address from the whitelist. @param body @param [Hash] opts the optional parameters @return [Array<(InlineResponse20078, Fixnum, Hash)>] InlineResponse20078 data, response status code and response headers

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<InlineResponse20077>]

# 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 = {}) click to toggle source

/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. @param body @param [Hash] opts the optional parameters @return [Array<(Array<InlineResponse20077>, Fixnum, Hash)>] Array<InlineResponse20077> data, response status code and response headers

# 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