bandwidth-sdk 16.2.2 → 17.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +8 -8
  3. data/README.md +20 -7
  4. data/bandwidth.yml +551 -277
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +197 -94
  7. data/coverage/index.html +2425 -1307
  8. data/docs/AsyncLookupRequest.md +18 -0
  9. data/docs/{LookupRequest.md → CompletedLookupStatusEnum.md} +2 -5
  10. data/docs/CreateAsyncBulkLookupResponse.md +22 -0
  11. data/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +4 -4
  12. data/docs/CreateSyncLookupResponse.md +22 -0
  13. data/docs/CreateSyncLookupResponseData.md +22 -0
  14. data/docs/DeactivationEventEnum.md +15 -0
  15. data/docs/GetAsyncBulkLookupResponse.md +22 -0
  16. data/docs/GetAsyncBulkLookupResponseData.md +22 -0
  17. data/docs/InProgressLookupStatusEnum.md +15 -0
  18. data/docs/LatestMessageDeliveryStatusEnum.md +15 -0
  19. data/docs/{LookupStatusEnum.md → LineTypeEnum.md} +2 -2
  20. data/docs/LinkSchema.md +22 -0
  21. data/docs/LookupErrorResponse.md +22 -0
  22. data/docs/LookupErrorSchema.md +24 -0
  23. data/docs/LookupErrorSchemaMeta.md +22 -0
  24. data/docs/LookupResult.md +22 -18
  25. data/docs/PhoneNumberLookupApi.md +111 -38
  26. data/docs/RbmActionBase.md +1 -1
  27. data/docs/RbmSuggestionResponse.md +1 -1
  28. data/docs/SyncLookupRequest.md +18 -0
  29. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +117 -47
  30. data/lib/bandwidth-sdk/configuration.rb +10 -4
  31. data/lib/bandwidth-sdk/models/async_lookup_request.rb +232 -0
  32. data/lib/bandwidth-sdk/models/completed_lookup_status_enum.rb +41 -0
  33. data/lib/bandwidth-sdk/models/create_async_bulk_lookup_response.rb +235 -0
  34. data/lib/bandwidth-sdk/models/{create_lookup_response.rb → create_async_bulk_lookup_response_data.rb} +5 -5
  35. data/lib/bandwidth-sdk/models/create_sync_lookup_response.rb +234 -0
  36. data/lib/bandwidth-sdk/models/{lookup_status.rb → create_sync_lookup_response_data.rb} +15 -27
  37. data/lib/bandwidth-sdk/models/deactivation_event_enum.rb +39 -0
  38. data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response.rb +234 -0
  39. data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response_data.rb +257 -0
  40. data/lib/bandwidth-sdk/models/{lookup_status_enum.rb → in_progress_lookup_status_enum.rb} +3 -3
  41. data/lib/bandwidth-sdk/models/latest_message_delivery_status_enum.rb +41 -0
  42. data/lib/bandwidth-sdk/models/line_type_enum.rb +42 -0
  43. data/lib/bandwidth-sdk/models/{lookup_request.rb → link_schema.rb} +31 -20
  44. data/lib/bandwidth-sdk/models/lookup_error_response.rb +235 -0
  45. data/lib/bandwidth-sdk/models/lookup_error_schema.rb +242 -0
  46. data/lib/bandwidth-sdk/models/{tn_lookup_request_error.rb → lookup_error_schema_meta.rb} +29 -8
  47. data/lib/bandwidth-sdk/models/lookup_result.rb +102 -63
  48. data/lib/bandwidth-sdk/models/sync_lookup_request.rb +232 -0
  49. data/lib/bandwidth-sdk/version.rb +1 -1
  50. data/lib/bandwidth-sdk.rb +17 -5
  51. data/spec/smoke/multi_channel_api_spec.rb +1 -1
  52. data/spec/smoke/phone_number_lookup_api_spec.rb +65 -70
  53. data/spec/unit/api/phone_number_lookup_api_spec.rb +71 -56
  54. metadata +36 -12
  55. data/docs/LookupStatus.md +0 -24
  56. data/docs/TnLookupRequestError.md +0 -18
