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

data/docs/Conference.md

@@ -0,0 +1,32 @@
+# Bandwidth::Conference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Bandwidth-generated conference ID | [optional] |
+| **name** | **String** | The name of the conference, as specified by your application | [optional] |
+| **created_time** | **Time** | The time the conference was initiated, in ISO 8601 format. | [optional] |
+| **completed_time** | **Time** | The time the conference was terminated, in ISO 8601 format. | [optional] |
+| **conference_event_url** | **String** | The URL to send the conference-related events. | [optional] |
+| **conference_event_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **tag** | **String** | The custom string attached to the conference that will be sent with callbacks. | [optional] |
+| **active_members** | [**Array<ConferenceMember>**](ConferenceMember.md) | A list of active members of the conference. Omitted if this is a response to the [Get Conferences endpoint](/apis/voice#tag/Conferences/operation/listConferences) | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Conference.new(
+  id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  created_time: 2022-06-17T22:19:40.375Z,
+  completed_time: 2022-06-17T22:20Z,
+  conference_event_url: https://myServer.com/bandwidth/webhooks/conferenceEvent,
+  conference_event_method: null,
+  tag: my custom tag,
+  active_members: null
+)
+```
+

data/docs/ConferenceCompletedCallback.md

@@ -0,0 +1,26 @@
+# Bandwidth::ConferenceCompletedCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [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::ConferenceCompletedCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  tag: exampleTag
+)
+```
+

data/docs/ConferenceCreatedCallback.md

@@ -0,0 +1,26 @@
+# Bandwidth::ConferenceCreatedCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [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::ConferenceCreatedCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  tag: exampleTag
+)
+```
+

data/docs/ConferenceMember.md

@@ -0,0 +1,28 @@
+# Bandwidth::ConferenceMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **call_id** | **String** | The call id associated with the event. | [optional] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] |
+| **mute** | **Boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants.  If used in a PUT request, 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.  If used in a PUT request, 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.  If present in a PUT request, 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::ConferenceMember.new(
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  member_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  mute: false,
+  hold: false,
+  call_ids_to_coach: ["c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"]
+)
+```
+

data/docs/ConferenceMemberExitCallback.md

@@ -0,0 +1,32 @@
+# Bandwidth::ConferenceMemberExitCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [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] |
+| **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::ConferenceMemberExitCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  from: +15555555555,
+  to: +15555555555,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  tag: exampleTag
+)
+```
+

data/docs/ConferenceMemberJoinCallback.md

@@ -0,0 +1,32 @@
+# Bandwidth::ConferenceMemberJoinCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [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] |
+| **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::ConferenceMemberJoinCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  from: +15555555555,
+  to: +15555555555,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  tag: exampleTag
+)
+```
+

data/docs/ConferenceRecordingAvailableCallback.md

@@ -0,0 +1,44 @@
+# Bandwidth::ConferenceRecordingAvailableCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
+| **account_id** | **String** | The user account associated with the call. | [optional] |
+| **recording_id** | **String** | The unique ID of this recording | [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] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [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] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::ConferenceRecordingAvailableCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  account_id: 920012,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  channels: 1,
+  start_time: 2022-06-17T22:19:40.375Z,
+  end_time: 2022-06-17T22:20Z,
+  duration: PT13.67S,
+  file_format: null,
+  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,
+  tag: exampleTag,
+  status: completed
+)
+```
+

data/docs/ConferenceRecordingMetadata.md

@@ -0,0 +1,38 @@
+# Bandwidth::ConferenceRecordingMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The user account associated with the call. | [optional] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
+| **recording_id** | **String** | The unique ID of this recording | [optional] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [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] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::ConferenceRecordingMetadata.new(
+  account_id: 920012,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  duration: PT13.67S,
+  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
+)
+```
+

data/docs/ConferenceRedirectCallback.md

@@ -0,0 +1,26 @@
+# Bandwidth::ConferenceRedirectCallback
+
+## 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] |
+| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
+| **name** | **String** | The user-specified name of the conference that was recorded | [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::ConferenceRedirectCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
+  name: my-conference-name,
+  tag: exampleTag
+)
+```
+

data/docs/ConferenceStateEnum.md

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