bandwidth-sdk 16.2.2 → 17.0.1

data/docs/{MultiChannelChannelListObjectContent.md → MultiChannelChannelListRBMObjectAllOfContent.md}

@@ -1,4 +1,4 @@
-# Bandwidth::MultiChannelChannelListObjectContent
+# Bandwidth::MultiChannelChannelListRBMObjectAllOfContent
 
 ## Class instance methods
 
@@ -11,14 +11,12 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'bandwidth-sdk'
 
-Bandwidth::MultiChannelChannelListObjectContent.openapi_one_of
+Bandwidth::MultiChannelChannelListRBMObjectAllOfContent.openapi_one_of
 # =>
 # [
-#   :'MmsMessageContent',
 #   :'RbmMessageContentRichCard',
 #   :'RbmMessageContentText',
-#   :'RbmMessageMedia',
-#   :'SmsMessageContent'
+#   :'RbmMessageMedia'
 # ]
 ```
 
@@ -31,10 +29,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'bandwidth-sdk'
 
-Bandwidth::MultiChannelChannelListObjectContent.build(data)
-# => #<MmsMessageContent:0x00007fdd4aab02a0>
+Bandwidth::MultiChannelChannelListRBMObjectAllOfContent.build(data)
+# => #<RbmMessageContentRichCard:0x00007fdd4aab02a0>
 
-Bandwidth::MultiChannelChannelListObjectContent.build(data_that_doesnt_match)
+Bandwidth::MultiChannelChannelListRBMObjectAllOfContent.build(data_that_doesnt_match)
 # => nil
 ```
 
@@ -46,10 +44,8 @@ Bandwidth::MultiChannelChannelListObjectContent.build(data_that_doesnt_match)
 
 #### Return type
 
-- `MmsMessageContent`
 - `RbmMessageContentRichCard`
 - `RbmMessageContentText`
 - `RbmMessageMedia`
-- `SmsMessageContent`
 - `nil` (if no type matches)
 

data/docs/MultiChannelChannelListRBMResponseObject.md

@@ -0,0 +1,26 @@
+# Bandwidth::MultiChannelChannelListRBMResponseObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  |  |
+| **content** | [**MultiChannelChannelListRBMObjectAllOfContent**](MultiChannelChannelListRBMObjectAllOfContent.md) |  |  |
+| **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListRBMResponseObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null,
+  owner: null
+)
+```
+

data/docs/MultiChannelChannelListRequestObject.md

@@ -0,0 +1,24 @@
+# Bandwidth::MultiChannelChannelListRequestObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  |  |
+| **content** | [**MmsMessageContent**](MmsMessageContent.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListRequestObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null
+)
+```
+

data/docs/MultiChannelChannelListResponseObject.md

@@ -0,0 +1,26 @@
+# Bandwidth::MultiChannelChannelListResponseObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  |  |
+| **content** | [**MmsMessageContent**](MmsMessageContent.md) |  |  |
+| **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListResponseObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null,
+  owner: null
+)
+```
+

data/docs/MultiChannelChannelListSMSObject.md

@@ -0,0 +1,24 @@
+# Bandwidth::MultiChannelChannelListSMSObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  |  |
+| **content** | [**SmsMessageContent**](SmsMessageContent.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListSMSObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null
+)
+```
+

data/docs/MultiChannelChannelListSMSResponseObject.md

