diff --git a/bandwidth.yml b/bandwidth.yml index 53949fed..61b41e72 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' @@ -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/MediaApi.md b/docs/MediaApi.md index ab6fd49f..8c800661 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -242,7 +242,7 @@ end 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). ### Examples @@ -265,7 +265,7 @@ media_id = 'bw.png' # String | The ID of the media file. body = File.new('/path/to/some/file') # File | opts = { 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. } begin @@ -302,7 +302,7 @@ end | **media_id** | **String** | The ID of the media file. | | | **body** | **File** | | | | **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] | ### Return type diff --git a/docs/RbmActionBase.md b/docs/RbmActionBase.md index f2565e35..685150d5 100644 --- a/docs/RbmActionBase.md +++ b/docs/RbmActionBase.md @@ -16,7 +16,7 @@ require 'bandwidth-sdk' instance = Bandwidth::RbmActionBase.new( type: null, text: Hello world, - postback_data: [B@dc3eda6 + postback_data: [B@d7c00de ) ``` diff --git a/docs/RbmSuggestionResponse.md b/docs/RbmSuggestionResponse.md index 47d34998..6c2ea470 100644 --- a/docs/RbmSuggestionResponse.md +++ b/docs/RbmSuggestionResponse.md @@ -15,7 +15,7 @@ require 'bandwidth-sdk' instance = Bandwidth::RbmSuggestionResponse.new( text: Yes, I would like to proceed, - postback_data: [B@dc3eda6, + postback_data: [B@d7c00de, paired_message_id: 1752697342534u24xerqdukke523x ) ``` diff --git a/docs/TollFreeVerificationApi.md b/docs/TollFreeVerificationApi.md index 9fd133a9..1646e37b 100644 --- a/docs/TollFreeVerificationApi.md +++ b/docs/TollFreeVerificationApi.md @@ -96,7 +96,7 @@ end 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. ### Examples @@ -462,7 +462,7 @@ end 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`. ### Examples @@ -536,7 +536,7 @@ nil (empty response body) 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`. ### Examples diff --git a/lib/bandwidth-sdk/api/media_api.rb b/lib/bandwidth-sdk/api/media_api.rb index 7ca88f54..cbe04871 100644 --- a/lib/bandwidth-sdk/api/media_api.rb +++ b/lib/bandwidth-sdk/api/media_api.rb @@ -224,13 +224,13 @@ def list_media_with_http_info(account_id, opts = {}) end # 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). # @param account_id [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.** # @param media_id [String] The ID of the media file. # @param body [File] # @param [Hash] opts the optional parameters # @option opts [String] :content_type The media type of the entity-body. - # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + # @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. # @return [nil] def upload_media(account_id, media_id, body, opts = {}) upload_media_with_http_info(account_id, media_id, body, opts) @@ -238,13 +238,13 @@ def upload_media(account_id, media_id, body, opts = {}) end # 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). # @param account_id [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.** # @param media_id [String] The ID of the media file. # @param body [File] # @param [Hash] opts the optional parameters # @option opts [String] :content_type The media type of the entity-body. - # @option opts [String] :cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. + # @option opts [String] :cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def upload_media_with_http_info(account_id, media_id, body, opts = {}) if @api_client.config.debugging diff --git a/lib/bandwidth-sdk/api/toll_free_verification_api.rb b/lib/bandwidth-sdk/api/toll_free_verification_api.rb index 70254f60..b62c4929 100644 --- a/lib/bandwidth-sdk/api/toll_free_verification_api.rb +++ b/lib/bandwidth-sdk/api/toll_free_verification_api.rb @@ -94,7 +94,7 @@ def create_webhook_subscription_with_http_info(account_id, webhook_subscription_ end # 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. # @param account_id [String] Your Bandwidth Account ID. # @param phone_number [String] Valid Toll-Free telephone number in E.164 format. # @param [Hash] opts the optional parameters @@ -105,7 +105,7 @@ def delete_verification_request(account_id, phone_number, opts = {}) end # 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. # @param account_id [String] Your Bandwidth Account ID. # @param phone_number [String] Valid Toll-Free telephone number in E.164 format. # @param [Hash] opts the optional parameters @@ -447,7 +447,7 @@ def list_webhook_subscriptions_with_http_info(account_id, opts = {}) end # 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`. # @param account_id [String] Your Bandwidth Account ID. # @param verification_request [VerificationRequest] Request for verification of a toll-free phone number. # @param [Hash] opts the optional parameters @@ -458,7 +458,7 @@ def request_toll_free_verification(account_id, verification_request, opts = {}) end # 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`. # @param account_id [String] Your Bandwidth Account ID. # @param verification_request [VerificationRequest] Request for verification of a toll-free phone number. # @param [Hash] opts the optional parameters @@ -521,7 +521,7 @@ def request_toll_free_verification_with_http_info(account_id, verification_reque end # 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`. # @param account_id [String] Your Bandwidth Account ID. # @param phone_number [String] Valid Toll-Free telephone number in E.164 format. # @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number. @@ -533,7 +533,7 @@ def update_toll_free_verification_request(account_id, phone_number, tfv_submissi end # 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`. # @param account_id [String] Your Bandwidth Account ID. # @param phone_number [String] Valid Toll-Free telephone number in E.164 format. # @param tfv_submission_wrapper [TfvSubmissionWrapper] Update a request for verification of a toll-free phone number.