bandwidth-sdk 10.2.0 → 11.0.0.pre.beta.1

data/docs/MessagesApi.md

@@ -0,0 +1,179 @@
+# Bandwidth::MessagesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_message**](MessagesApi.md#create_message) | **POST** /users/{accountId}/messages | Create Message |
+| [**list_messages**](MessagesApi.md#list_messages) | **GET** /users/{accountId}/messages | List Messages |
+
+
+## create_message
+
+> <Message> create_message(account_id, message_request)
+
+Create Message
+
+Endpoint for sending text messages and picture messages using V2 messaging.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MessagesApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+message_request = Bandwidth::MessageRequest.new({application_id: '93de2206-9669-4e07-948d-329f4b722ee2', to: ["+15554443333", "+15552223333"], from: '+15551113333'}) # MessageRequest | 
+
+begin
+  # Create Message
+  result = api_instance.create_message(account_id, message_request)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MessagesApi->create_message: #{e}"
+end
+```
+
+#### Using the create_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> create_message_with_http_info(account_id, message_request)
+
+```ruby
+begin
+  # Create Message
+  data, status_code, headers = api_instance.create_message_with_http_info(account_id, message_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MessagesApi->create_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **message_request** | [**MessageRequest**](MessageRequest.md) |  |  |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_messages
+
+> <MessagesList> list_messages(account_id, opts)
+
+List Messages
+
+Returns a list of messages based on query parameters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MessagesApi.new
+account_id = '9900000' # String | Your Bandwidth 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').
+  destination_tn: '%2B15554443333', # 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').
+  message_status: Bandwidth::MessageStatusEnum::RECEIVED, # MessageStatusEnum | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
+  message_direction: Bandwidth::ListMessageDirectionEnum::INBOUND, # ListMessageDirectionEnum | The direction of the message. One of INBOUND OUTBOUND.
+  carrier_name: 'Verizon', # String | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
+  message_type: Bandwidth::MessageTypeEnum::SMS, # MessageTypeEnum | The type of message. Either sms or mms.
+  error_code: 9902, # Integer | The error code of the message.
+  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.
+  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.
+}
+
+begin
+  # List Messages
+  result = api_instance.list_messages(account_id, opts)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MessagesApi->list_messages: #{e}"
+end
+```
+
+#### Using the list_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessagesList>, Integer, Hash)> list_messages_with_http_info(account_id, opts)
+
+```ruby
+begin
+  # List Messages
+  data, status_code, headers = api_instance.list_messages_with_http_info(account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessagesList>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MessagesApi->list_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth 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. &#39;%2B1919&#39;). | [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. &#39;%2B1919&#39;). | [optional] |
+| **message_status** | [**MessageStatusEnum**](.md) | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. | [optional] |
+| **message_direction** | [**ListMessageDirectionEnum**](.md) | The direction of the message. One of INBOUND OUTBOUND. | [optional] |
+| **carrier_name** | **String** | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&amp;T should be passed as AT%26T). | [optional] |
+| **message_type** | [**MessageTypeEnum**](.md) | The type of message. Either sms or mms. | [optional] |
+| **error_code** | **Integer** | The error code of the message. | [optional] |
+| **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] |
+| **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] |
+
+### Return type
+
+[**MessagesList**](MessagesList.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MessagesList.md

@@ -0,0 +1,22 @@
+# Bandwidth::MessagesList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_count** | **Integer** | Total number of messages matched by the search. | [optional] |
+| **page_info** | [**PageInfo**](PageInfo.md) |  | [optional] |
+| **messages** | [**Array<ListMessageItem>**](ListMessageItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessagesList.new(
+  total_count: 100,
+  page_info: null,
+  messages: null
+)
+```
+

data/docs/MessagingCodeResponse.md

@@ -0,0 +1,18 @@
+# Bandwidth::MessagingCodeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** | Messaging API Message ID. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessagingCodeResponse.new(
+  message_id: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
+)
+```
+

data/docs/MessagingRequestError.md

@@ -0,0 +1,20 @@
+# Bandwidth::MessagingRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessagingRequestError.new(
+  type: null,
+  description: null
+)
+```
+

data/docs/MfaForbiddenRequestError.md

@@ -0,0 +1,18 @@
+# Bandwidth::MfaForbiddenRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The message containing the reason behind the request being forbidden. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MfaForbiddenRequestError.new(
+  message: Missing Authentication Token
+)
+```
+

data/docs/MfaRequestError.md

@@ -0,0 +1,20 @@
+# Bandwidth::MfaRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | A message describing the error with your request. | [optional] |
+| **request_id** | **String** | The associated requestId from AWS. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MfaRequestError.new(
+  error: 400 Request is malformed or invalid,
+  request_id: 354cc8a3-6701-461e-8fa7-8671703dd898
+)
+```
+

data/docs/MfaUnauthorizedRequestError.md

@@ -0,0 +1,18 @@
+# Bandwidth::MfaUnauthorizedRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Unauthorized | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MfaUnauthorizedRequestError.new(
+  message: Unauthorized
+)
+```
+

data/docs/PageInfo.md

@@ -0,0 +1,24 @@
+# Bandwidth::PageInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prev_page** | **String** | The link to the previous page for pagination. | [optional] |
+| **next_page** | **String** | The link to the next page for pagination. | [optional] |
+| **prev_page_token** | **String** | The isolated pagination token for the previous page. | [optional] |
+| **next_page_token** | **String** | The isolated pagination token for the next page. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::PageInfo.new(
+  prev_page: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&nextPage=DLAPE902,
+  next_page: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&prevPage=GL83PD3C,
+  prev_page_token: DLAPE902,
+  next_page_token: GL83PD3C
+)
+```
+

data/docs/Participant.md

@@ -0,0 +1,30 @@
+# Bandwidth::Participant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique id of the participant. | [optional][readonly] |
+| **callback_url** | **String** | Full callback url to use for notifications about this participant. | [optional] |
+| **publish_permissions** | [**Array<PublishPermissionsEnum>**](PublishPermissionsEnum.md) | Defines if this participant can publish audio or video. | [optional] |
+| **sessions** | **Array<String>** | List of session ids this participant is associated with  Capped to one  Upon creation of a Participant, returns as an empty array. | [optional][readonly] |
+| **subscriptions** | [**Subscriptions**](Subscriptions.md) |  | [optional] |
+| **tag** | **String** | User defined tag to associate with the participant. | [optional] |
+| **device_api_version** | [**DeviceApiVersionEnum**](DeviceApiVersionEnum.md) |  | [optional][default to 'V3'] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Participant.new(
+  id: 320e2af6-13ec-498d-8b51-daba52c37853,
+  callback_url: https://example.com/callback,
+  publish_permissions: ["VIDEO","AUDIO"],
+  sessions: ["75c21163-e110-41bc-bd76-1bb428ec85d5"],
+  subscriptions: null,
+  tag: participant1,
+  device_api_version: null
+)
+```
+

data/docs/ParticipantSubscription.md

@@ -0,0 +1,20 @@
+# Bandwidth::ParticipantSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **participant_id** | **String** | The Participant the subscriber will be subscribed to |  |
+| **stream_aliases** | **Array<String>** | (optional) An array of specific streamAliases owned by the Participant that the subscriber will be subscribed to. Background: A streamAlias is created by a WebRTC client when it connects and declares a name for the related stream. The client is responsible for informing the application of any created streamAliases to enable the application to subscribe to specific streamAliases. Subscribing to a `streamAlias` that does not exist is undefined. If the array is empty all aliases are assumed. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::ParticipantSubscription.new(
+  participant_id: 568749d5-04d5-483d-adf5-deac7dd3d521,
+  stream_aliases: ["alias_1","alias_2"]
+)
+```
+

data/docs/ParticipantsApi.md

@@ -0,0 +1,227 @@
+# Bandwidth::ParticipantsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_participant**](ParticipantsApi.md#create_participant) | **POST** /accounts/{accountId}/participants | Create Participant |
+| [**delete_participant**](ParticipantsApi.md#delete_participant) | **DELETE** /accounts/{accountId}/participants/{participantId} | Delete Participant |
+| [**get_participant**](ParticipantsApi.md#get_participant) | **GET** /accounts/{accountId}/participants/{participantId} | Get Participant |
+
+
+## create_participant
+
+> <CreateParticipantResponse> create_participant(account_id, opts)
+
+Create Participant
+
+Create a new participant under this account. Participants are idempotent, so relevant parameters must be set in this function if desired.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::ParticipantsApi.new
+account_id = '9900000' # String | Account ID
+opts = {
+  create_participant_request: Bandwidth::CreateParticipantRequest.new # CreateParticipantRequest | Create participant request body.
+}
+
+begin
+  # Create Participant
+  result = api_instance.create_participant(account_id, opts)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->create_participant: #{e}"
+end
+```
+
+#### Using the create_participant_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateParticipantResponse>, Integer, Hash)> create_participant_with_http_info(account_id, opts)
+
+```ruby
+begin
+  # Create Participant
+  data, status_code, headers = api_instance.create_participant_with_http_info(account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateParticipantResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->create_participant_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Account ID |  |
+| **create_participant_request** | [**CreateParticipantRequest**](CreateParticipantRequest.md) | Create participant request body. | [optional] |
+
+### Return type
+
+[**CreateParticipantResponse**](CreateParticipantResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_participant
+
+> delete_participant(account_id, participant_id)
+
+Delete Participant
+
+Delete participant by ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::ParticipantsApi.new
+account_id = '9900000' # String | Account ID
+participant_id = '62e0ecb9-0b1b-5115-aae4-4f36123d6bb1' # String | Participant ID
+
+begin
+  # Delete Participant
+  api_instance.delete_participant(account_id, participant_id)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->delete_participant: #{e}"
+end
+```
+
+#### Using the delete_participant_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_participant_with_http_info(account_id, participant_id)
+
+```ruby
+begin
+  # Delete Participant
+  data, status_code, headers = api_instance.delete_participant_with_http_info(account_id, participant_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->delete_participant_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Account ID |  |
+| **participant_id** | **String** | Participant ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_participant
+
+> <Participant> get_participant(account_id, participant_id)
+
+Get Participant
+
+Get participant by ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::ParticipantsApi.new
+account_id = '9900000' # String | Account ID
+participant_id = '62e0ecb9-0b1b-5115-aae4-4f36123d6bb1' # String | Participant ID
+
+begin
+  # Get Participant
+  result = api_instance.get_participant(account_id, participant_id)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->get_participant: #{e}"
+end
+```
+
+#### Using the get_participant_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Participant>, Integer, Hash)> get_participant_with_http_info(account_id, participant_id)
+
+```ruby
+begin
+  # Get Participant
+  data, status_code, headers = api_instance.get_participant_with_http_info(account_id, participant_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Participant>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling ParticipantsApi->get_participant_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Account ID |  |
+| **participant_id** | **String** | Participant ID |  |
+
+### Return type
+
+[**Participant**](Participant.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+