Skip to content
Open
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
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ docs/CreateMessageRequestError.md
docs/CreateMultiChannelMessageResponse.md
docs/CreateSyncLookupResponse.md
docs/CreateSyncLookupResponseData.md
docs/CustomTooManyRequestsError.md
docs/DeactivationEventEnum.md
docs/DisconnectCallback.md
docs/Diversion.md
Expand Down Expand Up @@ -251,6 +252,7 @@ lib/bandwidth-sdk/models/create_message_request_error.rb
lib/bandwidth-sdk/models/create_multi_channel_message_response.rb
lib/bandwidth-sdk/models/create_sync_lookup_response.rb
lib/bandwidth-sdk/models/create_sync_lookup_response_data.rb
lib/bandwidth-sdk/models/custom_too_many_requests_error.rb
lib/bandwidth-sdk/models/deactivation_event_enum.rb
lib/bandwidth-sdk/models/disconnect_callback.rb
lib/bandwidth-sdk/models/diversion.rb
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ Class | Method | HTTP request | Description
- [Bandwidth::CreateMultiChannelMessageResponse](docs/CreateMultiChannelMessageResponse.md)
- [Bandwidth::CreateSyncLookupResponse](docs/CreateSyncLookupResponse.md)
- [Bandwidth::CreateSyncLookupResponseData](docs/CreateSyncLookupResponseData.md)
- [Bandwidth::CustomTooManyRequestsError](docs/CustomTooManyRequestsError.md)
- [Bandwidth::DeactivationEventEnum](docs/DeactivationEventEnum.md)
- [Bandwidth::DisconnectCallback](docs/DisconnectCallback.md)
- [Bandwidth::Diversion](docs/Diversion.md)
Expand Down
63 changes: 58 additions & 5 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,13 @@ paths:
/users/{accountId}/messages:
get:
summary: List Messages
description: Returns a list of messages based on query parameters.
description: >
Returns a list of messages based on query parameters.


**Rate Limit:** This endpoint is rate limited to 3500 requests per 5
minutes per Source IP address. Exceeding the limit returns HTTP 429 with
a `Retry-After` header.
operationId: listMessages
tags:
- Messages
Expand Down Expand Up @@ -207,10 +213,12 @@ paths:
$ref: '#/components/responses/messagingForbiddenError'
'404':
$ref: '#/components/responses/messagingNotFoundError'
'405':
$ref: '#/components/responses/messagingMethodNotAllowedError'
'415':
$ref: '#/components/responses/messagingInvalidMediaTypeError'
'429':
$ref: '#/components/responses/messagingTooManyRequestsError'
$ref: '#/components/responses/customTooManyRequestsError'
'500':
$ref: '#/components/responses/messagingInternalServerError'
post:
Expand Down Expand Up @@ -2257,7 +2265,9 @@ components:
type: object
properties:
media:
$ref: '#/components/schemas/rbmMessageContentFile'
type: array
items:
$ref: '#/components/schemas/rbmMessageContentFile'
suggestions:
$ref: '#/components/schemas/multiChannelFullActions'
required:
Expand Down Expand Up @@ -2944,6 +2954,21 @@ components:
- direction
- to
- from
customTooManyRequestsError:
title: CustomTooManyRequestsError
type: object
properties:
type:
type: string
example: rate_limit_exceeded
description:
type: string
example: >-
Rate limit exceeded. Wait for Retry-After time before sending
another request.
required:
- type
- description
callbackMethodEnum:
type: string
nullable: true
Expand Down Expand Up @@ -5875,15 +5900,13 @@ components:
type: object
internalTicketNumber:
type: string
format: uuid
description: >-
Unique identifier (UUID) generated by Bandwidth to assist in tracking
the verification status of a toll-free number - included in all webhook
payloads.
example: acde070d-8c4c-4f0d-9d8a-162843c10333
internalTicketNumberForWebhook:
type: string
format: uuid
description: >-
Unique identifier (UUID) generated by Bandwidth to assist in tracking
the verification status of a toll-free number.
Expand Down Expand Up @@ -5956,6 +5979,8 @@ components:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
cvToken:
$ref: '#/components/schemas/cvToken'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -6005,6 +6030,8 @@ components:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
cvToken:
$ref: '#/components/schemas/cvToken'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -6456,6 +6483,8 @@ components:
$ref: '#/components/schemas/blocked'
blockedReason:
$ref: '#/components/schemas/blockedReason'
cvToken:
$ref: '#/components/schemas/cvToken'
tfvSubmissionInfo:
type: object
properties:
Expand Down Expand Up @@ -6520,6 +6549,18 @@ components:
nullable: true
pattern: ^[ -~]{16,64}$
type: string
cvToken:
type: string
description: >-
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. If you pass an
empty string, it will be passed along and potentially rejected.
minLength: 0
maxLength: 500
nullable: true
example: >-
cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
responses:
createMessageResponse:
description: Accepted
Expand Down Expand Up @@ -6734,6 +6775,18 @@ components:
- type: internal-server-error
description: Internal server error. No further information available
source: {}
customTooManyRequestsError:
description: Too Many Requests
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
example: 300
content:
application/json:
schema:
$ref: '#/components/schemas/customTooManyRequestsError'
createCallResponse:
description: Created
headers:
Expand Down
20 changes: 20 additions & 0 deletions docs/CustomTooManyRequestsError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Bandwidth::CustomTooManyRequestsError

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **type** | **String** | | |
| **description** | **String** | | |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::CustomTooManyRequestsError.new(
type: rate_limit_exceeded,
description: Rate limit exceeded. Wait for Retry-After time before sending another request.
)
```

4 changes: 2 additions & 2 deletions docs/LookupResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ instance = Bandwidth::LookupResult.new(
deactivation_date: 2025-06-20 18:35,
deactivation_event: null,
latest_message_delivery_status: null,
initial_message_delivery_status_date: Thu Jun 19 20:00:00 EDT 2025,
latest_message_delivery_status_date: Fri Jun 20 20:00:00 EDT 2025
initial_message_delivery_status_date: Fri Jun 20 00:00:00 UTC 2025,
latest_message_delivery_status_date: Sat Jun 21 00:00:00 UTC 2025
)
```

