Skip to content

Commit f9ec08f

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-9666 Update SDK Based on Recent Spec Changes (#105)
* Generate SDK with OpenAPI Generator Version * unit tests --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent 0f0c383 commit f9ec08f

19 files changed

+283
-39
lines changed

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ docs/BlockedWebhook.md
2424
docs/BridgeCompleteCallback.md
2525
docs/BridgeTargetCompleteCallback.md
2626
docs/BusinessEntityTypeEnum.md
27+
docs/BusinessRegistrationIssuingCountryEnum.md
2728
docs/BusinessRegistrationTypeEnum.md
2829
docs/CallDirectionEnum.md
2930
docs/CallRecordingMetadata.md
@@ -213,6 +214,7 @@ models/blocked-webhook.ts
213214
models/bridge-complete-callback.ts
214215
models/bridge-target-complete-callback.ts
215216
models/business-entity-type-enum.ts
217+
models/business-registration-issuing-country-enum.ts
216218
models/business-registration-type-enum.ts
217219
models/call-direction-enum.ts
218220
models/call-recording-metadata.ts

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
169169
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
170170
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
171171
- [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
172+
- [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
172173
- [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
173174
- [CallDirectionEnum](docs/CallDirectionEnum.md)
174175
- [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/BusinessEntityTypeEnum.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# BusinessEntityTypeEnum
22

3-
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.
3+
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
44

55
## Enum
66

‎docs/BusinessRegistrationIssuingCountryEnum.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# BusinessRegistrationIssuingCountryEnum
2+
3+
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 |
4+
5+
## Enum
6+
7+
* `Usa` (value: `'USA'`)
8+
9+
* `Can` (value: `'CAN'`)
10+
11+
* `Hkg` (value: `'HKG'`)
12+
13+
* `Gbr` (value: `'GBR'`)
14+
15+
* `Irl` (value: `'IRL'`)
16+
17+
* `Bra` (value: `'BRA'`)
18+
19+
* `Nld` (value: `'NLD'`)
20+
21+
* `Aus` (value: `'AUS'`)
22+
23+
* `Fra` (value: `'FRA'`)
24+
25+
* `Nzl` (value: `'NZL'`)
26+
27+
* `Deu` (value: `'DEU'`)
28+
29+
* `Esp` (value: `'ESP'`)
30+
31+
* `Che` (value: `'CHE'`)
32+
33+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/BusinessRegistrationTypeEnum.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,43 @@
11
# BusinessRegistrationTypeEnum
22

3-
The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
3+
The type of business registration number.
44

55
## Enum
66

77
* `Ein` (value: `'EIN'`)
88

99
* `Cbn` (value: `'CBN'`)
1010

11+
* `Neq` (value: `'NEQ'`)
12+
13+
* `ProvincialNumber` (value: `'PROVINCIAL_NUMBER'`)
14+
15+
* `Crn` (value: `'CRN'`)
16+
17+
* `Vat` (value: `'VAT'`)
18+
19+
* `Acn` (value: `'ACN'`)
20+
21+
* `Abn` (value: `'ABN'`)
22+
23+
* `Brn` (value: `'BRN'`)
24+
25+
* `Siren` (value: `'SIREN'`)
26+
27+
* `Siret` (value: `'SIRET'`)
28+
29+
* `Nzbn` (value: `'NZBN'`)
30+
31+
* `UstIdnr` (value: `'UST_IDNR'`)
32+
33+
* `Cif` (value: `'CIF'`)
34+
35+
* `Nif` (value: `'NIF'`)
36+
37+
* `Cnpj` (value: `'CNPJ'`)
38+
39+
* `Uid` (value: `'UID'`)
40+
41+
* `Other` (value: `'OTHER'`)
42+
1143
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/TfvSubmissionInfo.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ Name | Type | Description | Notes
1717
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
1818
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
1919
**businessDba** | **string** | The company \&#39;Doing Business As\&#39;. | [optional] [default to undefined]
20-
**businessRegistrationNumber** | **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] [default to undefined]
20+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
2121
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
22+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
2223
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
2324

2425
## Example
@@ -41,6 +42,7 @@ const instance: TfvSubmissionInfo = {
4142
businessDba,
4243
businessRegistrationNumber,
4344
businessRegistrationType,
45+
businessRegistrationIssuingCountry,
4446
businessEntityType,
4547
};
4648
```

‎docs/VerificationRequest.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ Name | Type | Description | Notes
1818
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
1919
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
2020
**businessDba** | **string** | The company \&#39;Doing Business As\&#39;. | [optional] [default to undefined]
21-
**businessRegistrationNumber** | **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] [default to undefined]
21+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
2222
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
23-
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
23+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
24+
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
2425
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
2526
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
2627
**cvToken** | **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] [default to undefined]
@@ -46,6 +47,7 @@ const instance: VerificationRequest = {
4647
businessDba,
4748
businessRegistrationNumber,
4849
businessRegistrationType,
50+
businessRegistrationIssuingCountry,
4951
businessEntityType,
5052
helpMessageResponse,
5153
ageGatedContent,

‎docs/VerificationUpdateRequest.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ Name | Type | Description | Notes
1717
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
1818
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
1919
**businessDba** | **string** | The company \&#39;Doing Business As\&#39;. | [optional] [default to undefined]
20-
**businessRegistrationNumber** | **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] [default to undefined]
20+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
2121
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
2222
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
23+
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
2324
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
2425
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
2526
**cvToken** | **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] [default to undefined]
@@ -45,6 +46,7 @@ const instance: VerificationUpdateRequest = {
4546
businessRegistrationNumber,
4647
businessRegistrationType,
4748
businessEntityType,
49+
businessRegistrationIssuingCountry,
4850
helpMessageResponse,
4951
ageGatedContent,
5052
cvToken,

‎models/business-entity-type-enum.ts‎

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

1616

1717
/**
18-
* 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.
18+
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
1919
*/
2020

2121
export const BusinessEntityTypeEnum = {

0 commit comments

Comments
 (0)