Class: Pingram::NumbersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pingram/api/numbers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NumbersApi

Returns a new instance of NumbersApi.



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

def api_client
  @api_client
end

Instance Method Details

#numbers_list(opts = {}) ⇒ ListPhoneNumbersResponse

List active phone numbers registered for the account

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/pingram/api/numbers_api.rb', line 25

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

#numbers_list_released(opts = {}) ⇒ ListReleasedPhoneNumbersResponse

List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/pingram/api/numbers_api.rb', line 80

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

#numbers_list_released_with_http_info(opts = {}) ⇒ Array<(ListReleasedPhoneNumbersResponse, Integer, Hash)>

List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.

Parameters:

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

    the optional parameters

Returns:



88
89
90
91
92
93
94
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
 
# File 'lib/pingram/api/numbers_api.rb', line 88

def numbers_list_released_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_list_released ...'
  end
  # resource path
  local_var_path = '/numbers/released'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListReleasedPhoneNumbersResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"NumbersApi.numbers_list_released",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NumbersApi#numbers_list_released\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#numbers_list_with_http_info(opts = {}) ⇒ Array<(ListPhoneNumbersResponse, Integer, Hash)>

List active phone numbers registered for the account

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ListPhoneNumbersResponse, Integer, Hash)>) —

    ListPhoneNumbersResponse data, response status code and response headers



33
34
35
36
37
38
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
 
# File 'lib/pingram/api/numbers_api.rb', line 33

def numbers_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_list ...'
  end
  # resource path
  local_var_path = '/numbers/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListPhoneNumbersResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"NumbersApi.numbers_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NumbersApi#numbers_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#numbers_order_number(order_phone_number_request, opts = {}) ⇒ OrderPhoneNumberResponse

Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).

Parameters:

Returns:



136
137
138
139
 
# File 'lib/pingram/api/numbers_api.rb', line 136

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

#numbers_order_number_with_http_info(order_phone_number_request, opts = {}) ⇒ Array<(OrderPhoneNumberResponse, Integer, Hash)>

Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).

Parameters:

Returns:

  • (Array<(OrderPhoneNumberResponse, Integer, Hash)>) —

    OrderPhoneNumberResponse data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
 
# File 'lib/pingram/api/numbers_api.rb', line 145

def numbers_order_number_with_http_info(order_phone_number_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_order_number ...'
  end
  # verify the required parameter 'order_phone_number_request' is set
  if @api_client.config.client_side_validation && order_phone_number_request.nil?
    fail ArgumentError, "Missing the required parameter 'order_phone_number_request' when calling NumbersApi.numbers_order_number"
  end
  # resource path
  local_var_path = '/numbers/order'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(order_phone_number_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OrderPhoneNumberResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"NumbersApi.numbers_order_number",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NumbersApi#numbers_order_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#numbers_release_number(phone_number, opts = {}) ⇒ ReleasePhoneNumberResponse

Release a phone number from the account. No refund for the current billing month.

Parameters:

  • phone_number (String) —

    E.164 phone number to release

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

    the optional parameters

Returns:



202
203
204
205
 
# File 'lib/pingram/api/numbers_api.rb', line 202

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

#numbers_release_number_with_http_info(phone_number, opts = {}) ⇒ Array<(ReleasePhoneNumberResponse, Integer, Hash)>

Release a phone number from the account. No refund for the current billing month.

Parameters:

  • phone_number (String) —

    E.164 phone number to release

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

    the optional parameters

Returns:

  • (Array<(ReleasePhoneNumberResponse, Integer, Hash)>) —

    ReleasePhoneNumberResponse data, response status code and response headers



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/pingram/api/numbers_api.rb', line 211

def numbers_release_number_with_http_info(phone_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_release_number ...'
  end
  # verify the required parameter 'phone_number' is set
  if @api_client.config.client_side_validation && phone_number.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number' when calling NumbersApi.numbers_release_number"
  end
  # resource path
  local_var_path = '/numbers/{phoneNumber}'.sub('{' + 'phoneNumber' + '}', CGI.escape(phone_number.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ReleasePhoneNumberResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"NumbersApi.numbers_release_number",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NumbersApi#numbers_release_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#numbers_search_available(country_code, opts = {}) ⇒ SearchAvailablePhoneNumbersResponse

Search for available phone numbers

Parameters:

  • country_code (String) —

    ISO 3166-1 alpha-2 country code (e.g., US, CA)

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

    the optional parameters

Options Hash (opts):

  • :features (String) —

    Comma-separated

  • :area_code (String) —

    National destination / area code filter

  • :limit (Float) —

    Max results (default 10, max 50)

Returns:



266
267
268
269
 
# File 'lib/pingram/api/numbers_api.rb', line 266

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

#numbers_search_available_with_http_info(country_code, opts = {}) ⇒ Array<(SearchAvailablePhoneNumbersResponse, Integer, Hash)>

Search for available phone numbers

Parameters:

  • country_code (String) —

    ISO 3166-1 alpha-2 country code (e.g., US, CA)

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

    the optional parameters

Options Hash (opts):

  • :features (String) —

    Comma-separated

  • :area_code (String) —

    National destination / area code filter

  • :limit (Float) —

    Max results (default 10, max 50)

Returns:



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/pingram/api/numbers_api.rb', line 278

def numbers_search_available_with_http_info(country_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_search_available ...'
  end
  # verify the required parameter 'country_code' is set
  if @api_client.config.client_side_validation && country_code.nil?
    fail ArgumentError, "Missing the required parameter 'country_code' when calling NumbersApi.numbers_search_available"
  end
  # resource path
  local_var_path = '/numbers/available'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'countryCode'] = country_code
  query_params[:'features'] = opts[:'features'] if !opts[:'features'].nil?
  query_params[:'areaCode'] = opts[:'area_code'] if !opts[:'area_code'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SearchAvailablePhoneNumbersResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"NumbersApi.numbers_search_available",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NumbersApi#numbers_search_available\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end