bandwidth-sdk 16.2.2 → 17.0.1

data/docs/AsyncLookupRequest.md

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

data/docs/{LookupRequest.md → CompletedLookupStatusEnum.md}

@@ -1,18 +1,15 @@
-# Bandwidth::LookupRequest
+# Bandwidth::CompletedLookupStatusEnum
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **tns** | **Array<String>** |  |  |
 
 ## Example
 
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::LookupRequest.new(
-  tns: null
-)
+instance = Bandwidth::CompletedLookupStatusEnum.new()
 ```
 

data/docs/CreateAsyncBulkLookupResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::CreateAsyncBulkLookupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<LinkSchema>**](LinkSchema.md) | Links for pagination (if applicable) | [optional] |
+| **data** | [**CreateAsyncBulkLookupResponseData**](CreateAsyncBulkLookupResponseData.md) |  | [optional] |
+| **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateAsyncBulkLookupResponse.new(
+  links: null,
+  data: null,
+  errors: null
+)
+```
+

data/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md}

@@ -1,19 +1,19 @@
-# Bandwidth::CreateLookupResponse
+# Bandwidth::CreateAsyncBulkLookupResponseData
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
-| **status** | [**LookupStatusEnum**](LookupStatusEnum.md) |  | [optional] |
+| **status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::CreateLookupResponse.new(
-  request_id: null,
+instance = Bandwidth::CreateAsyncBulkLookupResponseData.new(
+  request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
   status: null
 )
 ```

data/docs/CreateSyncLookupResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::CreateSyncLookupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<LinkSchema>**](LinkSchema.md) |  | [optional] |
+| **data** | [**CreateSyncLookupResponseData**](CreateSyncLookupResponseData.md) |  | [optional] |
+| **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateSyncLookupResponse.new(
+  links: [],
+  data: null,
+  errors: null
+)
+```
+

data/docs/CreateSyncLookupResponseData.md

@@ -0,0 +1,22 @@
+# Bandwidth::CreateSyncLookupResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
+| **status** | [**CompletedLookupStatusEnum**](CompletedLookupStatusEnum.md) |  | [optional] |
+| **results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone numbers. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateSyncLookupResponseData.new(
+  request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
+  status: null,
+  results: null
+)
+```
+

data/docs/DeactivationEventEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::DeactivationEventEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::DeactivationEventEnum.new()
+```
+

data/docs/GetAsyncBulkLookupResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::GetAsyncBulkLookupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<LinkSchema>**](LinkSchema.md) |  | [optional] |
+| **data** | [**GetAsyncBulkLookupResponseData**](GetAsyncBulkLookupResponseData.md) |  | [optional] |
+| **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::GetAsyncBulkLookupResponse.new(
+  links: [],
+  data: null,
+  errors: null
+)
+```
+

data/docs/GetAsyncBulkLookupResponseData.md

@@ -0,0 +1,22 @@
+# Bandwidth::GetAsyncBulkLookupResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
+| **status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) |  | [optional] |
+| **results** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::GetAsyncBulkLookupResponseData.new(
+  request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
+  status: null,
+  results: null
+)
+```
+

data/docs/InProgressLookupStatusEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::InProgressLookupStatusEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::InProgressLookupStatusEnum.new()
+```
+

data/docs/LatestMessageDeliveryStatusEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::LatestMessageDeliveryStatusEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LatestMessageDeliveryStatusEnum.new()
+```
+

data/docs/{LookupStatusEnum.md → LineTypeEnum.md}

@@ -1,4 +1,4 @@
-# Bandwidth::LookupStatusEnum
+# Bandwidth::LineTypeEnum
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::LookupStatusEnum.new()
+instance = Bandwidth::LineTypeEnum.new()
 ```
 

data/docs/LinkSchema.md

@@ -0,0 +1,22 @@
+# Bandwidth::LinkSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | URI of the link. | [optional] |
+| **rel** | **String** | Specifies the relationship between this link and the resource. | [optional] |
+| **method** | **String** | HTTP method to be used. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LinkSchema.new(
+  href: /relative/uri,
+  rel: aRelatedResource,
+  method: GET
+)
+```
+