2 changes: 1 addition & 1 deletion docs/MessagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ end

List Messages

Returns a list of messages based on query parameters.
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.

### Examples

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@13866865
postback_data: [B@19d13d04
)
```

2 changes: 1 addition & 1 deletion docs/RbmMessageMedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | |
| **media** | [**Array<RbmMessageContentFile>**](RbmMessageContentFile.md) | | |
| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] |

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ require 'bandwidth-sdk'

instance = Bandwidth::RbmSuggestionResponse.new(
text: Yes, I would like to proceed,
postback_data: [B@13866865
postback_data: [B@19d13d04
)
```

4 changes: 3 additions & 1 deletion docs/TfvStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
| **submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] |
| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] |

## Example

Expand All @@ -30,7 +31,8 @@ instance = Bandwidth::TfvStatus.new(
modified_date_time: 2021-06-08T06:45:13Z,
submission: null,
blocked: true,
blocked_reason: Toll-free number was used to send spam messages
blocked_reason: Toll-free number was used to send spam messages,
cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
)
```

4 changes: 3 additions & 1 deletion docs/VerificationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
| **age_gated_content** | **Boolean** | 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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] |

## Example

Expand All @@ -46,7 +47,8 @@ instance = Bandwidth::VerificationRequest.new(
business_registration_type: null,
business_entity_type: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false
age_gated_content: false,
cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
)
```

4 changes: 3 additions & 1 deletion docs/VerificationUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
| **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] |
| **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
| **age_gated_content** | **Boolean** | 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. If you pass an empty string, it will be passed along and potentially rejected. | [optional] |

## Example

Expand All @@ -44,7 +45,8 @@ instance = Bandwidth::VerificationUpdateRequest.new(
business_registration_type: null,
business_entity_type: null,
help_message_response: Please contact support for assistance.,
age_gated_content: false
age_gated_content: false,
cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
)
```

1 change: 1 addition & 0 deletions lib/bandwidth-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
require 'bandwidth-sdk/models/create_multi_channel_message_response'
require 'bandwidth-sdk/models/create_sync_lookup_response'
require 'bandwidth-sdk/models/create_sync_lookup_response_data'
require 'bandwidth-sdk/models/custom_too_many_requests_error'
require 'bandwidth-sdk/models/deactivation_event_enum'
require 'bandwidth-sdk/models/disconnect_callback'
require 'bandwidth-sdk/models/diversion'
Expand Down
4 changes: 2 additions & 2 deletions lib/bandwidth-sdk/api/messages_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def create_message_with_http_info(account_id, message_request, opts = {})
end

# List Messages
# Returns a list of messages based on query parameters.
# Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
# @param account_id [String] Your Bandwidth Account ID.
# @param [Hash] opts the optional parameters
# @option opts [String] :message_id The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
Expand Down Expand Up @@ -131,7 +131,7 @@ def list_messages(account_id, opts = {})
end

# List Messages
# Returns a list of messages based on query parameters.
# Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
# @param account_id [String] Your Bandwidth Account ID.
# @param [Hash] opts the optional parameters
# @option opts [String] :message_id The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
Expand Down
Loading