Class: PhoneComClient::CallerIdsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/api/caller_ids_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CallerIdsApi

Returns a new instance of CallerIdsApi.



19
20
21
 
# File 'lib/phone_com_client/api/caller_ids_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/phone_com_client/api/caller_ids_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_caller_ids(account_id, extension_id, opts = {}) ⇒ ListCallerIds

Show the Caller ID options a given extension can use. Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

  • :filters_number (Array<String>) —

    Number filter

  • :filters_name (Array<String>) —

    Name filter

  • :sort_number (String) —

    Number sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



35
36
37
38
 
# File 'lib/phone_com_client/api/caller_ids_api.rb', line 35

def get_caller_ids(, extension_id, opts = {})
  data, _status_code, _headers = get_caller_ids_with_http_info(, extension_id, opts)
  data
end

#get_caller_ids_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ListCallerIds, Fixnum, Hash)>

Show the Caller ID options a given extension can use. Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

  • :filters_number (Array<String>) —

    Number filter

  • :filters_name (Array<String>) —

    Name filter

  • :sort_number (String) —

    Number sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListCallerIds data, response status code and response headers



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/phone_com_client/api/caller_ids_api.rb', line 53

def get_caller_ids_with_http_info(, extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallerIdsApi.get_caller_ids ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CallerIdsApi.get_caller_ids"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling CallerIdsApi.get_caller_ids"
  end
  if @api_client.config.client_side_validation && !opts[:'sort_number'].nil? && opts[:'sort_number'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_number\"]' when calling CallerIdsApi.get_caller_ids, must conform to the pattern /asc|desc/."
  end

  if @api_client.config.client_side_validation && !opts[:'sort_name'].nil? && opts[:'sort_name'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_name\"]' when calling CallerIdsApi.get_caller_ids, must conform to the pattern /asc|desc/."
  end

  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/caller-ids'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'filters[number]'] = @api_client.build_collection_param(opts[:'filters_number'], :multi) if !opts[:'filters_number'].nil?
  query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil?
  query_params[:'sort[number]'] = opts[:'sort_number'] if !opts[:'sort_number'].nil?
  query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  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 => 'ListCallerIds')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallerIdsApi#get_caller_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end