bandwidth-sdk 11.3.0 → 12.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (126) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +18 -16
  3. data/README.md +15 -9
  4. data/Rakefile +4 -12
  5. data/bandwidth.yml +243 -28
  6. data/coverage/.last_run.json +1 -1
  7. data/coverage/.resultset.json +1412 -1009
  8. data/coverage/index.html +16274 -11823
  9. data/custom_templates/README.mustache +4 -4
  10. data/docs/AnswerCallback.md +1 -1
  11. data/docs/BridgeCompleteCallback.md +1 -1
  12. data/docs/BridgeTargetCompleteCallback.md +1 -1
  13. data/docs/CallRecordingMetadata.md +3 -3
  14. data/docs/CallTranscription.md +24 -0
  15. data/docs/CallTranscriptionMetadata.md +20 -0
  16. data/docs/CallTranscriptionResponse.md +24 -0
  17. data/docs/CallsApi.md +1 -1
  18. data/docs/ConferenceMemberExitCallback.md +1 -1
  19. data/docs/ConferenceMemberJoinCallback.md +1 -1
  20. data/docs/CreateCall.md +5 -3
  21. data/docs/DisconnectCallback.md +1 -1
  22. data/docs/DtmfCallback.md +2 -2
  23. data/docs/GatherCallback.md +2 -2
  24. data/docs/InitiateCallback.md +1 -1
  25. data/docs/MachineDetectionCompleteCallback.md +1 -1
  26. data/docs/RecordingAvailableCallback.md +4 -4
  27. data/docs/RecordingCompleteCallback.md +2 -2
  28. data/docs/RecordingTranscriptionMetadata.md +24 -0
  29. data/docs/RecordingTranscriptions.md +18 -0
  30. data/docs/RecordingsApi.md +49 -49
  31. data/docs/RedirectCallback.md +2 -2
  32. data/docs/TranscriptionAvailableCallback.md +2 -2
  33. data/docs/TranscriptionsApi.md +229 -0
  34. data/docs/TransferAnswerCallback.md +2 -2
  35. data/docs/TransferCompleteCallback.md +2 -2
  36. data/docs/TransferDisconnectCallback.md +2 -2
  37. data/lib/bandwidth-sdk/api/recordings_api.rb +56 -56
  38. data/lib/bandwidth-sdk/api/transcriptions_api.rb +241 -0
  39. data/lib/bandwidth-sdk/configuration.rb +22 -4
  40. data/lib/bandwidth-sdk/models/answer_callback.rb +1 -1
  41. data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +1 -1
  42. data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +1 -1
  43. data/lib/bandwidth-sdk/models/call_recording_metadata.rb +3 -3
  44. data/lib/bandwidth-sdk/models/call_transcription.rb +317 -0
  45. data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +223 -0
  46. data/lib/bandwidth-sdk/models/call_transcription_response.rb +244 -0
  47. data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +1 -1
  48. data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +1 -1
  49. data/lib/bandwidth-sdk/models/create_call.rb +14 -3
  50. data/lib/bandwidth-sdk/models/disconnect_callback.rb +1 -1
  51. data/lib/bandwidth-sdk/models/dtmf_callback.rb +2 -2
  52. data/lib/bandwidth-sdk/models/gather_callback.rb +2 -2
  53. data/lib/bandwidth-sdk/models/initiate_callback.rb +1 -1
  54. data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +1 -1
  55. data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +1 -1
  56. data/lib/bandwidth-sdk/models/recording_available_callback.rb +4 -4
  57. data/lib/bandwidth-sdk/models/recording_complete_callback.rb +2 -2
  58. data/lib/bandwidth-sdk/models/recording_transcription_metadata.rb +244 -0
  59. data/lib/bandwidth-sdk/models/recording_transcriptions.rb +214 -0
  60. data/lib/bandwidth-sdk/models/redirect_callback.rb +2 -2
  61. data/lib/bandwidth-sdk/models/transcription_available_callback.rb +2 -2
  62. data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +2 -2
  63. data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +2 -2
  64. data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +2 -2
  65. data/lib/bandwidth-sdk/version.rb +1 -1
  66. data/lib/bandwidth-sdk.rb +6 -2
  67. data/spec/{integration/calls_api_integration_spec.rb → smoke/calls_api_spec.rb} +9 -7
  68. data/spec/{integration/conferences_api_integration_spec.rb → smoke/conferences_api_spec.rb} +9 -9
  69. data/spec/{integration/media_api_integration_spec.rb → smoke/media_api_spec.rb} +7 -7
  70. data/spec/{integration/messages_api_integration_spec.rb → smoke/messages_api_spec.rb} +3 -3
  71. data/spec/{integration/mfa_api_integration_spec.rb → smoke/mfa_api_spec.rb} +3 -3
  72. data/spec/{integration/phone_number_lookup_api_integration_spec.rb → smoke/phone_number_lookup_api_spec.rb} +2 -2
  73. data/spec/{integration/recordings_api_integration_spec.rb → smoke/recordings_api_spec.rb} +14 -14
  74. data/spec/{integration/statistics_api_integration_spec.rb → smoke/statistics_api_spec.rb} +1 -1
  75. data/spec/smoke/transcriptions_api_spec.rb +84 -0
  76. data/spec/spec_helper.rb +2 -2
  77. data/spec/{api → unit/api}/calls_api_spec.rb +6 -4
  78. data/spec/{api → unit/api}/conferences_api_spec.rb +12 -12
  79. data/spec/{api → unit/api}/media_api_spec.rb +6 -6
  80. data/spec/{api → unit/api}/messages_api_spec.rb +2 -2
  81. data/spec/{api → unit/api}/mfa_api_spec.rb +6 -6
  82. data/spec/{api → unit/api}/phone_number_lookup_api_spec.rb +2 -2
  83. data/spec/{api → unit/api}/recordings_api_spec.rb +30 -30
  84. data/spec/{api → unit/api}/statistics_api_spec.rb +1 -1
  85. data/spec/unit/api/transcriptions_api_spec.rb +130 -0
  86. data/spec/{api_client_spec.rb → unit/client/api_client_spec.rb} +2 -2
  87. metadata +130 -114
  88. /data/spec/{api_error_spec.rb → unit/client/api_error_spec.rb} +0 -0
  89. /data/spec/{configuration_spec.rb → unit/client/configuration_spec.rb} +0 -0
  90. /data/spec/{models → unit/models}/bxml/bxml_spec.rb +0 -0
  91. /data/spec/{models → unit/models}/bxml/nestable_verb_spec.rb +0 -0
  92. /data/spec/{models → unit/models}/bxml/response_spec.rb +0 -0
  93. /data/spec/{models → unit/models}/bxml/verb_spec.rb +0 -0
  94. /data/spec/{models → unit/models}/bxml/verbs/bridge_spec.rb +0 -0
  95. /data/spec/{models → unit/models}/bxml/verbs/conference_spec.rb +0 -0
  96. /data/spec/{models → unit/models}/bxml/verbs/custom_param_spec.rb +0 -0
  97. /data/spec/{models → unit/models}/bxml/verbs/forward_spec.rb +0 -0
  98. /data/spec/{models → unit/models}/bxml/verbs/gather_spec.rb +0 -0
  99. /data/spec/{models → unit/models}/bxml/verbs/hangup_spec.rb +0 -0
  100. /data/spec/{models → unit/models}/bxml/verbs/pause_recording_spec.rb +0 -0
  101. /data/spec/{models → unit/models}/bxml/verbs/pause_spec.rb +0 -0
  102. /data/spec/{models → unit/models}/bxml/verbs/phone_number_spec.rb +0 -0
  103. /data/spec/{models → unit/models}/bxml/verbs/play_audio_spec.rb +0 -0
  104. /data/spec/{models → unit/models}/bxml/verbs/record_spec.rb +0 -0
  105. /data/spec/{models → unit/models}/bxml/verbs/redirect_spec.rb +0 -0
  106. /data/spec/{models → unit/models}/bxml/verbs/resume_recording_spec.rb +0 -0
  107. /data/spec/{models → unit/models}/bxml/verbs/ring_spec.rb +0 -0
  108. /data/spec/{models → unit/models}/bxml/verbs/send_dtmf_spec.rb +0 -0
  109. /data/spec/{models → unit/models}/bxml/verbs/sip_uri_spec.rb +0 -0
  110. /data/spec/{models → unit/models}/bxml/verbs/speak_sentence_spec.rb +0 -0
  111. /data/spec/{models → unit/models}/bxml/verbs/start_gather_spec.rb +0 -0
  112. /data/spec/{models → unit/models}/bxml/verbs/start_recording_spec.rb +0 -0
  113. /data/spec/{models → unit/models}/bxml/verbs/start_stream_spec.rb +0 -0
  114. /data/spec/{models → unit/models}/bxml/verbs/start_transcription_spec.rb +0 -0
  115. /data/spec/{models → unit/models}/bxml/verbs/stop_gather_spec.rb +0 -0
  116. /data/spec/{models → unit/models}/bxml/verbs/stop_recording_spec.rb +0 -0
  117. /data/spec/{models → unit/models}/bxml/verbs/stop_stream_spec.rb +0 -0
  118. /data/spec/{models → unit/models}/bxml/verbs/stop_transcription_spec.rb +0 -0
  119. /data/spec/{models → unit/models}/bxml/verbs/stream_param_spec.rb +0 -0
  120. /data/spec/{models → unit/models}/bxml/verbs/tag_spec.rb +0 -0
  121. /data/spec/{models → unit/models}/bxml/verbs/transfer_spec.rb +0 -0
  122. /data/spec/{models → unit/models}/call_state_enum_spec.rb +0 -0
  123. /data/spec/{models → unit/models}/call_state_spec.rb +0 -0
  124. /data/spec/{models → unit/models}/deferred_result_spec.rb +0 -0
  125. /data/spec/{models → unit/models}/message_spec.rb +0 -0
  126. /data/spec/{models → unit/models}/verify_code_request_spec.rb +0 -0
