bandwidth-sdk 14.0.0 → 14.1.1

data/docs/DisconenctCallback.md

@@ -1,50 +0,0 @@
-# Bandwidth::DisconenctCallback
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
-| **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
-| **account_id** | **String** | The user account associated with the call. | [optional] |
-| **application_id** | **String** | The id of the application associated with the call. | [optional] |
-| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
-| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
-| **call_id** | **String** | The call id associated with the event. | [optional] |
-| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
-| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
-| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
-| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
-| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
-| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
-| **cause** | **String** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] |
-| **error_message** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] |
-| **error_id** | **String** | Bandwidth's internal id that references the error event. | [optional] |
-| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::DisconenctCallback.new(
-  event_type: bridgeComplete,
-  event_time: null,
-  account_id: 920012,
-  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
-  from: +15555555555,
-  to: +15555555555,
-  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
-  direction: null,
-  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
-  enqueued_time: 2022-06-17T22:20Z,
-  start_time: 2022-06-17T22:19:40.375Z,
-  answer_time: 2022-06-17T22:20Z,
-  end_time: 2022-06-17T22:20Z,
-  cause: busy,
-  error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
-  error_id: 4642074b-7b58-478b-96e4-3a60955c6765,
-  tag: exampleTag
-)
-```
-

data/docs/ForbiddenRequest.md

@@ -1,18 +0,0 @@
-# Bandwidth::ForbiddenRequest
-
-## 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::ForbiddenRequest.new(
-  message: Missing Authentication Token
-)
-```
-

data/docs/InboundMessageCallback.md

@@ -1,26 +0,0 @@
-# Bandwidth::InboundMessageCallback
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **time** | **Time** |  |  |
-| **type** | **String** |  |  |
-| **to** | **String** |  |  |
-| **description** | **String** |  |  |
-| **message** | [**InboundMessageCallbackMessage**](InboundMessageCallbackMessage.md) |  |  |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::InboundMessageCallback.new(
-  time: 2016-09-14T18:20:16Z,
-  type: message-received,
-  to: +15552223333,
-  description: Incoming message received,
-  message: null
-)
-```
-

data/docs/InboundMessageCallbackMessage.md

@@ -1,40 +0,0 @@
-# Bandwidth::InboundMessageCallbackMessage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **owner** | **String** |  |  |
-| **application_id** | **String** |  |  |
-| **time** | **Time** |  |  |
-| **segment_count** | **Integer** |  |  |
-| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
-| **to** | **Array<String>** |  |  |
-| **from** | **String** |  |  |
-| **text** | **String** |  |  |
-| **tag** | **String** |  | [optional] |
-| **media** | **Array<String>** |  | [optional] |
-| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::InboundMessageCallbackMessage.new(
-  id: 1661365814859loidf7mcwd4qacn7,
-  owner: +15553332222,
-  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
-  time: 2016-09-14T18:20:16Z,
-  segment_count: 1,
-  direction: null,
-  to: ["+15552223333"],
-  from: +15553332222,
-  text: Hello world,
-  tag: custom string,
-  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
-  priority: null
-)
-```
-

data/docs/MessageDeliveredCallback.md

@@ -1,26 +0,0 @@
-# Bandwidth::MessageDeliveredCallback
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **time** | **Time** |  |  |
-| **type** | **String** |  |  |
-| **to** | **String** |  |  |
-| **description** | **String** |  |  |
-| **message** | [**MessageDeliveredCallbackMessage**](MessageDeliveredCallbackMessage.md) |  |  |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageDeliveredCallback.new(
-  time: 2016-09-14T18:20:16Z,
-  type: message-delivered,
-  to: +15552223333,
-  description: Message delivered to carrier.,
-  message: null
-)
-```
-

data/docs/MessageDeliveredCallbackMessage.md

@@ -1,40 +0,0 @@
-# Bandwidth::MessageDeliveredCallbackMessage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **owner** | **String** |  |  |
-| **application_id** | **String** |  |  |
-| **time** | **Time** |  |  |
-| **segment_count** | **Integer** |  |  |
-| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
-| **to** | **Array<String>** |  |  |
-| **from** | **String** |  |  |
-| **text** | **String** |  |  |
-| **tag** | **String** |  |  |
-| **media** | **Array<String>** |  | [optional] |
-| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageDeliveredCallbackMessage.new(
-  id: 1661365814859loidf7mcwd4qacn7,
-  owner: +15553332222,
-  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
-  time: 2016-09-14T18:20:16Z,
-  segment_count: 1,
-  direction: null,
-  to: ["+15552223333"],
-  from: +15553332222,
-  text: Hello world,
-  tag: custom string,
-  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
-  priority: null
-)
-```
-

