Skip to content

SWI-8413 Update SDK Based on Recent Spec Changes #180

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
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 @@ -100,6 +100,7 @@ docs/OptInWorkflow.md
docs/PageInfo.md
docs/PhoneNumberLookupApi.md
docs/PriorityEnum.md
docs/ProductTypeEnum.md
docs/RbmActionBase.md
docs/RbmActionDial.md
docs/RbmActionOpenUrl.md
Expand Down Expand Up @@ -271,6 +272,7 @@ lib/bandwidth-sdk/models/multi_channel_message_response_data_channel_list_inner.
lib/bandwidth-sdk/models/opt_in_workflow.rb
lib/bandwidth-sdk/models/page_info.rb
lib/bandwidth-sdk/models/priority_enum.rb
lib/bandwidth-sdk/models/product_type_enum.rb
lib/bandwidth-sdk/models/rbm_action_base.rb
lib/bandwidth-sdk/models/rbm_action_dial.rb
lib/bandwidth-sdk/models/rbm_action_open_url.rb
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ Class | Method | HTTP request | Description
- [Bandwidth::OptInWorkflow](docs/OptInWorkflow.md)
- [Bandwidth::PageInfo](docs/PageInfo.md)
- [Bandwidth::PriorityEnum](docs/PriorityEnum.md)
- [Bandwidth::ProductTypeEnum](docs/ProductTypeEnum.md)
- [Bandwidth::RbmActionBase](docs/RbmActionBase.md)
- [Bandwidth::RbmActionDial](docs/RbmActionDial.md)
- [Bandwidth::RbmActionOpenUrl](docs/RbmActionOpenUrl.md)
Expand Down
136 changes: 136 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,16 @@ paths:
- $ref: '#/components/parameters/fromDateTime'
- $ref: '#/components/parameters/toDateTime'
- $ref: '#/components/parameters/campaignId'
- $ref: '#/components/parameters/fromBwLatency'
- $ref: '#/components/parameters/bwQueued'
- $ref: '#/components/parameters/product'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/callingNumberCountryA3'
- $ref: '#/components/parameters/calledNumberCountryA3'
- $ref: '#/components/parameters/fromSegmentCount'
- $ref: '#/components/parameters/toSegmentCount'
- $ref: '#/components/parameters/fromMessageSize'
- $ref: '#/components/parameters/toMessageSize'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/limit'
Expand Down Expand Up @@ -1716,7 +1726,22 @@ components:
enum:
- sms
- mms
- rcs
example: sms
productTypeEnum:
type: string
description: The type of product associated with the message.
enum:
- LOCAL_A2P
- P2P
- SHORT_CODE_REACH
- TOLL_FREE
- HOSTED_SHORT_CODE
- ALPHA_NUMERIC
- RBM_MEDIA
- RBM_RICH
- RBM_CONVERSATIONAL
example: P2P
fieldError:
type: object
properties:
Expand Down Expand Up @@ -1819,6 +1844,33 @@ components:
description: The campaign ID of the message if it has one.
nullable: true
example: CJEUMDK
bwLatency:
type: integer
description: >-
The Bandwidth latency of the message in seconds. Only available for
accounts with the Advanced Quality Metrics feature enabled.
nullable: true
example: 20
callingNumberCountryA3:
type: string
description: The A3 country code of the calling number.
nullable: true
example: USA
calledNumberCountryA3:
type: string
description: The A3 country code of the called number.
nullable: true
example: USA
product:
type: string
description: The messaging product associated with the message.
nullable: true
example: P2P
location:
type: string
description: The location ID associated with this message.
nullable: true
example: 123ID
pageInfo:
title: PageInfo
type: object
Expand Down Expand Up @@ -6940,6 +6992,90 @@ components:
example: CJEUMDK
schema:
type: string
fromBwLatency:
in: query
name: fromBwLatency
required: false
description: >-
The minimum Bandwidth latency of the message in seconds. Only available
for accounts with the Advanced Quality Metrics feature enabled.
example: 5
schema:
type: integer
bwQueued:
in: query
name: bwQueued
required: false
description: >-
A boolean value indicating whether the message is queued in the
Bandwidth network.
example: true
schema:
type: boolean
product:
in: query
name: product
required: false
description: Messaging product associated with the message.
example: P2P
schema:
$ref: '#/components/schemas/productTypeEnum'
location:
in: query
name: location
required: false
description: Location Id associated with the message.
example: 123ABC
schema:
type: string
callingNumberCountryA3:
in: query
name: callingNumberCountryA3
required: false
description: Calling number country in A3 format.
example: USA
schema:
type: string
calledNumberCountryA3:
in: query
name: calledNumberCountryA3
required: false
description: Called number country in A3 format.
example: USA
schema:
type: string
fromSegmentCount:
in: query
name: fromSegmentCount
required: false
description: Segment count (start range).
example: 1
schema:
type: integer
toSegmentCount:
in: query
name: toSegmentCount
required: false
description: Segment count (end range).
example: 3
schema:
type: integer
fromMessageSize:
in: query
name: fromMessageSize
required: false
description: Message size (start range).
example: 100
schema:
type: integer
toMessageSize:
in: query
name: toMessageSize
required: false
description: Message size (end range).
example: 120
schema:
type: integer
sort:
in: query
name: sort
Expand Down
12 changes: 11 additions & 1 deletion docs/ListMessageItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
| **recipient_count** | **Integer** | The number of recipients the message has. | [optional] |
| **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
| **campaign_id** | **String** | The campaign ID of the message if it has one. | [optional] |
| **bw_latency** | **Integer** | The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **calling_number_country_a3** | **String** | The A3 country code of the calling number. | [optional] |
| **called_number_country_a3** | **String** | The A3 country code of the called number. | [optional] |
| **product** | **String** | The messaging product associated with the message. | [optional] |
| **location** | **String** | The location ID associated with this message. | [optional] |

