Class: PhoneComClient::PhoneNumbersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhoneNumbersApi

Returns a new instance of PhoneNumbersApi.



19
20
21
 
# File 'lib/phone_com_client/api/phone_numbers_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/phone_numbers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_account_phone_number(account_id, opts = {}) ⇒ PhoneNumberFull

Add a phone number to an account. Add a phone number to an account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 28

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

#create_account_phone_number_with_http_info(account_id, opts = {}) ⇒ Array<(PhoneNumberFull, Fixnum, Hash)>

Add a phone number to an account. Add a phone number to an account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PhoneNumberFull data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.create_account_phone_number ...'
  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 PhoneNumbersApi.create_account_phone_number"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/phone-numbers'.sub('{' + 'account_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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apiKey']
  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 => 'PhoneNumberFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumbersApi#create_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_phone_number(account_id, number_id, opts = {}) ⇒ PhoneNumberFull

Show details of an individual phone number. Show details of an individual phone number. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • number_id —

    Number ID

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 84

def (, number_id, opts = {})
  data, _status_code, _headers = (, number_id, opts)
  data
end

#get_account_phone_number_with_http_info(account_id, number_id, opts = {}) ⇒ Array<(PhoneNumberFull, Fixnum, Hash)>

Show details of an individual phone number. Show details of an individual phone number. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • number_id —

    Number ID

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

    the optional parameters

Returns:

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

    PhoneNumberFull data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 95

def (, number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_account_phone_number ...'
  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 PhoneNumbersApi.get_account_phone_number"
  end
  # verify the required parameter 'number_id' is set
  if @api_client.config.client_side_validation && number_id.nil?
    fail ArgumentError, "Missing the required parameter 'number_id' when calling PhoneNumbersApi.get_account_phone_number"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/phone-numbers/{number_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'number_id' + '}', number_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 = ['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 => 'PhoneNumberFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumbersApi#get_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_phone_numbers(account_id, opts = {}) ⇒ ListPhoneNumbers

Get a list of phone numbers registered to an account. Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_name (Array<String>) —

    Name filter

  • :filters_phone_number (Array<String>) —

    Phone number filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :sort_phone_number (String) —

    Phone number sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



152
153
154
155
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 152

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

#list_account_phone_numbers_with_http_info(account_id, opts = {}) ⇒ Array<(ListPhoneNumbers, Fixnum, Hash)>

Get a list of phone numbers registered to an account. Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_name (Array<String>) —

    Name filter

  • :filters_phone_number (Array<String>) —

    Phone number filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :sort_phone_number (String) —

    Phone number sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListPhoneNumbers data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 171

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.list_account_phone_numbers ...'
  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 PhoneNumbersApi.list_account_phone_numbers"
  end
  if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling PhoneNumbersApi.list_account_phone_numbers, 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 PhoneNumbersApi.list_account_phone_numbers, must conform to the pattern /asc|desc/."
  end

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

  # resource path
  local_var_path = '/accounts/{account_id}/phone-numbers'.sub('{' + 'account_id' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil?
  query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil?
  query_params[:'filters[phone_number]'] = @api_client.build_collection_param(opts[:'filters_phone_number'], :multi) if !opts[:'filters_phone_number'].nil?
  query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil?
  query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].nil?
  query_params[:'sort[phone_number]'] = opts[:'sort_phone_number'] if !opts[:'sort_phone_number'].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 => 'ListPhoneNumbers')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumbersApi#list_account_phone_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_account_phone_number(account_id, number_id, opts = {}) ⇒ PhoneNumberFull

Update the settings for an existing phone number on your account. Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • number_id —

    Number ID

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

    the optional parameters

Options Hash (opts):

Returns:



238
239
240
241
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 238

def (, number_id, opts = {})
  data, _status_code, _headers = (, number_id, opts)
  data
end

#replace_account_phone_number_with_http_info(account_id, number_id, opts = {}) ⇒ Array<(PhoneNumberFull, Fixnum, Hash)>

Update the settings for an existing phone number on your account. Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • number_id —

    Number ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PhoneNumberFull data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/phone_com_client/api/phone_numbers_api.rb', line 250

def (, number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.replace_account_phone_number ...'
  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 PhoneNumbersApi.replace_account_phone_number"
  end
  # verify the required parameter 'number_id' is set
  if @api_client.config.client_side_validation && number_id.nil?
    fail ArgumentError, "Missing the required parameter 'number_id' when calling PhoneNumbersApi.replace_account_phone_number"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/phone-numbers/{number_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'number_id' + '}', number_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 = @api_client.object_to_http_body(opts[:'data'])
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PhoneNumberFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneNumbersApi#replace_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end