Class: Bandwidth::PhoneNumberLookupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/phone_number_lookup_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhoneNumberLookupApi

Returns a new instance of PhoneNumberLookupApi.



19
20
21
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_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/bandwidth-sdk/api/phone_number_lookup_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_async_bulk_lookup(account_id, async_lookup_request, opts = {}) ⇒ CreateAsyncBulkLookupResponse

Create Asynchronous Bulk Number Lookup Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.

Parameters:

  • account_id (String)
  • async_lookup_request (AsyncLookupRequest) —

    Asynchronous bulk phone number lookup request.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 28

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

#create_async_bulk_lookup_with_http_info(account_id, async_lookup_request, opts = {}) ⇒ Array<(CreateAsyncBulkLookupResponse, Integer, Hash)>

Create Asynchronous Bulk Number Lookup Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.

Parameters:

  • account_id (String)
  • async_lookup_request (AsyncLookupRequest) —

    Asynchronous bulk phone number lookup request.

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

    the optional parameters

Returns:



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 39

def create_async_bulk_lookup_with_http_info(, async_lookup_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_async_bulk_lookup ...'
  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 PhoneNumberLookupApi.create_async_bulk_lookup"
  end
  # verify the required parameter 'async_lookup_request' is set
  if @api_client.config.client_side_validation && async_lookup_request.nil?
    fail ArgumentError, "Missing the required parameter 'async_lookup_request' when calling PhoneNumberLookupApi.create_async_bulk_lookup"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/phoneNumberLookup/bulk'.sub('{' + 'accountId' + '}', CGI.escape(.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']
  # 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(async_lookup_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']

  new_options = opts.merge(
    :operation => :"PhoneNumberLookupApi.create_async_bulk_lookup",
    :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: PhoneNumberLookupApi#create_async_bulk_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sync_lookup(account_id, sync_lookup_request, opts = {}) ⇒ CreateSyncLookupResponse

Create Synchronous Number Lookup Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.

Parameters:

  • account_id (String)
  • sync_lookup_request (SyncLookupRequest) —

    Synchronous phone number lookup request.

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 102

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

#create_sync_lookup_with_http_info(account_id, sync_lookup_request, opts = {}) ⇒ Array<(CreateSyncLookupResponse, Integer, Hash)>

Create Synchronous Number Lookup Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.

Parameters:

  • account_id (String)
  • sync_lookup_request (SyncLookupRequest) —

    Synchronous phone number lookup request.

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

    the optional parameters

Returns:

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

    CreateSyncLookupResponse data, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 113

def create_sync_lookup_with_http_info(, sync_lookup_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_sync_lookup ...'
  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 PhoneNumberLookupApi.create_sync_lookup"
  end
  # verify the required parameter 'sync_lookup_request' is set
  if @api_client.config.client_side_validation && sync_lookup_request.nil?
    fail ArgumentError, "Missing the required parameter 'sync_lookup_request' when calling PhoneNumberLookupApi.create_sync_lookup"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/phoneNumberLookup'.sub('{' + 'accountId' + '}', CGI.escape(.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']
  # 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(sync_lookup_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']

  new_options = opts.merge(
    :operation => :"PhoneNumberLookupApi.create_sync_lookup",
    :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: PhoneNumberLookupApi#create_sync_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_async_bulk_lookup(account_id, request_id, opts = {}) ⇒ GetAsyncBulkLookupResponse

Get Asynchronous Bulk Number Lookup Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.

Parameters:

  • account_id (String)
  • request_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 176

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

#get_async_bulk_lookup_with_http_info(account_id, request_id, opts = {}) ⇒ Array<(GetAsyncBulkLookupResponse, Integer, Hash)>

Get Asynchronous Bulk Number Lookup Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.

Parameters:

  • account_id (String)
  • request_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    GetAsyncBulkLookupResponse data, response status code and response headers



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
231
232
233
234
235
236
237
 
# File 'lib/bandwidth-sdk/api/phone_number_lookup_api.rb', line 187

def get_async_bulk_lookup_with_http_info(, request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.get_async_bulk_lookup ...'
  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 PhoneNumberLookupApi.get_async_bulk_lookup"
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling PhoneNumberLookupApi.get_async_bulk_lookup"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/phoneNumberLookup/bulk/{requestId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'requestId' + '}', CGI.escape(request_id.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] || 'GetAsyncBulkLookupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']

  new_options = opts.merge(
    :operation => :"PhoneNumberLookupApi.get_async_bulk_lookup",
    :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: PhoneNumberLookupApi#get_async_bulk_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end