## Example

Expand All @@ -44,7 +49,12 @@ instance = Bandwidth::ListMessageItem.new(
attachment_count: 1,
recipient_count: 1,
campaign_class: T,
campaign_id: CJEUMDK
campaign_id: CJEUMDK,
bw_latency: 20,
calling_number_country_a3: USA,
called_number_country_a3: USA,
product: P2P,
location: 123ID
)
```

20 changes: 20 additions & 0 deletions docs/MessagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,16 @@ opts = {
from_date_time: '2022-09-14T18:20:16.000Z', # String | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
to_date_time: '2022-09-14T18:20:16.000Z', # String | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
campaign_id: 'CJEUMDK', # String | The campaign ID of the message.
from_bw_latency: 5, # Integer | The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
bw_queued: true, # Boolean | A boolean value indicating whether the message is queued in the Bandwidth network.
product: Bandwidth::ProductTypeEnum::LOCAL_A2_P, # ProductTypeEnum | Messaging product associated with the message.
location: '123ABC', # String | Location Id associated with the message.
calling_number_country_a3: 'USA', # String | Calling number country in A3 format.
called_number_country_a3: 'USA', # String | Called number country in A3 format.
from_segment_count: 1, # Integer | Segment count (start range).
to_segment_count: 3, # Integer | Segment count (end range).
from_message_size: 100, # Integer | Message size (start range).
to_message_size: 120, # Integer | Message size (end range).
sort: 'sourceTn:desc', # String | The field and direction to sort by combined with a colon. Direction is either asc or desc.
page_token: 'gdEewhcJLQRB5', # String | A base64 encoded value used for pagination of results.
limit: 50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
Expand Down Expand Up @@ -163,6 +173,16 @@ end
| **from_date_time** | **String** | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
| **to_date_time** | **String** | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
| **campaign_id** | **String** | The campaign ID of the message. | [optional] |
| **from_bw_latency** | **Integer** | The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] |
| **bw_queued** | **Boolean** | A boolean value indicating whether the message is queued in the Bandwidth network. | [optional] |
| **product** | [**ProductTypeEnum**](.md) | Messaging product associated with the message. | [optional] |
| **location** | **String** | Location Id associated with the message. | [optional] |
| **calling_number_country_a3** | **String** | Calling number country in A3 format. | [optional] |
| **called_number_country_a3** | **String** | Called number country in A3 format. | [optional] |
| **from_segment_count** | **Integer** | Segment count (start range). | [optional] |
| **to_segment_count** | **Integer** | Segment count (end range). | [optional] |
| **from_message_size** | **Integer** | Message size (start range). | [optional] |
| **to_message_size** | **Integer** | Message size (end range). | [optional] |
| **sort** | **String** | The field and direction to sort by combined with a colon. Direction is either asc or desc. | [optional] |
| **page_token** | **String** | A base64 encoded value used for pagination of results. | [optional] |
| **limit** | **Integer** | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | [optional] |
Expand Down
15 changes: 15 additions & 0 deletions docs/ProductTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Bandwidth::ProductTypeEnum

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |

## Example

```ruby
require 'bandwidth-sdk'

