Skip to content

MV-21235 - Creating minor SDK release for upcoming TFV breaking changes #97

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
adamrbaldwin-bw wants to merge 1 commit into from
+2,298 −2,229
Closed

MV-21235 - Creating minor SDK release for upcoming TFV breaking changes #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4,440 changes: 2,241 additions & 2,199 deletions bandwidth.yml
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Api/MediaApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ uploadMedia($account_id, $media_id, $body, $content_type, $cache_control)
- https://messaging.bandwidth.com/api/v2 Production
Upload Media

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

Expand Down Expand Up @@ -268,7 +268,7 @@ $account_id = 9900000; // string | This is your 7-digit Bandwidth Account ID, as
$media_id = bw.png; // string | The ID of the media file.
$body = '/path/to/file.txt'; // \SplFileObject
$content_type = audio/wav; // string | The media type of the entity-body.
$cache_control = no-cache; // string | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
$cache_control = no-cache; // 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.

$hostIndex = 0;
$variables = [
Expand All @@ -289,7 +289,7 @@ try {
| **media_id** | **string**| The ID of the media file. | |
| **body** | **\SplFileObject****\SplFileObject**| | |
| **content_type** | **string**| The media type of the entity-body. | [optional] |
| **cache_control** | **string**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
| **cache_control** | **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] |
| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] |
| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] |

Expand Down
6 changes: 3 additions & 3 deletions docs/Api/TollFreeVerificationApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ deleteVerificationRequest($account_id, $phone_number)
- https://api.bandwidth.com/api/v2 Production
Delete a Toll-Free Verification Submission

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

Expand Down Expand Up @@ -459,7 +459,7 @@ requestTollFreeVerification($account_id, $verification_request)
- https://api.bandwidth.com/api/v2 Production
Request Toll-Free Verification

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

Expand Down Expand Up @@ -532,7 +532,7 @@ updateTollFreeVerificationRequest($account_id, $phone_number, $tfv_submission_wr
- https://api.bandwidth.com/api/v2 Production
Update Toll-Free Verification Request

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

Expand Down
4 changes: 2 additions & 2 deletions docs/Model/TfvSubmissionInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Name | Type | Description | Notes
**privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional]
**terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional]
**business_dba** | **string** | The company 'Doing Business As'. | [optional]
**business_registration_number** | **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]
**business_registration_number** | **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]
**business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional]
**business_registration_issuing_country** | **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]
**business_registration_issuing_country** | **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]
**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
4 changes: 2 additions & 2 deletions docs/Model/VerificationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Name | Type | Description | Notes
**privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional]
**terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional]
**business_dba** | **string** | The company 'Doing Business As'. | [optional]
**business_registration_number** | **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]
**business_registration_number** | **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]
**business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional]
**business_registration_issuing_country** | **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]
**business_registration_issuing_country** | **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]
**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | |
**help_message_response** | **string** | A message that gets sent to users requesting help. | [optional]
**age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/Model/VerificationUpdateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Name | Type | Description | Notes
**privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional]
**terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional]
**business_dba** | **string** | The company 'Doing Business As'. | [optional]
**business_registration_number** | **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]
**business_registration_number** | **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]
**business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional]
**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional]
**business_registration_issuing_country** | **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]
**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | |
**business_registration_issuing_country** | **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]
**help_message_response** | **string** | A message that gets sent to users requesting help. | [optional]
**age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional]
**cv_token** | **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]
Expand Down
Loading