diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 805e8a2..665ecea 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -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 @@ -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 diff --git a/README.md b/README.md index 008a264..1f44d1e 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/bandwidth.yml b/bandwidth.yml index 4948dd1..0c6582e 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -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 @@ -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 | @@ -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 @@ -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: @@ -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: @@ -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: diff --git a/docs/BusinessEntityTypeEnum.md b/docs/BusinessEntityTypeEnum.md index 9dc7e32..5ed6e5d 100644 --- a/docs/BusinessEntityTypeEnum.md +++ b/docs/BusinessEntityTypeEnum.md @@ -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 diff --git a/docs/BusinessRegistrationTypeEnum.md b/docs/BusinessRegistrationTypeEnum.md index bddf103..5d119b0 100644 --- a/docs/BusinessRegistrationTypeEnum.md +++ b/docs/BusinessRegistrationTypeEnum.md @@ -1,6 +1,6 @@ # BusinessRegistrationTypeEnum -The type of business registration number. +The type of business registration number. ## Enum diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index c322b77..7aeda28 100644 --- a/docs/TfvSubmissionInfo.md +++ b/docs/TfvSubmissionInfo.md @@ -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 diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 8234009..cb06f8e 100644 --- a/docs/VerificationRequest.md +++ b/docs/VerificationRequest.md @@ -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] diff --git a/docs/VerificationUpdateRequest.md b/docs/VerificationUpdateRequest.md index 54c4ab9..a7a90e3 100644 --- a/docs/VerificationUpdateRequest.md +++ b/docs/VerificationUpdateRequest.md @@ -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] diff --git a/models/business-entity-type-enum.ts b/models/business-entity-type-enum.ts index 7e68242..700f175 100644 --- a/models/business-entity-type-enum.ts +++ b/models/business-entity-type-enum.ts @@ -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 = { diff --git a/models/business-registration-type-enum.ts b/models/business-registration-type-enum.ts index 2855a3a..d20408d 100644 --- a/models/business-registration-type-enum.ts +++ b/models/business-registration-type-enum.ts @@ -15,7 +15,7 @@ /** - * The type of business registration number. + * The type of business registration number. */ export const BusinessRegistrationTypeEnum = { diff --git a/models/index.ts b/models/index.ts index fc8c4cf..7900f52 100644 --- a/models/index.ts +++ b/models/index.ts @@ -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'; diff --git a/models/tfv-submission-info.ts b/models/tfv-submission-info.ts index fe685e7..ea85791 100644 --- a/models/tfv-submission-info.ts +++ b/models/tfv-submission-info.ts @@ -21,9 +21,6 @@ import type { Address } from './address'; import type { BusinessEntityTypeEnum } from './business-entity-type-enum'; // May contain unused imports in some cases // @ts-ignore -import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum'; -// May contain unused imports in some cases -// @ts-ignore import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum'; // May contain unused imports in some cases // @ts-ignore @@ -73,11 +70,14 @@ export interface TfvSubmissionInfo { */ 'businessDba'?: string; /** - * Government-issued business identifying number. + * 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. */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - 'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum; + /** + * 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 | + */ + 'businessRegistrationIssuingCountry'?: string; 'businessEntityType'?: BusinessEntityTypeEnum; } diff --git a/models/verification-request.ts b/models/verification-request.ts index a521a7b..190e68b 100644 --- a/models/verification-request.ts +++ b/models/verification-request.ts @@ -21,9 +21,6 @@ import type { Address } from './address'; import type { BusinessEntityTypeEnum } from './business-entity-type-enum'; // May contain unused imports in some cases // @ts-ignore -import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum'; -// May contain unused imports in some cases -// @ts-ignore import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum'; // May contain unused imports in some cases // @ts-ignore @@ -74,11 +71,14 @@ export interface VerificationRequest { */ 'businessDba'?: string; /** - * Government-issued business identifying number. + * 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. */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - 'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum; + /** + * 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 | + */ + 'businessRegistrationIssuingCountry'?: string; 'businessEntityType': BusinessEntityTypeEnum; /** * A message that gets sent to users requesting help. diff --git a/models/verification-update-request.ts b/models/verification-update-request.ts index 75958e9..4801432 100644 --- a/models/verification-update-request.ts +++ b/models/verification-update-request.ts @@ -21,9 +21,6 @@ import type { Address } from './address'; import type { BusinessEntityTypeEnum } from './business-entity-type-enum'; // May contain unused imports in some cases // @ts-ignore -import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum'; -// May contain unused imports in some cases -// @ts-ignore import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum'; // May contain unused imports in some cases // @ts-ignore @@ -73,12 +70,15 @@ export interface VerificationUpdateRequest { */ 'businessDba'?: string; /** - * Government-issued business identifying number. + * 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. */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; 'businessEntityType'?: BusinessEntityTypeEnum; - 'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum; + /** + * 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 | + */ + 'businessRegistrationIssuingCountry'?: string; /** * A message that gets sent to users requesting help. */