instance = Bandwidth::ProductTypeEnum.new()
```

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@2c6aa46c
postback_data: [B@12ebfb2d
)
```

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@2c6aa46c
postback_data: [B@12ebfb2d
)
```

1 change: 1 addition & 0 deletions lib/bandwidth-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
require 'bandwidth-sdk/models/opt_in_workflow'
require 'bandwidth-sdk/models/page_info'
require 'bandwidth-sdk/models/priority_enum'
require 'bandwidth-sdk/models/product_type_enum'
require 'bandwidth-sdk/models/rbm_action_base'
require 'bandwidth-sdk/models/rbm_action_dial'
require 'bandwidth-sdk/models/rbm_action_open_url'
Expand Down
30 changes: 30 additions & 0 deletions lib/bandwidth-sdk/api/messages_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,16 @@ def create_message_with_http_info(account_id, message_request, opts = {})
# @option opts [String] :from_date_time The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
# @option opts [String] :to_date_time The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
# @option opts [String] :campaign_id The campaign ID of the message.
# @option opts [Integer] :from_bw_latency The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
# @option opts [Boolean] :bw_queued A boolean value indicating whether the message is queued in the Bandwidth network.
# @option opts [ProductTypeEnum] :product Messaging product associated with the message.
# @option opts [String] :location Location Id associated with the message.
# @option opts [String] :calling_number_country_a3 Calling number country in A3 format.
# @option opts [String] :called_number_country_a3 Called number country in A3 format.
# @option opts [Integer] :from_segment_count Segment count (start range).
# @option opts [Integer] :to_segment_count Segment count (end range).
# @option opts [Integer] :from_message_size Message size (start range).
# @option opts [Integer] :to_message_size Message size (end range).
# @option opts [String] :sort The field and direction to sort by combined with a colon. Direction is either asc or desc.
# @option opts [String] :page_token A base64 encoded value used for pagination of results.
# @option opts [Integer] :limit The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
Expand All @@ -133,6 +143,16 @@ def list_messages(account_id, opts = {})
# @option opts [String] :from_date_time The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
# @option opts [String] :to_date_time The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
# @option opts [String] :campaign_id The campaign ID of the message.
# @option opts [Integer] :from_bw_latency The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
# @option opts [Boolean] :bw_queued A boolean value indicating whether the message is queued in the Bandwidth network.
# @option opts [ProductTypeEnum] :product Messaging product associated with the message.
# @option opts [String] :location Location Id associated with the message.
# @option opts [String] :calling_number_country_a3 Calling number country in A3 format.
# @option opts [String] :called_number_country_a3 Called number country in A3 format.
# @option opts [Integer] :from_segment_count Segment count (start range).
# @option opts [Integer] :to_segment_count Segment count (end range).
# @option opts [Integer] :from_message_size Message size (start range).
# @option opts [Integer] :to_message_size Message size (end range).
# @option opts [String] :sort The field and direction to sort by combined with a colon. Direction is either asc or desc.
# @option opts [String] :page_token A base64 encoded value used for pagination of results.
# @option opts [Integer] :limit The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
Expand Down Expand Up @@ -162,6 +182,16 @@ def list_messages_with_http_info(account_id, opts = {})
query_params[:'fromDateTime'] = opts[:'from_date_time'] if !opts[:'from_date_time'].nil?
query_params[:'toDateTime'] = opts[:'to_date_time'] if !opts[:'to_date_time'].nil?
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
query_params[:'fromBwLatency'] = opts[:'from_bw_latency'] if !opts[:'from_bw_latency'].nil?
query_params[:'bwQueued'] = opts[:'bw_queued'] if !opts[:'bw_queued'].nil?
query_params[:'product'] = opts[:'product'] if !opts[:'product'].nil?
query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
query_params[:'callingNumberCountryA3'] = opts[:'calling_number_country_a3'] if !opts[:'calling_number_country_a3'].nil?
query_params[:'calledNumberCountryA3'] = opts[:'called_number_country_a3'] if !opts[:'called_number_country_a3'].nil?
query_params[:'fromSegmentCount'] = opts[:'from_segment_count'] if !opts[:'from_segment_count'].nil?
query_params[:'toSegmentCount'] = opts[:'to_segment_count'] if !opts[:'to_segment_count'].nil?
query_params[:'fromMessageSize'] = opts[:'from_message_size'] if !opts[:'from_message_size'].nil?
query_params[:'toMessageSize'] = opts[:'to_message_size'] if !opts[:'to_message_size'].nil?
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
Expand Down
Loading
Loading