Skip to content

SWI-11959 Update SDK Based on Recent Spec Changes #219

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

Open
band-swi-release-engineering wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SWI-11959 Update SDK Based on Recent Spec Changes #219

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
136 changes: 87 additions & 49 deletions bandwidth.yml
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/MediaApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MediaApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.

begin
Expand Down Expand Up @@ -67,7 +67,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **media_id** | **String** | Media ID to retrieve. | |

### Return type
Expand Down Expand Up @@ -108,7 +108,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MediaApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.

begin
Expand Down Expand Up @@ -142,7 +142,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **media_id** | **String** | Media ID to retrieve. | |

### Return type
Expand Down Expand Up @@ -183,7 +183,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MediaApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
opts = {
continuation_token: '1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39' # String | Continuation token used to retrieve subsequent media.
}
Expand Down Expand Up @@ -219,7 +219,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **continuation_token** | **String** | Continuation token used to retrieve subsequent media. | [optional] |

### Return type
Expand Down Expand Up @@ -260,7 +260,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MediaApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
body = File.new('/path/to/some/file') # File |
opts = {
Expand Down Expand Up @@ -298,7 +298,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **media_id** | **String** | Media ID to retrieve. | |
| **body** | **File** | | |
| **content_type** | **String** | The media type of the entity-body. | [optional] |
Expand Down
8 changes: 4 additions & 4 deletions docs/MessagesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MessagesApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
message_request = Bandwidth::MessageRequest.new({application_id: '93de2206-9669-4e07-948d-329f4b722ee2', to: ["+15554443333", "+15552223333"], from: '+15551113333'}) # MessageRequest |

begin
Expand Down Expand Up @@ -66,7 +66,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **message_request** | [**MessageRequest**](MessageRequest.md) | | |

### Return type
Expand Down Expand Up @@ -107,7 +107,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MessagesApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
opts = {
message_id: '9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # String | 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.
source_tn: '%2B15554443333', # String | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
Expand Down Expand Up @@ -169,7 +169,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **message_id** | **String** | 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. | [optional] |
| **source_tn** | **String** | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
| **destination_tn** | **String** | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
Expand Down
4 changes: 2 additions & 2 deletions docs/MultiChannelApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Bandwidth.configure do |config|
end

api_instance = Bandwidth::MultiChannelApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
account_id = '9900000' # 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.**
multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new({to: '+15552223333', channel_list: [Bandwidth::MultiChannelChannelListRequestObject.new({from: 'BandwidthRBM', application_id: '93de2206-9669-4e07-948d-329f4b722ee2', channel: Bandwidth::MultiChannelMessageChannelEnum::RBM, content: Bandwidth::MmsMessageContent.new})]}) # MultiChannelMessageRequest |

begin
Expand Down Expand Up @@ -65,7 +65,7 @@ end

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your Bandwidth Account ID. | |
| **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.** | |
| **multi_channel_message_request** | [**MultiChannelMessageRequest**](MultiChannelMessageRequest.md) | | |

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmActionBase.md
View file
Open in desktop
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@3dabdd11
postback_data: [B@1ecf784f
)
```

2 changes: 1 addition & 1 deletion docs/RbmSuggestionResponse.md
View file
Open in desktop
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@3dabdd11,
postback_data: [B@1ecf784f,
paired_message_id: 1752697342534u24xerqdukke523x
)
```
Expand Down
16 changes: 8 additions & 8 deletions lib/bandwidth-sdk/api/media_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default)
end
# Delete Media
# Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
# @param account_id [String] Your Bandwidth Account ID.
# @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] Media ID to retrieve.
# @param [Hash] opts the optional parameters
# @return [nil]
Expand All @@ -32,7 +32,7 @@ def delete_media(account_id, media_id, opts = {})

# Delete Media
# Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
# @param account_id [String] Your Bandwidth Account ID.
# @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] Media ID to retrieve.
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
Expand Down Expand Up @@ -90,7 +90,7 @@ def delete_media_with_http_info(account_id, media_id, opts = {})

# Get Media
# Downloads a media file you previously uploaded.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param media_id [String] Media ID to retrieve.
# @param [Hash] opts the optional parameters
# @return [File]
Expand All @@ -101,7 +101,7 @@ def get_media(account_id, media_id, opts = {})

# Get Media
# Downloads a media file you previously uploaded.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param media_id [String] Media ID to retrieve.
# @param [Hash] opts the optional parameters
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
Expand Down Expand Up @@ -159,7 +159,7 @@ def get_media_with_http_info(account_id, media_id, opts = {})

# List Media
# Gets a list of your media files. No query parameters are supported.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param [Hash] opts the optional parameters
# @option opts [String] :continuation_token Continuation token used to retrieve subsequent media.
# @return [Array<Media>]
Expand All @@ -170,7 +170,7 @@ def list_media(account_id, opts = {})

# List Media
# Gets a list of your media files. No query parameters are supported.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param [Hash] opts the optional parameters
# @option opts [String] :continuation_token Continuation token used to retrieve subsequent media.
# @return [Array<(Array<Media>, Integer, Hash)>] Array<Media> data, response status code and response headers
Expand Down Expand Up @@ -225,7 +225,7 @@ def list_media_with_http_info(account_id, opts = {})

# 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).
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param media_id [String] Media ID to retrieve.
# @param body [File]
# @param [Hash] opts the optional parameters
Expand All @@ -239,7 +239,7 @@ def upload_media(account_id, media_id, body, opts = {})

# 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).
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param media_id [String] Media ID to retrieve.
# @param body [File]
# @param [Hash] opts the optional parameters
Expand Down
8 changes: 4 additions & 4 deletions lib/bandwidth-sdk/api/messages_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default)
end
# Create Message
# Endpoint for sending text messages and picture messages using V2 messaging.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param message_request [MessageRequest]
# @param [Hash] opts the optional parameters
# @return [Message]
Expand All @@ -32,7 +32,7 @@ def create_message(account_id, message_request, opts = {})

# Create Message
# Endpoint for sending text messages and picture messages using V2 messaging.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
# @param message_request [MessageRequest]
# @param [Hash] opts the optional parameters
# @return [Array<(Message, Integer, Hash)>] Message data, response status code and response headers
Expand Down Expand Up @@ -95,7 +95,7 @@ def create_message_with_http_info(account_id, message_request, opts = {})

# List Messages
# 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 account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit 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.
# @option opts [String] :source_tn The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).
Expand Down Expand Up @@ -132,7 +132,7 @@ def list_messages(account_id, opts = {})

# List Messages
# 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 &#x60;Retry-After&#x60; header.
# @param account_id [String] Your Bandwidth Account ID.
# @param account_id [String] This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit 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.
# @option opts [String] :source_tn The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).
Expand Down
Loading