bandwidth-sdk 12.0.0 → 13.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (221) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -2
  3. data/Gemfile.lock +13 -22
  4. data/README.md +3 -1
  5. data/Rakefile +4 -12
  6. data/bandwidth-sdk.gemspec +3 -1
  7. data/bandwidth.yml +48 -33
  8. data/coverage/.last_run.json +1 -1
  9. data/coverage/.resultset.json +1333 -1598
  10. data/coverage/index.html +6890 -9805
  11. data/custom_templates/Gemfile.mustache +1 -2
  12. data/custom_templates/gemspec.mustache +2 -0
  13. data/docs/AnswerCallback.md +2 -2
  14. data/docs/BridgeCompleteCallback.md +2 -2
  15. data/docs/BridgeTargetCompleteCallback.md +2 -2
  16. data/docs/CallRecordingMetadata.md +4 -4
  17. data/docs/CallState.md +1 -1
  18. data/docs/CallTranscription.md +6 -6
  19. data/docs/CallTranscriptionDetectedLanguageEnum.md +15 -0
  20. data/docs/CallTranscriptionResponse.md +2 -2
  21. data/docs/CallTranscriptionTrackEnum.md +15 -0
  22. data/docs/CallsApi.md +1 -1
  23. data/docs/ConferenceMemberExitCallback.md +1 -1
  24. data/docs/ConferenceMemberJoinCallback.md +1 -1
  25. data/docs/ConferenceRecordingAvailableCallback.md +1 -1
  26. data/docs/ConferenceRecordingMetadata.md +1 -1
  27. data/docs/CreateCall.md +5 -3
  28. data/docs/DisconnectCallback.md +2 -2
  29. data/docs/DtmfCallback.md +4 -4
  30. data/docs/GatherCallback.md +4 -4
  31. data/docs/InitiateCallback.md +2 -2
  32. data/docs/MachineDetectionCompleteCallback.md +2 -2
  33. data/docs/MessagingCodeResponse.md +1 -1
  34. data/docs/RecordingAvailableCallback.md +4 -4
  35. data/docs/RecordingCompleteCallback.md +4 -4
  36. data/docs/RecordingTranscriptionMetadata.md +1 -1
  37. data/docs/RedirectCallback.md +4 -4
  38. data/docs/TranscriptionAvailableCallback.md +4 -4
  39. data/docs/TranscriptionsApi.md +1 -1
  40. data/docs/TransferAnswerCallback.md +4 -4
  41. data/docs/TransferCompleteCallback.md +4 -4
  42. data/docs/TransferDisconnectCallback.md +4 -4
  43. data/lib/bandwidth-sdk/api/calls_api.rb +1 -1
  44. data/lib/bandwidth-sdk/api/conferences_api.rb +1 -1
  45. data/lib/bandwidth-sdk/api/media_api.rb +1 -1
  46. data/lib/bandwidth-sdk/api/messages_api.rb +1 -1
  47. data/lib/bandwidth-sdk/api/mfa_api.rb +1 -1
  48. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +1 -1
  49. data/lib/bandwidth-sdk/api/recordings_api.rb +1 -1
  50. data/lib/bandwidth-sdk/api/statistics_api.rb +1 -1
  51. data/lib/bandwidth-sdk/api/transcriptions_api.rb +3 -3
  52. data/lib/bandwidth-sdk/api_client.rb +44 -41
  53. data/lib/bandwidth-sdk/api_error.rb +1 -1
  54. data/lib/bandwidth-sdk/configuration.rb +11 -1
  55. data/lib/bandwidth-sdk/models/account_statistics.rb +2 -2
  56. data/lib/bandwidth-sdk/models/answer_callback.rb +3 -3
  57. data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +3 -3
  58. data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +3 -3
  59. data/lib/bandwidth-sdk/models/bxml/root.rb +0 -6
  60. data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +0 -6
  61. data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +0 -6
  62. data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +0 -6
  63. data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +0 -6
  64. data/lib/bandwidth-sdk/models/call_direction_enum.rb +1 -1
  65. data/lib/bandwidth-sdk/models/call_recording_metadata.rb +4 -4
  66. data/lib/bandwidth-sdk/models/call_state.rb +2 -2
  67. data/lib/bandwidth-sdk/models/call_state_enum.rb +1 -1
  68. data/lib/bandwidth-sdk/models/call_transcription.rb +11 -37
  69. data/lib/bandwidth-sdk/models/call_transcription_detected_language_enum.rb +41 -0
  70. data/lib/bandwidth-sdk/models/call_transcription_metadata.rb +2 -2
  71. data/lib/bandwidth-sdk/models/call_transcription_response.rb +2 -2
  72. data/lib/bandwidth-sdk/models/call_transcription_track_enum.rb +40 -0
  73. data/lib/bandwidth-sdk/models/callback_method_enum.rb +1 -1
  74. data/lib/bandwidth-sdk/models/code_request.rb +2 -2
  75. data/lib/bandwidth-sdk/models/conference.rb +2 -2
  76. data/lib/bandwidth-sdk/models/conference_completed_callback.rb +2 -2
  77. data/lib/bandwidth-sdk/models/conference_created_callback.rb +2 -2
  78. data/lib/bandwidth-sdk/models/conference_member.rb +2 -2
  79. data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +3 -3
  80. data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +3 -3
  81. data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +2 -2
  82. data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +2 -2
  83. data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +2 -2
  84. data/lib/bandwidth-sdk/models/conference_state_enum.rb +1 -1
  85. data/lib/bandwidth-sdk/models/create_call.rb +16 -5
  86. data/lib/bandwidth-sdk/models/create_call_response.rb +2 -2
  87. data/lib/bandwidth-sdk/models/create_lookup_response.rb +2 -2
  88. data/lib/bandwidth-sdk/models/create_message_request_error.rb +2 -2
  89. data/lib/bandwidth-sdk/models/deferred_result.rb +2 -2
  90. data/lib/bandwidth-sdk/models/disconnect_callback.rb +3 -3
  91. data/lib/bandwidth-sdk/models/diversion.rb +2 -2
  92. data/lib/bandwidth-sdk/models/dtmf_callback.rb +4 -4
  93. data/lib/bandwidth-sdk/models/field_error.rb +2 -2
  94. data/lib/bandwidth-sdk/models/file_format_enum.rb +1 -1
  95. data/lib/bandwidth-sdk/models/gather_callback.rb +4 -4
  96. data/lib/bandwidth-sdk/models/inbound_message_callback.rb +2 -2
  97. data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +2 -2
  98. data/lib/bandwidth-sdk/models/initiate_callback.rb +3 -3
  99. data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +1 -1
  100. data/lib/bandwidth-sdk/models/list_message_item.rb +2 -2
  101. data/lib/bandwidth-sdk/models/lookup_request.rb +2 -2
  102. data/lib/bandwidth-sdk/models/lookup_result.rb +2 -2
  103. data/lib/bandwidth-sdk/models/lookup_status.rb +2 -2
  104. data/lib/bandwidth-sdk/models/lookup_status_enum.rb +1 -1
  105. data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +3 -3
  106. data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +3 -3
  107. data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +1 -1
  108. data/lib/bandwidth-sdk/models/machine_detection_result.rb +2 -2
  109. data/lib/bandwidth-sdk/models/media.rb +2 -2
  110. data/lib/bandwidth-sdk/models/message.rb +2 -2
  111. data/lib/bandwidth-sdk/models/message_delivered_callback.rb +2 -2
  112. data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +2 -2
  113. data/lib/bandwidth-sdk/models/message_direction_enum.rb +1 -1
  114. data/lib/bandwidth-sdk/models/message_failed_callback.rb +2 -2
  115. data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +2 -2
  116. data/lib/bandwidth-sdk/models/message_request.rb +2 -2
  117. data/lib/bandwidth-sdk/models/message_sending_callback.rb +2 -2
  118. data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +2 -2
  119. data/lib/bandwidth-sdk/models/message_status_enum.rb +1 -1
  120. data/lib/bandwidth-sdk/models/message_type_enum.rb +1 -1
  121. data/lib/bandwidth-sdk/models/messages_list.rb +2 -2
  122. data/lib/bandwidth-sdk/models/messaging_code_response.rb +2 -2
  123. data/lib/bandwidth-sdk/models/messaging_request_error.rb +2 -2
  124. data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +2 -2
  125. data/lib/bandwidth-sdk/models/mfa_request_error.rb +2 -2
  126. data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +2 -2
  127. data/lib/bandwidth-sdk/models/page_info.rb +2 -2
  128. data/lib/bandwidth-sdk/models/priority_enum.rb +1 -1
  129. data/lib/bandwidth-sdk/models/recording_available_callback.rb +4 -4
  130. data/lib/bandwidth-sdk/models/recording_complete_callback.rb +4 -4
  131. data/lib/bandwidth-sdk/models/recording_state_enum.rb +1 -1
  132. data/lib/bandwidth-sdk/models/recording_transcription_metadata.rb +3 -3
  133. data/lib/bandwidth-sdk/models/recording_transcriptions.rb +2 -2
  134. data/lib/bandwidth-sdk/models/redirect_callback.rb +4 -4
  135. data/lib/bandwidth-sdk/models/redirect_method_enum.rb +1 -1
  136. data/lib/bandwidth-sdk/models/stir_shaken.rb +2 -2
  137. data/lib/bandwidth-sdk/models/tag.rb +2 -2
  138. data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +2 -2
  139. data/lib/bandwidth-sdk/models/transcribe_recording.rb +2 -2
  140. data/lib/bandwidth-sdk/models/transcription.rb +2 -2
  141. data/lib/bandwidth-sdk/models/transcription_available_callback.rb +4 -4
  142. data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +4 -4
  143. data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +4 -4
  144. data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +4 -4
  145. data/lib/bandwidth-sdk/models/update_call.rb +2 -2
  146. data/lib/bandwidth-sdk/models/update_call_recording.rb +2 -2
  147. data/lib/bandwidth-sdk/models/update_conference.rb +2 -2
  148. data/lib/bandwidth-sdk/models/update_conference_member.rb +2 -2
  149. data/lib/bandwidth-sdk/models/verify_code_request.rb +2 -2
  150. data/lib/bandwidth-sdk/models/verify_code_response.rb +2 -2
  151. data/lib/bandwidth-sdk/models/voice_api_error.rb +2 -2
  152. data/lib/bandwidth-sdk/models/voice_code_response.rb +2 -2
  153. data/lib/bandwidth-sdk/version.rb +2 -2
  154. data/lib/bandwidth-sdk.rb +3 -1
  155. data/openapitools.json +1 -1
  156. data/spec/call_utils.rb +1 -1
  157. data/spec/{integration/calls_api_integration_spec.rb → smoke/calls_api_spec.rb} +3 -6
  158. data/spec/{integration/conferences_api_integration_spec.rb → smoke/conferences_api_spec.rb} +0 -5
  159. data/spec/{integration/media_api_integration_spec.rb → smoke/media_api_spec.rb} +0 -5
  160. data/spec/{integration/messages_api_integration_spec.rb → smoke/messages_api_spec.rb} +0 -5
  161. data/spec/{integration/mfa_api_integration_spec.rb → smoke/mfa_api_spec.rb} +0 -5
  162. data/spec/{integration/phone_number_lookup_api_integration_spec.rb → smoke/phone_number_lookup_api_spec.rb} +0 -5
  163. data/spec/{integration/recordings_api_integration_spec.rb → smoke/recordings_api_spec.rb} +0 -5
  164. data/spec/{integration/statistics_api_integration_spec.rb → smoke/statistics_api_spec.rb} +0 -5
  165. data/spec/{integration/transcriptions_api_integration_spec.rb → smoke/transcriptions_api_spec.rb} +0 -5
  166. data/spec/spec_helper.rb +13 -6
  167. data/spec/unit/api/calls_api_spec.rb +233 -0
  168. data/spec/unit/api/conferences_api_spec.rb +330 -0
  169. data/spec/{api → unit/api}/media_api_spec.rb +17 -32
  170. data/spec/unit/api/messages_api_spec.rb +103 -0
  171. data/spec/{api → unit/api}/mfa_api_spec.rb +8 -24
  172. data/spec/unit/api/phone_number_lookup_api_spec.rb +86 -0
  173. data/spec/{api → unit/api}/recordings_api_spec.rb +83 -110
  174. data/spec/unit/api/statistics_api_spec.rb +37 -0
  175. data/spec/{api → unit/api}/transcriptions_api_spec.rb +18 -37
  176. data/spec/{api_client_spec.rb → unit/client/api_client_spec.rb} +4 -4
  177. metadata +136 -118
  178. data/spec/api/calls_api_spec.rb +0 -261
  179. data/spec/api/conferences_api_spec.rb +0 -393
  180. data/spec/api/messages_api_spec.rb +0 -193
  181. data/spec/api/phone_number_lookup_api_spec.rb +0 -100
  182. data/spec/api/statistics_api_spec.rb +0 -45
  183. /data/spec/{api_error_spec.rb → unit/client/api_error_spec.rb} +0 -0
  184. /data/spec/{configuration_spec.rb → unit/client/configuration_spec.rb} +0 -0
  185. /data/spec/{models → unit/models}/bxml/bxml_spec.rb +0 -0
  186. /data/spec/{models → unit/models}/bxml/nestable_verb_spec.rb +0 -0
  187. /data/spec/{models → unit/models}/bxml/response_spec.rb +0 -0
  188. /data/spec/{models → unit/models}/bxml/verb_spec.rb +0 -0
  189. /data/spec/{models → unit/models}/bxml/verbs/bridge_spec.rb +0 -0
  190. /data/spec/{models → unit/models}/bxml/verbs/conference_spec.rb +0 -0
  191. /data/spec/{models → unit/models}/bxml/verbs/custom_param_spec.rb +0 -0
  192. /data/spec/{models → unit/models}/bxml/verbs/forward_spec.rb +0 -0
  193. /data/spec/{models → unit/models}/bxml/verbs/gather_spec.rb +0 -0
  194. /data/spec/{models → unit/models}/bxml/verbs/hangup_spec.rb +0 -0
  195. /data/spec/{models → unit/models}/bxml/verbs/pause_recording_spec.rb +0 -0
  196. /data/spec/{models → unit/models}/bxml/verbs/pause_spec.rb +0 -0
  197. /data/spec/{models → unit/models}/bxml/verbs/phone_number_spec.rb +0 -0
  198. /data/spec/{models → unit/models}/bxml/verbs/play_audio_spec.rb +0 -0
  199. /data/spec/{models → unit/models}/bxml/verbs/record_spec.rb +0 -0
  200. /data/spec/{models → unit/models}/bxml/verbs/redirect_spec.rb +0 -0
  201. /data/spec/{models → unit/models}/bxml/verbs/resume_recording_spec.rb +0 -0
  202. /data/spec/{models → unit/models}/bxml/verbs/ring_spec.rb +0 -0
  203. /data/spec/{models → unit/models}/bxml/verbs/send_dtmf_spec.rb +0 -0
  204. /data/spec/{models → unit/models}/bxml/verbs/sip_uri_spec.rb +0 -0
  205. /data/spec/{models → unit/models}/bxml/verbs/speak_sentence_spec.rb +0 -0
  206. /data/spec/{models → unit/models}/bxml/verbs/start_gather_spec.rb +0 -0
  207. /data/spec/{models → unit/models}/bxml/verbs/start_recording_spec.rb +0 -0
  208. /data/spec/{models → unit/models}/bxml/verbs/start_stream_spec.rb +0 -0
  209. /data/spec/{models → unit/models}/bxml/verbs/start_transcription_spec.rb +0 -0
  210. /data/spec/{models → unit/models}/bxml/verbs/stop_gather_spec.rb +0 -0
  211. /data/spec/{models → unit/models}/bxml/verbs/stop_recording_spec.rb +0 -0
  212. /data/spec/{models → unit/models}/bxml/verbs/stop_stream_spec.rb +0 -0
  213. /data/spec/{models → unit/models}/bxml/verbs/stop_transcription_spec.rb +0 -0
  214. /data/spec/{models → unit/models}/bxml/verbs/stream_param_spec.rb +0 -0
  215. /data/spec/{models → unit/models}/bxml/verbs/tag_spec.rb +0 -0
  216. /data/spec/{models → unit/models}/bxml/verbs/transfer_spec.rb +0 -0
  217. /data/spec/{models → unit/models}/call_state_enum_spec.rb +0 -0
  218. /data/spec/{models → unit/models}/call_state_spec.rb +0 -0
  219. /data/spec/{models → unit/models}/deferred_result_spec.rb +0 -0
  220. /data/spec/{models → unit/models}/message_spec.rb +0 -0
  221. /data/spec/{models → unit/models}/verify_code_request_spec.rb +0 -0
