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 @@ -12,6 +12,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 @@ -241,6 +242,7 @@ src/main/java/com/bandwidth/sdk/model/BlockedWebhook.java
src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java
src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java
src/main/java/com/bandwidth/sdk/model/BusinessEntityTypeEnum.java
src/main/java/com/bandwidth/sdk/model/BusinessRegistrationIssuingCountryEnum.java
src/main/java/com/bandwidth/sdk/model/BusinessRegistrationTypeEnum.java
src/main/java/com/bandwidth/sdk/model/CallDirectionEnum.java
src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ Class | Method | HTTP request | Description
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
- [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
- [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
- [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
- [CallDirectionEnum](docs/CallDirectionEnum.md)
- [CallRecordingMetadata](docs/CallRecordingMetadata.md)
Expand Down
95 changes: 72 additions & 23 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13725,35 +13725,84 @@ components:
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
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.
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationTypeEnum:
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
type: string
businessRegistrationIssuingCountryEnum:
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
type: string
businessEntityTypeEnum:
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
type: string
helpMessageResponse:
description: A message that gets sent to users requesting help.
Expand Down Expand Up @@ -13872,16 +13921,15 @@ components:
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
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.
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationType:
$ref: "#/components/schemas/businessRegistrationTypeEnum"
businessRegistrationIssuingCountry:
$ref: "#/components/schemas/businessRegistrationIssuingCountryEnum"
businessEntityType:
$ref: "#/components/schemas/businessEntityTypeEnum"
helpMessageResponse:
Expand All @@ -13907,6 +13955,7 @@ components:
required:
- businessAddress
- businessContact
- businessEntityType
- messageVolume
- optInWorkflow
- phoneNumbers
Expand Down Expand Up @@ -13976,10 +14025,7 @@ components:
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
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.
example: 12-3456789
maxLength: 500
nullable: true
Expand All @@ -13988,6 +14034,8 @@ components:
$ref: "#/components/schemas/businessRegistrationTypeEnum"
businessEntityType:
$ref: "#/components/schemas/businessEntityTypeEnum"
businessRegistrationIssuingCountry:
$ref: "#/components/schemas/businessRegistrationIssuingCountryEnum"
helpMessageResponse:
description: A message that gets sent to users requesting help.
example: Please contact support for assistance.
Expand Down Expand Up @@ -14655,6 +14703,7 @@ components:
isvReseller: Test ISV
businessRegistrationNumber: 12-3456789
productionMessageContent: Production message content
businessRegistrationIssuingCountry: USA
businessAddress:
zip: "27606"
addr2: 2230 Bandmate Way
Expand Down Expand Up @@ -14753,6 +14802,7 @@ components:
isvReseller: Test ISV
businessRegistrationNumber: 12-3456789
productionMessageContent: Production message content
businessRegistrationIssuingCountry: USA
businessAddress:
zip: "27606"
addr2: 2230 Bandmate Way
Expand Down Expand Up @@ -14823,16 +14873,15 @@ components:
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
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.
example: 12-3456789
maxLength: 500
nullable: true
type: string
businessRegistrationType:
$ref: "#/components/schemas/businessRegistrationTypeEnum"
businessRegistrationIssuingCountry:
$ref: "#/components/schemas/businessRegistrationIssuingCountryEnum"
businessEntityType:
$ref: "#/components/schemas/businessEntityTypeEnum"
type: object
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
Loading