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
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/BusinessEntityTypeEnum.md
docs/BusinessRegistrationIssuingCountryEnum.md
docs/BusinessRegistrationTypeEnum.md
docs/CallDirectionEnum.md
docs/CallRecordingMetadata.md
Expand Down Expand Up @@ -217,6 +218,7 @@ 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_issuing_country_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
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ Class | Method | HTTP request | Description
- [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
- [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
- [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
- [Bandwidth::BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)
Expand Down
111 changes: 88 additions & 23 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5828,38 +5828,106 @@ components:
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.
description: Government-issued business identifying number.
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.
description: The type of business registration number.
enum:
- EIN
- CBN
- NEQ
- PROVINCIAL_NUMBER
- CRN
- VAT
- ACN
- ABN
- BRN
- SIREN
- SIRET
- NZBN
- UST_IDNR
- CIF
- NIF
- CNPJ
- UID
- OTHER
nullable: true
businessRegistrationIssuingCountryEnum:
type: string
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
| Registration Type | Supported Countries |
|----------------------|------------------------------------|
| EIN | USA |
| CBN | CAN |
| NEQ | CAN |
| PROVINCIAL_NUMBER | CAN |
| CRN | GBR, HKG |
| VAT | GBR, IRL, BRA, NLD |
| ACN | AUS |
| ABN | AUS |
| BRN | HKG |
| SIREN | FRA |
| SIRET | FRA |
| NZBN | NZL |
| UST_IDNR | DEU |
| CIF | ESP |
| NIF | ESP |
| CNPJ | BRA |
| UID | CHE |
| OTHER | Must Provide Country Code |
enum:
- USA
- CAN
- HKG
- GBR
- IRL
- BRA
- NLD
- AUS
- FRA
- NZL
- DEU
- ESP
- CHE
nullable: false
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.
provide "SOLE_PROPRIETOR" as a value.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
nullable: true
nullable: false
helpMessageResponse:
type: string
description: A message that gets sent to users requesting help.
Expand Down Expand Up @@ -5914,6 +5982,7 @@ components:
- useCaseSummary
- productionMessageContent
- optInWorkflow
- businessEntityType
properties:
businessAddress:
$ref: '#/components/schemas/address'
Expand Down Expand Up @@ -5958,6 +6027,8 @@ components:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
Expand Down Expand Up @@ -6011,6 +6082,8 @@ components:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
Expand Down Expand Up @@ -6503,20 +6576,12 @@ components:
$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.
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
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
15 changes: 15 additions & 0 deletions docs/BusinessRegistrationIssuingCountryEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth::BusinessRegistrationIssuingCountryEnum

## Properties

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

## Example

```ruby
require 'bandwidth-sdk'

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

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@768d27e8
postback_data: [B@177302d6
)
```

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@768d27e8
postback_data: [B@177302d6
)
```

4 changes: 3 additions & 1 deletion docs/TfvSubmissionInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +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_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |

## Example
Expand All @@ -40,6 +41,7 @@ instance = Bandwidth::TfvSubmissionInfo.new(
business_dba: Another Company Name Inc.,
business_registration_number: 12-3456789,
business_registration_type: null,
business_registration_issuing_country: null,
business_entity_type: null
)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/TollFreeVerificationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ end

api_instance = Bandwidth::TollFreeVerificationApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
verification_request = Bandwidth::VerificationRequest.new({business_address: Bandwidth::Address.new({name: 'Bandwidth Inc.', addr1: '2230 Bandmate Way', city: 'Raleigh', state: 'NC', zip: '27606', url: 'https://www.example.com/path/to/resource'}), business_contact: Bandwidth::Contact.new({first_name: 'John', last_name: 'Doe', email: 'foo@bar.com', phone_number: '+19192654500'}), message_volume: 10000, phone_numbers: ['+18005555555'], use_case: '2FA', use_case_summary: 'Text summarizing the use case for the toll-free number', production_message_content: 'Production message content', opt_in_workflow: Bandwidth::OptInWorkflow.new({description: 'Opt In Flow', image_urls: ['https://www.example.com/path/to/resource']})}) # VerificationRequest | Request for verification of a toll-free phone number.
verification_request = Bandwidth::VerificationRequest.new({business_address: Bandwidth::Address.new({name: 'Bandwidth Inc.', addr1: '2230 Bandmate Way', city: 'Raleigh', state: 'NC', zip: '27606', url: 'https://www.example.com/path/to/resource'}), business_contact: Bandwidth::Contact.new({first_name: 'John', last_name: 'Doe', email: 'foo@bar.com', phone_number: '+19192654500'}), message_volume: 10000, phone_numbers: ['+18005555555'], use_case: '2FA', use_case_summary: 'Text summarizing the use case for the toll-free number', production_message_content: 'Production message content', opt_in_workflow: Bandwidth::OptInWorkflow.new({description: 'Opt In Flow', image_urls: ['https://www.example.com/path/to/resource']}), business_entity_type: Bandwidth::BusinessEntityTypeEnum::SOLE_PROPRIETOR}) # VerificationRequest | Request for verification of a toll-free phone number.

begin
# Request Toll-Free Verification
Expand Down
6 changes: 4 additions & 2 deletions docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
| **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_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
| **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] |
| **cv_token** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] |
Expand All @@ -45,6 +46,7 @@ instance = Bandwidth::VerificationRequest.new(
business_dba: Another Company Name Inc.,
business_registration_number: 12-3456789,
business_registration_type: null,
business_registration_issuing_country: null,
business_entity_type: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false,
Expand Down
4 changes: 3 additions & 1 deletion docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@
| **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_number** | **String** | Government-issued business identifying number. | [optional] |
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.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] |
| **cv_token** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] |
Expand All @@ -44,6 +45,7 @@ instance = Bandwidth::VerificationUpdateRequest.new(
business_registration_number: 12-3456789,
business_registration_type: null,
business_entity_type: null,
business_registration_issuing_country: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false,
cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
Expand Down
1 change: 1 addition & 0 deletions lib/bandwidth-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
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_issuing_country_enum'
require 'bandwidth-sdk/models/business_registration_type_enum'
require 'bandwidth-sdk/models/call_direction_enum'
require 'bandwidth-sdk/models/call_recording_metadata'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
=begin
#Bandwidth

#Bandwidth's Communication APIs

The version of the OpenAPI document: 1.0.0
Contact: letstalk@bandwidth.com
Generated by: https://openapi-generator.tech
Generator version: 7.17.0

=end

require 'date'
require 'time'

module Bandwidth
class BusinessRegistrationIssuingCountryEnum
USA = 'USA'.freeze
CAN = 'CAN'.freeze
HKG = 'HKG'.freeze
GBR = 'GBR'.freeze
IRL = 'IRL'.freeze
BRA = 'BRA'.freeze
NLD = 'NLD'.freeze
AUS = 'AUS'.freeze
FRA = 'FRA'.freeze
NZL = 'NZL'.freeze
DEU = 'DEU'.freeze
ESP = 'ESP'.freeze
CHE = 'CHE'.freeze

def self.all_vars
@all_vars ||= [USA, CAN, HKG, GBR, IRL, BRA, NLD, AUS, FRA, NZL, DEU, ESP, CHE].freeze
end

# Builds the enum from string
# @param [String] The enum value in the form of the string
# @return [String] The enum value
def self.build_from_hash(value)
new.build_from_hash(value)
end

# Builds the enum from string
# @param [String] The enum value in the form of the string
# @return [String] The enum value
def build_from_hash(value)
return value if BusinessRegistrationIssuingCountryEnum.all_vars.include?(value)
raise "Invalid ENUM value #{value} for class #BusinessRegistrationIssuingCountryEnum"
end
end
end
18 changes: 17 additions & 1 deletion lib/bandwidth-sdk/models/business_registration_type_enum.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,25 @@ module Bandwidth
class BusinessRegistrationTypeEnum
EIN = 'EIN'.freeze
CBN = 'CBN'.freeze
NEQ = 'NEQ'.freeze
PROVINCIAL_NUMBER = 'PROVINCIAL_NUMBER'.freeze
CRN = 'CRN'.freeze
VAT = 'VAT'.freeze
ACN = 'ACN'.freeze
ABN = 'ABN'.freeze
BRN = 'BRN'.freeze
SIREN = 'SIREN'.freeze
SIRET = 'SIRET'.freeze
NZBN = 'NZBN'.freeze
UST_IDNR = 'UST_IDNR'.freeze
CIF = 'CIF'.freeze
NIF = 'NIF'.freeze
CNPJ = 'CNPJ'.freeze
UID = 'UID'.freeze
OTHER = 'OTHER'.freeze

def self.all_vars
@all_vars ||= [EIN, CBN].freeze
@all_vars ||= [EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER].freeze
end

# Builds the enum from string
Expand Down
Loading