@@ -7,10 +7,10 @@
7
7
 
8
8
  | **OS** | **Ruby** |
9
9
  |:---:|:---:|
10
- | Windows 2019 | 2.7, 3.0, 3.1, 3.2 |
11
- | Windows 2022 | 2.7, 3.0, 3.1, 3.2 |
12
- | Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2 |
13
- | Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2 |
10
+ | Windows 2019 | 2.7, 3.0, 3.1, 3.2, 3.3 |
11
+ | Windows 2022 | 2.7, 3.0, 3.1, 3.2, 3.3 |
12
+ | Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
13
+ | Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
14
14
 
15
15
  {{moduleName}} - the Ruby gem for the {{appName}} SDK
16
16
 
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -10,8 +10,8 @@
10
10
  | **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] |
11
11
  | **recording_id** | **String** | The unique ID of this recording | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
- | **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] |
14
- | **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] |
13
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
14
+ | **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
15
15
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
16
16
  | **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
17
17
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
@@ -21,7 +21,7 @@
21
21
  | **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
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
- | **transcription** | [**TranscriptionMetadata**](TranscriptionMetadata.md) | | [optional] |
24
+ | **transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] |
25
25
 
26
26
  ## Example
27
27
 
@@ -0,0 +1,24 @@
1
+ # Bandwidth::CallTranscription
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **detected_language** | **String** | The detected language for this transcription. | [optional] |
8
+ | **track** | **String** | Which `track` this transcription is derived from. | [optional] |
9
+ | **text** | **String** | The transcription itself. | [optional] |
10
+ | **confidence** | **Float** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::CallTranscription.new(
18
+ detected_language: en-US,
19
+ track: inbound,
20
+ text: Hello World! This is an example.,
21
+ confidence: 0.9
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # Bandwidth::CallTranscriptionMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
8
+ | **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
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bandwidth-sdk'
14
+
15
+ instance = Bandwidth::CallTranscriptionMetadata.new(
16
+ transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
17
+ 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
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Bandwidth::CallTranscriptionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | The user account associated with the call. | [optional] |
8
+ | **call_id** | **String** | The call id associated with the event. | [optional] |
9
+ | **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
10
+ | **tracks** | [**Array<CallTranscription>**](CallTranscription.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::CallTranscriptionResponse.new(
18
+ account_id: 920012,
19
+ call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
20
+ transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
21
+ tracks: [{"detectedLanguage":"en-US","track":"inbound","text":"Hello World! This is an example.","confidence":0.9}]
22
+ )
23
+ ```
24
+
data/docs/CallsApi.md CHANGED
@@ -33,7 +33,7 @@ end
33
33
 
34
34
  api_instance = Bandwidth::CallsApi.new
35
35
  account_id = '9900000' # String | Your Bandwidth Account ID.
36
- create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+19195554321', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call
36
+ create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+15555551212', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call
37
37
 
38
38
  begin
39
39
  # Create Call
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
10
10
  | **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **call_id** | **String** | The call id associated with the event. | [optional] |
14
14
  | **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] |
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
10
10
  | **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **call_id** | **String** | The call id associated with the event. | [optional] |
14
14
  | **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] |
data/docs/CreateCall.md CHANGED
@@ -5,8 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **to** | **String** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | |
8
- | **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`, or be one of the following strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). | |
9
- | **display_name** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. | [optional] |
8
+ | **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | |
9
+ | **privacy** | **Boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] |
10
+ | **display_name** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] |
10
11
  | **uui** | **String** | A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433'>RFC 7433</a>. Only 'jwt' and 'base64' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] |
