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

data/docs/AccountStatistics.md

@@ -0,0 +1,20 @@
+# Bandwidth::AccountStatistics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **current_call_queue_size** | **Integer** | The number of calls currently enqueued. | [optional] |
+| **max_call_queue_size** | **Integer** | The maximum size of the queue before outgoing calls start being rejected. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::AccountStatistics.new(
+  current_call_queue_size: 0,
+  max_call_queue_size: 900
+)
+```
+

data/docs/AnswerCallback.md

@@ -0,0 +1,44 @@
+# Bandwidth::AnswerCallback
+
+## 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] |
+| **machine_detection_result** | **String** | (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::AnswerCallback.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,
+  machine_detection_result: null
+)
+```
+

data/docs/BridgeCompleteCallback.md

@@ -0,0 +1,48 @@
+# Bandwidth::BridgeCompleteCallback
+
+## 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] |
+| **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::BridgeCompleteCallback.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,
+  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/BridgeTargetCompleteCallback.md

@@ -0,0 +1,42 @@
+# Bandwidth::BridgeTargetCompleteCallback
+
+## 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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BridgeTargetCompleteCallback.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
+)
+```
+

data/docs/CallDirectionEnum.md

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

data/docs/CallRecordingMetadata.md

@@ -0,0 +1,52 @@
+# Bandwidth::CallRecordingMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The id of the application associated with the call. | [optional] |
+| **account_id** | **String** | The user account associated with the call. | [optional] |
+| **call_id** | **String** | The call id 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] |
+| **recording_id** | **String** | The unique ID of this recording | [optional] |
+| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [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] |
+| **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] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [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] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [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] |
+| **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] |
+| **transcription** | [**TranscriptionMetadata**](TranscriptionMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CallRecordingMetadata.new(
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  account_id: 920012,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  to: +15555555555,
+  from: +15555555555,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555),
+  duration: PT13.67S,
+  direction: null,
+  channels: 1,
+  start_time: 2022-06-17T22:19:40.375Z,
+  end_time: 2022-06-17T22:20Z,
+  file_format: null,
+  status: completed,
+  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,
+  transcription: null
+)
+```
+

data/docs/CallState.md

