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

data/docs/Subscriptions.md

@@ -0,0 +1,20 @@
+# Bandwidth::Subscriptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | If present, and not overridden by the array of participants, it  represents the session the subscriptions are associated with. If this is the only field, the subscriber will be subscribed to all participants in the session (including any participants that are later added to the session). Upon creation of a Participant, returns as an empty object. | [optional] |
+| **participants** | [**Array<ParticipantSubscription>**](ParticipantSubscription.md) | (optional) A list of participants  in the session that will be subscribed to.  If present and not  empty or null, this will override  any sessionId specified in the body. Returns empty if used during the creation of a Participant.  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Subscriptions.new(
+  session_id: d8886aad-b956-4e1b-b2f4-d7c9f8162772,
+  participants: [{"participantId":"568749d5-04d5-483d-adf5-deac7dd3d521"},{"participantId":"0275e47f-dd21-4cf0-a1e1-dfdc719e73a7","streamAliases":["alias_1","alias_2"]}]
+)
+```
+

data/docs/Tag.md

@@ -0,0 +1,20 @@
+# Bandwidth::Tag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Tag.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/TnLookupRequestError.md

@@ -0,0 +1,18 @@
+# Bandwidth::TnLookupRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A description of what validation error occurred. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TnLookupRequestError.new(
+  message: example error message
+)
+```
+

data/docs/TranscribeRecording.md

@@ -0,0 +1,28 @@
+# Bandwidth::TranscribeRecording
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **callback_url** | **String** | The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization. | [optional] |
+| **callback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [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] |
+| **callback_timeout** | **Float** | This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25. | [optional][default to 15] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TranscribeRecording.new(
+  callback_url: https://myServer.com/bandwidth/webhooks/transcriptionAvailable,
+  callback_method: null,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  tag: exampleTag,
+  callback_timeout: 5.5
+)
+```
+

data/docs/Transcription.md

@@ -0,0 +1,20 @@
+# Bandwidth::Transcription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The transcribed text | [optional] |
+| **confidence** | **Float** | The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Transcription.new(
+  text: Nice talking to you, friend!,
+  confidence: 0.9
+)
+```
+

data/docs/TranscriptionAvailableCallback.md

@@ -0,0 +1,58 @@
+# Bandwidth::TranscriptionAvailableCallback
+
+## 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] |
+| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [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] |
+| **recording_id** | **String** | The unique ID of this recording | [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] |
+| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [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] |
+| **transcription** | [**Transcription**](Transcription.md) |  | [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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TranscriptionAvailableCallback.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,
+  media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  end_time: 2022-06-17T22:20Z,
+  duration: PT13.67S,
+  file_format: null,
+  tag: exampleTag,
+  transcription: null,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555)
+)
+```
+

data/docs/TranscriptionList.md

@@ -0,0 +1,18 @@
+# Bandwidth::TranscriptionList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transcripts** | [**Array<Transcription>**](Transcription.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TranscriptionList.new(
+  transcripts: null
+)
+```
+

data/docs/TranscriptionMetadata.md

@@ -0,0 +1,24 @@
+# Bandwidth::TranscriptionMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique transcription ID | [optional] |
+| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
+| **completed_time** | **String** | The time that the transcription was completed | [optional] |
+| **url** | **String** | The URL of the [transcription](#operation/getCallTranscription) | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TranscriptionMetadata.new(
+  id: t-387bd648-18f3-4823-9d16-746bca0003c9,
+  status: completed,
+  completed_time: 2022-06-13T18:46:29.715Z,
+  url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription
+)
+```
+

data/docs/TransferAnswerCallback.md

@@ -0,0 +1,46 @@
+# Bandwidth::TransferAnswerCallback
+
+## 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] |
+| **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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TransferAnswerCallback.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,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  answer_time: 2022-06-17T22:20Z,
+  tag: exampleTag,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555)
+)
+```
+

data/docs/TransferCompleteCallback.md

@@ -0,0 +1,52 @@
+# Bandwidth::TransferCompleteCallback
+
+## 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] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TransferCompleteCallback.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,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  answer_time: 2022-06-17T22:20Z,
+  tag: exampleTag,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555),
+  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
+)
+```
+

data/docs/TransferDisconnectCallback.md

@@ -0,0 +1,56 @@
+# Bandwidth::TransferDisconnectCallback
+
+## 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] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TransferDisconnectCallback.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,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  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,
+  tag: exampleTag,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555),
+  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
+)
+```
+

data/docs/UnauthorizedRequest.md

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

data/docs/UpdateCall.md

