Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ docs/AnswerCallback.md
docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/BusinessEntityTypeEnum.md
docs/BusinessRegistrationTypeEnum.md
docs/CallDirectionEnum.md
docs/CallRecordingMetadata.md
docs/CallState.md
Expand Down Expand Up @@ -190,6 +192,8 @@ lib/bandwidth-sdk/models/answer_callback.rb
lib/bandwidth-sdk/models/blocked_webhook.rb
lib/bandwidth-sdk/models/bridge_complete_callback.rb
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
lib/bandwidth-sdk/models/business_entity_type_enum.rb
lib/bandwidth-sdk/models/business_registration_type_enum.rb
lib/bandwidth-sdk/models/call_direction_enum.rb
lib/bandwidth-sdk/models/call_recording_metadata.rb
lib/bandwidth-sdk/models/call_state.rb
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ Class | Method | HTTP request | Description
- [Bandwidth::BlockedWebhook](docs/BlockedWebhook.md)
- [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
- [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
- [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
- [Bandwidth::CallState](docs/CallState.md)
Expand Down
118 changes: 118 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ paths:
- $ref: '#/components/parameters/bwQueued'
- $ref: '#/components/parameters/product'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/carrierQueued'
- $ref: '#/components/parameters/fromCarrierLatency'
- $ref: '#/components/parameters/callingNumberCountryA3'
- $ref: '#/components/parameters/calledNumberCountryA3'
- $ref: '#/components/parameters/fromSegmentCount'
Expand Down Expand Up @@ -1851,6 +1853,14 @@ components:
accounts with the Advanced Quality Metrics feature enabled.
nullable: true
example: 20
carrierLatency:
type: integer
description: >-
The carrier latency of the message in seconds. Only available for
OUTBOUND messages from accounts with the Advanced Quality Metrics
feature enabled.
nullable: true
example: 20
callingNumberCountryA3:
type: string
description: The A3 country code of the calling number.
Expand Down Expand Up @@ -5530,6 +5540,50 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
type: string
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
until early 2026. If a value is provided for this field, a value must be
provided for `businessRegistrationType` and `businessEntityType`.
Available starting October 1st, 2025.
nullable: true
maxLength: 500
example: 12-3456789
businessRegistrationTypeEnum:
type: string
description: >-
The type of business registration number. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
enum:
- EIN
- CBN
nullable: true
businessEntityTypeEnum:
type: string
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
nullable: true
helpMessageResponse:
type: string
description: A message that gets sent to users requesting help.
nullable: true
maxLength: 500
example: Please contact support for assistance.
ageGatedContent:
type: boolean
description: Indicates whether the content is age-gated.
example: false
additionalDenialReason:
properties:
statusCode:
Expand Down Expand Up @@ -5616,6 +5670,16 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -5655,6 +5719,16 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -5858,6 +5932,12 @@ components:
example: https://www.example.com/path/to/resource
pattern: >-
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
confirmationResponse:
type: string
minLength: 0
maxLength: 500
nullable: true
example: Thank you for opting in!
isvReseller:
type: string
description: ISV name.
Expand Down Expand Up @@ -6131,6 +6211,22 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
Available starting October 1st, 2025.
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
description: >-
The type of business registration number. Available starting October
1st, 2025.
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value. Available starting October
1st, 2025.
tfvStatusEnum:
type: string
enum:
Expand Down Expand Up @@ -7028,6 +7124,28 @@ components:
example: 123ABC
schema:
type: string
carrierQueued:
in: query
name: carrierQueued
required: false
description: >-
A boolean value indicating whether the message is queued in the carrier
network. Only available for OUTBOUND messages from accounts with the
Advanced Quality Metrics feature enabled.
example: true
schema:
type: boolean
fromCarrierLatency:
in: query
name: fromCarrierLatency
required: false
description: >-
The minimum carrier latency of the message in seconds. Only available
for OUTBOUND messages from accounts with the Advanced Quality Metrics
feature enabled.
example: 50
schema:
type: integer
callingNumberCountryA3:
in: query
name: callingNumberCountryA3
Expand Down
15 changes: 15 additions & 0 deletions docs/BusinessEntityTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth::BusinessEntityTypeEnum

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::BusinessEntityTypeEnum.new()
```

15 changes: 15 additions & 0 deletions docs/BusinessRegistrationTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth::BusinessRegistrationTypeEnum

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::BusinessRegistrationTypeEnum.new()
```

2 changes: 2 additions & 0 deletions docs/ListMessageItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
| **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
| **campaign_id** | **String** | The campaign ID of the message if it has one. | [optional] |
| **bw_latency** | **Integer** | The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **carrier_latency** | **Integer** | The carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **calling_number_country_a3** | **String** | The A3 country code of the calling number. | [optional] |
| **called_number_country_a3** | **String** | The A3 country code of the called number. | [optional] |
| **product** | **String** | The messaging product associated with the message. | [optional] |
Expand Down Expand Up @@ -51,6 +52,7 @@ instance = Bandwidth::ListMessageItem.new(
campaign_class: T,
campaign_id: CJEUMDK,
bw_latency: 20,
carrier_latency: 20,
calling_number_country_a3: USA,
called_number_country_a3: USA,
product: P2P,
Expand Down
4 changes: 4 additions & 0 deletions docs/MessagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ opts = {
bw_queued: true, # Boolean | A boolean value indicating whether the message is queued in the Bandwidth network.
product: Bandwidth::ProductTypeEnum::LOCAL_A2_P, # ProductTypeEnum | Messaging product associated with the message.
location: '123ABC', # String | Location Id associated with the message.
carrier_queued: true, # Boolean | A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
from_carrier_latency: 50, # Integer | The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
calling_number_country_a3: 'USA', # String | Calling number country in A3 format.
called_number_country_a3: 'USA', # String | Called number country in A3 format.
from_segment_count: 1, # Integer | Segment count (start range).
Expand Down Expand Up @@ -177,6 +179,8 @@ end
| **bw_queued** | **Boolean** | A boolean value indicating whether the message is queued in the Bandwidth network. | [optional] |
| **product** | [**ProductTypeEnum**](.md) | Messaging product associated with the message. | [optional] |
| **location** | **String** | Location Id associated with the message. | [optional] |
| **carrier_queued** | **Boolean** | A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **from_carrier_latency** | **Integer** | The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **calling_number_country_a3** | **String** | Calling number country in A3 format. | [optional] |
| **called_number_country_a3** | **String** | Called number country in A3 format. | [optional] |
| **from_segment_count** | **Integer** | Segment count (start range). | [optional] |
Expand Down
4 changes: 3 additions & 1 deletion docs/OptInWorkflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
| ---- | ---- | ----------- | ----- |
| **description** | **String** | | |
| **image_urls** | **Array<String>** | | |
| **confirmation_response** | **String** | | [optional] |

## Example

Expand All @@ -14,7 +15,8 @@ require 'bandwidth-sdk'

instance = Bandwidth::OptInWorkflow.new(
description: Opt In Flow,
image_urls: null
image_urls: null,
confirmation_response: Thank you for opting in!
)
```

2 changes: 1 addition & 1 deletion docs/RbmActionBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ require 'bandwidth-sdk'
instance = Bandwidth::RbmActionBase.new(
type: null,
text: Hello world,
postback_data: [B@12ebfb2d
postback_data: [B@a93c798
)
```

2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ require 'bandwidth-sdk'

instance = Bandwidth::RbmSuggestionResponse.new(
text: Yes, I would like to proceed,
postback_data: [B@12ebfb2d
postback_data: [B@a93c798
)
```

8 changes: 7 additions & 1 deletion docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
| **business_registration_number** | **String** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |

## Example

Expand All @@ -34,7 +37,10 @@ instance = Bandwidth::TfvSubmissionInfo.new(
isv_reseller: Test ISV,
privacy_policy_url: http://your-company.com/privacyPolicy,
terms_and_conditions_url: http://your-company.com/termsAndConditions,
business_dba: Another Company Name Inc.
business_dba: Another Company Name Inc.,
business_registration_number: 12-3456789,
business_registration_type: null,
business_entity_type: null
)
```

12 changes: 11 additions & 1 deletion docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
| **business_registration_number** | **String** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |

## Example

Expand All @@ -36,7 +41,12 @@ instance = Bandwidth::VerificationRequest.new(
isv_reseller: Test ISV,
privacy_policy_url: http://your-company.com/privacyPolicy,
terms_and_conditions_url: http://your-company.com/termsAndConditions,
business_dba: Another Company Name Inc.
business_dba: Another Company Name Inc.,
business_registration_number: 12-3456789,
business_registration_type: null,
business_entity_type: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false
)
```

12 changes: 11 additions & 1 deletion docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
| **business_registration_number** | **String** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |

## Example

Expand All @@ -34,7 +39,12 @@ instance = Bandwidth::VerificationUpdateRequest.new(
isv_reseller: Test ISV,
privacy_policy_url: http://your-company.com/privacyPolicy,
terms_and_conditions_url: http://your-company.com/termsAndConditions,
business_dba: Another Company Name Inc.
business_dba: Another Company Name Inc.,
business_registration_number: 12-3456789,
business_registration_type: null,
business_entity_type: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false
)
```

2 changes: 2 additions & 0 deletions lib/bandwidth-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
require 'bandwidth-sdk/models/blocked_webhook'
require 'bandwidth-sdk/models/bridge_complete_callback'
require 'bandwidth-sdk/models/bridge_target_complete_callback'
require 'bandwidth-sdk/models/business_entity_type_enum'
require 'bandwidth-sdk/models/business_registration_type_enum'
require 'bandwidth-sdk/models/call_direction_enum'
require 'bandwidth-sdk/models/call_recording_metadata'
require 'bandwidth-sdk/models/call_state'
Expand Down
Loading