@@ -3,9 +3,8 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 13.0.1'
6
+ gem 'rake', '~> 13.2.1'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 1.52.0'
9
- gem 'webmock', '~> 3.18.0'
10
9
  gem 'simplecov', '~> 0.21.2'
11
10
  end
@@ -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
 
@@ -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] |
@@ -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: 920012,
30
+ account_id: 9900000,
31
31
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
32
32
  from: +15555555555,
33
33
  to: +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] |
@@ -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: 920012,
32
+ account_id: 9900000,
33
33
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
34
34
  from: +15555555555,
35
35
  to: +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] |
@@ -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: 920012,
29
+ account_id: 9900000,
30
30
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
31
31
  from: +15555555555,
32
32
  to: +15555555555,
@@ -10,8 +10,8 @@
10
10
  | **parent_call_id** | **String** | (optional) If the event is related to the B leg of a &lt;Transfer&gt;, the call id of the original call leg that executed the &lt;Transfer&gt;. 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] |
@@ -30,14 +30,14 @@ require 'bandwidth-sdk'
30
30
 
31
31
  instance = Bandwidth::CallRecordingMetadata.new(
32
32
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
33
- account_id: 920012,
33
+ account_id: 9900000,
34
34
  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
35
35
  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
36
36
  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
37
37
  to: +15555555555,
38
38
  from: +15555555555,
39
39
  transfer_caller_id: +15555555555,
40
- transfer_to: +15555555555),
40
+ transfer_to: +15555555555,
41
41
  duration: PT13.67S,
