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/api/media-api.ts b/api/media-api.ts index 33cfe6c..e73e510 100644 --- a/api/media-api.ts +++ b/api/media-api.ts @@ -169,7 +169,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * 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-). + * 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). * @summary Upload Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. @@ -280,7 +280,7 @@ export const MediaApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * 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-). + * 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). * @summary Upload Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. @@ -339,7 +339,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath return localVarFp.listMedia(accountId, continuationToken, options).then((request) => request(axios, basePath)); }, /** - * 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-). + * 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). * @summary Upload Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. @@ -396,7 +396,7 @@ export class MediaApi extends BaseAPI { } /** - * 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-). + * 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). * @summary Upload Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. diff --git a/bandwidth.yml b/bandwidth.yml index d3f8539..835ec5a 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -95,8 +95,8 @@ paths: 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-). + 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). operationId: uploadMedia tags: - Media @@ -2255,8 +2255,8 @@ components: 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) + fail, see more at [Bandwidth + Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. example: https://dev.bandwidth.com/images/bandwidth-logo.png maxLength: 1000 @@ -5887,17 +5887,21 @@ components: 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. + **Note: As of October 19th, 2026 this field will be required when + `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is + provided, `businessRegistrationType` and + `businessRegistrationIssuingCountry` are also required.** nullable: true maxLength: 500 example: 12-3456789 businessRegistrationTypeEnum: type: string - description: | + description: > The type of business registration number. + + + **Note: As of October 19th, 2026 this field will be required when + `businessRegistrationNumber` is provided.** enum: - EIN - CBN @@ -5919,20 +5923,16 @@ components: - OTHER example: EIN nullable: true - businessRegistrationIssuingCountryEnum: + businessRegistrationIssuingCountry: type: string description: >- 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. + format. Alpha-2 format is accepted by the API, but alpha-3 is highly + 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`. + **Note: As of October 19th, 2026 this field will be required when + `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | @@ -5974,30 +5974,22 @@ components: | UID | CHE | | OTHER | Must Provide Country Code | - enum: - - USA - - CAN - - HKG - - GBR - - IRL - - BRA - - NLD - - AUS - - FRA - - NZL - - DEU - - ESP - - CHE - - CYP - - IND - - CHN - - BGR example: USA - nullable: false + nullable: true businessEntityTypeEnum: type: string - description: | + description: > The type of registered business. + + + **Note: As of October 19th, 2026 submissions using a value other than + `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, + `businessRegistrationType`, and `businessRegistrationIssuingCountry`. + + Submissions using `SOLE_PROPRIETOR` must _omit_ + `businessRegistrationNumber`, `businessRegistrationType`, and + `businessRegistrationIssuingCountry`. Failure to adhere to these + constraints will result in a 400 Bad Request rejection.** enum: - SOLE_PROPRIETOR - PRIVATE_PROFIT @@ -6106,7 +6098,7 @@ components: businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: @@ -6161,7 +6153,7 @@ components: businessEntityType: $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: '#/components/schemas/businessRegistrationIssuingCountryEnum' + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: @@ -6657,13 +6649,15 @@ components: description: Government-issued business identifying number. businessRegistrationType: $ref: '#/components/schemas/businessRegistrationTypeEnum' + description: The type of business registration number. 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' + description: The type of registered business. tfvStatusEnum: type: string enum: diff --git a/docs/BusinessEntityTypeEnum.md b/docs/BusinessEntityTypeEnum.md index 5ed6e5d..345ba25 100644 --- a/docs/BusinessEntityTypeEnum.md +++ b/docs/BusinessEntityTypeEnum.md @@ -1,6 +1,6 @@ # BusinessEntityTypeEnum -The type of registered business. +The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.** ## Enum diff --git a/docs/BusinessRegistrationIssuingCountryEnum.md b/docs/BusinessRegistrationIssuingCountryEnum.md deleted file mode 100644 index 047639b..0000000 --- a/docs/BusinessRegistrationIssuingCountryEnum.md +++ /dev/null @@ -1,41 +0,0 @@ -# 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 | - -## Enum - -* `Usa` (value: `'USA'`) - -* `Can` (value: `'CAN'`) - -* `Hkg` (value: `'HKG'`) - -* `Gbr` (value: `'GBR'`) - -* `Irl` (value: `'IRL'`) - -* `Bra` (value: `'BRA'`) - -* `Nld` (value: `'NLD'`) - -* `Aus` (value: `'AUS'`) - -* `Fra` (value: `'FRA'`) - -* `Nzl` (value: `'NZL'`) - -* `Deu` (value: `'DEU'`) - -* `Esp` (value: `'ESP'`) - -* `Che` (value: `'CHE'`) - -* `Cyp` (value: `'CYP'`) - -* `Ind` (value: `'IND'`) - -* `Chn` (value: `'CHN'`) - -* `Bgr` (value: `'BGR'`) - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BusinessRegistrationTypeEnum.md b/docs/BusinessRegistrationTypeEnum.md index 5d119b0..15d9f54 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. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** ## Enum diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 49f8a5b..2a863f2 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -198,7 +198,7 @@ const { status, data } = await apiInstance.listMedia( # **uploadMedia** > uploadMedia(body) -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-). +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). ### Example diff --git a/docs/MmsMessageContentFile.md b/docs/MmsMessageContentFile.md index 7941f42..b7f30bc 100644 --- a/docs/MmsMessageContentFile.md +++ b/docs/MmsMessageContentFile.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fileUrl** | **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. | [default to undefined] +**fileUrl** | **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. | [default to undefined] ## Example diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index 230d016..e517c7c 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. **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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` 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] [default to undefined] **businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined] ## Example diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 8e3d4da..38e3531 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. **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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` 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] [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 05c8d7c..c0ebba6 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. **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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` 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] [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 700f175..63f2eb8 100644 --- a/models/business-entity-type-enum.ts +++ b/models/business-entity-type-enum.ts @@ -15,7 +15,7 @@ /** - * The type of registered business. + * The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.** */ export const BusinessEntityTypeEnum = { diff --git a/models/business-registration-issuing-country-enum.ts b/models/business-registration-issuing-country-enum.ts deleted file mode 100644 index 78cd5f9..0000000 --- a/models/business-registration-issuing-country-enum.ts +++ /dev/null @@ -1,44 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Bandwidth - * Bandwidth\'s Communication APIs - * - * The version of the OpenAPI document: 1.0.0 - * Contact: letstalk@bandwidth.com - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - - -/** - * 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 | - */ - -export const BusinessRegistrationIssuingCountryEnum = { - Usa: 'USA', - Can: 'CAN', - Hkg: 'HKG', - Gbr: 'GBR', - Irl: 'IRL', - Bra: 'BRA', - Nld: 'NLD', - Aus: 'AUS', - Fra: 'FRA', - Nzl: 'NZL', - Deu: 'DEU', - Esp: 'ESP', - Che: 'CHE', - Cyp: 'CYP', - Ind: 'IND', - Chn: 'CHN', - Bgr: 'BGR' -} as const; - -export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum]; - - - diff --git a/models/business-registration-type-enum.ts b/models/business-registration-type-enum.ts index d20408d..f0d9b3e 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. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** */ 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/mms-message-content-file.ts b/models/mms-message-content-file.ts index a06be6a..36a3921 100644 --- a/models/mms-message-content-file.ts +++ b/models/mms-message-content-file.ts @@ -16,7 +16,7 @@ export interface MmsMessageContentFile { /** - * 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. + * 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. */ 'fileUrl': string; } diff --git a/models/tfv-submission-info.ts b/models/tfv-submission-info.ts index 91e96af..e3114c8 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. **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. + * Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - 'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum; + /** + * 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 `businessRegistrationNumber` 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 | + */ + 'businessRegistrationIssuingCountry'?: string | null; 'businessEntityType'?: BusinessEntityTypeEnum; } diff --git a/models/verification-request.ts b/models/verification-request.ts index bf96eab..fdd534d 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. **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. + * Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; - 'businessRegistrationIssuingCountry'?: BusinessRegistrationIssuingCountryEnum; + /** + * 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 `businessRegistrationNumber` 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 | + */ + 'businessRegistrationIssuingCountry'?: string | null; '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 6587205..76b1abe 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. **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. + * Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** */ '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 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` 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 | + */ + 'businessRegistrationIssuingCountry'?: string | null; /** * A message that gets sent to users requesting help. */ diff --git a/tests/unit/api/toll-free-verification-api.test.ts b/tests/unit/api/toll-free-verification-api.test.ts index ec8d049..b8062d9 100644 --- a/tests/unit/api/toll-free-verification-api.test.ts +++ b/tests/unit/api/toll-free-verification-api.test.ts @@ -140,7 +140,7 @@ describe('TollFreeVerificationApi', () => { businessDba: 'businessDba', businessRegistrationNumber: 'businessRegistrationNumber', businessRegistrationType: BusinessRegistrationTypeEnum.Ein, - businessRegistrationIssuingCountry: BusinessRegistrationIssuingCountryEnum.Us, + businessRegistrationIssuingCountry: 'USA', businessEntityType: BusinessEntityTypeEnum.NonProfit, helpMessageResponse: 'helpMessageResponse', ageGatedContent: true, diff --git a/tests/unit/models/business-registration-issuing-country-enum.test.ts b/tests/unit/models/business-registration-issuing-country-enum.test.ts deleted file mode 100644 index 73d5136..0000000 --- a/tests/unit/models/business-registration-issuing-country-enum.test.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { BusinessRegistrationIssuingCountryEnum } from '../../../models/business-registration-issuing-country-enum'; - -describe('BusinessRegistrationIssuingCountryEnum', () => { - test('should define the expected values', () => { - expect(BusinessRegistrationIssuingCountryEnum.Usa).toBe('USA'); - expect(BusinessRegistrationIssuingCountryEnum.Can).toBe('CAN'); - expect(BusinessRegistrationIssuingCountryEnum.Hkg).toBe('HKG'); - expect(BusinessRegistrationIssuingCountryEnum.Gbr).toBe('GBR'); - expect(BusinessRegistrationIssuingCountryEnum.Irl).toBe('IRL'); - expect(BusinessRegistrationIssuingCountryEnum.Bra).toBe('BRA'); - expect(BusinessRegistrationIssuingCountryEnum.Nld).toBe('NLD'); - expect(BusinessRegistrationIssuingCountryEnum.Aus).toBe('AUS'); - expect(BusinessRegistrationIssuingCountryEnum.Fra).toBe('FRA'); - expect(BusinessRegistrationIssuingCountryEnum.Nzl).toBe('NZL'); - expect(BusinessRegistrationIssuingCountryEnum.Deu).toBe('DEU'); - expect(BusinessRegistrationIssuingCountryEnum.Esp).toBe('ESP'); - expect(BusinessRegistrationIssuingCountryEnum.Che).toBe('CHE'); - expect(BusinessRegistrationIssuingCountryEnum.Cyp).toBe('CYP'); - expect(BusinessRegistrationIssuingCountryEnum.Ind).toBe('IND'); - expect(BusinessRegistrationIssuingCountryEnum.Chn).toBe('CHN'); - expect(BusinessRegistrationIssuingCountryEnum.Bgr).toBe('BGR'); - }); -});