@@ -0,0 +1,18 @@
1
+ # Bandwidth::AsyncLookupRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **phone_numbers** | **Array<String>** | Telephone numbers in E.164 format. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'bandwidth-sdk'
13
+
14
+ instance = Bandwidth::AsyncLookupRequest.new(
15
+ phone_numbers: null
16
+ )
17
+ ```
18
+
@@ -1,18 +1,15 @@
1
- # Bandwidth::LookupRequest
1
+ # Bandwidth::CompletedLookupStatusEnum
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **tns** | **Array<String>** | | |
8
7
 
9
8
  ## Example
10
9
 
11
10
  ```ruby
12
11
  require 'bandwidth-sdk'
13
12
 
14
- instance = Bandwidth::LookupRequest.new(
15
- tns: null
16
- )
13
+ instance = Bandwidth::CompletedLookupStatusEnum.new()
17
14
  ```
18
15
 
@@ -0,0 +1,22 @@
1
+ # Bandwidth::CreateAsyncBulkLookupResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<LinkSchema>**](LinkSchema.md) | Links for pagination (if applicable) | [optional] |
8
+ | **data** | [**CreateAsyncBulkLookupResponseData**](CreateAsyncBulkLookupResponseData.md) | | [optional] |
9
+ | **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::CreateAsyncBulkLookupResponse.new(
17
+ links: null,
18
+ data: null,
19
+ errors: null
20
+ )
21
+ ```
22
+
@@ -1,19 +1,19 @@
1
- # Bandwidth::CreateLookupResponse
1
+ # Bandwidth::CreateAsyncBulkLookupResponseData
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
8
- | **status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] |
8
+ | **status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```ruby
13
13
  require 'bandwidth-sdk'
14
14
 
15
- instance = Bandwidth::CreateLookupResponse.new(
16
- request_id: null,
15
+ instance = Bandwidth::CreateAsyncBulkLookupResponseData.new(
16
+ request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
17
17
  status: null
18
18
  )
19
19
  ```