11
12
  | **application_id** | **String** | The id of the application associated with the `from` number. | |
12
13
  | **answer_url** | **String** | The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | |
@@ -32,7 +33,8 @@ require 'bandwidth-sdk'
32
33
 
33
34
  instance = Bandwidth::CreateCall.new(
34
35
  to: +19195551234,
35
- from: +19195554321,
36
+ from: +15555551212,
37
+ privacy: false,
36
38
  display_name: John Doe,
37
39
  uui: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64,
38
40
  application_id: 1234-qwer-5679-tyui,
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **call_id** | **String** | The call id associated with the event. | [optional] |
14
14
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
data/docs/DtmfCallback.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **call_id** | **String** | The call id associated with the event. | [optional] |
14
14
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
@@ -18,7 +18,7 @@
18
18
  | **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
19
19
  | **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
20
20
  | **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] |
21
- | **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] |
21
+ | **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
22
22
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
23
23
  | **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] |
24
24
 
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -19,7 +19,7 @@
19
19
  | **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
20
20
  | **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] |
21
21
  | **terminating_digit** | **String** | (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. | [optional] |
22
- | **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] |
22
+ | **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
23
23
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
24
24
  | **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] |
25
25
 
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -21,10 +21,10 @@
21
21
  | **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
22
22
  | **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