@@ -0,0 +1,36 @@
+# Bandwidth::UpdateCall
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | [**CallStateEnum**](CallStateEnum.md) |  | [optional][default to 'active'] |
+| **redirect_url** | **String** | The URL to send the [Redirect](/docs/voice/bxml/redirect) event to which will provide new BXML.  Required if `state` is `active`.  Not allowed if `state` is `completed`. | [optional] |
+| **redirect_method** | [**RedirectMethodEnum**](RedirectMethodEnum.md) |  | [optional][default to 'POST'] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [optional] |
+| **redirect_fallback_url** | **String** | A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond | [optional] |
+| **redirect_fallback_method** | [**RedirectMethodEnum**](RedirectMethodEnum.md) |  | [optional][default to 'POST'] |
+| **fallback_username** | **String** | Basic auth username. | [optional] |
+| **fallback_password** | **String** | Basic auth password. | [optional] |
+| **tag** | **String** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared.  May be cleared by setting `tag=\"\"`.  Max length 256 characters.  Not allowed if `state` is `completed`. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::UpdateCall.new(
+  state: null,
+  redirect_url: https://myServer.com/bandwidth/webhooks/redirect,
+  redirect_method: null,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  redirect_fallback_url: https://myFallbackServer.com/bandwidth/webhooks/redirect,
+  redirect_fallback_method: null,
+  fallback_username: mySecretUsername,
+  fallback_password: mySecretPassword1!,
+  tag: My Custom Tag
+)
+```
+

data/docs/UpdateCallRecording.md

@@ -0,0 +1,18 @@
+# Bandwidth::UpdateCallRecording
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | [**RecordingStateEnum**](RecordingStateEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::UpdateCallRecording.new(
+  state: null
+)
+```
+

data/docs/UpdateConference.md

@@ -0,0 +1,34 @@
+# Bandwidth::UpdateConference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**ConferenceStateEnum**](ConferenceStateEnum.md) |  | [optional][default to 'active'] |
+| **redirect_url** | **String** | The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if `state` is `completed`, but required if `state` is `active` | [optional] |
+| **redirect_method** | [**RedirectMethodEnum**](RedirectMethodEnum.md) |  | [optional][default to 'POST'] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [optional] |
+| **redirect_fallback_url** | **String** | A fallback url which, if provided, will be used to retry the `conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond.  Not allowed if `state` is `completed`. | [optional] |
+| **redirect_fallback_method** | [**RedirectMethodEnum**](RedirectMethodEnum.md) |  | [optional][default to 'POST'] |
+| **fallback_username** | **String** | Basic auth username. | [optional] |
+| **fallback_password** | **String** | Basic auth password. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::UpdateConference.new(
+  status: null,
+  redirect_url: https://myServer.com/bandwidth/webhooks/conferenceRedirect,
+  redirect_method: null,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  redirect_fallback_url: https://myFallbackServer.com/bandwidth/webhooks/conferenceRedirect,
+  redirect_fallback_method: null,
+  fallback_username: mySecretUsername,
+  fallback_password: mySecretPassword1!
+)
+```
+

data/docs/UpdateConferenceMember.md

@@ -0,0 +1,22 @@
+# Bandwidth::UpdateConferenceMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mute** | **Boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants.  Updates this member's mute status. Has no effect if omitted. | [optional] |
+| **hold** | **Boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference.  Updates this member's hold status. Has no effect if omitted. | [optional] |
+| **call_ids_to_coach** | **Array<String>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls.  Modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching.  Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::UpdateConferenceMember.new(
+  mute: false,
+  hold: false,
+  call_ids_to_coach: ["c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"]
+)
+```
+

data/docs/VerifyCodeRequest.md

@@ -0,0 +1,24 @@
+# Bandwidth::VerifyCodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **String** | The phone number to send the mfa code to. |  |
+| **scope** | **String** | An optional field to denote what scope or action the mfa code is addressing.  If not supplied, defaults to \"2FA\". | [optional] |
+| **expiration_time_in_minutes** | **Float** | The time period, in minutes, to validate the mfa code.  By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid.  The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively. |  |
+| **code** | **String** | The generated mfa code to check if valid. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::VerifyCodeRequest.new(
+  to: +19195551234,
+  scope: 2FA,
+  expiration_time_in_minutes: 3,
+  code: 123456
+)
+```
+

data/docs/VerifyCodeResponse.md

@@ -0,0 +1,18 @@
+# Bandwidth::VerifyCodeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | Whether or not the supplied code is valid. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::VerifyCodeResponse.new(
+  valid: true
+)
+```
+

data/docs/VoiceApiError.md

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

data/docs/VoiceCodeResponse.md

@@ -0,0 +1,18 @@
+# Bandwidth::VoiceCodeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **call_id** | **String** | Programmable Voice API Call ID. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::VoiceCodeResponse.new(
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'