42
42
  direction: null,
43
43
  channels: 1,
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: {&quot;verstat&quot;:&quot;TN-Verification-Passed&quot;,&quot;attestationIndicator&quot;:&quot;A&quot;,&quot;originatingId&quot;:&quot;abc123&quot;},
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **detected_language** | **String** | The detected language for this transcription. | [optional] |
8
- | **track** | **String** | Which &#x60;track&#x60; this transcription is derived from. | [optional] |
9
- | **text** | **String** | The transcription itself. | [optional] |
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 &#x60;0&#x60; to &#x60;1&#x60;). | [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: en-US,
19
- track: inbound,
20
- text: Hello World! This is an example.,
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
+
@@ -15,10 +15,10 @@
15
15
  require 'bandwidth-sdk'
16
16
 
17
17
  instance = Bandwidth::CallTranscriptionResponse.new(
18
- account_id: 920012,
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: [{&quot;detectedLanguage&quot;:&quot;en-US&quot;,&quot;track&quot;:&quot;inbound&quot;,&quot;text&quot;:&quot;Hello World! This is an example.&quot;,&quot;confidence&quot;:0.9}]
21
+ tracks: [{&quot;detectedLanguage&quot;:&quot;en-US&quot;,&quot;track&quot;:&quot;inbound&quot;,&quot;transcript&quot;:&quot;Hello World! This is an example.&quot;,&quot;confidence&quot;: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
+
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] |
@@ -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: 920012,
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,
@@ -22,7 +22,7 @@
22
22
  require 'bandwidth-sdk'
23
23
 
24
24
  instance = Bandwidth::ConferenceRecordingMetadata.new(
25
- account_id: 920012,
25
+ account_id: 9900000,
26
26
  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
27
27
  name: my-conference-name,
28
28
  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
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. &#x60;+15555551212&#x60;) or a SIP URI (e.g. &#x60;sip:user@server.example&#x60;)). | |
8
- | **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like &#x60;+15555551212&#x60;, or be one of the following strings: &#x60;Restricted&#x60;, &#x60;Anonymous&#x60;, &#x60;Private&#x60;, or &#x60;Unavailable&#x60;). | |
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 &#x60;+15555551212&#x60;) even if &#x60;privacy&#x60; is set to true. | |
9
+ | **privacy** | **Boolean** | Hide the calling number. The &#x60;displayName&#x60; 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 &#x60;privacy&#x60; is true, only the following values are valid: &#x60;Restricted&#x60;, &#x60;Anonymous&#x60;, &#x60;Private&#x60;, or &#x60;Unavailable&#x60;. | [optional] |
10
11
  | **uui** | **String** | A comma-separated list of &#39;User-To-User&#39; headers to be sent in the INVITE when calling a SIP URI. Each value must end with an &#39;encoding&#39; parameter as described in &lt;a href&#x3D;&#39;https://tools.ietf.org/html/rfc7433&#39;&gt;RFC 7433&lt;/a&gt;. Only &#39;jwt&#39; and &#39;base64&#39; 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 &#x60;from&#x60; number. | |
12
13
  | **answer_url** | **String** | The full URL to send the &lt;a href&#x3D;&#39;/docs/voice/webhooks/answer&#39;&gt;Answer&lt;/a&gt; event to when the called party answers. This endpoint should return the first &lt;a href&#x3D;&#39;/docs/voice/bxml&#39;&gt;BXML document&lt;/a&gt; to be executed in the call. Must use &#x60;https&#x60; if specifying &#x60;username&#x60; and &#x60;password&#x60;. | |
@@ -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&#x3D;jwt,aGVsbG8gd29ybGQ;encoding&#x3D;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] |
@@ -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: 920012,
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
@@ -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 &lt;Transfer&gt;, the call id of the original call leg that executed the &lt;Transfer&gt;. 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
 
@@ -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: 920012,
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
  ```
@@ -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 &lt;Transfer&gt;, the call id of the original call leg that executed the &lt;Transfer&gt;. 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
 
@@ -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: 920012,
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
  ```
@@ -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] |
@@ -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: 920012,
28
+ account_id: 9900000,
29
29
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
30
30
  from: +15555555555,
31
31
  to: +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] |
@@ -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: 920012,
30
+ account_id: 9900000,
31
31
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
32
32
  from: +15555555555,
33
33
  to: +15555555555,
@@ -12,7 +12,7 @@
12
12
  require 'bandwidth-sdk'
13
13
 
14
14
  instance = Bandwidth::MessagingCodeResponse.new(
15
- message_id: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
15
+ message_id: 1589228074636lm4k2je7j7jklbn2
16
16
  )
17
17
  ```
18
18
 
@@ -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
  | **channels** | **Integer** | Always &#x60;1&#x60; 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 &#39;processing&#39;, &#39;partial&#39;, &#39;complete&#39;, &#39;deleted&#39;, and &#39;error&#39;. For transcriptions, current possible values are &#39;none&#39;, &#39;processing&#39;, &#39;available&#39;, &#39;error&#39;, &#39;timeout&#39;, &#39;file-size-too-big&#39;, and &#39;file-size-too-small&#39;. 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
@@ -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: 920012,
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
 
@@ -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 &#x60;1&#x60; 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
@@ -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: 920012,
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 &#39;processing&#39;, &#39;partial&#39;, &#39;complete&#39;, &#39;deleted&#39;, and &#39;error&#39;. For transcriptions, current possible values are &#39;none&#39;, &#39;processing&#39;, &#39;available&#39;, &#39;error&#39;, &#39;timeout&#39;, &#39;file-size-too-big&#39;, and &#39;file-size-too-small&#39;. 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] |
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
@@ -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] |
@@ -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
  | **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] |
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
 
24
24
  ## Example
@@ -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: 920012,
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
 
@@ -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] |
@@ -23,7 +23,7 @@
23
23
  | **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [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
  | **transcription** | [**Transcription**](Transcription.md) | | [optional] |
26
- | **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] |
26
+ | **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] |
27
27
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
28
28
 
29
29
  ## Example
@@ -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: 920012,
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
 
@@ -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 `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.
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
 
@@ -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] |
@@ -17,7 +17,7 @@
17
17
  | **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
18
18
  | **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
19
19
  | **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] |
20
- | **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] |
20
+ | **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] |
21
21
  | **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
22
22
 
23
23
  ## Example
@@ -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: 920012,
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