bandwidth-sdk 10.3.0 → 11.0.0.pre.beta.1.1

data/docs/CreateCall.md

@@ -0,0 +1,54 @@
+# Bandwidth::CreateCall
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **String** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.com`)). |  |
+| **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`, or be one of the following strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). |  |
+| **uui** | **String** | A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433'>RFC 7433</a>. Only 'jwt' and 'base64' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] |
+| **application_id** | **String** | The id of the application associated with the `from` number. |  |
+| **answer_url** | **String** | The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call.  Must use `https` if specifying `username` and `password` |  |
+| **answer_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [optional] |
+| **answer_fallback_url** | **String** | A fallback url which, if provided, will be used to retry the `answer` webhook delivery in case `answerUrl` fails to respond  Must use `https` if specifying `fallbackUsername` and `fallbackPassword` | [optional] |
+| **answer_fallback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **fallback_username** | **String** | Basic auth username. | [optional] |
+| **fallback_password** | **String** | Basic auth password. | [optional] |
+| **disconnect_url** | **String** | The URL to send the <a href='/docs/voice/webhooks/disconnect'>Disconnect</a> event to when the call ends. This event does not expect a BXML response. | [optional] |
+| **disconnect_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **call_timeout** | **Float** | The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value.  Can be any numeric value (including decimals) between 1 and 300. | [optional][default to 30] |
+| **callback_timeout** | **Float** | This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. | [optional][default to 15] |
+| **machine_detection** | [**MachineDetectionConfiguration**](MachineDetectionConfiguration.md) |  | [optional] |
+| **priority** | **Integer** | The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. | [optional][default to 5] |
+| **tag** | **String** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href='/docs/voice/bxml/tag'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared.  May be cleared by setting `tag=\"\"`  Max length 256 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateCall.new(
+  to: +19195551234,
+  from: +19195554321,
+  uui: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ=;encoding=base64,
+  application_id: 1234-qwer-5679-tyui,
+  answer_url: https://www.myCallbackServer.com/webhooks/answer,
+  answer_method: null,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  answer_fallback_url: https://www.myFallbackServer.com/webhooks/answer,
+  answer_fallback_method: null,
+  fallback_username: mySecretUsername,
+  fallback_password: mySecretPassword1!,
+  disconnect_url: null,
+  disconnect_method: null,
+  call_timeout: null,
+  callback_timeout: null,
+  machine_detection: null,
+  priority: null,
+  tag: null
+)
+```
+

data/docs/CreateCallResponse.md

@@ -0,0 +1,58 @@
+# Bandwidth::CreateCallResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The id of the application associated with the `from` number. |  |
+| **account_id** | **String** | The bandwidth account ID associated with the call |  |
+| **call_id** | **String** | Programmable Voice API Call ID |  |
+| **to** | **String** | Recipient of the outgoing call |  |
+| **from** | **String** | Phone number that created the outbound call |  |
+| **enqueued_time** | **Time** | Time the call was accepted into the queue | [optional] |
+| **call_url** | **String** | The URL to update call state |  |
+| **call_timeout** | **Float** | The timeout (in seconds) for the callee to answer the call after it starts ringing. | [optional] |
+| **callback_timeout** | **Float** | This is the timeout (in seconds) to use when delivering webhooks for the call. | [optional] |
+| **tag** | **String** | Custom tag value | [optional] |
+| **answer_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [default to 'POST'] |
+| **answer_url** | **String** | URL to deliver the `answer` event webhook. |  |
+| **answer_fallback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **answer_fallback_url** | **String** | Fallback URL to deliver the `answer` event webhook. | [optional] |
+| **disconnect_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [default to 'POST'] |
+| **disconnect_url** | **String** | URL to deliver the `disconnect` event webhook. | [optional] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [optional] |
+| **fallback_username** | **String** | Basic auth username. | [optional] |
+| **fallback_password** | **String** | Basic auth password. | [optional] |
+| **priority** | **Float** | The priority of this call over other calls from your account. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateCallResponse.new(
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  account_id: 9900000,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  to: +19195551234,
+  from: +19195554321,
+  enqueued_time: 2022-06-16T13:15:07.160Z,
+  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  call_timeout: 30,
+  callback_timeout: 15,
+  tag: My custom tag value,
+  answer_method: null,
+  answer_url: https://myServer.com/bandwidth/webhooks/answer,
+  answer_fallback_method: null,
+  answer_fallback_url: https://myFallbackServer.com/bandwidth/webhooks/answer,
+  disconnect_method: null,
+  disconnect_url: https://myServer.com/bandwidth/webhooks/disconnect,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  fallback_username: mySecretUsername,
+  fallback_password: mySecretPassword1!,
+  priority: 5
+)
+```
+

data/docs/CreateLookupResponse.md

