Skip to content

SWI-10044 Update SDK Based on Recent Spec Changes #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
band-swi-release-engineering wants to merge 1 commit into from
Closed

SWI-10044 Update SDK Based on Recent Spec Changes #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 0 additions & 2 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ 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 @@ -214,7 +213,6 @@ models/blocked-webhook.ts
models/bridge-complete-callback.ts
models/bridge-target-complete-callback.ts
models/business-entity-type-enum.ts
models/business-registration-issuing-country-enum.ts
models/business-registration-type-enum.ts
models/call-direction-enum.ts
models/call-recording-metadata.ts
Expand Down
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ 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
54 changes: 30 additions & 24 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5828,13 +5828,21 @@ components:
type: string
businessRegistrationNumber:
type: string
description: Government-issued business identifying number.
description: >
Government-issued business identifying number.


**Note:** If this field is provided, it is strongly recommended to also
provide `businessRegistrationType` and
`businessRegistrationIssuingCountry`. Submissions missing these fields
have a high likelihood of rejection.
nullable: true
maxLength: 500
example: 12-3456789
businessRegistrationTypeEnum:
type: string
description: The type of business registration number.
description: |
The type of business registration number.
enum:
- EIN
- CBN
Expand All @@ -5855,11 +5863,20 @@ components:
- UID
- OTHER
nullable: true
businessRegistrationIssuingCountryEnum:
businessRegistrationIssuingCountry:
type: string
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
format. Alpha-2 country codes are acceptable, but the application will
convert them to alpha-3 when received, so alpha-3 is encouraged.


**Note:** If this field is omitted but `businessRegistrationType` is
provided, the application will attempt to infer the country based on the
registration type. However, if the application cannot confidently infer
the country, the submission may be rejected. To ensure the highest
likelihood of acceptance, it is recommended to provide both
`businessRegistrationType` and `businessRegistrationIssuingCountry`.


| Registration Type | Supported Countries |
Expand Down Expand Up @@ -5901,26 +5918,11 @@ components:
| 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.
description: |
The type of registered business.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
Expand Down Expand Up @@ -6028,7 +6030,7 @@ components:
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
Expand Down Expand Up @@ -6083,7 +6085,7 @@ components:
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
Expand Down Expand Up @@ -6576,10 +6578,14 @@ components:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
description: Government-issued business identifying number.
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessRegistrationIssuingCountry:
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
description: >-
The country issuing the business registration in ISO-3166-1 alpha-3
format.
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
tfvStatusEnum:
Expand Down
2 changes: 1 addition & 1 deletion docs/BusinessEntityTypeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BusinessEntityTypeEnum

The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
The type of registered business.

## Enum

Expand Down
2 changes: 1 addition & 1 deletion docs/BusinessRegistrationTypeEnum.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BusinessRegistrationTypeEnum

The type of business registration number.
The type of business registration number.

## Enum

Expand Down
4 changes: 2 additions & 2 deletions docs/TfvSubmissionInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | 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] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]

## Example
Expand Down
4 changes: 2 additions & 2 deletions docs/VerificationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | 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] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
Expand Down
4 changes: 2 additions & 2 deletions docs/VerificationUpdateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Name | Type | Description | Notes
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. | [optional] [default to undefined]
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection. | [optional] [default to undefined]
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | 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] [default to undefined]
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
**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]
Expand Down
2 changes: 1 addition & 1 deletion models/business-entity-type-enum.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value.
* The type of registered business.
*/

export const BusinessEntityTypeEnum = {
Expand Down
2 changes: 1 addition & 1 deletion models/business-registration-type-enum.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* The type of business registration number.
* The type of business registration number.
*/

export const BusinessRegistrationTypeEnum = {
Expand Down
1 change: 0 additions & 1 deletion models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export * from './blocked-webhook';
export * from './bridge-complete-callback';
export * from './bridge-target-complete-callback';
export * from './business-entity-type-enum';
export * from './business-registration-issuing-country-enum';
export * from './business-registration-type-enum';
export * from './call-direction-enum';
export * from './call-recording-metadata';
Expand Down
Loading
Loading