Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 50 additions & 8 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand All @@ -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':
Expand Down Expand Up @@ -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'
Expand All @@ -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':
Expand All @@ -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'
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/MediaApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/RbmActionBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ require 'bandwidth-sdk'
instance = Bandwidth::RbmActionBase.new(
type: null,
text: Hello world,
postback_data: [B@dc3eda6
postback_data: [B@d7c00de
)
```

2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
```
Expand Down
6 changes: 3 additions & 3 deletions docs/TollFreeVerificationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions lib/bandwidth-sdk/api/media_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -224,27 +224,27 @@ 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)
nil
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
Expand Down
12 changes: 6 additions & 6 deletions lib/bandwidth-sdk/api/toll_free_verification_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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 &#x60;409 Conflict&#x60;. 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 &#x60;202&#x60;.
# @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
Expand Down Expand Up @@ -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.
Expand All @@ -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 &#x60;404&#x60; if no verification request exists for the phone number, and a &#x60;400&#x60; 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 &#x60;409 Conflict&#x60;.
# @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.
Expand Down