bandwidth-sdk 12.1.0 → 13.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -2
- data/Gemfile.lock +16 -25
- data/README.md +2 -0
- data/bandwidth-sdk.gemspec +3 -1
- data/bandwidth.yml +43 -22
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +529 -792
- data/coverage/index.html +5293 -8186
- data/custom_templates/Gemfile.mustache +1 -2
- data/custom_templates/gemspec.mustache +2 -0
- data/docs/AnswerCallback.md +1 -1
- data/docs/BridgeCompleteCallback.md +1 -1
- data/docs/BridgeTargetCompleteCallback.md +1 -1
- data/docs/CallRecordingMetadata.md +5 -3
- data/docs/CallState.md +1 -1
- data/docs/CallTranscription.md +6 -6
- data/docs/CallTranscriptionDetectedLanguageEnum.md +15 -0
- data/docs/CallTranscriptionMetadata.md +2 -0
- data/docs/CallTranscriptionResponse.md +2 -2
- data/docs/CallTranscriptionTrackEnum.md +15 -0
- data/docs/ConferenceRecordingAvailableCallback.md +1 -1
- data/docs/ConferenceRecordingMetadata.md +4 -2
- data/docs/DisconnectCallback.md +1 -1
- data/docs/DtmfCallback.md +2 -2
- data/docs/GatherCallback.md +2 -2
- data/docs/InitiateCallback.md +1 -1
- data/docs/MachineDetectionCompleteCallback.md +1 -1
- data/docs/MessagingCodeResponse.md +1 -1
- data/docs/RecordingAvailableCallback.md +2 -2
- data/docs/RecordingCompleteCallback.md +2 -2
- data/docs/RecordingTranscriptionMetadata.md +1 -1
- data/docs/RedirectCallback.md +2 -2
- data/docs/TranscriptionAvailableCallback.md +2 -2
- data/docs/TranscriptionsApi.md +1 -1
- data/docs/TransferAnswerCallback.md +2 -2
- data/docs/TransferCompleteCallback.md +2 -2
- data/docs/TransferDisconnectCallback.md +2 -2
- data/lib/bandwidth-sdk/api/calls_api.rb +1 -1
- data/lib/bandwidth-sdk/api/conferences_api.rb +1 -1
- data/lib/bandwidth-sdk/api/media_api.rb +1 -1
- data/lib/bandwidth-sdk/api/messages_api.rb +1 -1
- data/lib/bandwidth-sdk/api/mfa_api.rb +1 -1
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +1 -1
- data/lib/bandwidth-sdk/api/recordings_api.rb +1 -1
- data/lib/bandwidth-sdk/api/statistics_api.rb +1 -1
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +3 -3
- data/lib/bandwidth-sdk/api_client.rb +44 -41
- data/lib/bandwidth-sdk/api_error.rb +1 -1
- data/lib/bandwidth-sdk/configuration.rb +11 -1
- data/lib/bandwidth-sdk/models/account_statistics.rb +2 -2
- data/lib/bandwidth-sdk/models/answer_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/bxml/root.rb +0 -6
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +0 -6
- data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +0 -6
- data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +0 -6
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +0 -6
- data/lib/bandwidth-sdk/models/call_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +17 -7
- data/lib/bandwidth-sdk/models/call_state.rb +2 -2
- data/lib/bandwidth-sdk/models/call_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/call_transcription.rb +11 -37
- data/lib/bandwidth-sdk/models/call_transcription_detected_language_enum.rb +41 -0
- data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +13 -3
- data/lib/bandwidth-sdk/models/call_transcription_response.rb +2 -2
- data/lib/bandwidth-sdk/models/call_transcription_track_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/callback_method_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/code_request.rb +2 -2
- data/lib/bandwidth-sdk/models/conference.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_completed_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_created_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_member.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +17 -7
- data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/conference_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/create_call.rb +2 -2
- data/lib/bandwidth-sdk/models/create_call_response.rb +2 -2
- data/lib/bandwidth-sdk/models/create_lookup_response.rb +2 -2
- data/lib/bandwidth-sdk/models/create_message_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/deferred_result.rb +2 -2
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/diversion.rb +2 -2
- data/lib/bandwidth-sdk/models/dtmf_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/field_error.rb +2 -2
- data/lib/bandwidth-sdk/models/file_format_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/gather_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/inbound_message_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +2 -2
- data/lib/bandwidth-sdk/models/initiate_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/list_message_item.rb +2 -2
- data/lib/bandwidth-sdk/models/lookup_request.rb +2 -2
- data/lib/bandwidth-sdk/models/lookup_result.rb +2 -2
- data/lib/bandwidth-sdk/models/lookup_status.rb +2 -2
- data/lib/bandwidth-sdk/models/lookup_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +2 -2
- data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/machine_detection_result.rb +2 -2
- data/lib/bandwidth-sdk/models/media.rb +2 -2
- data/lib/bandwidth-sdk/models/message.rb +2 -2
- data/lib/bandwidth-sdk/models/message_delivered_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +2 -2
- data/lib/bandwidth-sdk/models/message_direction_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/message_failed_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +2 -2
- data/lib/bandwidth-sdk/models/message_request.rb +2 -2
- data/lib/bandwidth-sdk/models/message_sending_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +2 -2
- data/lib/bandwidth-sdk/models/message_status_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/message_type_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/messages_list.rb +2 -2
- data/lib/bandwidth-sdk/models/messaging_code_response.rb +2 -2
- data/lib/bandwidth-sdk/models/messaging_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/mfa_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/page_info.rb +2 -2
- data/lib/bandwidth-sdk/models/priority_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/recording_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/recording_state_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/recording_transcription_metadata.rb +3 -3
- data/lib/bandwidth-sdk/models/recording_transcriptions.rb +2 -2
- data/lib/bandwidth-sdk/models/redirect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/redirect_method_enum.rb +1 -1
- data/lib/bandwidth-sdk/models/stir_shaken.rb +2 -2
- data/lib/bandwidth-sdk/models/tag.rb +2 -2
- data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +2 -2
- data/lib/bandwidth-sdk/models/transcribe_recording.rb +2 -2
- data/lib/bandwidth-sdk/models/transcription.rb +2 -2
- data/lib/bandwidth-sdk/models/transcription_available_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +2 -2
- data/lib/bandwidth-sdk/models/update_call.rb +2 -2
- data/lib/bandwidth-sdk/models/update_call_recording.rb +2 -2
- data/lib/bandwidth-sdk/models/update_conference.rb +2 -2
- data/lib/bandwidth-sdk/models/update_conference_member.rb +2 -2
- data/lib/bandwidth-sdk/models/verify_code_request.rb +2 -2
- data/lib/bandwidth-sdk/models/verify_code_response.rb +2 -2
- data/lib/bandwidth-sdk/models/voice_api_error.rb +2 -2
- data/lib/bandwidth-sdk/models/voice_code_response.rb +2 -2
- data/lib/bandwidth-sdk/version.rb +2 -2
- data/lib/bandwidth-sdk.rb +3 -1
- data/openapitools.json +1 -1
- data/spec/call_utils.rb +1 -1
- data/spec/smoke/calls_api_spec.rb +1 -6
- data/spec/smoke/conferences_api_spec.rb +0 -5
- data/spec/smoke/media_api_spec.rb +0 -5
- data/spec/smoke/messages_api_spec.rb +0 -5
- data/spec/smoke/mfa_api_spec.rb +0 -5
- data/spec/smoke/phone_number_lookup_api_spec.rb +0 -5
- data/spec/smoke/recordings_api_spec.rb +0 -5
- data/spec/smoke/statistics_api_spec.rb +0 -5
- data/spec/smoke/transcriptions_api_spec.rb +1 -5
- data/spec/spec_helper.rb +11 -4
- data/spec/unit/api/calls_api_spec.rb +98 -128
- data/spec/unit/api/conferences_api_spec.rb +63 -126
- data/spec/unit/api/media_api_spec.rb +17 -32
- data/spec/unit/api/messages_api_spec.rb +46 -136
- data/spec/unit/api/mfa_api_spec.rb +8 -24
- data/spec/unit/api/phone_number_lookup_api_spec.rb +23 -37
- data/spec/unit/api/recordings_api_spec.rb +87 -111
- data/spec/unit/api/statistics_api_spec.rb +7 -15
- data/spec/unit/api/transcriptions_api_spec.rb +19 -37
- data/spec/unit/client/api_client_spec.rb +4 -4
- metadata +61 -43
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
|
|
18
18
|
s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
|
19
19
|
s.license = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
|
20
20
|
s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.7{{/gemRequiredRubyVersion}}"
|
21
|
+
s.metadata = {}
|
21
22
|
|
22
23
|
{{#isFaraday}}
|
23
24
|
s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
|
@@ -27,6 +28,7 @@ Gem::Specification.new do |s|
|
|
27
28
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
28
29
|
{{/isFaraday}}
|
29
30
|
s.add_runtime_dependency 'ox', '~> 2.4'
|
31
|
+
s.add_runtime_dependency 'marcel'
|
30
32
|
|
31
33
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
32
34
|
|
data/docs/AnswerCallback.md
CHANGED
@@ -27,7 +27,7 @@ require 'bandwidth-sdk'
|
|
27
27
|
instance = Bandwidth::AnswerCallback.new(
|
28
28
|
event_type: bridgeComplete,
|
29
29
|
event_time: 2022-06-17T22:19:40.375Z,
|
30
|
-
account_id:
|
30
|
+
account_id: 9900000,
|
31
31
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
32
32
|
from: +15555555555,
|
33
33
|
to: +15555555555,
|
@@ -29,7 +29,7 @@ require 'bandwidth-sdk'
|
|
29
29
|
instance = Bandwidth::BridgeCompleteCallback.new(
|
30
30
|
event_type: bridgeComplete,
|
31
31
|
event_time: 2022-06-17T22:19:40.375Z,
|
32
|
-
account_id:
|
32
|
+
account_id: 9900000,
|
33
33
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
34
34
|
from: +15555555555,
|
35
35
|
to: +15555555555,
|
@@ -26,7 +26,7 @@ require 'bandwidth-sdk'
|
|
26
26
|
instance = Bandwidth::BridgeTargetCompleteCallback.new(
|
27
27
|
event_type: bridgeComplete,
|
28
28
|
event_time: 2022-06-17T22:19:40.375Z,
|
29
|
-
account_id:
|
29
|
+
account_id: 9900000,
|
30
30
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
31
31
|
from: +15555555555,
|
32
32
|
to: +15555555555,
|
@@ -22,6 +22,7 @@
|
|
22
22
|
| **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] |
|
23
23
|
| **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] |
|
24
24
|
| **transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] |
|
25
|
+
| **recording_name** | **String** | A name to identify this recording. | [optional] |
|
25
26
|
|
26
27
|
## Example
|
27
28
|
|
@@ -30,14 +31,14 @@ require 'bandwidth-sdk'
|
|
30
31
|
|
31
32
|
instance = Bandwidth::CallRecordingMetadata.new(
|
32
33
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
33
|
-
account_id:
|
34
|
+
account_id: 9900000,
|
34
35
|
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
35
36
|
parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
|
36
37
|
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
37
38
|
to: +15555555555,
|
38
39
|
from: +15555555555,
|
39
40
|
transfer_caller_id: +15555555555,
|
40
|
-
transfer_to: +15555555555
|
41
|
+
transfer_to: +15555555555,
|
41
42
|
duration: PT13.67S,
|
42
43
|
direction: null,
|
43
44
|
channels: 1,
|
@@ -46,7 +47,8 @@ instance = Bandwidth::CallRecordingMetadata.new(
|
|
46
47
|
file_format: null,
|
47
48
|
status: completed,
|
48
49
|
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,
|
49
|
-
transcription: null
|
50
|
+
transcription: null,
|
51
|
+
recording_name: my-recording-name
|
50
52
|
)
|
51
53
|
```
|
52
54
|
|
data/docs/CallState.md
CHANGED
@@ -34,7 +34,7 @@ instance = Bandwidth::CallState.new(
|
|
34
34
|
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
35
35
|
parent_call_id: c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
36
36
|
to: +19195551234,
|
37
|
-
from: 19195554321,
|
37
|
+
from: +19195554321,
|
38
38
|
direction: null,
|
39
39
|
state: disconnected,
|
40
40
|
stir_shaken: {"verstat":"TN-Verification-Passed","attestationIndicator":"A","originatingId":"abc123"},
|
data/docs/CallTranscription.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **detected_language** | **
|
8
|
-
| **track** | **
|
9
|
-
| **
|
7
|
+
| **detected_language** | [**CallTranscriptionDetectedLanguageEnum**](CallTranscriptionDetectedLanguageEnum.md) | | [optional] |
|
8
|
+
| **track** | [**CallTranscriptionTrackEnum**](CallTranscriptionTrackEnum.md) | | [optional] |
|
9
|
+
| **transcript** | **String** | The transcription itself. | [optional] |
|
10
10
|
| **confidence** | **Float** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] |
|
11
11
|
|
12
12
|
## Example
|
@@ -15,9 +15,9 @@
|
|
15
15
|
require 'bandwidth-sdk'
|
16
16
|
|
17
17
|
instance = Bandwidth::CallTranscription.new(
|
18
|
-
detected_language:
|
19
|
-
track:
|
20
|
-
|
18
|
+
detected_language: null,
|
19
|
+
track: null,
|
20
|
+
transcript: Hello World! This is an example.,
|
21
21
|
confidence: 0.9
|
22
22
|
)
|
23
23
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Bandwidth::CallTranscriptionDetectedLanguageEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'bandwidth-sdk'
|
12
|
+
|
13
|
+
instance = Bandwidth::CallTranscriptionDetectedLanguageEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
|
8
|
+
| **transcription_name** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
|
8
9
|
| **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] |
|
9
10
|
|
10
11
|
## Example
|
@@ -14,6 +15,7 @@ require 'bandwidth-sdk'
|
|
14
15
|
|
15
16
|
instance = Bandwidth::CallTranscriptionMetadata.new(
|
16
17
|
transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
|
18
|
+
transcription_name: live_transcription,
|
17
19
|
transcription_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
18
20
|
)
|
19
21
|
```
|
@@ -15,10 +15,10 @@
|
|
15
15
|
require 'bandwidth-sdk'
|
16
16
|
|
17
17
|
instance = Bandwidth::CallTranscriptionResponse.new(
|
18
|
-
account_id:
|
18
|
+
account_id: 9900000,
|
19
19
|
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
20
20
|
transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
|
21
|
-
tracks: [{"detectedLanguage":"en-US","track":"inbound","
|
21
|
+
tracks: [{"detectedLanguage":"en-US","track":"inbound","transcript":"Hello World! This is an example.","confidence":0.9}]
|
22
22
|
)
|
23
23
|
```
|
24
24
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Bandwidth::CallTranscriptionTrackEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'bandwidth-sdk'
|
12
|
+
|
13
|
+
instance = Bandwidth::CallTranscriptionTrackEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -29,7 +29,7 @@ instance = Bandwidth::ConferenceRecordingAvailableCallback.new(
|
|
29
29
|
event_time: 2022-06-17T22:19:40.375Z,
|
30
30
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
31
31
|
name: my-conference-name,
|
32
|
-
account_id:
|
32
|
+
account_id: 9900000,
|
33
33
|
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
34
34
|
channels: 1,
|
35
35
|
start_time: 2022-06-17T22:19:40.375Z,
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
16
16
|
| **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] |
|
17
17
|
| **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] |
|
18
|
+
| **recording_name** | **String** | A name to identify this recording. | [optional] |
|
18
19
|
|
19
20
|
## Example
|
20
21
|
|
@@ -22,7 +23,7 @@
|
|
22
23
|
require 'bandwidth-sdk'
|
23
24
|
|
24
25
|
instance = Bandwidth::ConferenceRecordingMetadata.new(
|
25
|
-
account_id:
|
26
|
+
account_id: 9900000,
|
26
27
|
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
27
28
|
name: my-conference-name,
|
28
29
|
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
@@ -32,7 +33,8 @@ instance = Bandwidth::ConferenceRecordingMetadata.new(
|
|
32
33
|
end_time: 2022-06-17T22:20Z,
|
33
34
|
file_format: null,
|
34
35
|
status: completed,
|
35
|
-
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
|
36
|
+
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,
|
37
|
+
recording_name: my-recording-name
|
36
38
|
)
|
37
39
|
```
|
38
40
|
|
data/docs/DisconnectCallback.md
CHANGED
@@ -30,7 +30,7 @@ require 'bandwidth-sdk'
|
|
30
30
|
instance = Bandwidth::DisconnectCallback.new(
|
31
31
|
event_type: bridgeComplete,
|
32
32
|
event_time: 2022-06-17T22:19:40.375Z,
|
33
|
-
account_id:
|
33
|
+
account_id: 9900000,
|
34
34
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
35
35
|
from: +15555555555,
|
36
36
|
to: +15555555555,
|
data/docs/DtmfCallback.md
CHANGED
@@ -30,7 +30,7 @@ require 'bandwidth-sdk'
|
|
30
30
|
instance = Bandwidth::DtmfCallback.new(
|
31
31
|
event_type: bridgeComplete,
|
32
32
|
event_time: 2022-06-17T22:19:40.375Z,
|
33
|
-
account_id:
|
33
|
+
account_id: 9900000,
|
34
34
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
35
35
|
from: +15555555555,
|
36
36
|
to: +15555555555,
|
@@ -43,7 +43,7 @@ instance = Bandwidth::DtmfCallback.new(
|
|
43
43
|
answer_time: 2022-06-17T22:20Z,
|
44
44
|
parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
|
45
45
|
transfer_caller_id: +15555555555,
|
46
|
-
transfer_to: +15555555555
|
46
|
+
transfer_to: +15555555555,
|
47
47
|
tag: exampleTag
|
48
48
|
)
|
49
49
|
```
|
data/docs/GatherCallback.md
CHANGED
@@ -31,7 +31,7 @@ require 'bandwidth-sdk'
|
|
31
31
|
instance = Bandwidth::GatherCallback.new(
|
32
32
|
event_type: bridgeComplete,
|
33
33
|
event_time: 2022-06-17T22:19:40.375Z,
|
34
|
-
account_id:
|
34
|
+
account_id: 9900000,
|
35
35
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
36
36
|
from: +15555555555,
|
37
37
|
to: +15555555555,
|
@@ -45,7 +45,7 @@ instance = Bandwidth::GatherCallback.new(
|
|
45
45
|
parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
|
46
46
|
terminating_digit: #,
|
47
47
|
transfer_caller_id: +15555555555,
|
48
|
-
transfer_to: +15555555555
|
48
|
+
transfer_to: +15555555555,
|
49
49
|
tag: exampleTag
|
50
50
|
)
|
51
51
|
```
|
data/docs/InitiateCallback.md
CHANGED
@@ -25,7 +25,7 @@ require 'bandwidth-sdk'
|
|
25
25
|
instance = Bandwidth::InitiateCallback.new(
|
26
26
|
event_type: bridgeComplete,
|
27
27
|
event_time: 2022-06-17T22:19:40.375Z,
|
28
|
-
account_id:
|
28
|
+
account_id: 9900000,
|
29
29
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
30
30
|
from: +15555555555,
|
31
31
|
to: +15555555555,
|
@@ -27,7 +27,7 @@ require 'bandwidth-sdk'
|
|
27
27
|
instance = Bandwidth::MachineDetectionCompleteCallback.new(
|
28
28
|
event_type: bridgeComplete,
|
29
29
|
event_time: 2022-06-17T22:19:40.375Z,
|
30
|
-
account_id:
|
30
|
+
account_id: 9900000,
|
31
31
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
32
32
|
from: +15555555555,
|
33
33
|
to: +15555555555,
|
@@ -35,7 +35,7 @@ require 'bandwidth-sdk'
|
|
35
35
|
instance = Bandwidth::RecordingAvailableCallback.new(
|
36
36
|
event_type: bridgeComplete,
|
37
37
|
event_time: 2022-06-17T22:19:40.375Z,
|
38
|
-
account_id:
|
38
|
+
account_id: 9900000,
|
39
39
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
40
40
|
from: +15555555555,
|
41
41
|
to: +15555555555,
|
@@ -54,7 +54,7 @@ instance = Bandwidth::RecordingAvailableCallback.new(
|
|
54
54
|
tag: exampleTag,
|
55
55
|
status: completed,
|
56
56
|
transfer_caller_id: +15555555555,
|
57
|
-
transfer_to: +15555555555
|
57
|
+
transfer_to: +15555555555
|
58
58
|
)
|
59
59
|
```
|
60
60
|
|
@@ -35,7 +35,7 @@ require 'bandwidth-sdk'
|
|
35
35
|
instance = Bandwidth::RecordingCompleteCallback.new(
|
36
36
|
event_type: bridgeComplete,
|
37
37
|
event_time: 2022-06-17T22:19:40.375Z,
|
38
|
-
account_id:
|
38
|
+
account_id: 9900000,
|
39
39
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
40
40
|
from: +15555555555,
|
41
41
|
to: +15555555555,
|
@@ -54,7 +54,7 @@ instance = Bandwidth::RecordingCompleteCallback.new(
|
|
54
54
|
channels: 1,
|
55
55
|
tag: exampleTag,
|
56
56
|
transfer_caller_id: +15555555555,
|
57
|
-
transfer_to: +15555555555
|
57
|
+
transfer_to: +15555555555
|
58
58
|
)
|
59
59
|
```
|
60
60
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The unique transcription ID | [optional] |
|
8
8
|
| **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] |
|
9
|
-
| **completed_time** | **
|
9
|
+
| **completed_time** | **Time** | The time that the transcription was completed | [optional] |
|
10
10
|
| **url** | **String** | The URL of the [transcription](#operation/getCallTranscription) | [optional] |
|
11
11
|
|
12
12
|
## Example
|
data/docs/RedirectCallback.md
CHANGED
@@ -29,7 +29,7 @@ require 'bandwidth-sdk'
|
|
29
29
|
instance = Bandwidth::RedirectCallback.new(
|
30
30
|
event_type: bridgeComplete,
|
31
31
|
event_time: 2022-06-17T22:19:40.375Z,
|
32
|
-
account_id:
|
32
|
+
account_id: 9900000,
|
33
33
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
34
34
|
from: +15555555555,
|
35
35
|
to: +15555555555,
|
@@ -42,7 +42,7 @@ instance = Bandwidth::RedirectCallback.new(
|
|
42
42
|
answer_time: 2022-06-17T22:20Z,
|
43
43
|
tag: exampleTag,
|
44
44
|
transfer_caller_id: +15555555555,
|
45
|
-
transfer_to: +15555555555
|
45
|
+
transfer_to: +15555555555
|
46
46
|
)
|
47
47
|
```
|
48
48
|
|
@@ -34,7 +34,7 @@ require 'bandwidth-sdk'
|
|
34
34
|
instance = Bandwidth::TranscriptionAvailableCallback.new(
|
35
35
|
event_type: bridgeComplete,
|
36
36
|
event_time: 2022-06-17T22:19:40.375Z,
|
37
|
-
account_id:
|
37
|
+
account_id: 9900000,
|
38
38
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
39
39
|
from: +15555555555,
|
40
40
|
to: +15555555555,
|
@@ -52,7 +52,7 @@ instance = Bandwidth::TranscriptionAvailableCallback.new(
|
|
52
52
|
tag: exampleTag,
|
53
53
|
transcription: null,
|
54
54
|
transfer_caller_id: +15555555555,
|
55
|
-
transfer_to: +15555555555
|
55
|
+
transfer_to: +15555555555
|
56
56
|
)
|
57
57
|
```
|
58
58
|
|
data/docs/TranscriptionsApi.md
CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *http://localhost*
|
|
15
15
|
|
16
16
|
Delete a specific transcription
|
17
17
|
|
18
|
-
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `
|
18
|
+
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
19
19
|
|
20
20
|
### Examples
|
21
21
|
|
@@ -28,7 +28,7 @@ require 'bandwidth-sdk'
|
|
28
28
|
instance = Bandwidth::TransferAnswerCallback.new(
|
29
29
|
event_type: bridgeComplete,
|
30
30
|
event_time: 2022-06-17T22:19:40.375Z,
|
31
|
-
account_id:
|
31
|
+
account_id: 9900000,
|
32
32
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
33
33
|
from: +15555555555,
|
34
34
|
to: +15555555555,
|
@@ -40,7 +40,7 @@ instance = Bandwidth::TransferAnswerCallback.new(
|
|
40
40
|
answer_time: 2022-06-17T22:20Z,
|
41
41
|
tag: exampleTag,
|
42
42
|
transfer_caller_id: +15555555555,
|
43
|
-
transfer_to: +15555555555
|
43
|
+
transfer_to: +15555555555
|
44
44
|
)
|
45
45
|
```
|
46
46
|
|
@@ -31,7 +31,7 @@ require 'bandwidth-sdk'
|
|
31
31
|
instance = Bandwidth::TransferCompleteCallback.new(
|
32
32
|
event_type: bridgeComplete,
|
33
33
|
event_time: 2022-06-17T22:19:40.375Z,
|
34
|
-
account_id:
|
34
|
+
account_id: 9900000,
|
35
35
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
36
36
|
from: +15555555555,
|
37
37
|
to: +15555555555,
|
@@ -43,7 +43,7 @@ instance = Bandwidth::TransferCompleteCallback.new(
|
|
43
43
|
answer_time: 2022-06-17T22:20Z,
|
44
44
|
tag: exampleTag,
|
45
45
|
transfer_caller_id: +15555555555,
|
46
|
-
transfer_to: +15555555555
|
46
|
+
transfer_to: +15555555555,
|
47
47
|
cause: busy,
|
48
48
|
error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
|
49
49
|
error_id: 4642074b-7b58-478b-96e4-3a60955c6765
|
@@ -33,7 +33,7 @@ require 'bandwidth-sdk'
|
|
33
33
|
instance = Bandwidth::TransferDisconnectCallback.new(
|
34
34
|
event_type: bridgeComplete,
|
35
35
|
event_time: 2022-06-17T22:19:40.375Z,
|
36
|
-
account_id:
|
36
|
+
account_id: 9900000,
|
37
37
|
application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
|
38
38
|
from: +15555555555,
|
39
39
|
to: +15555555555,
|
@@ -47,7 +47,7 @@ instance = Bandwidth::TransferDisconnectCallback.new(
|
|
47
47
|
end_time: 2022-06-17T22:20Z,
|
48
48
|
tag: exampleTag,
|
49
49
|
transfer_caller_id: +15555555555,
|
50
|
-
transfer_to: +15555555555
|
50
|
+
transfer_to: +15555555555,
|
51
51
|
cause: busy,
|
52
52
|
error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
|
53
53
|
error_id: 4642074b-7b58-478b-96e4-3a60955c6765
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
Contact: letstalk@bandwidth.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 7.7.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,7 +20,7 @@ module Bandwidth
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Delete a specific transcription
|
23
|
-
# Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `
|
23
|
+
# Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
24
24
|
# @param account_id [String] Your Bandwidth Account ID.
|
25
25
|
# @param call_id [String] Programmable Voice API Call ID.
|
26
26
|
# @param transcription_id [String] Programmable Voice API Transcription ID.
|
@@ -32,7 +32,7 @@ module Bandwidth
|
|
32
32
|
end
|
33
33
|
|
34
34
|
# Delete a specific transcription
|
35
|
-
# Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `
|
35
|
+
# Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
|
36
36
|
# @param account_id [String] Your Bandwidth Account ID.
|
37
37
|
# @param call_id [String] Programmable Voice API Call ID.
|
38
38
|
# @param transcription_id [String] Programmable Voice API Transcription ID.
|