@@ -0,0 +1,26 @@
+# Bandwidth::MultiChannelChannelListSMSResponseObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The sender ID of the message. This could be an alphanumeric sender ID. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  |  |
+| **content** | [**SmsMessageContent**](SmsMessageContent.md) |  |  |
+| **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListSMSResponseObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null,
+  owner: null
+)
+```
+

data/docs/MultiChannelMessageRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **to** | **String** | The phone number the message should be sent to in E164 format. |  |
-| **channel_list** | [**Array<MultiChannelChannelListObject>**](MultiChannelChannelListObject.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. |  |
+| **channel_list** | [**Array<MultiChannelChannelListRequestObject>**](MultiChannelChannelListRequestObject.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. |  |
 | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
 | **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
 | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |

data/docs/MultiChannelMessageResponseData.md

@@ -8,7 +8,7 @@
 | **time** | **Time** | The time the message was received by the Bandwidth API. |  |
 | **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
 | **to** | **Array<String>** | The destination phone number(s) of the message, in E164 format. |  |
-| **channel_list** | [**Array<MultiChannelMessageResponseDataChannelListInner>**](MultiChannelMessageResponseDataChannelListInner.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. |  |
+| **channel_list** | [**Array<MultiChannelChannelListResponseObject>**](MultiChannelChannelListResponseObject.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. |  |
 | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
 | **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
 | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |

data/docs/PhoneNumberLookupApi.md

@@ -4,17 +4,18 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_lookup**](PhoneNumberLookupApi.md#create_lookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup |
-| [**get_lookup_status**](PhoneNumberLookupApi.md#get_lookup_status) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status |
+| [**create_async_bulk_lookup**](PhoneNumberLookupApi.md#create_async_bulk_lookup) | **POST** /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup |
+| [**create_sync_lookup**](PhoneNumberLookupApi.md#create_sync_lookup) | **POST** /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup |
+| [**get_async_bulk_lookup**](PhoneNumberLookupApi.md#get_async_bulk_lookup) | **GET** /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup |
 
 
-## create_lookup
+## create_async_bulk_lookup
 
-> <CreateLookupResponse> create_lookup(account_id, lookup_request)
+> <CreateAsyncBulkLookupResponse> create_async_bulk_lookup(account_id, async_lookup_request)
 
-Create Lookup
+Create Asynchronous Bulk Number Lookup
 
-Create a Phone Number Lookup Request.
+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.
 
 ### Examples
 
@@ -29,33 +30,33 @@ Bandwidth.configure do |config|
 end
 
 api_instance = Bandwidth::PhoneNumberLookupApi.new
-account_id = '9900000' # String | Your Bandwidth Account ID.
-lookup_request = Bandwidth::LookupRequest.new({tns: ['tns_example']}) # LookupRequest | Phone number lookup request.
+account_id = '9900000' # String | 
+async_lookup_request = Bandwidth::AsyncLookupRequest.new({phone_numbers: ['phone_numbers_example']}) # AsyncLookupRequest | Asynchronous bulk phone number lookup request.
 
 begin
-  # Create Lookup
-  result = api_instance.create_lookup(account_id, lookup_request)
+  # Create Asynchronous Bulk Number Lookup
+  result = api_instance.create_async_bulk_lookup(account_id, async_lookup_request)
   p result
 rescue Bandwidth::ApiError => e
-  puts "Error when calling PhoneNumberLookupApi->create_lookup: #{e}"
+  puts "Error when calling PhoneNumberLookupApi->create_async_bulk_lookup: #{e}"
 end
 ```
 
-#### Using the create_lookup_with_http_info variant
+#### Using the create_async_bulk_lookup_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CreateLookupResponse>, Integer, Hash)> create_lookup_with_http_info(account_id, lookup_request)
+> <Array(<CreateAsyncBulkLookupResponse>, Integer, Hash)> create_async_bulk_lookup_with_http_info(account_id, async_lookup_request)
 
 ```ruby
 begin
-  # Create Lookup
-  data, status_code, headers = api_instance.create_lookup_with_http_info(account_id, lookup_request)
+  # Create Asynchronous Bulk Number Lookup
+  data, status_code, headers = api_instance.create_async_bulk_lookup_with_http_info(account_id, async_lookup_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <CreateLookupResponse>
+  p data # => <CreateAsyncBulkLookupResponse>
 rescue Bandwidth::ApiError => e
-  puts "Error when calling PhoneNumberLookupApi->create_lookup_with_http_info: #{e}"
+  puts "Error when calling PhoneNumberLookupApi->create_async_bulk_lookup_with_http_info: #{e}"
 end
 ```
 
@@ -63,12 +64,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | Your Bandwidth Account ID. |  |
-| **lookup_request** | [**LookupRequest**](LookupRequest.md) | Phone number lookup request. |  |
+| **account_id** | **String** |  |  |
+| **async_lookup_request** | [**AsyncLookupRequest**](AsyncLookupRequest.md) | Asynchronous bulk phone number lookup request. |  |
 
 ### Return type
 
-[**CreateLookupResponse**](CreateLookupResponse.md)
+[**CreateAsyncBulkLookupResponse**](CreateAsyncBulkLookupResponse.md)
 
 ### Authorization
 
@@ -80,13 +81,13 @@ end
 - **Accept**: application/json
 
 
-## get_lookup_status
+## create_sync_lookup
 
-> <LookupStatus> get_lookup_status(account_id, request_id)
+> <CreateSyncLookupResponse> create_sync_lookup(account_id, sync_lookup_request)
 
-Get Lookup Request Status
+Create Synchronous Number Lookup
 
-Get an existing Phone Number Lookup Request.
+Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
 
 ### Examples
 