data/docs/MessageFailedCallback.md

@@ -1,28 +0,0 @@
-# Bandwidth::MessageFailedCallback
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **time** | **Time** |  |  |
-| **type** | **String** |  |  |
-| **to** | **String** |  |  |
-| **description** | **String** |  |  |
-| **message** | [**MessageFailedCallbackMessage**](MessageFailedCallbackMessage.md) |  |  |
-| **error_code** | **Integer** |  |  |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageFailedCallback.new(
-  time: 2016-09-14T18:20:16Z,
-  type: message-failed,
-  to: +15552223333,
-  description: rejected-unallocated-from-number,
-  message: null,
-  error_code: 9902
-)
-```
-

data/docs/MessageFailedCallbackMessage.md

@@ -1,40 +0,0 @@
-# Bandwidth::MessageFailedCallbackMessage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **owner** | **String** |  |  |
-| **application_id** | **String** |  |  |
-| **time** | **Time** |  |  |
-| **segment_count** | **Integer** |  |  |
-| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
-| **to** | **Array<String>** |  |  |
-| **from** | **String** |  |  |
-| **text** | **String** |  |  |
-| **tag** | **String** |  |  |
-| **media** | **Array<String>** |  | [optional] |
-| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageFailedCallbackMessage.new(
-  id: 1661365814859loidf7mcwd4qacn7,
-  owner: +15553332222,
-  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
-  time: 2016-09-14T18:20:16Z,
-  segment_count: 1,
-  direction: null,
-  to: ["+15552223333"],
-  from: +15553332222,
-  text: Hello world,
-  tag: custom string,
-  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
-  priority: null
-)
-```
-

data/docs/MessageSendingCallback.md

@@ -1,26 +0,0 @@
-# Bandwidth::MessageSendingCallback
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **time** | **Time** |  |  |
-| **type** | **String** |  |  |
-| **to** | **String** |  |  |
-| **description** | **String** |  |  |
-| **message** | [**MessageSendingCallbackMessage**](MessageSendingCallbackMessage.md) |  |  |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageSendingCallback.new(
-  time: 2016-09-14T18:20:16Z,
-  type: message-sending,
-  to: +15552223333,
-  description: Message is sending to carrier,
-  message: null
-)
-```
-

data/docs/MessageSendingCallbackMessage.md

@@ -1,40 +0,0 @@
-# Bandwidth::MessageSendingCallbackMessage
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **owner** | **String** |  |  |
-| **application_id** | **String** |  |  |
-| **time** | **Time** |  |  |
-| **segment_count** | **Integer** |  |  |
-| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
-| **to** | **Array<String>** |  |  |
-| **from** | **String** |  |  |
-| **text** | **String** |  |  |
-| **tag** | **String** |  | [optional] |
-| **media** | **Array<String>** |  |  |
-| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::MessageSendingCallbackMessage.new(
-  id: 1661365814859loidf7mcwd4qacn7,
-  owner: +15553332222,
-  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
-  time: 2016-09-14T18:20:16Z,
-  segment_count: 1,
-  direction: null,
-  to: ["+15552223333"],
-  from: +15553332222,
-  text: Hello world,
-  tag: custom string,
-  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
-  priority: null
-)
-```
-

data/docs/Participant.md

@@ -1,30 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,227 +0,0 @@
-# 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
-

data/docs/RequestError.md

@@ -1,20 +0,0 @@
-# Bandwidth::RequestError
-
-## 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::RequestError.new(
-  error: Internal error,
-  request_id: 12af78d1-5f88-4917-925d-17c1ac8fda7a
-)
-```
-

data/docs/Session.md

@@ -1,20 +0,0 @@
-# Bandwidth::Session
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique id of the session. | [optional] |
-| **tag** | **String** | User defined tag to associate with the session. | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::Session.new(
-  id: 75c21163-e110-41bc-bd76-1bb428ec85d5,
-  tag: session1
-)
-```
-