@@ -0,0 +1,22 @@
1
+ # Bandwidth::CreateSyncLookupResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] |
8
+ | **data** | [**CreateSyncLookupResponseData**](CreateSyncLookupResponseData.md) | | [optional] |
9
+ | **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::CreateSyncLookupResponse.new(
17
+ links: [],
18
+ data: null,
19
+ errors: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::CreateSyncLookupResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
8
+ | **status** | [**CompletedLookupStatusEnum**](CompletedLookupStatusEnum.md) | | [optional] |
9
+ | **results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone numbers. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::CreateSyncLookupResponseData.new(
17
+ request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
18
+ status: null,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::DeactivationEventEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::DeactivationEventEnum.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::GetAsyncBulkLookupResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] |
8
+ | **data** | [**GetAsyncBulkLookupResponseData**](GetAsyncBulkLookupResponseData.md) | | [optional] |
9
+ | **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::GetAsyncBulkLookupResponse.new(
17
+ links: [],
18
+ data: null,
19
+ errors: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::GetAsyncBulkLookupResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
8
+ | **status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] |
9
+ | **results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::GetAsyncBulkLookupResponseData.new(
17
+ request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
18
+ status: null,
19
+ results: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::InProgressLookupStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::InProgressLookupStatusEnum.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # Bandwidth::LatestMessageDeliveryStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'bandwidth-sdk'
12
+
13
+ instance = Bandwidth::LatestMessageDeliveryStatusEnum.new()
14
+ ```
15
+
@@ -1,4 +1,4 @@
1
- # Bandwidth::LookupStatusEnum
1
+ # Bandwidth::LineTypeEnum
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'bandwidth-sdk'
12
12
 
13
- instance = Bandwidth::LookupStatusEnum.new()
13
+ instance = Bandwidth::LineTypeEnum.new()
14
14
  ```
15
15
 
@@ -0,0 +1,22 @@
1
+ # Bandwidth::LinkSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **href** | **String** | URI of the link. | [optional] |
8
+ | **rel** | **String** | Specifies the relationship between this link and the resource. | [optional] |
9
+ | **method** | **String** | HTTP method to be used. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::LinkSchema.new(
17
+ href: /relative/uri,
18
+ rel: aRelatedResource,
19
+ method: GET
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::LookupErrorResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **links** | [**Array<LinkSchema>**](LinkSchema.md) | | [optional] |
8
+ | **data** | **Object** | The phone number lookup response data | [optional] |
9
+ | **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::LookupErrorResponse.new(
17
+ links: [],
18
+ data: null,
19
+ errors: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # Bandwidth::LookupErrorSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | Validation error code | [optional] |
8
+ | **description** | **String** | Description of validation error | [optional] |
9
+ | **type** | **String** | Type of validation error | [optional] |
10
+ | **meta** | [**LookupErrorSchemaMeta**](LookupErrorSchemaMeta.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::LookupErrorSchema.new(
18
+ code: NO-MATCH,
19
+ description: Example error description,
20
+ type: NumberInventory,
21
+ meta: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # Bandwidth::LookupErrorSchemaMeta
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **phone_numbers** | **Array<String>** | | [optional] |
8
+ | **message** | **String** | Message describing the error | [optional] |
9
+ | **code** | **Integer** | Error code associated with the message | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'bandwidth-sdk'
15
+
16
+ instance = Bandwidth::LookupErrorSchemaMeta.new(
17
+ phone_numbers: ["+13992077164","+19196104424"],
18
+ message: Invalid TNs,
19
+ code: 1001
20
+ )
21
+ ```
22
+
data/docs/LookupResult.md CHANGED
@@ -4,15 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **response_code** | **Integer** | Our vendor's response code. | [optional] |
8
- | **message** | **String** | Message associated with the response code. | [optional] |
9
- | **e_164_format** | **String** | The telephone number in E.164 format. | [optional] |
10
- | **formatted** | **String** | The formatted version of the telephone number. | [optional] |
11
- | **country** | **String** | The country of the telephone number. | [optional] |
12
- | **line_type** | **String** | The line type of the telephone number. | [optional] |
13
- | **line_provider** | **String** | The messaging service provider of the telephone number. | [optional] |
14
- | **mobile_country_code** | **String** | The first half of the Home Network Identity (HNI). | [optional] |
15
- | **mobile_network_code** | **String** | The second half of the HNI. | [optional] |
7
+ | **phone_number** | **String** | The telephone number in E.164 format. | [optional] |
8
+ | **line_type** | [**LineTypeEnum**](LineTypeEnum.md) | | [optional] |
9
+ | **messaging_provider** | **String** | The messaging service provider of the telephone number. | [optional] |
10
+ | **voice_provider** | **String** | The voice service provider of the telephone number. | [optional] |
11
+ | **country_code_a3** | **String** | The country code of the telephone number in ISO 3166-1 alpha-3 format. | [optional] |
12
+ | **deactivation_reporter** | **String** | [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number. | [optional] |
13
+ | **deactivation_date** | **String** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] |
14
+ | **deactivation_event** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] |
15
+ | **latest_message_delivery_status** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] |
16
+ | **initial_message_delivery_status_date** | **Date** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
17
+ | **latest_message_delivery_status_date** | **Date** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
16
18
 
17
19
  ## Example
18
20
 
@@ -20,15 +22,17 @@
20
22
  require 'bandwidth-sdk'
21
23
 
22
24
  instance = Bandwidth::LookupResult.new(
23
- response_code: 0,
24
- message: NOERROR,
25
- e_164_format: +19195551234,
26
- formatted: (919) 555-1234,
27
- country: US,
28
- line_type: Mobile,
29
- line_provider: Verizon Wireless,
30
- mobile_country_code: 310,
31
- mobile_network_code: 010
25
+ phone_number: +10072904498,
26
+ line_type: null,
27
+ messaging_provider: Verizon Wireless,
28
+ voice_provider: Verizon Wireless,
29
+ country_code_a3: USA,
30
+ deactivation_reporter: null,
31
+ deactivation_date: 2025-06-20 18:35,
32
+ deactivation_event: null,
33
+ latest_message_delivery_status: null,
34
+ initial_message_delivery_status_date: Thu Jun 19 20:00:00 EDT 2025,
35
+ latest_message_delivery_status_date: Fri Jun 20 20:00:00 EDT 2025
32
36
  )
33
37
  ```
34
38
 
@@ -4,17 +4,18 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_lookup**](PhoneNumberLookupApi.md#create_lookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup |
8
- | [**get_lookup_status**](PhoneNumberLookupApi.md#get_lookup_status) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status |
7
+ | [**create_async_bulk_lookup**](PhoneNumberLookupApi.md#create_async_bulk_lookup) | **POST** /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup |
8
+ | [**create_sync_lookup**](PhoneNumberLookupApi.md#create_sync_lookup) | **POST** /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup |
9
+ | [**get_async_bulk_lookup**](PhoneNumberLookupApi.md#get_async_bulk_lookup) | **GET** /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup |
9
10
 
10
11
 
11
- ## create_lookup
12
+ ## create_async_bulk_lookup
12
13
 
13
- > <CreateLookupResponse> create_lookup(account_id, lookup_request)
14
+ > <CreateAsyncBulkLookupResponse> create_async_bulk_lookup(account_id, async_lookup_request)
14
15
 
15
- Create Lookup
16
+ Create Asynchronous Bulk Number Lookup
16
17
 
17
- Create a Phone Number Lookup Request.
18
+ 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.
18
19
 
19
20
  ### Examples
20
21
 
@@ -29,33 +30,33 @@ Bandwidth.configure do |config|
29
30
  end
30
31
 
31
32
  api_instance = Bandwidth::PhoneNumberLookupApi.new
32
- account_id = '9900000' # String | Your Bandwidth Account ID.
33
- lookup_request = Bandwidth::LookupRequest.new({tns: ['tns_example']}) # LookupRequest | Phone number lookup request.
33
+ account_id = '9900000' # String |
34
+ async_lookup_request = Bandwidth::AsyncLookupRequest.new({phone_numbers: ['phone_numbers_example']}) # AsyncLookupRequest | Asynchronous bulk phone number lookup request.
34
35
 
35
36
  begin
36
- # Create Lookup
37
- result = api_instance.create_lookup(account_id, lookup_request)
37
+ # Create Asynchronous Bulk Number Lookup
38
+ result = api_instance.create_async_bulk_lookup(account_id, async_lookup_request)
38
39
  p result
39
40
  rescue Bandwidth::ApiError => e
40
- puts "Error when calling PhoneNumberLookupApi->create_lookup: #{e}"
41
+ puts "Error when calling PhoneNumberLookupApi->create_async_bulk_lookup: #{e}"
41
42
  end
42
43
  ```
43
44
 
44
- #### Using the create_lookup_with_http_info variant
45
+ #### Using the create_async_bulk_lookup_with_http_info variant
45
46
 
46
47
  This returns an Array which contains the response data, status code and headers.
47
48
 
48
- > <Array(<CreateLookupResponse>, Integer, Hash)> create_lookup_with_http_info(account_id, lookup_request)
49
+ > <Array(<CreateAsyncBulkLookupResponse>, Integer, Hash)> create_async_bulk_lookup_with_http_info(account_id, async_lookup_request)
49
50
 
50
51
  ```ruby
51
52
  begin
52
- # Create Lookup
53
- data, status_code, headers = api_instance.create_lookup_with_http_info(account_id, lookup_request)
53
+ # Create Asynchronous Bulk Number Lookup
54
+ data, status_code, headers = api_instance.create_async_bulk_lookup_with_http_info(account_id, async_lookup_request)
54
55
  p status_code # => 2xx
55
56
  p headers # => { ... }
56
- p data # => <CreateLookupResponse>
57
+ p data # => <CreateAsyncBulkLookupResponse>
57
58
  rescue Bandwidth::ApiError => e
58
- puts "Error when calling PhoneNumberLookupApi->create_lookup_with_http_info: #{e}"
59
+ puts "Error when calling PhoneNumberLookupApi->create_async_bulk_lookup_with_http_info: #{e}"
59
60
  end
60
61
  ```
61
62
 
@@ -63,12 +64,12 @@ end
63
64
 
64
65
  | Name | Type | Description | Notes |
65
66
  | ---- | ---- | ----------- | ----- |
66
- | **account_id** | **String** | Your Bandwidth Account ID. | |
67
- | **lookup_request** | [**LookupRequest**](LookupRequest.md) | Phone number lookup request. | |
67
+ | **account_id** | **String** | | |
68
+ | **async_lookup_request** | [**AsyncLookupRequest**](AsyncLookupRequest.md) | Asynchronous bulk phone number lookup request. | |
68
69
 
69
70
  ### Return type
70
71
 
71
- [**CreateLookupResponse**](CreateLookupResponse.md)
72
+ [**CreateAsyncBulkLookupResponse**](CreateAsyncBulkLookupResponse.md)
72
73
 
73
74
  ### Authorization
74
75
 
@@ -80,13 +81,13 @@ end
80
81
  - **Accept**: application/json
81
82
 
82
83
 
83
- ## get_lookup_status
84
+ ## create_sync_lookup
84
85
 
85
- > <LookupStatus> get_lookup_status(account_id, request_id)
86
+ > <CreateSyncLookupResponse> create_sync_lookup(account_id, sync_lookup_request)
86
87
 
87
- Get Lookup Request Status
88
+ Create Synchronous Number Lookup
88
89
 
89
- Get an existing Phone Number Lookup Request.
90
+ Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
90
91
 
91
92
  ### Examples
92
93
 
@@ -101,33 +102,33 @@ Bandwidth.configure do |config|
101
102
  end
102
103
 
103
104
  api_instance = Bandwidth::PhoneNumberLookupApi.new
104
- account_id = '9900000' # String | Your Bandwidth Account ID.
105
- request_id = '004223a0-8b17-41b1-bf81-20732adf5590' # String | The phone number lookup request ID from Bandwidth.
105
+ account_id = '9900000' # String |
106
+ sync_lookup_request = Bandwidth::SyncLookupRequest.new({phone_numbers: ['phone_numbers_example']}) # SyncLookupRequest | Synchronous phone number lookup request.
106
107
 
107
108
  begin
108
- # Get Lookup Request Status
109
- result = api_instance.get_lookup_status(account_id, request_id)
109
+ # Create Synchronous Number Lookup
110
+ result = api_instance.create_sync_lookup(account_id, sync_lookup_request)
110
111
  p result
111
112
  rescue Bandwidth::ApiError => e
112
- puts "Error when calling PhoneNumberLookupApi->get_lookup_status: #{e}"
113
+ puts "Error when calling PhoneNumberLookupApi->create_sync_lookup: #{e}"
113
114
  end
114
115
  ```
115
116
 
116
- #### Using the get_lookup_status_with_http_info variant
117
+ #### Using the create_sync_lookup_with_http_info variant
117
118
 
118
119
  This returns an Array which contains the response data, status code and headers.
119
120
 
120
- > <Array(<LookupStatus>, Integer, Hash)> get_lookup_status_with_http_info(account_id, request_id)
121
+ > <Array(<CreateSyncLookupResponse>, Integer, Hash)> create_sync_lookup_with_http_info(account_id, sync_lookup_request)
121
122
 
122
123
  ```ruby
123
124
  begin
124
- # Get Lookup Request Status
125
- data, status_code, headers = api_instance.get_lookup_status_with_http_info(account_id, request_id)
125
+ # Create Synchronous Number Lookup
126
+ data, status_code, headers = api_instance.create_sync_lookup_with_http_info(account_id, sync_lookup_request)
126
127
  p status_code # => 2xx
127
128
  p headers # => { ... }
128
- p data # => <LookupStatus>
129
+ p data # => <CreateSyncLookupResponse>
129
130
  rescue Bandwidth::ApiError => e
130
- puts "Error when calling PhoneNumberLookupApi->get_lookup_status_with_http_info: #{e}"
131
+ puts "Error when calling PhoneNumberLookupApi->create_sync_lookup_with_http_info: #{e}"
131
132
  end
132
133
  ```
133
134
 
@@ -135,12 +136,84 @@ end
135
136
 
136
137
  | Name | Type | Description | Notes |
137
138
  | ---- | ---- | ----------- | ----- |
138
- | **account_id** | **String** | Your Bandwidth Account ID. | |
139
- | **request_id** | **String** | The phone number lookup request ID from Bandwidth. | |
139
+ | **account_id** | **String** | | |
140
+ | **sync_lookup_request** | [**SyncLookupRequest**](SyncLookupRequest.md) | Synchronous phone number lookup request. | |
140
141
 
141
142
  ### Return type
142
143
 
143
- [**LookupStatus**](LookupStatus.md)
144
+ [**CreateSyncLookupResponse**](CreateSyncLookupResponse.md)
145
+
146
+ ### Authorization
147
+
148
+ [Basic](../README.md#Basic)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: application/json
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## get_async_bulk_lookup
157
+
158
+ > <GetAsyncBulkLookupResponse> get_async_bulk_lookup(account_id, request_id)
159
+
160
+ Get Asynchronous Bulk Number Lookup
161
+
162
+ 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.
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'bandwidth-sdk'
169
+ # setup authorization
170
+ Bandwidth.configure do |config|
171
+ # Configure HTTP basic authorization: Basic
172
+ config.username = 'YOUR USERNAME'
173
+ config.password = 'YOUR PASSWORD'
174
+ end
175
+
176
+ api_instance = Bandwidth::PhoneNumberLookupApi.new
177
+ account_id = '9900000' # String |
178
+ request_id = '004223a0-8b17-41b1-bf81-20732adf5590' # String |
179
+
180
+ begin
181
+ # Get Asynchronous Bulk Number Lookup
182
+ result = api_instance.get_async_bulk_lookup(account_id, request_id)
183
+ p result
184
+ rescue Bandwidth::ApiError => e
185
+ puts "Error when calling PhoneNumberLookupApi->get_async_bulk_lookup: #{e}"
186
+ end
187
+ ```
188
+
189
+ #### Using the get_async_bulk_lookup_with_http_info variant
190
+
191
+ This returns an Array which contains the response data, status code and headers.
192
+
193
+ > <Array(<GetAsyncBulkLookupResponse>, Integer, Hash)> get_async_bulk_lookup_with_http_info(account_id, request_id)
194
+
195
+ ```ruby
196
+ begin
197
+ # Get Asynchronous Bulk Number Lookup
198
+ data, status_code, headers = api_instance.get_async_bulk_lookup_with_http_info(account_id, request_id)
199
+ p status_code # => 2xx
200
+ p headers # => { ... }
201
+ p data # => <GetAsyncBulkLookupResponse>
202
+ rescue Bandwidth::ApiError => e
203
+ puts "Error when calling PhoneNumberLookupApi->get_async_bulk_lookup_with_http_info: #{e}"
204
+ end
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ | Name | Type | Description | Notes |
210
+ | ---- | ---- | ----------- | ----- |
211
+ | **account_id** | **String** | | |
212
+ | **request_id** | **String** | | |
213
+
214
+ ### Return type
215
+
216
+ [**GetAsyncBulkLookupResponse**](GetAsyncBulkLookupResponse.md)
144
217
 
145
218
  ### Authorization
146
219
 
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
16
16
  instance = Bandwidth::RbmActionBase.new(
17
17
  type: null,
18
18
  text: Hello world,
19
- postback_data: [B@a93c798
19
+ postback_data: [B@1d33e72e
20
20
  )
21
21
  ```
22
22
 
@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
14
14
 
15
15
  instance = Bandwidth::RbmSuggestionResponse.new(
16
16
  text: Yes, I would like to proceed,
17
- postback_data: [B@a93c798
17
+ postback_data: [B@1d33e72e
18
18
  )
19
19
  ```
20
20