data/docs/LookupErrorResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::LookupErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<LinkSchema>**](LinkSchema.md) |  | [optional] |
+| **data** | **Object** | The phone number lookup response data | [optional] |
+| **errors** | [**Array<LookupErrorSchema>**](LookupErrorSchema.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupErrorResponse.new(
+  links: [],
+  data: null,
+  errors: null
+)
+```
+

data/docs/LookupErrorSchema.md

@@ -0,0 +1,24 @@
+# Bandwidth::LookupErrorSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Validation error code | [optional] |
+| **description** | **String** | Description of validation error | [optional] |
+| **type** | **String** | Type of validation error | [optional] |
+| **meta** | [**LookupErrorSchemaMeta**](LookupErrorSchemaMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupErrorSchema.new(
+  code: NO-MATCH,
+  description: Example error description,
+  type: NumberInventory,
+  meta: null
+)
+```
+

data/docs/LookupErrorSchemaMeta.md

@@ -0,0 +1,22 @@
+# Bandwidth::LookupErrorSchemaMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_numbers** | **Array<String>** |  | [optional] |
+| **message** | **String** | Message describing the error | [optional] |
+| **code** | **Integer** | Error code associated with the message | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupErrorSchemaMeta.new(
+  phone_numbers: ["+13992077164","+19196104424"],
+  message: Invalid TNs,
+  code: 1001
+)
+```
+

data/docs/LookupResult.md

@@ -4,15 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **response_code** | **Integer** | Our vendor's response code. | [optional] |
-| **message** | **String** | Message associated with the response code. | [optional] |
-| **e_164_format** | **String** | The telephone number in E.164 format. | [optional] |
-| **formatted** | **String** | The formatted version of the telephone number. | [optional] |
-| **country** | **String** | The country of the telephone number. | [optional] |
-| **line_type** | **String** | The line type of the telephone number. | [optional] |
-| **line_provider** | **String** | The messaging service provider of the telephone number. | [optional] |
-| **mobile_country_code** | **String** | The first half of the Home Network Identity (HNI). | [optional] |
-| **mobile_network_code** | **String** | The second half of the HNI. | [optional] |
+| **phone_number** | **String** | The telephone number in E.164 format. | [optional] |
+| **line_type** | [**LineTypeEnum**](LineTypeEnum.md) |  | [optional] |
+| **messaging_provider** | **String** | The messaging service provider of the telephone number. | [optional] |
+| **voice_provider** | **String** | The voice service provider of the telephone number. | [optional] |
+| **country_code_a3** | **String** | The country code of the telephone number in ISO 3166-1 alpha-3 format. | [optional] |
+| **deactivation_reporter** | **String** | [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number.  | [optional] |
+| **deactivation_date** | **String** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] |
+| **deactivation_event** | [**DeactivationEventEnum**](DeactivationEventEnum.md) |  | [optional] |
+| **latest_message_delivery_status** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) |  | [optional] |
+| **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] |
+| **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] |
 
 ## Example
 
@@ -20,15 +22,17 @@
 require 'bandwidth-sdk'
 
 instance = Bandwidth::LookupResult.new(
-  response_code: 0,
-  message: NOERROR,
-  e_164_format: +19195551234,
-  formatted: (919) 555-1234,
-  country: US,
-  line_type: Mobile,
-  line_provider: Verizon Wireless,
-  mobile_country_code: 310,
-  mobile_network_code: 010
+  phone_number: +10072904498,
+  line_type: null,
+  messaging_provider: Verizon Wireless,
+  voice_provider: Verizon Wireless,
+  country_code_a3: USA,
+  deactivation_reporter: null,
+  deactivation_date: 2025-06-20 18:35,
+  deactivation_event: null,
+  latest_message_delivery_status: null,
+  initial_message_delivery_status_date: Thu Jun 19 20:00:00 EDT 2025,
+  latest_message_delivery_status_date: Fri Jun 20 20:00:00 EDT 2025
 )
 ```
 

data/docs/MultiChannelAction.md

@@ -1,89 +1,40 @@
 # Bandwidth::MultiChannelAction
 
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'bandwidth-sdk'
-
-Bandwidth::MultiChannelAction.openapi_one_of
-# =>
-# [
-#   :'MultiChannelActionCalendarEvent',
-#   :'RbmActionBase',
-#   :'RbmActionDial',
-#   :'RbmActionOpenUrl',
-#   :'RbmActionViewLocation'
-# ]
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's property name.
-
-#### Example
-
-```ruby
-require 'bandwidth-sdk'
-
-Bandwidth::MultiChannelAction.openapi_discriminator_name
-# => :'type'
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's mapping.
-
-#### Example
-
-```ruby
-require 'bandwidth-sdk'
-
-Bandwidth::MultiChannelAction.openapi_discriminator_mapping
-# =>
-# {
-#   :'CREATE_CALENDAR_EVENT' => :'MultiChannelActionCalendarEvent',
-#   :'DIAL_PHONE' => :'RbmActionDial',
-#   :'OPEN_URL' => :'RbmActionOpenUrl',
-#   :'REPLY' => :'RbmActionBase',
-#   :'REQUEST_LOCATION' => :'RbmActionBase',
-#   :'SHOW_LOCATION' => :'RbmActionViewLocation'
-# }
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) |  |  |
+| **text** | **String** | Displayed text for user to click |  |
+| **postback_data** | **String** | Base64 payload the customer receives when the reply is clicked. |  |
+| **phone_number** | **String** | The phone number to dial. Must be E164 format. |  |
+| **latitude** | **Float** | The latitude of the location. |  |
+| **longitude** | **Float** | The longitude of the location. |  |
+| **label** | **String** | The label of the location. | [optional] |
+| **title** | **String** | The title of the event. |  |
+| **start_time** | **Time** | The start time of the event. |  |
+| **end_time** | **Time** | The end time of the event. |  |
+| **description** | **String** | The description of the event. | [optional] |
+| **url** | **String** | The URL to open in browser. |  |
+
+## Example
 
 ```ruby
 require 'bandwidth-sdk'
 
-Bandwidth::MultiChannelAction.build(data)
-# => #<MultiChannelActionCalendarEvent:0x00007fdd4aab02a0>
-
-Bandwidth::MultiChannelAction.build(data_that_doesnt_match)
-# => nil
+instance = Bandwidth::MultiChannelAction.new(
+  type: null,
+  text: Hello world,
+  postback_data: U0dWc2JHOGdkMjl5YkdRPQ&#x3D;&#x3D;,
+  phone_number: +15552223333,
+  latitude: 37.7749,
+  longitude: -122.4194,
+  label: San Francisco,
+  title: Meeting with John,
+  start_time: 2022-09-14T18:20:16Z,
+  end_time: 2022-09-14T18:20:16Z,
+  description: Discuss the new project,
+  url: https://dev.bandwidth.com
+)
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `MultiChannelActionCalendarEvent`
-- `RbmActionBase`
-- `RbmActionDial`
-- `RbmActionOpenUrl`
-- `RbmActionViewLocation`
-- `nil` (if no type matches)
-

data/docs/MultiChannelApi.md

@@ -29,7 +29,7 @@ end
 
 api_instance = Bandwidth::MultiChannelApi.new
 account_id = '9900000' # String | Your Bandwidth Account ID.
-multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest | 
+multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListRequestObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest | 
 
 begin
   # Create Multi-Channel Message

data/docs/{MultiChannelChannelListObject.md → MultiChannelChannelListMMSObject.md}

@@ -1,4 +1,4 @@
-# Bandwidth::MultiChannelChannelListObject
+# Bandwidth::MultiChannelChannelListMMSObject
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **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** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) |  |  |
+| **content** | [**MmsMessageContent**](MmsMessageContent.md) |  |  |
 
 ## Example
 
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::MultiChannelChannelListObject.new(
+instance = Bandwidth::MultiChannelChannelListMMSObject.new(
   from: BandwidthRBM,
   application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
   channel: null,

data/docs/{MultiChannelMessageResponseDataChannelListInner.md → MultiChannelChannelListMMSResponseObject.md}

@@ -1,4 +1,4 @@
-# Bandwidth::MultiChannelMessageResponseDataChannelListInner
+# Bandwidth::MultiChannelChannelListMMSResponseObject
 
 ## Properties
 
@@ -7,7 +7,7 @@
 | **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** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) |  |  |
+| **content** | [**MmsMessageContent**](MmsMessageContent.md) |  |  |
 | **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. |  |
 
 ## Example
@@ -15,7 +15,7 @@
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::MultiChannelMessageResponseDataChannelListInner.new(
+instance = Bandwidth::MultiChannelChannelListMMSResponseObject.new(
   from: BandwidthRBM,
   application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
   channel: null,

data/docs/MultiChannelChannelListObjectBase.md

@@ -0,0 +1,22 @@
+# Bandwidth::MultiChannelChannelListObjectBase
+
+## 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) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListObjectBase.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null
+)
+```
+

data/docs/MultiChannelChannelListOwnerObject.md

@@ -0,0 +1,18 @@
+# Bandwidth::MultiChannelChannelListOwnerObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **owner** | **String** | The Bandwidth senderId associated with the message. Identical to 'from'. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListOwnerObject.new(
+  owner: null
+)
+```
+

data/docs/MultiChannelChannelListRBMObject.md

@@ -0,0 +1,24 @@
+# Bandwidth::MultiChannelChannelListRBMObject
+
+## 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) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MultiChannelChannelListRBMObject.new(
+  from: BandwidthRBM,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  channel: null,
+  content: null
+)
+```
+