class Mimepost::DomainsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

domains_get(opts = {}) click to toggle source

Get a list of all the domains @param [Hash] opts the optional parameters @return [ApiResponseDomainsList]

# File lib/mimepost/api/domains_api.rb, line 25
def domains_get(opts = {})
  data, _status_code, _headers = domains_get_with_http_info(opts)
  data
end
domains_get_with_http_info(opts = {}) click to toggle source

Get a list of all the domains @param [Hash] opts the optional parameters @return [Array<(ApiResponseDomainsList, Fixnum, Hash)>] ApiResponseDomainsList data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 33
def domains_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_get ...'
  end
  # resource path
  local_var_path = '/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 = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseDomainsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_approve_post(id, opts = {}) click to toggle source

Submit request for the approval of a verified domain @param id @param [Hash] opts the optional parameters @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 72
def domains_id_approve_post(id, opts = {})
  data, _status_code, _headers = domains_id_approve_post_with_http_info(id, opts)
  data
end
domains_id_approve_post_with_http_info(id, opts = {}) click to toggle source

Submit request for the approval of a verified domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 81
def domains_id_approve_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_approve_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_approve_post"
  end
  # resource path
  local_var_path = '/domains/{id}/approve/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_approve_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_delete(id, opts = {}) click to toggle source

Remove a single domain @param id @param [Hash] opts the optional parameters @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 124
def domains_id_delete(id, opts = {})
  data, _status_code, _headers = domains_id_delete_with_http_info(id, opts)
  data
end
domains_id_delete_with_http_info(id, opts = {}) click to toggle source

Remove a single domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 133
def domains_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_delete"
  end
  # resource path
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_get(id, opts = {}) click to toggle source

Get the details of a single domain @param id @param [Hash] opts the optional parameters @return [ApiResponseDomainsList]

# File lib/mimepost/api/domains_api.rb, line 176
def domains_id_get(id, opts = {})
  data, _status_code, _headers = domains_id_get_with_http_info(id, opts)
  data
end
domains_id_get_with_http_info(id, opts = {}) click to toggle source

Get the details of a single domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponseDomainsList, Fixnum, Hash)>] ApiResponseDomainsList data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 185
def domains_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_get"
  end
  # resource path
  local_var_path = '/domains/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseDomainsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_verify_dkim_post(id, opts = {}) click to toggle source

Request for the verification of DKIM record for a single domain @param id @param [Hash] opts the optional parameters @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 228
def domains_id_verify_dkim_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_dkim_post_with_http_info(id, opts)
  data
end
domains_id_verify_dkim_post_with_http_info(id, opts = {}) click to toggle source

Request for the verification of DKIM record for a single domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 237
def domains_id_verify_dkim_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_dkim_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_dkim_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_dkim/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_dkim_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_verify_spf_post(id, opts = {}) click to toggle source

Request for the verification of SPF record for a single domain @param id @param [Hash] opts the optional parameters @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 280
def domains_id_verify_spf_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_spf_post_with_http_info(id, opts)
  data
end
domains_id_verify_spf_post_with_http_info(id, opts = {}) click to toggle source

Request for the verification of SPF record for a single domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 289
def domains_id_verify_spf_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_spf_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_spf_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_spf/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_spf_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_id_verify_tracking_post(id, opts = {}) click to toggle source

Request for the verification of tracking record for a single domain @param id @param [Hash] opts the optional parameters @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 332
def domains_id_verify_tracking_post(id, opts = {})
  data, _status_code, _headers = domains_id_verify_tracking_post_with_http_info(id, opts)
  data
end
domains_id_verify_tracking_post_with_http_info(id, opts = {}) click to toggle source

Request for the verification of tracking record for a single domain @param id @param [Hash] opts the optional parameters @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 341
def domains_id_verify_tracking_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_id_verify_tracking_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DomainsApi.domains_id_verify_tracking_post"
  end
  # resource path
  local_var_path = '/domains/{id}/verify_tracking/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_id_verify_tracking_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
domains_post(opts = {}) click to toggle source

Add single domain @param [Hash] opts the optional parameters @option opts [Domain] :domain The name of the domain name @return [ApiResponse]

# File lib/mimepost/api/domains_api.rb, line 384
def domains_post(opts = {})
  data, _status_code, _headers = domains_post_with_http_info(opts)
  data
end
domains_post_with_http_info(opts = {}) click to toggle source

Add single domain @param [Hash] opts the optional parameters @option opts [Domain] :domain The name of the domain name @return [Array<(ApiResponse, Fixnum, Hash)>] ApiResponse data, response status code and response headers

# File lib/mimepost/api/domains_api.rb, line 393
def domains_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.domains_post ...'
  end
  # resource path
  local_var_path = '/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(opts[:'domain'])
  auth_names = ['api_key']
  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 => 'ApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainsApi#domains_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end