@@ -0,0 +1,20 @@
+# Bandwidth::CreateLookupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** | The phone number lookup request ID from Bandwidth. | [optional] |
+| **status** | [**LookupStatusEnum**](LookupStatusEnum.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateLookupResponse.new(
+  request_id: null,
+  status: null
+)
+```
+

data/docs/CreateMessageRequestError.md

@@ -0,0 +1,22 @@
+# Bandwidth::CreateMessageRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **description** | **String** |  |  |
+| **field_errors** | [**Array<FieldError>**](FieldError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateMessageRequestError.new(
+  type: null,
+  description: null,
+  field_errors: null
+)
+```
+

data/docs/CreateParticipantRequest.md

@@ -0,0 +1,24 @@
+# Bandwidth::CreateParticipantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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::CreateParticipantRequest.new(
+  callback_url: https://example.com/callback,
+  publish_permissions: ["VIDEO","AUDIO"],
+  tag: participant1,
+  device_api_version: null
+)
+```
+

data/docs/CreateParticipantResponse.md

@@ -0,0 +1,20 @@
+# Bandwidth::CreateParticipantResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **participant** | [**Participant**](Participant.md) |  | [optional] |
+| **token** | **String** | Auth token for the returned participant.  This should be passed to the participant so that they can connect to the platform. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateParticipantResponse.new(
+  participant: null,
+  token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWF0IjoxNTE2MjM5MDIyfQ.L8i6g3PfcHlioHCCPURC9pmXT7gdJpx3kOoyAfNUwCc
+)
+```
+

data/docs/DeferredResult.md

@@ -0,0 +1,20 @@
+# Bandwidth::DeferredResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **Object** |  | [optional] |
+| **set_or_expired** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::DeferredResult.new(
+  result: null,
+  set_or_expired: null
+)
+```
+

data/docs/DeviceApiVersionEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::DeviceApiVersionEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::DeviceApiVersionEnum.new()
+```
+

data/docs/DisconenctCallback.md

@@ -0,0 +1,50 @@
+# 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/DisconnectCallback.md

@@ -0,0 +1,50 @@
+# Bandwidth::DisconnectCallback
+
+## 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::DisconnectCallback.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/Diversion.md

@@ -0,0 +1,30 @@
+# Bandwidth::Diversion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | The reason for the diversion. Common values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. | [optional] |
+| **privacy** | **String** | off or full | [optional] |
+| **screen** | **String** | No if the number was provided by the user, yes if the number was provided by the network | [optional] |
+| **counter** | **String** | The number of diversions that have occurred | [optional] |
+| **limit** | **String** | The maximum number of diversions allowed for this session | [optional] |
+| **unknown** | **String** | The normal list of values is not exhaustive. Your application must be tolerant of unlisted keys and unlisted values of those keys. | [optional] |
+| **orig_to** | **String** | Always present. Indicates the last telephone number that the call was diverted from. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Diversion.new(
+  reason: unavailable,
+  privacy: off,
+  screen: no,
+  counter: 2,
+  limit: 3,
+  unknown: unknownValue,
+  orig_to: +15558884444
+)
+```
+

data/docs/DtmfCallback.md

@@ -0,0 +1,50 @@
+# Bandwidth::DtmfCallback
+
+## 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] |
+| **digit** | **String** | The digit collected in the call. | [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] |
+| **parent_call_id** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] |
+| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
+| **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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::DtmfCallback.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,
+  digit: 2,
+  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,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555),
+  tag: exampleTag
+)
+```
+

data/docs/FieldError.md

@@ -0,0 +1,20 @@
+# Bandwidth::FieldError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** | The name of the field that contains the error | [optional] |
+| **description** | **String** | The error associated with the field | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::FieldError.new(
+  field_name: from,
+  description: '+invalid' must be replaced with a valid E164 formatted telephone number
+)
+```
+

data/docs/FileFormatEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::FileFormatEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::FileFormatEnum.new()
+```
+

data/docs/ForbiddenRequest.md

@@ -0,0 +1,18 @@
+# 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/GatherCallback.md

@@ -0,0 +1,52 @@
+# Bandwidth::GatherCallback
+
+## 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] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **call_id** | **String** | The call id associated with the event. | [optional] |
+| **digits** | **String** | (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. | [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] |
+| **parent_call_id** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] |
+| **terminating_digit** | **String** | (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. | [optional] |
+| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
+| **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [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::GatherCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  account_id: 920012,
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  from: +15555555555,
+  to: +15555555555,
+  direction: null,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  digits: 123,
+  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,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  terminating_digit: #,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555),
+  tag: exampleTag
+)
+```
+

data/docs/InboundMessageCallback.md

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

@@ -0,0 +1,40 @@
+# 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/InitiateCallback.md

@@ -0,0 +1,40 @@
+# Bandwidth::InitiateCallback
+
+## 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] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **call_id** | **String** | The call id associated with the event. | [optional] |
+| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
+| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
+| **diversion** | [**Diversion**](Diversion.md) |  | [optional] |
+| **stir_shaken** | [**StirShaken**](StirShaken.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::InitiateCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  account_id: 920012,
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  from: +15555555555,
+  to: +15555555555,
+  direction: null,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  start_time: 2022-06-17T22:19:40.375Z,
+  diversion: null,
+  stir_shaken: null
+)
+```
+