23
23
  | **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
24
- | **channels** | **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] |
24
+ | **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
25
25
  | **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] |
26
26
  | **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] |
27
- | **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] |
27
+ | **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
28
28
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
29
29
 
30
30
  ## Example
@@ -50,7 +50,7 @@ instance = Bandwidth::RecordingAvailableCallback.new(
50
50
  end_time: 2022-06-17T22:20Z,
51
51
  duration: PT13.67S,
52
52
  file_format: null,
53
- channels: completed,
53
+ channels: 1,
54
54
  tag: exampleTag,
55
55
  status: completed,
56
56
  transfer_caller_id: +15555555555,
@@ -8,7 +8,7 @@
8
8
  | **event_time** | **Time** | 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] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **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] |
11
+ | **from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
12
12
  | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **call_id** | **String** | The call id associated with the event. | [optional] |
@@ -24,7 +24,7 @@
24
24
  | **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
25
25
  | **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
26
26
  | **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] |
27
- | **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] |
27
+ | **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
28
28
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
29
29
 
30
30
  ## Example
@@ -0,0 +1,24 @@
1
+ # Bandwidth::RecordingTranscriptionMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique transcription ID | [optional] |
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** | **String** | The time that the transcription was completed | [optional] |
10
+ | **url** | **String** | The URL of the [transcription](#operation/getCallTranscription) | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bandwidth-sdk'
16
+
17
+ instance = Bandwidth::RecordingTranscriptionMetadata.new(
18
+ id: t-387bd648-18f3-4823-9d16-746bca0003c9,
19
+ status: completed,
20
+ completed_time: 2022-06-13T18:46:29.715Z,
21
+ 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
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # Bandwidth::RecordingTranscriptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transcripts** | [**Array<Transcription>**](Transcription.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'bandwidth-sdk'
13
+
14
+ instance = Bandwidth::RecordingTranscriptions.new(
15
+ transcripts: null
16
+ )
17
+ ```
18
+
@@ -4,25 +4,25 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_call_transcription**](RecordingsApi.md#delete_call_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription |
8
7
  | [**delete_recording**](RecordingsApi.md#delete_recording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording |
9
8
  | [**delete_recording_media**](RecordingsApi.md#delete_recording_media) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media |
9
+ | [**delete_recording_transcription**](RecordingsApi.md#delete_recording_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription |
10
10
  | [**download_call_recording**](RecordingsApi.md#download_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording |
11
11
  | [**get_call_recording**](RecordingsApi.md#get_call_recording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording |
12
- | [**get_call_transcription**](RecordingsApi.md#get_call_transcription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription |
12
+ | [**get_recording_transcription**](RecordingsApi.md#get_recording_transcription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription |
13
13
  | [**list_account_call_recordings**](RecordingsApi.md#list_account_call_recordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings |
14
14
  | [**list_call_recordings**](RecordingsApi.md#list_call_recordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings |
15
15
  | [**transcribe_call_recording**](RecordingsApi.md#transcribe_call_recording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request |
16
16
  | [**update_call_recording_state**](RecordingsApi.md#update_call_recording_state) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording |
17
17
 
18
18
 
19
- ## delete_call_transcription
19
+ ## delete_recording
20
20
 
21
- > delete_call_transcription(account_id, call_id, recording_id)
21
+ > delete_recording(account_id, call_id, recording_id)
22
22
 
23
- Delete Transcription
23
+ Delete Recording
24
24
 
25
- Deletes the specified recording's transcription. Note: After the deletion is requested and a `204` 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.
25
+ Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
26
26
 
27
27
  ### Examples
28
28
 
@@ -42,28 +42,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
42
42
  recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
43
43
 
44
44
  begin
45
- # Delete Transcription
46
- api_instance.delete_call_transcription(account_id, call_id, recording_id)
45
+ # Delete Recording
46
+ api_instance.delete_recording(account_id, call_id, recording_id)
47
47
  rescue Bandwidth::ApiError => e
48
- puts "Error when calling RecordingsApi->delete_call_transcription: #{e}"
48
+ puts "Error when calling RecordingsApi->delete_recording: #{e}"
49
49
  end
50
50
  ```
51
51
 
52
- #### Using the delete_call_transcription_with_http_info variant
52
+ #### Using the delete_recording_with_http_info variant
53
53
 
54
54
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
55
55
 
56
- > <Array(nil, Integer, Hash)> delete_call_transcription_with_http_info(account_id, call_id, recording_id)
56
+ > <Array(nil, Integer, Hash)> delete_recording_with_http_info(account_id, call_id, recording_id)
57
57
 
58
58
  ```ruby
59
59
  begin
60
- # Delete Transcription
61
- data, status_code, headers = api_instance.delete_call_transcription_with_http_info(account_id, call_id, recording_id)
60
+ # Delete Recording
61
+ data, status_code, headers = api_instance.delete_recording_with_http_info(account_id, call_id, recording_id)
62
62
  p status_code # => 2xx
63
63
  p headers # => { ... }
64
64
  p data # => nil
65
65
  rescue Bandwidth::ApiError => e
66
- puts "Error when calling RecordingsApi->delete_call_transcription_with_http_info: #{e}"
66
+ puts "Error when calling RecordingsApi->delete_recording_with_http_info: #{e}"
67
67
  end
68
68
  ```
69
69
 
@@ -89,13 +89,13 @@ nil (empty response body)
89
89
  - **Accept**: application/json
90
90
 
91
91
 
92
- ## delete_recording
92
+ ## delete_recording_media
93
93
 
94
- > delete_recording(account_id, call_id, recording_id)
94
+ > delete_recording_media(account_id, call_id, recording_id)
95
95
 
96
- Delete Recording
96
+ Delete Recording Media
97
97
 
98
- Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
98
+ Deletes the specified recording's media.
99
99
 
100
100
  ### Examples
101
101
 
@@ -115,28 +115,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
115
115
  recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
116
116
 
117
117
  begin
118
- # Delete Recording
119
- api_instance.delete_recording(account_id, call_id, recording_id)
118
+ # Delete Recording Media
119
+ api_instance.delete_recording_media(account_id, call_id, recording_id)
120
120
  rescue Bandwidth::ApiError => e
121
- puts "Error when calling RecordingsApi->delete_recording: #{e}"
121
+ puts "Error when calling RecordingsApi->delete_recording_media: #{e}"
122
122
  end
123
123
  ```
124
124
 
125
- #### Using the delete_recording_with_http_info variant
125
+ #### Using the delete_recording_media_with_http_info variant
126
126
 
127
127
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
128
128
 
129
- > <Array(nil, Integer, Hash)> delete_recording_with_http_info(account_id, call_id, recording_id)
129
+ > <Array(nil, Integer, Hash)> delete_recording_media_with_http_info(account_id, call_id, recording_id)
130
130
 
131
131
  ```ruby
132
132
  begin
133
- # Delete Recording
134
- data, status_code, headers = api_instance.delete_recording_with_http_info(account_id, call_id, recording_id)
133
+ # Delete Recording Media
134
+ data, status_code, headers = api_instance.delete_recording_media_with_http_info(account_id, call_id, recording_id)
135
135
  p status_code # => 2xx
136
136
  p headers # => { ... }
137
137
  p data # => nil
138
138
  rescue Bandwidth::ApiError => e
139
- puts "Error when calling RecordingsApi->delete_recording_with_http_info: #{e}"
139
+ puts "Error when calling RecordingsApi->delete_recording_media_with_http_info: #{e}"
140
140
  end
141
141
  ```
142
142
 
@@ -162,13 +162,13 @@ nil (empty response body)
162
162
  - **Accept**: application/json
163
163
 
164
164
 
165
- ## delete_recording_media
165
+ ## delete_recording_transcription
166
166
 
167
- > delete_recording_media(account_id, call_id, recording_id)
167
+ > delete_recording_transcription(account_id, call_id, recording_id)
168
168
 
169
- Delete Recording Media
169
+ Delete Transcription
170
170
 
171
- Deletes the specified recording's media.
171
+ Deletes the specified recording's transcription. Note: After the deletion is requested and a `204` 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.
172
172
 
173
173
  ### Examples
174
174
 
@@ -188,28 +188,28 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
188
188
  recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
189
189
 
190
190
  begin
191
- # Delete Recording Media
192
- api_instance.delete_recording_media(account_id, call_id, recording_id)
191
+ # Delete Transcription
192
+ api_instance.delete_recording_transcription(account_id, call_id, recording_id)
193
193
  rescue Bandwidth::ApiError => e
194
- puts "Error when calling RecordingsApi->delete_recording_media: #{e}"
194
+ puts "Error when calling RecordingsApi->delete_recording_transcription: #{e}"
195
195
  end
196
196
  ```
197
197
 
198
- #### Using the delete_recording_media_with_http_info variant
198
+ #### Using the delete_recording_transcription_with_http_info variant
199
199
 
200
200
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
201
201
 
202
- > <Array(nil, Integer, Hash)> delete_recording_media_with_http_info(account_id, call_id, recording_id)
202
+ > <Array(nil, Integer, Hash)> delete_recording_transcription_with_http_info(account_id, call_id, recording_id)
203
203
 
204
204
  ```ruby
205
205
  begin
206
- # Delete Recording Media
207
- data, status_code, headers = api_instance.delete_recording_media_with_http_info(account_id, call_id, recording_id)
206
+ # Delete Transcription
207
+ data, status_code, headers = api_instance.delete_recording_transcription_with_http_info(account_id, call_id, recording_id)
208
208
  p status_code # => 2xx
209
209
  p headers # => { ... }
210
210
  p data # => nil
211
211
  rescue Bandwidth::ApiError => e
212
- puts "Error when calling RecordingsApi->delete_recording_media_with_http_info: #{e}"
212
+ puts "Error when calling RecordingsApi->delete_recording_transcription_with_http_info: #{e}"
213
213
  end
214
214
  ```
215
215
 
@@ -383,13 +383,13 @@ end
383
383
  - **Accept**: application/json
384
384
 
385
385
 
386
- ## get_call_transcription
386
+ ## get_recording_transcription
387
387
 
388
- > <TranscriptionList> get_call_transcription(account_id, call_id, recording_id)
388
+ > <RecordingTranscriptions> get_recording_transcription(account_id, call_id, recording_id)
389
389
 
390
390
  Get Transcription
391
391
 
392
- Downloads the specified transcription. If the transcribed recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
392
+ Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
393
393
 
394
394
  ### Examples
395
395
 
@@ -410,28 +410,28 @@ recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Prog
410
410
 
411
411
  begin
412
412
  # Get Transcription
413
- result = api_instance.get_call_transcription(account_id, call_id, recording_id)
413
+ result = api_instance.get_recording_transcription(account_id, call_id, recording_id)
414
414
  p result
415
415
  rescue Bandwidth::ApiError => e
416
- puts "Error when calling RecordingsApi->get_call_transcription: #{e}"
416
+ puts "Error when calling RecordingsApi->get_recording_transcription: #{e}"
417
417
  end
418
418
  ```
419
419
 
420
- #### Using the get_call_transcription_with_http_info variant
420
+ #### Using the get_recording_transcription_with_http_info variant
421
421
 
422
422
  This returns an Array which contains the response data, status code and headers.
423
423
 
424
- > <Array(<TranscriptionList>, Integer, Hash)> get_call_transcription_with_http_info(account_id, call_id, recording_id)
424
+ > <Array(<RecordingTranscriptions>, Integer, Hash)> get_recording_transcription_with_http_info(account_id, call_id, recording_id)
425
425
 
426
426
  ```ruby
427
427
  begin
428
428
  # Get Transcription
429
- data, status_code, headers = api_instance.get_call_transcription_with_http_info(account_id, call_id, recording_id)
429
+ data, status_code, headers = api_instance.get_recording_transcription_with_http_info(account_id, call_id, recording_id)
430
430
  p status_code # => 2xx
431
431
  p headers # => { ... }
432
- p data # => <TranscriptionList>
432
+ p data # => <RecordingTranscriptions>
433
433
  rescue Bandwidth::ApiError => e
434
- puts "Error when calling RecordingsApi->get_call_transcription_with_http_info: #{e}"
434
+ puts "Error when calling RecordingsApi->get_recording_transcription_with_http_info: #{e}"
435
435
  end
436
436
  ```
437
437
 
@@ -445,7 +445,7 @@ end
445
445
 
446
446
  ### Return type
447
447
 
448
- [**TranscriptionList**](TranscriptionList.md)
448
+ [**RecordingTranscriptions**](RecordingTranscriptions.md)
449
449
 
450
450
  ### Authorization
451
451