@@ -101,33 +102,33 @@ Bandwidth.configure do |config|
 end
 
 api_instance = Bandwidth::PhoneNumberLookupApi.new
-account_id = '9900000' # String | Your Bandwidth Account ID.
-request_id = '004223a0-8b17-41b1-bf81-20732adf5590' # String | The phone number lookup request ID from Bandwidth.
+account_id = '9900000' # String | 
+sync_lookup_request = Bandwidth::SyncLookupRequest.new({phone_numbers: ['phone_numbers_example']}) # SyncLookupRequest | Synchronous phone number lookup request.
 
 begin
-  # Get Lookup Request Status
-  result = api_instance.get_lookup_status(account_id, request_id)
+  # Create Synchronous Number Lookup
+  result = api_instance.create_sync_lookup(account_id, sync_lookup_request)
   p result
 rescue Bandwidth::ApiError => e
-  puts "Error when calling PhoneNumberLookupApi->get_lookup_status: #{e}"
+  puts "Error when calling PhoneNumberLookupApi->create_sync_lookup: #{e}"
 end
 ```
 
-#### Using the get_lookup_status_with_http_info variant
+#### Using the create_sync_lookup_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<LookupStatus>, Integer, Hash)> get_lookup_status_with_http_info(account_id, request_id)
+> <Array(<CreateSyncLookupResponse>, Integer, Hash)> create_sync_lookup_with_http_info(account_id, sync_lookup_request)
 
 ```ruby
 begin
-  # Get Lookup Request Status
-  data, status_code, headers = api_instance.get_lookup_status_with_http_info(account_id, request_id)
+  # Create Synchronous Number Lookup
+  data, status_code, headers = api_instance.create_sync_lookup_with_http_info(account_id, sync_lookup_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <LookupStatus>
+  p data # => <CreateSyncLookupResponse>
 rescue Bandwidth::ApiError => e
-  puts "Error when calling PhoneNumberLookupApi->get_lookup_status_with_http_info: #{e}"
+  puts "Error when calling PhoneNumberLookupApi->create_sync_lookup_with_http_info: #{e}"
 end
 ```
 
@@ -135,12 +136,84 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | Your Bandwidth Account ID. |  |
-| **request_id** | **String** | The phone number lookup request ID from Bandwidth. |  |
+| **account_id** | **String** |  |  |
+| **sync_lookup_request** | [**SyncLookupRequest**](SyncLookupRequest.md) | Synchronous phone number lookup request. |  |
 
 ### Return type
 
-[**LookupStatus**](LookupStatus.md)
+[**CreateSyncLookupResponse**](CreateSyncLookupResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_async_bulk_lookup
+
+> <GetAsyncBulkLookupResponse> get_async_bulk_lookup(account_id, request_id)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::PhoneNumberLookupApi.new
+account_id = '9900000' # String | 
+request_id = '004223a0-8b17-41b1-bf81-20732adf5590' # String | 
+
+begin
+  # Get Asynchronous Bulk Number Lookup
+  result = api_instance.get_async_bulk_lookup(account_id, request_id)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->get_async_bulk_lookup: #{e}"
+end
+```
+
+#### Using the get_async_bulk_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAsyncBulkLookupResponse>, Integer, Hash)> get_async_bulk_lookup_with_http_info(account_id, request_id)
+
+```ruby
+begin
+  # Get Asynchronous Bulk Number Lookup
+  data, status_code, headers = api_instance.get_async_bulk_lookup_with_http_info(account_id, request_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAsyncBulkLookupResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->get_async_bulk_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  |  |
+| **request_id** | **String** |  |  |
+
+### Return type
+
+[**GetAsyncBulkLookupResponse**](GetAsyncBulkLookupResponse.md)
 
 ### Authorization
 

data/docs/RbmActionBase.md

@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
 instance = Bandwidth::RbmActionBase.new(
   type: null,
   text: Hello world,
-  postback_data: [B@a93c798
+  postback_data: [B@7d5d77a6
 )
 ```
 

data/docs/RbmSuggestionResponse.md

@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
 
 instance = Bandwidth::RbmSuggestionResponse.new(
   text: Yes, I would like to proceed,
-  postback_data: [B@a93c798
+  postback_data: [B@7d5d77a6
 )
 ```
 

data/docs/SyncLookupRequest.md

@@ -0,0 +1,18 @@
+# Bandwidth::SyncLookupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_numbers** | **Array<String>** | Telephone numbers in E.164 format. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::SyncLookupRequest.new(
+  phone_numbers: null
+)
+```
+