class DialMyCalls::DoNotContactsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_do_not_contacts(opts = {}) click to toggle source

List DoNotContacts Retrieve a list of donotcontacts.
Returns a list of donotcontact objects.
“` curl -i -H "Content-Type: application/json" -X GET $API_KEY@api.dialmycalls.com/2.0/donotcontacts “` @param [Hash] opts the optional parameters @option opts [String] :range Range (ie "records=201-300") of donotcontacts requested @return [Object]

# File lib/dialmycalls_client/api/do_not_contacts_api.rb, line 39
def get_do_not_contacts(opts = {})
  data, _status_code, _headers = get_do_not_contacts_with_http_info(opts)
  return data
end
get_do_not_contacts_with_http_info(opts = {}) click to toggle source

List DoNotContacts Retrieve a list of donotcontacts. &lt;br&gt;&lt;br&gt; Returns a list of donotcontact objects. &lt;br&gt;&lt;br&gt; &#x60;&#x60;&#x60; curl -i -H "Content-Type: application/json&quot; -X GET $API_KEY@api.dialmycalls.com/2.0/donotcontacts &#x60;&#x60;&#x60; @param [Hash] opts the optional parameters @option opts [String] :range Range (ie "records&#x3D;201-300&quot;) of donotcontacts requested @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# File lib/dialmycalls_client/api/do_not_contacts_api.rb, line 49
def get_do_not_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DoNotContactsApi.get_do_not_contacts ..."
  end
  # resource path
  local_var_path = "/donotcontacts".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/xml']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/xml']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Range'] = opts[:'range'] if !opts[:'range'].nil?

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