Skip to content

Commit ab2f956

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-9676 Update SDK Based on Recent Spec Changes (#194)
* Generate SDK with OpenAPI Generator Version * update unit test --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent 579d5f5 commit ab2f956

17 files changed

+242
-40
lines changed

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ docs/BlockedWebhook.md
1313
docs/BridgeCompleteCallback.md
1414
docs/BridgeTargetCompleteCallback.md
1515
docs/BusinessEntityTypeEnum.md
16+
docs/BusinessRegistrationIssuingCountryEnum.md
1617
docs/BusinessRegistrationTypeEnum.md
1718
docs/CallDirectionEnum.md
1819
docs/CallRecordingMetadata.md
@@ -217,6 +218,7 @@ lib/bandwidth-sdk/models/blocked_webhook.rb
217218
lib/bandwidth-sdk/models/bridge_complete_callback.rb
218219
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
219220
lib/bandwidth-sdk/models/business_entity_type_enum.rb
221+
lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb
220222
lib/bandwidth-sdk/models/business_registration_type_enum.rb
221223
lib/bandwidth-sdk/models/call_direction_enum.rb
222224
lib/bandwidth-sdk/models/call_recording_metadata.rb

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ Class | Method | HTTP request | Description
180180
- [Bandwidth::BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
181181
- [Bandwidth::BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
182182
- [Bandwidth::BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
183+
- [Bandwidth::BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
183184
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
184185
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
185186
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)

‎bandwidth.yml‎

Lines changed: 88 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5828,38 +5828,106 @@ components:
58285828
type: string
58295829
businessRegistrationNumber:
58305830
type: string
5831-
description: >-
5832-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
5833-
until early 2026. If a value is provided for this field, a value must be
5834-
provided for `businessRegistrationType` and `businessEntityType`.
5835-
Available starting October 1st, 2025.
5831+
description: Government-issued business identifying number.
58365832
nullable: true
58375833
maxLength: 500
58385834
example: 12-3456789
58395835
businessRegistrationTypeEnum:
58405836
type: string
5841-
description: >-
5842-
The type of business registration number. Optional until early 2026;
5843-
required if `businessRegistrationNumber` is provided. Available starting
5844-
October 1st, 2025.
5837+
description: The type of business registration number.
58455838
enum:
58465839
- EIN
58475840
- CBN
5841+
- NEQ
5842+
- PROVINCIAL_NUMBER
5843+
- CRN
5844+
- VAT
5845+
- ACN
5846+
- ABN
5847+
- BRN
5848+
- SIREN
5849+
- SIRET
5850+
- NZBN
5851+
- UST_IDNR
5852+
- CIF
5853+
- NIF
5854+
- CNPJ
5855+
- UID
5856+
- OTHER
58485857
nullable: true
5858+
businessRegistrationIssuingCountryEnum:
5859+
type: string
5860+
description: >-
5861+
The country issuing the business registration in ISO-3166-1 alpha-3
5862+
format.
5863+
5864+
5865+
| Registration Type | Supported Countries |
5866+
5867+
|----------------------|------------------------------------|
5868+
5869+
| EIN | USA |
5870+
5871+
| CBN | CAN |
5872+
5873+
| NEQ | CAN |
5874+
5875+
| PROVINCIAL_NUMBER | CAN |
5876+
5877+
| CRN | GBR, HKG |
5878+
5879+
| VAT | GBR, IRL, BRA, NLD |
5880+
5881+
| ACN | AUS |
5882+
5883+
| ABN | AUS |
5884+
5885+
| BRN | HKG |
5886+
5887+
| SIREN | FRA |
5888+
5889+
| SIRET | FRA |
5890+
5891+
| NZBN | NZL |
5892+
5893+
| UST_IDNR | DEU |
5894+
5895+
| CIF | ESP |
5896+
5897+
| NIF | ESP |
5898+
5899+
| CNPJ | BRA |
5900+
5901+
| UID | CHE |
5902+
5903+
| OTHER | Must Provide Country Code |
5904+
enum:
5905+
- USA
5906+
- CAN
5907+
- HKG
5908+
- GBR
5909+
- IRL
5910+
- BRA
5911+
- NLD
5912+
- AUS
5913+
- FRA
5914+
- NZL
5915+
- DEU
5916+
- ESP
5917+
- CHE
5918+
nullable: false
58495919
businessEntityTypeEnum:
58505920
type: string
58515921
description: >-
58525922
The type of registered business. If no option is applicable, please
5853-
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
5854-
required if `businessRegistrationNumber` is provided. Available starting
5855-
October 1st, 2025.
5923+
provide "SOLE_PROPRIETOR" as a value.
58565924
enum:
58575925
- SOLE_PROPRIETOR
58585926
- PRIVATE_PROFIT
58595927
- PUBLIC_PROFIT
58605928
- NON_PROFIT
58615929
- GOVERNMENT
5862-
nullable: true
5930+
nullable: false
58635931
helpMessageResponse:
58645932
type: string
58655933
description: A message that gets sent to users requesting help.
@@ -5914,6 +5982,7 @@ components:
59145982
- useCaseSummary
59155983
- productionMessageContent
59165984
- optInWorkflow
5985+
- businessEntityType
59175986
properties:
59185987
businessAddress:
59195988
$ref: '#/components/schemas/address'
@@ -5958,6 +6027,8 @@ components:
59586027
$ref: '#/components/schemas/businessRegistrationNumber'
59596028
businessRegistrationType:
59606029
$ref: '#/components/schemas/businessRegistrationTypeEnum'
6030+
businessRegistrationIssuingCountry:
6031+
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
59616032
businessEntityType:
59626033
$ref: '#/components/schemas/businessEntityTypeEnum'
59636034
helpMessageResponse:
@@ -6011,6 +6082,8 @@ components:
60116082
$ref: '#/components/schemas/businessRegistrationTypeEnum'
60126083
businessEntityType:
60136084
$ref: '#/components/schemas/businessEntityTypeEnum'
6085+
businessRegistrationIssuingCountry:
6086+
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
60146087
helpMessageResponse:
60156088
$ref: '#/components/schemas/helpMessageResponse'
60166089
ageGatedContent:
@@ -6503,20 +6576,12 @@ components:
65036576
$ref: '#/components/schemas/businessDba'
65046577
businessRegistrationNumber:
65056578
$ref: '#/components/schemas/businessRegistrationNumber'
6506-
description: >-
6507-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
6508-
Available starting October 1st, 2025.
65096579
businessRegistrationType:
65106580
$ref: '#/components/schemas/businessRegistrationTypeEnum'
6511-
description: >-
6512-
The type of business registration number. Available starting October
6513-
1st, 2025.
6581+
businessRegistrationIssuingCountry:
6582+
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
65146583
businessEntityType:
65156584
$ref: '#/components/schemas/businessEntityTypeEnum'
6516-
description: >-
6517-
The type of registered business. If no option is applicable, please
6518-
provide "SOLE_PROPRIETOR" as a value. Available starting October
6519-
1st, 2025.
65206585
tfvStatusEnum:
65216586
type: string
65226587
enum:

‎docs/BusinessRegistrationIssuingCountryEnum.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Bandwidth::BusinessRegistrationIssuingCountryEnum
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
8+
## Example
9+
10+
```ruby
11+
require 'bandwidth-sdk'
12+
13+
instance = Bandwidth::BusinessRegistrationIssuingCountryEnum.new()
14+
```
15+

‎docs/RbmActionBase.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
1616
instance = Bandwidth::RbmActionBase.new(
1717
type: null,
1818
text: Hello world,
19-
postback_data: [B@768d27e8
19+
postback_data: [B@177302d6
2020
)
2121
```
2222

‎docs/RbmSuggestionResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
1414

1515
instance = Bandwidth::RbmSuggestionResponse.new(
1616
text: Yes, I would like to proceed,
17-
postback_data: [B@768d27e8
17+
postback_data: [B@177302d6
1818
)
1919
```
2020

‎docs/TfvSubmissionInfo.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@
1616
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
1717
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
1818
| **business_dba** | **String** | The company &#39;Doing Business As&#39;. | [optional] |
19-
| **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 &#x60;businessRegistrationType&#x60; and &#x60;businessEntityType&#x60;. Available starting October 1st, 2025. | [optional] |
19+
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
2020
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21+
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
2122
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
2223

2324
## Example
@@ -40,6 +41,7 @@ instance = Bandwidth::TfvSubmissionInfo.new(
4041
business_dba: Another Company Name Inc.,
4142
business_registration_number: 12-3456789,
4243
business_registration_type: null,
44+
business_registration_issuing_country: null,
4345
business_entity_type: null
4446
)
4547
```

‎docs/TollFreeVerificationApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,7 @@ end
481481

482482
api_instance = Bandwidth::TollFreeVerificationApi.new
483483
account_id = '9900000' # String | Your Bandwidth Account ID.
484-
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.
484+
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.
485485

486486
begin
487487
# Request Toll-Free Verification

‎docs/VerificationRequest.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
1818
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
1919
| **business_dba** | **String** | The company &#39;Doing Business As&#39;. | [optional] |
20-
| **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 &#x60;businessRegistrationType&#x60; and &#x60;businessEntityType&#x60;. Available starting October 1st, 2025. | [optional] |
20+
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
2121
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
22-
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
22+
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
23+
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
2324
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
2425
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
2526
| **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] |
@@ -45,6 +46,7 @@ instance = Bandwidth::VerificationRequest.new(
4546
business_dba: Another Company Name Inc.,
4647
business_registration_number: 12-3456789,
4748
business_registration_type: null,
49+
business_registration_issuing_country: null,
4850
business_entity_type: null,
4951
help_message_response: Please contact support for assistance.,
5052
age_gated_content: false,

‎docs/VerificationUpdateRequest.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@
1616
| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
1717
| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
1818
| **business_dba** | **String** | The company &#39;Doing Business As&#39;. | [optional] |
19-
| **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 &#x60;businessRegistrationType&#x60; and &#x60;businessEntityType&#x60;. Available starting October 1st, 2025. | [optional] |
19+
| **business_registration_number** | **String** | Government-issued business identifying number. | [optional] |
2020
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
2121
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
22+
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
2223
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
2324
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
2425
| **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] |
@@ -44,6 +45,7 @@ instance = Bandwidth::VerificationUpdateRequest.new(
4445
business_registration_number: 12-3456789,
4546
business_registration_type: null,
4647
business_entity_type: null,
48+
business_registration_issuing_country: null,
4749
help_message_response: Please contact support for assistance.,
4850
age_gated_content: false,
4951
cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw

0 commit comments

Comments
 (0)