diff --git a/api/media-api.ts b/api/media-api.ts index 71c3de6..863f070 100644 --- a/api/media-api.ts +++ b/api/media-api.ts @@ -169,13 +169,13 @@ 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 at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). + * Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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 This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** * @param {string} mediaId The ID of the media file. * @param {File} body * @param {string} [contentType] The media type of the entity-body. - * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + * @param {string} [cacheControl] Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -279,13 +279,13 @@ 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 at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). + * Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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 This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** * @param {string} mediaId The ID of the media file. * @param {File} body * @param {string} [contentType] The media type of the entity-body. - * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + * @param {string} [cacheControl] Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -338,13 +338,13 @@ 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 at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). + * Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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 This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** * @param {string} mediaId The ID of the media file. * @param {File} body * @param {string} [contentType] The media type of the entity-body. - * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + * @param {string} [cacheControl] Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -395,13 +395,13 @@ 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 at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). + * Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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 This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** * @param {string} mediaId The ID of the media file. * @param {File} body * @param {string} [contentType] The media type of the entity-body. - * @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + * @param {string} [cacheControl] Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. * @param {*} [options] Override http request option. * @throws {RequiredError} */ diff --git a/api/toll-free-verification-api.ts b/api/toll-free-verification-api.ts index 7c6d062..1b3c917 100644 --- a/api/toll-free-verification-api.ts +++ b/api/toll-free-verification-api.ts @@ -88,7 +88,7 @@ export const TollFreeVerificationApiAxiosParamCreator = function (configuration? }; }, /** - * Delete a toll-free verification submission for a toll-free number. + * Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -306,7 +306,7 @@ export const TollFreeVerificationApiAxiosParamCreator = function (configuration? }; }, /** - * Submit a request for verification of a toll-free phone number. + * Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. @@ -353,7 +353,7 @@ export const TollFreeVerificationApiAxiosParamCreator = function (configuration? }; }, /** - * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -478,7 +478,7 @@ export const TollFreeVerificationApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Delete a toll-free verification submission for a toll-free number. + * Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -545,7 +545,7 @@ export const TollFreeVerificationApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Submit a request for verification of a toll-free phone number. + * Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. @@ -559,7 +559,7 @@ export const TollFreeVerificationApiFp = function(configuration?: Configuration) return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -609,7 +609,7 @@ export const TollFreeVerificationApiFactory = function (configuration?: Configur return localVarFp.createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then((request) => request(axios, basePath)); }, /** - * Delete a toll-free verification submission for a toll-free number. + * Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -661,7 +661,7 @@ export const TollFreeVerificationApiFactory = function (configuration?: Configur return localVarFp.listWebhookSubscriptions(accountId, options).then((request) => request(axios, basePath)); }, /** - * Submit a request for verification of a toll-free phone number. + * Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. @@ -672,7 +672,7 @@ export const TollFreeVerificationApiFactory = function (configuration?: Configur return localVarFp.requestTollFreeVerification(accountId, verificationRequest, options).then((request) => request(axios, basePath)); }, /** - * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -715,7 +715,7 @@ export class TollFreeVerificationApi extends BaseAPI { } /** - * Delete a toll-free verification submission for a toll-free number. + * Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. @@ -772,7 +772,7 @@ export class TollFreeVerificationApi extends BaseAPI { } /** - * Submit a request for verification of a toll-free phone number. + * Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. @@ -784,7 +784,7 @@ export class TollFreeVerificationApi extends BaseAPI { } /** - * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. diff --git a/bandwidth.yml b/bandwidth.yml index 53949fe..6b44f54 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -88,12 +88,11 @@ paths: put: summary: Upload Media description: >- - Upload a file. You may add headers to the request in order to provide - some control to your media file. + Upload a 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. + Filename should always be unique. Reusing filenames may result in the + wrong media being sent. A list of supported media types can be found at [Bandwidth @@ -1404,7 +1403,19 @@ paths: tags: - Toll-Free Verification summary: Request Toll-Free Verification - description: Submit a request for verification of a toll-free phone number. + description: >- + Submit a request for verification of a toll-free phone number. + + + **Upcoming change (effective January 2027):** If any phone number in the + request already has a verification in progress, the request will be + rejected with a `409 Conflict`. + + This check is all-or-nothing: if a single phone number conflicts, the + entire request is rejected and **none** of the phone numbers in the + request are submitted. + + Today, these requests are accepted with a `202`. operationId: requestTollFreeVerification parameters: - $ref: '#/components/parameters/accountId4' @@ -1421,6 +1432,8 @@ paths: $ref: '#/components/responses/tfvForbiddenResponse' '405': $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' '429': $ref: '#/components/responses/tfvTooManyRequestsResponse' '500': @@ -1477,6 +1490,14 @@ paths: Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + + Returns a `404` if no verification request exists for the phone number, + and a `400` if the existing request is not eligible for resubmission. + + + **Upcoming change (effective January 2027):** If a verification for the + phone number is in progress, the update will be rejected with a `409 + Conflict`. operationId: updateTollFreeVerificationRequest parameters: - $ref: '#/components/parameters/accountId4' @@ -1492,8 +1513,12 @@ paths: $ref: '#/components/responses/tfvUnauthorizedResponse' '403': $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' '405': $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' '429': $ref: '#/components/responses/tfvTooManyRequestsResponse' '500': @@ -1504,7 +1529,13 @@ paths: tfVerificationStatus: $ref: '#/components/callbacks/tfVerificationStatus' delete: - description: Delete a toll-free verification submission for a toll-free number. + description: >- + Delete a toll-free verification submission for a toll-free number. + + + **Upcoming change (effective January 2027):** If a verification for the + phone number is in progress, it will be cancelled and the submission + will then be deleted asynchronously. operationId: deleteVerificationRequest parameters: - $ref: '#/components/parameters/accountId4' @@ -6273,10 +6304,9 @@ components: 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.** + **This field is 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 @@ -6286,8 +6316,8 @@ components: The type of business registration number. - **Note: As of October 19th, 2026 this field will be required when - `businessRegistrationNumber` is provided.** + **This field is required when `businessRegistrationNumber` is + provided.** enum: - EIN - CBN @@ -6317,8 +6347,8 @@ components: encouraged. - **Note: As of October 19th, 2026 this field will be required when - `businessRegistrationNumber` is provided.** + **This field is required when `businessRegistrationNumber` is + provided.** | Registration Type | Supported Countries | @@ -6368,9 +6398,9 @@ components: 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 a value other than `SOLE_PROPRIETOR` must provide a + value for `businessRegistrationNumber`, `businessRegistrationType`, and + `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and @@ -6490,6 +6520,7 @@ components: - useCaseSummary - productionMessageContent - optInWorkflow + - businessEntityType properties: businessAddress: $ref: '#/components/schemas/address' @@ -8072,6 +8103,17 @@ components: example: description: Cannot find the requested resource. type: Not Found + tfvConflictResponse: + description: >- + Conflict. A toll-free verification for the phone number is already in + progress. + content: + application/json: + schema: + $ref: '#/components/schemas/tfvError' + example: + description: 'TFV request already in progress for phone number: +18005551234' + type: conflict tfvNotAllowedResponse: description: Method Not Allowed content: @@ -8256,8 +8298,8 @@ components: style: simple explode: false description: >- - General-header field is used to specify directives that MUST be obeyed - by all caching mechanisms along the request/response chain. + Pass-through header stored with the media and returned when the media is + retrieved by the user. Does not affect internal server caching behavior. example: no-cache schema: type: string diff --git a/docs/BusinessEntityTypeEnum.md b/docs/BusinessEntityTypeEnum.md index 345ba25..9bbd331 100644 --- a/docs/BusinessEntityTypeEnum.md +++ b/docs/BusinessEntityTypeEnum.md @@ -1,6 +1,6 @@ # BusinessEntityTypeEnum -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.** +The type of registered business. **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/BusinessRegistrationTypeEnum.md b/docs/BusinessRegistrationTypeEnum.md index 15d9f54..1c9be40 100644 --- a/docs/BusinessRegistrationTypeEnum.md +++ b/docs/BusinessRegistrationTypeEnum.md @@ -1,6 +1,6 @@ # BusinessRegistrationTypeEnum -The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** +The type of business registration number. **This field is required when `businessRegistrationNumber` is provided.** ## Enum diff --git a/docs/MediaApi.md b/docs/MediaApi.md index c0393c1..e5ee4a3 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 at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). +Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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 @@ -215,7 +215,7 @@ let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in let mediaId: string; //The ID of the media file. (default to undefined) let body: File; // let contentType: string; //The media type of the entity-body. (optional) (default to undefined) -let cacheControl: string; //General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) (default to undefined) +let cacheControl: string; //Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) (default to undefined) const { status, data } = await apiInstance.uploadMedia( accountId, @@ -234,7 +234,7 @@ const { status, data } = await apiInstance.uploadMedia( | **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined| | **mediaId** | [**string**] | The ID of the media file. | defaults to undefined| | **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined| -| **cacheControl** | [**string**] | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | (optional) defaults to undefined| +| **cacheControl** | [**string**] | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | (optional) defaults to undefined| ### Return type diff --git a/docs/TfvSubmissionInfo.md b/docs/TfvSubmissionInfo.md index e517c7c..37ba73e 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: 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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **This field is 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** | **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] +**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. **This field is 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/TollFreeVerificationApi.md b/docs/TollFreeVerificationApi.md index 573946b..1e7d896 100644 --- a/docs/TollFreeVerificationApi.md +++ b/docs/TollFreeVerificationApi.md @@ -80,7 +80,7 @@ const { status, data } = await apiInstance.createWebhookSubscription( # **deleteVerificationRequest** > deleteVerificationRequest() -Delete a toll-free verification submission for a toll-free number. +Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. ### Example @@ -376,7 +376,7 @@ const { status, data } = await apiInstance.listWebhookSubscriptions( # **requestTollFreeVerification** > requestTollFreeVerification(verificationRequest) -Submit a request for verification of a toll-free phone number. +Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. ### Example @@ -429,6 +429,7 @@ void (empty response body) |**401** | Unauthorized | - | |**403** | Forbidden | - | |**405** | Method Not Allowed | - | +|**409** | Conflict. A toll-free verification for the phone number is already in progress. | - | |**429** | Too Many Requests | - | |**500** | Internal Server Error | - | |**503** | Service Unavailable | - | @@ -438,7 +439,7 @@ void (empty response body) # **updateTollFreeVerificationRequest** > updateTollFreeVerificationRequest(tfvSubmissionWrapper) -Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). +Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. ### Example @@ -493,7 +494,9 @@ void (empty response body) |**400** | Bad Request | - | |**401** | Unauthorized | - | |**403** | Forbidden | - | +|**404** | Cannot find the requested resource. | - | |**405** | Method Not Allowed | - | +|**409** | Conflict. A toll-free verification for the phone number is already in progress. | - | |**429** | Too Many Requests | - | |**500** | Internal Server Error | - | |**503** | Service Unavailable | - | diff --git a/docs/VerificationRequest.md b/docs/VerificationRequest.md index 38e3531..808d404 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: 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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **This field is 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** | **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] +**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. **This field is 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 c0ebba6..ffed80e 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: 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] +**businessRegistrationNumber** | **string** | Government-issued business identifying number. **This field is 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** | **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] +**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. **This field is 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 5101067..3c38db8 100644 --- a/models/business-entity-type-enum.ts +++ b/models/business-entity-type-enum.ts @@ -15,7 +15,7 @@ /** - * 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.** + * The type of registered business. **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-type-enum.ts b/models/business-registration-type-enum.ts index b73039b..5260bae 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. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** + * The type of business registration number. **This field is required when `businessRegistrationNumber` is provided.** */ export const BusinessRegistrationTypeEnum = { diff --git a/models/tfv-submission-info.ts b/models/tfv-submission-info.ts index e3114c8..b1b9c09 100644 --- a/models/tfv-submission-info.ts +++ b/models/tfv-submission-info.ts @@ -70,12 +70,12 @@ export interface TfvSubmissionInfo { */ 'businessDba'?: 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.** + * Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; /** - * 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 | + * 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. **This field is 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 fdd534d..bb673fd 100644 --- a/models/verification-request.ts +++ b/models/verification-request.ts @@ -71,12 +71,12 @@ export interface VerificationRequest { */ 'businessDba'?: 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.** + * Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** */ 'businessRegistrationNumber'?: string | null; 'businessRegistrationType'?: BusinessRegistrationTypeEnum | null; /** - * 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 | + * 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. **This field is 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-update-request.ts b/models/verification-update-request.ts index 76b1abe..3829597 100644 --- a/models/verification-update-request.ts +++ b/models/verification-update-request.ts @@ -70,13 +70,13 @@ export interface VerificationUpdateRequest { */ 'businessDba'?: 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.** + * Government-issued business identifying number. **This field is 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; + 'businessEntityType': BusinessEntityTypeEnum; /** - * 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 | + * 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. **This field is 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; /**