@@ -0,0 +1,52 @@
+# Bandwidth::CallState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The application id associated with the call. | [optional] |
+| **account_id** | **String** | The account id associated with the call. | [optional] |
+| **call_id** | **String** | The programmable voice API call ID. | [optional] |
+| **parent_call_id** | **String** | The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer). | [optional] |
+| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI | [optional] |
+| **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **state** | **String** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
+| **stir_shaken** | **Hash<String, String>** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows.  | Property          | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. |  Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs.  More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken) | [optional] |
+| **identity** | **String** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] |
+| **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] |
+| **start_time** | **Time** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
+| **answer_time** | **Time** | Populated once the call has been answered, with the time in ISO 8601 format. | [optional] |
+| **end_time** | **Time** | Populated once the call has ended, with the time in ISO 8601 format. | [optional] |
+| **disconnect_cause** | **String** | | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn't answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn't be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. |  Note: This list is not exhaustive and other values can appear in the future. | [optional] |
+| **error_message** | **String** | Populated only if the call ended with an error, with text explaining the reason. | [optional] |
+| **error_id** | **String** | Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. | [optional] |
+| **last_update** | **Time** | The last time the call had a state update, in ISO 8601 format. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CallState.new(
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  account_id: 9900000,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  parent_call_id: c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  to: +19195551234,
+  from: 19195554321,
+  direction: null,
+  state: disconnected,
+  stir_shaken: {"verstat":"TN-Verification-Passed","attestationIndicator":"A","originatingId":"abc123"},
+  identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken,
+  enqueued_time: 2022-06-16T13:15:07.160Z,
+  start_time: 2022-06-16T13:15:07.160Z,
+  answer_time: 2022-06-16T13:15:18.126Z,
+  end_time: 2022-06-16T13:15:18.314Z,
+  disconnect_cause: null,
+  error_message: null,
+  error_id: null,
+  last_update: 2022-06-16T13:15:18.314Z
+)
+```
+

data/docs/CallStateEnum.md

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

data/docs/CallbackMethodEnum.md

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

data/docs/CallsApi.md

@@ -0,0 +1,304 @@
+# Bandwidth::CallsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_call**](CallsApi.md#create_call) | **POST** /accounts/{accountId}/calls | Create Call |
+| [**get_call_state**](CallsApi.md#get_call_state) | **GET** /accounts/{accountId}/calls/{callId} | Get Call State Information |
+| [**update_call**](CallsApi.md#update_call) | **POST** /accounts/{accountId}/calls/{callId} | Update Call |
+| [**update_call_bxml**](CallsApi.md#update_call_bxml) | **PUT** /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML |
+
+
+## create_call
+
+> <CreateCallResponse> create_call(account_id, create_call)
+
+Create Call
+
+Creates an outbound phone call.  All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand.  <b>Please note:</b> Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
+
+### 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::CallsApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID
+create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+19195554321', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.com/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call
+
+begin
+  # Create Call
+  result = api_instance.create_call(account_id, create_call)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->create_call: #{e}"
+end
+```
+
+#### Using the create_call_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCallResponse>, Integer, Hash)> create_call_with_http_info(account_id, create_call)
+
+```ruby
+begin
+  # Create Call
+  data, status_code, headers = api_instance.create_call_with_http_info(account_id, create_call)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCallResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->create_call_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID |  |
+| **create_call** | [**CreateCall**](CreateCall.md) | JSON object containing information to create an outbound call |  |
+
+### Return type
+
+[**CreateCallResponse**](CreateCallResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_call_state
+
+> <CallState> get_call_state(account_id, call_id)
+
+Get Call State Information
+
+Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint.  **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
+
+### 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::CallsApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID
+call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
+
+begin
+  # Get Call State Information
+  result = api_instance.get_call_state(account_id, call_id)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->get_call_state: #{e}"
+end
+```
+
+#### Using the get_call_state_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CallState>, Integer, Hash)> get_call_state_with_http_info(account_id, call_id)
+
+```ruby
+begin
+  # Get Call State Information
+  data, status_code, headers = api_instance.get_call_state_with_http_info(account_id, call_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CallState>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->get_call_state_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID |  |
+| **call_id** | **String** | Programmable Voice API Call ID |  |
+
+### Return type
+
+[**CallState**](CallState.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_call
+
+> update_call(account_id, call_id, update_call)
+
+Update Call
+
+Interrupts and redirects a call to a different URL that should return a BXML document.
+
+### 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::CallsApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID
+call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
+update_call = Bandwidth::UpdateCall.new # UpdateCall | JSON object containing information to redirect an existing call to a new BXML document
+
+begin
+  # Update Call
+  api_instance.update_call(account_id, call_id, update_call)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->update_call: #{e}"
+end
+```
+
+#### Using the update_call_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)> update_call_with_http_info(account_id, call_id, update_call)
+
+```ruby
+begin
+  # Update Call
+  data, status_code, headers = api_instance.update_call_with_http_info(account_id, call_id, update_call)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->update_call_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID |  |
+| **call_id** | **String** | Programmable Voice API Call ID |  |
+| **update_call** | [**UpdateCall**](UpdateCall.md) | JSON object containing information to redirect an existing call to a new BXML document |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_call_bxml
+
+> update_call_bxml(account_id, call_id, body)
+
+Update Call BXML
+
+Interrupts and replaces an active call's BXML document.
+
+### 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::CallsApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID
+call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID
+body = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<Bxml>
+  <SpeakSentence>This is a test sentence.</SpeakSentence>
+</Bxml>' # String | 
+
+begin
+  # Update Call BXML
+  api_instance.update_call_bxml(account_id, call_id, body)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->update_call_bxml: #{e}"
+end
+```
+
+#### Using the update_call_bxml_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)> update_call_bxml_with_http_info(account_id, call_id, body)
+
+```ruby
+begin
+  # Update Call BXML
+  data, status_code, headers = api_instance.update_call_bxml_with_http_info(account_id, call_id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling CallsApi->update_call_bxml_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID |  |
+| **call_id** | **String** | Programmable Voice API Call ID |  |
+| **body** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/xml
+- **Accept**: application/json
+

data/docs/CodeRequest.md

@@ -0,0 +1,28 @@
+# Bandwidth::CodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | **String** | The phone number to send the mfa code to. |  |
+| **from** | **String** | The application phone number, the sender of the mfa code. |  |
+| **application_id** | **String** | The application unique ID, obtained from Bandwidth. |  |
+| **scope** | **String** | An optional field to denote what scope or action the mfa code is addressing.  If not supplied, defaults to \"2FA\". | [optional] |
+| **message** | **String** | The message format of the mfa code.  There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\".  The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied.  As the name would suggest, code will be replace with the actual mfa code.  Name is replaced with the application name, configured during provisioning of mfa.  The scope value is the same value sent during the call and partitioned by the server. |  |
+| **digits** | **Integer** | The number of digits for your mfa code.  The valid number ranges from 2 to 8, inclusively. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CodeRequest.new(
+  to: +19195551234,
+  from: +19195554321,
+  application_id: 66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1,
+  scope: 2FA,
+  message: Your temporary {NAME} {SCOPE} code is {CODE},
+  digits: 6
+)
+```
+