Skip to content

Commit d4f50c6

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-10425 Update SDK Based on Recent Spec Changes (#201)
* Generate SDK with OpenAPI Generator Version * remove old models * update test --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent 37502ba commit d4f50c6

19 files changed

Lines changed: 64 additions & 138 deletions

.openapi-generator/FILES

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ docs/BlockedWebhook.md
1313
docs/BridgeCompleteCallback.md
1414
docs/BridgeTargetCompleteCallback.md
1515
docs/BusinessEntityTypeEnum.md
16-
docs/BusinessRegistrationIssuingCountryEnum.md
1716
docs/BusinessRegistrationTypeEnum.md
1817
docs/CallDirectionEnum.md
1918
docs/CallRecordingMetadata.md
@@ -218,7 +217,6 @@ lib/bandwidth-sdk/models/blocked_webhook.rb
218217
lib/bandwidth-sdk/models/bridge_complete_callback.rb
219218
lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
220219
lib/bandwidth-sdk/models/business_entity_type_enum.rb
221-
lib/bandwidth-sdk/models/business_registration_issuing_country_enum.rb
222220
lib/bandwidth-sdk/models/business_registration_type_enum.rb
223221
lib/bandwidth-sdk/models/call_direction_enum.rb
224222
lib/bandwidth-sdk/models/call_recording_metadata.rb

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ 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)
184183
- [Bandwidth::BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
185184
- [Bandwidth::CallDirectionEnum](docs/CallDirectionEnum.md)
186185
- [Bandwidth::CallRecordingMetadata](docs/CallRecordingMetadata.md)

bandwidth.yml

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ paths:
9595
under this account, the previous file will be overwritten.
9696
9797
98-
A list of supported media types can be found
99-
[here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
98+
A list of supported media types can be found at [Bandwidth
99+
Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
100100
operationId: uploadMedia
101101
tags:
102102
- Media
@@ -2255,8 +2255,8 @@ components:
22552255
22562256
For MMS, the API limits file size to 3.5MB. Specific carriers and
22572257
channels may have a smaller limit that could cause a large file to
2258-
fail, see
2259-
[here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits)
2258+
fail, see more at [Bandwidth
2259+
Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits)
22602260
for more details.
22612261
example: https://dev.bandwidth.com/images/bandwidth-logo.png
22622262
maxLength: 1000
@@ -5887,17 +5887,21 @@ components:
58875887
Government-issued business identifying number.
58885888
58895889
5890-
**Note:** If this field is provided, it is strongly recommended to also
5891-
provide `businessRegistrationType` and
5892-
`businessRegistrationIssuingCountry`. Submissions missing these fields
5893-
have a high likelihood of rejection.
5890+
**Note: As of October 19th, 2026 this field will be required when
5891+
`businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is
5892+
provided, `businessRegistrationType` and
5893+
`businessRegistrationIssuingCountry` are also required.**
58945894
nullable: true
58955895
maxLength: 500
58965896
example: 12-3456789
58975897
businessRegistrationTypeEnum:
58985898
type: string
5899-
description: |
5899+
description: >
59005900
The type of business registration number.
5901+
5902+
5903+
**Note: As of October 19th, 2026 this field will be required when
5904+
`businessRegistrationNumber` is provided.**
59015905
enum:
59025906
- EIN
59035907
- CBN
@@ -5919,20 +5923,16 @@ components:
59195923
- OTHER
59205924
example: EIN
59215925
nullable: true
5922-
businessRegistrationIssuingCountryEnum:
5926+
businessRegistrationIssuingCountry:
59235927
type: string
59245928
description: >-
59255929
The country issuing the business registration in ISO-3166-1 alpha-3
5926-
format. Alpha-2 country codes are acceptable, but the application will
5927-
convert them to alpha-3 when received, so alpha-3 is encouraged.
5930+
format. Alpha-2 format is accepted by the API, but alpha-3 is highly
5931+
encouraged.
59285932
59295933
5930-
**Note:** If this field is omitted but `businessRegistrationType` is
5931-
provided, the application will attempt to infer the country based on the
5932-
registration type. However, if the application cannot confidently infer
5933-
the country, the submission may be rejected. To ensure the highest
5934-
likelihood of acceptance, it is recommended to provide both
5935-
`businessRegistrationType` and `businessRegistrationIssuingCountry`.
5934+
**Note: As of October 19th, 2026 this field will be required when
5935+
`businessRegistrationNumber` is provided.**
59365936
59375937
59385938
| Registration Type | Supported Countries |
@@ -5974,30 +5974,22 @@ components:
59745974
| UID | CHE |
59755975
59765976
| OTHER | Must Provide Country Code |
5977-
enum:
5978-
- USA
5979-
- CAN
5980-
- HKG
5981-
- GBR
5982-
- IRL
5983-
- BRA
5984-
- NLD
5985-
- AUS
5986-
- FRA
5987-
- NZL
5988-
- DEU
5989-
- ESP
5990-
- CHE
5991-
- CYP
5992-
- IND
5993-
- CHN
5994-
- BGR
59955977
example: USA
5996-
nullable: false
5978+
nullable: true
59975979
businessEntityTypeEnum:
59985980
type: string
5999-
description: |
5981+
description: >
60005982
The type of registered business.
5983+
5984+
5985+
**Note: As of October 19th, 2026 submissions using a value other than
5986+
`SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`,
5987+
`businessRegistrationType`, and `businessRegistrationIssuingCountry`.
5988+
5989+
Submissions using `SOLE_PROPRIETOR` must _omit_
5990+
`businessRegistrationNumber`, `businessRegistrationType`, and
5991+
`businessRegistrationIssuingCountry`. Failure to adhere to these
5992+
constraints will result in a 400 Bad Request rejection.**
60015993
enum:
60025994
- SOLE_PROPRIETOR
60035995
- PRIVATE_PROFIT
@@ -6106,7 +6098,7 @@ components:
61066098
businessRegistrationType:
61076099
$ref: '#/components/schemas/businessRegistrationTypeEnum'
61086100
businessRegistrationIssuingCountry:
6109-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6101+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
61106102
businessEntityType:
61116103
$ref: '#/components/schemas/businessEntityTypeEnum'
61126104
helpMessageResponse:
@@ -6161,7 +6153,7 @@ components:
61616153
businessEntityType:
61626154
$ref: '#/components/schemas/businessEntityTypeEnum'
61636155
businessRegistrationIssuingCountry:
6164-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6156+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
61656157
helpMessageResponse:
61666158
$ref: '#/components/schemas/helpMessageResponse'
61676159
ageGatedContent:
@@ -6657,13 +6649,15 @@ components:
66576649
description: Government-issued business identifying number.
66586650
businessRegistrationType:
66596651
$ref: '#/components/schemas/businessRegistrationTypeEnum'
6652+
description: The type of business registration number.
66606653
businessRegistrationIssuingCountry:
6661-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6654+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
66626655
description: >-
66636656
The country issuing the business registration in ISO-3166-1 alpha-3
66646657
format.
66656658
businessEntityType:
66666659
$ref: '#/components/schemas/businessEntityTypeEnum'
6660+
description: The type of registered business.
66676661
tfvStatusEnum:
66686662
type: string
66696663
enum:

docs/BusinessRegistrationIssuingCountryEnum.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/MediaApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ end
242242
243243
Upload Media
244244

245-
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
245+
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
246246

247247
### Examples
248248

docs/MmsMessageContentFile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **file_url** | **String** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | |
7+
| **file_url** | **String** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. | |
88

99
## Example
1010

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@4693d24f
19+
postback_data: [B@662d3e85
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@4693d24f
17+
postback_data: [B@662d3e85
1818
)
1919
```
2020

docs/TfvSubmissionInfo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +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** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60;. Submissions missing these fields have a high likelihood of rejection. | [optional] |
19+
| **business_registration_number** | **String** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when &#x60;businessEntityType&#x60; is _not_ &#x60;SOLE_PROPRIETOR&#x60;. If this field is provided, &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60; are also required.** | [optional] |
2020
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
21-
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
21+
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when &#x60;businessRegistrationNumber&#x60; is provided.** | 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 | | [optional] |
2222
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
2323

2424
## Example
@@ -41,7 +41,7 @@ instance = Bandwidth::TfvSubmissionInfo.new(
4141
business_dba: Another Company Name Inc.,
4242
business_registration_number: 12-3456789,
4343
business_registration_type: null,
44-
business_registration_issuing_country: null,
44+
business_registration_issuing_country: USA,
4545
business_entity_type: null
4646
)
4747
```

docs/VerificationRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
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** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60;. Submissions missing these fields have a high likelihood of rejection. | [optional] |
20+
| **business_registration_number** | **String** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when &#x60;businessEntityType&#x60; is _not_ &#x60;SOLE_PROPRIETOR&#x60;. If this field is provided, &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60; are also required.** | [optional] |
2121
| **business_registration_type** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] |
22-
| **business_registration_issuing_country** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] |
22+
| **business_registration_issuing_country** | **String** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when &#x60;businessRegistrationNumber&#x60; is provided.** | 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 | | [optional] |
2323
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | |
2424
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
2525
| **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
@@ -46,7 +46,7 @@ instance = Bandwidth::VerificationRequest.new(
4646
business_dba: Another Company Name Inc.,
4747
business_registration_number: 12-3456789,
4848
business_registration_type: null,
49-
business_registration_issuing_country: null,
49+
business_registration_issuing_country: USA,
5050
business_entity_type: null,
5151
help_message_response: Please contact support for assistance.,
5252
age_gated_content: false,

0 commit comments

Comments
 (0)