bandwidth-sdk 10.0.0 → 11.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (489) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +11 -0
  3. data/Gemfile.lock +102 -0
  4. data/README.md +204 -139
  5. data/Rakefile +30 -0
  6. data/bandwidth-sdk.gemspec +40 -0
  7. data/bandwidth.yml +5626 -0
  8. data/coverage/.last_run.json +5 -0
  9. data/coverage/.resultset.json +9761 -0
  10. data/coverage/.resultset.json.lock +0 -0
  11. data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png +0 -0
  12. data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png +0 -0
  13. data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png +0 -0
  14. data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png +0 -0
  15. data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png +0 -0
  16. data/coverage/assets/0.12.3/application.css +1 -0
  17. data/coverage/assets/0.12.3/application.js +7 -0
  18. data/coverage/assets/0.12.3/colorbox/border.png +0 -0
  19. data/coverage/assets/0.12.3/colorbox/controls.png +0 -0
  20. data/coverage/assets/0.12.3/colorbox/loading.gif +0 -0
  21. data/coverage/assets/0.12.3/colorbox/loading_background.png +0 -0
  22. data/coverage/assets/0.12.3/favicon_green.png +0 -0
  23. data/coverage/assets/0.12.3/favicon_red.png +0 -0
  24. data/coverage/assets/0.12.3/favicon_yellow.png +0 -0
  25. data/coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  26. data/coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  27. data/coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  28. data/coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  29. data/coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  30. data/coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  31. data/coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  32. data/coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  33. data/coverage/assets/0.12.3/images/ui-icons_222222_256x240.png +0 -0
  34. data/coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png +0 -0
  35. data/coverage/assets/0.12.3/images/ui-icons_454545_256x240.png +0 -0
  36. data/coverage/assets/0.12.3/images/ui-icons_888888_256x240.png +0 -0
  37. data/coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png +0 -0
  38. data/coverage/assets/0.12.3/loading.gif +0 -0
  39. data/coverage/assets/0.12.3/magnify.png +0 -0
  40. data/coverage/index.html +108271 -0
  41. data/custom_templates/Gemfile.mustache +11 -0
  42. data/custom_templates/README.mustache +173 -0
  43. data/custom_templates/gem.mustache +99 -0
  44. data/custom_templates/gemspec.mustache +37 -0
  45. data/docs/AccountStatistics.md +20 -0
  46. data/docs/AnswerCallback.md +44 -0
  47. data/docs/BridgeCompleteCallback.md +48 -0
  48. data/docs/BridgeTargetCompleteCallback.md +42 -0
  49. data/docs/CallDirectionEnum.md +15 -0
  50. data/docs/CallRecordingMetadata.md +52 -0
  51. data/docs/CallState.md +52 -0
  52. data/docs/CallStateEnum.md +15 -0
  53. data/docs/CallbackMethodEnum.md +15 -0
  54. data/docs/CallsApi.md +304 -0
  55. data/docs/CodeRequest.md +28 -0
  56. data/docs/Conference.md +32 -0
  57. data/docs/ConferenceCompletedCallback.md +26 -0
  58. data/docs/ConferenceCreatedCallback.md +26 -0
  59. data/docs/ConferenceMember.md +28 -0
  60. data/docs/ConferenceMemberExitCallback.md +32 -0
  61. data/docs/ConferenceMemberJoinCallback.md +32 -0
  62. data/docs/ConferenceRecordingAvailableCallback.md +44 -0
  63. data/docs/ConferenceRecordingMetadata.md +38 -0
  64. data/docs/ConferenceRedirectCallback.md +26 -0
  65. data/docs/ConferenceStateEnum.md +15 -0
  66. data/docs/ConferencesApi.md +688 -0
  67. data/docs/CreateCall.md +56 -0
  68. data/docs/CreateCallResponse.md +58 -0
  69. data/docs/CreateLookupResponse.md +20 -0
  70. data/docs/CreateMessageRequestError.md +22 -0
  71. data/docs/CreateParticipantRequest.md +24 -0
  72. data/docs/CreateParticipantResponse.md +20 -0
  73. data/docs/DeferredResult.md +20 -0
  74. data/docs/DeviceApiVersionEnum.md +15 -0
  75. data/docs/DisconenctCallback.md +50 -0
  76. data/docs/DisconnectCallback.md +50 -0
  77. data/docs/Diversion.md +30 -0
  78. data/docs/DtmfCallback.md +50 -0
  79. data/docs/FieldError.md +20 -0
  80. data/docs/FileFormatEnum.md +15 -0
  81. data/docs/ForbiddenRequest.md +18 -0
  82. data/docs/GatherCallback.md +52 -0
  83. data/docs/InboundMessageCallback.md +26 -0
  84. data/docs/InboundMessageCallbackMessage.md +40 -0
  85. data/docs/InitiateCallback.md +40 -0
  86. data/docs/ListMessageDirectionEnum.md +15 -0
  87. data/docs/ListMessageItem.md +50 -0
  88. data/docs/LookupRequest.md +18 -0
  89. data/docs/LookupResult.md +34 -0
  90. data/docs/LookupStatus.md +24 -0
  91. data/docs/LookupStatusEnum.md +15 -0
  92. data/docs/MFAApi.md +226 -0
  93. data/docs/MachineDetectionCompleteCallback.md +44 -0
  94. data/docs/MachineDetectionConfiguration.md +46 -0
  95. data/docs/MachineDetectionModeEnum.md +15 -0
  96. data/docs/MachineDetectionResult.md +20 -0
  97. data/docs/Media.md +22 -0
  98. data/docs/MediaApi.md +307 -0
  99. data/docs/Message.md +42 -0
  100. data/docs/MessageDeliveredCallback.md +26 -0
  101. data/docs/MessageDeliveredCallbackMessage.md +40 -0
  102. data/docs/MessageDirectionEnum.md +15 -0
  103. data/docs/MessageFailedCallback.md +28 -0
  104. data/docs/MessageFailedCallbackMessage.md +40 -0
  105. data/docs/MessageRequest.md +32 -0
  106. data/docs/MessageSendingCallback.md +26 -0
  107. data/docs/MessageSendingCallbackMessage.md +40 -0
  108. data/docs/MessageStatusEnum.md +15 -0
  109. data/docs/MessageTypeEnum.md +15 -0
  110. data/docs/MessagesApi.md +183 -0
  111. data/docs/MessagesList.md +22 -0
  112. data/docs/MessagingCodeResponse.md +18 -0
  113. data/docs/MessagingRequestError.md +20 -0
  114. data/docs/MfaForbiddenRequestError.md +18 -0
  115. data/docs/MfaRequestError.md +20 -0
  116. data/docs/MfaUnauthorizedRequestError.md +18 -0
  117. data/docs/PageInfo.md +24 -0
  118. data/docs/Participant.md +30 -0
  119. data/docs/ParticipantSubscription.md +20 -0
  120. data/docs/ParticipantsApi.md +227 -0
  121. data/docs/PhoneNumberLookupApi.md +153 -0
  122. data/docs/PriorityEnum.md +15 -0
  123. data/docs/PublishPermissionsEnum.md +15 -0
  124. data/docs/RecordingAvailableCallback.md +60 -0
  125. data/docs/RecordingCompleteCallback.md +60 -0
  126. data/docs/RecordingStateEnum.md +15 -0
  127. data/docs/RecordingsApi.md +758 -0
  128. data/docs/RedirectCallback.md +48 -0
  129. data/docs/RedirectMethodEnum.md +15 -0
  130. data/docs/RequestError.md +20 -0
  131. data/docs/Session.md +20 -0
  132. data/docs/SessionsApi.md +605 -0
  133. data/docs/StatisticsApi.md +78 -0
  134. data/docs/StirShaken.md +22 -0
  135. data/docs/Subscriptions.md +20 -0
  136. data/docs/Tag.md +20 -0
  137. data/docs/TnLookupRequestError.md +18 -0
  138. data/docs/TranscribeRecording.md +30 -0
  139. data/docs/Transcription.md +20 -0
  140. data/docs/TranscriptionAvailableCallback.md +58 -0
  141. data/docs/TranscriptionList.md +18 -0
  142. data/docs/TranscriptionMetadata.md +24 -0
  143. data/docs/TransferAnswerCallback.md +46 -0
  144. data/docs/TransferCompleteCallback.md +52 -0
  145. data/docs/TransferDisconnectCallback.md +56 -0
  146. data/docs/UnauthorizedRequest.md +18 -0
  147. data/docs/UpdateCall.md +36 -0
  148. data/docs/UpdateCallRecording.md +18 -0
  149. data/docs/UpdateConference.md +34 -0
  150. data/docs/UpdateConferenceMember.md +22 -0
  151. data/docs/VerifyCodeRequest.md +24 -0
  152. data/docs/VerifyCodeResponse.md +18 -0
  153. data/docs/VoiceApiError.md +22 -0
  154. data/docs/VoiceCodeResponse.md +18 -0
  155. data/git_push.sh +57 -0
  156. data/lib/bandwidth-sdk/api/calls_api.rb +325 -0
  157. data/lib/bandwidth-sdk/api/conferences_api.rb +717 -0
  158. data/lib/bandwidth-sdk/api/media_api.rb +312 -0
  159. data/lib/bandwidth-sdk/api/messages_api.rb +204 -0
  160. data/lib/bandwidth-sdk/api/mfa_api.rb +244 -0
  161. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +165 -0
  162. data/lib/bandwidth-sdk/api/recordings_api.rb +782 -0
  163. data/lib/bandwidth-sdk/api/statistics_api.rb +85 -0
  164. data/lib/bandwidth-sdk/api_client.rb +428 -0
  165. data/lib/bandwidth-sdk/api_error.rb +58 -0
  166. data/lib/bandwidth-sdk/configuration.rb +591 -0
  167. data/lib/bandwidth-sdk/models/account_statistics.rb +223 -0
  168. data/lib/bandwidth-sdk/models/answer_callback.rb +368 -0
  169. data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +390 -0
  170. data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +358 -0
  171. data/lib/bandwidth-sdk/models/bxml/bxml.rb +11 -0
  172. data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb +46 -0
  173. data/lib/bandwidth-sdk/models/bxml/response.rb +11 -0
  174. data/lib/bandwidth-sdk/models/bxml/root.rb +47 -0
  175. data/lib/bandwidth-sdk/models/bxml/verb.rb +50 -0
  176. data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb +28 -0
  177. data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb +28 -0
  178. data/lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb +16 -0
  179. data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +20 -0
  180. data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +42 -0
  181. data/lib/bandwidth-sdk/models/bxml/verbs/hangup.rb +10 -0
  182. data/lib/bandwidth-sdk/models/bxml/verbs/pause.rb +15 -0
  183. data/lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb +10 -0
  184. data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +26 -0
  185. data/lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb +17 -0
  186. data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +32 -0
  187. data/lib/bandwidth-sdk/models/bxml/verbs/redirect.rb +23 -0
  188. data/lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb +10 -0
  189. data/lib/bandwidth-sdk/models/bxml/verbs/ring.rb +16 -0
  190. data/lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb +17 -0
  191. data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +27 -0
  192. data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +25 -0
  193. data/lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb +19 -0
  194. data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +24 -0
  195. data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +28 -0
  196. data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +29 -0
  197. data/lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb +10 -0
  198. data/lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb +10 -0
  199. data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +15 -0
  200. data/lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb +15 -0
  201. data/lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb +16 -0
  202. data/lib/bandwidth-sdk/models/bxml/verbs/tag.rb +11 -0
  203. data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +34 -0
  204. data/lib/bandwidth-sdk/models/call_direction_enum.rb +40 -0
  205. data/lib/bandwidth-sdk/models/call_recording_metadata.rb +404 -0
  206. data/lib/bandwidth-sdk/models/call_state.rb +416 -0
  207. data/lib/bandwidth-sdk/models/call_state_enum.rb +40 -0
  208. data/lib/bandwidth-sdk/models/callback_method_enum.rb +40 -0
  209. data/lib/bandwidth-sdk/models/code_request.rb +434 -0
  210. data/lib/bandwidth-sdk/models/conference.rb +313 -0
  211. data/lib/bandwidth-sdk/models/conference_completed_callback.rb +255 -0
  212. data/lib/bandwidth-sdk/models/conference_created_callback.rb +255 -0
  213. data/lib/bandwidth-sdk/models/conference_member.rb +266 -0
  214. data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +285 -0
  215. data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +285 -0
  216. data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +367 -0
  217. data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +335 -0
  218. data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +255 -0
  219. data/lib/bandwidth-sdk/models/conference_state_enum.rb +40 -0
  220. data/lib/bandwidth-sdk/models/create_call.rb +687 -0
  221. data/lib/bandwidth-sdk/models/create_call_response.rb +559 -0
  222. data/lib/bandwidth-sdk/models/create_lookup_response.rb +245 -0
  223. data/lib/bandwidth-sdk/models/create_message_request_error.rb +246 -0
  224. data/lib/bandwidth-sdk/models/deferred_result.rb +221 -0
  225. data/lib/bandwidth-sdk/models/disconenct_callback.rb +405 -0
  226. data/lib/bandwidth-sdk/models/disconnect_callback.rb +400 -0
  227. data/lib/bandwidth-sdk/models/diversion.rb +273 -0
  228. data/lib/bandwidth-sdk/models/dtmf_callback.rb +398 -0
  229. data/lib/bandwidth-sdk/models/field_error.rb +223 -0
  230. data/lib/bandwidth-sdk/models/file_format_enum.rb +40 -0
  231. data/lib/bandwidth-sdk/models/gather_callback.rb +408 -0
  232. data/lib/bandwidth-sdk/models/inbound_message_callback.rb +284 -0
  233. data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +411 -0
  234. data/lib/bandwidth-sdk/models/initiate_callback.rb +343 -0
  235. data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +40 -0
  236. data/lib/bandwidth-sdk/models/list_message_item.rb +398 -0
  237. data/lib/bandwidth-sdk/models/lookup_request.rb +222 -0
  238. data/lib/bandwidth-sdk/models/lookup_result.rb +294 -0
  239. data/lib/bandwidth-sdk/models/lookup_status.rb +269 -0
  240. data/lib/bandwidth-sdk/models/lookup_status_enum.rb +42 -0
  241. data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +368 -0
  242. data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +493 -0
  243. data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +40 -0
  244. data/lib/bandwidth-sdk/models/machine_detection_result.rb +224 -0
  245. data/lib/bandwidth-sdk/models/media.rb +230 -0
  246. data/lib/bandwidth-sdk/models/message.rb +377 -0
  247. data/lib/bandwidth-sdk/models/message_delivered_callback.rb +284 -0
  248. data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +418 -0
  249. data/lib/bandwidth-sdk/models/message_direction_enum.rb +40 -0
  250. data/lib/bandwidth-sdk/models/message_failed_callback.rb +300 -0
  251. data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +425 -0
  252. data/lib/bandwidth-sdk/models/message_request.rb +358 -0
  253. data/lib/bandwidth-sdk/models/message_sending_callback.rb +284 -0
  254. data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +425 -0
  255. data/lib/bandwidth-sdk/models/message_status_enum.rb +46 -0
  256. data/lib/bandwidth-sdk/models/message_type_enum.rb +40 -0
  257. data/lib/bandwidth-sdk/models/messages_list.rb +233 -0
  258. data/lib/bandwidth-sdk/models/messaging_code_response.rb +213 -0
  259. data/lib/bandwidth-sdk/models/messaging_request_error.rb +235 -0
  260. data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +213 -0
  261. data/lib/bandwidth-sdk/models/mfa_request_error.rb +223 -0
  262. data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +213 -0
  263. data/lib/bandwidth-sdk/models/page_info.rb +243 -0
  264. data/lib/bandwidth-sdk/models/priority_enum.rb +40 -0
  265. data/lib/bandwidth-sdk/models/recording_available_callback.rb +447 -0
  266. data/lib/bandwidth-sdk/models/recording_complete_callback.rb +448 -0
  267. data/lib/bandwidth-sdk/models/recording_state_enum.rb +40 -0
  268. data/lib/bandwidth-sdk/models/redirect_callback.rb +388 -0
  269. data/lib/bandwidth-sdk/models/redirect_method_enum.rb +40 -0
  270. data/lib/bandwidth-sdk/models/stir_shaken.rb +233 -0
  271. data/lib/bandwidth-sdk/models/tag.rb +221 -0
  272. data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +213 -0
  273. data/lib/bandwidth-sdk/models/transcribe_recording.rb +360 -0
  274. data/lib/bandwidth-sdk/models/transcription.rb +223 -0
  275. data/lib/bandwidth-sdk/models/transcription_available_callback.rb +436 -0
  276. data/lib/bandwidth-sdk/models/transcription_list.rb +214 -0
  277. data/lib/bandwidth-sdk/models/transcription_metadata.rb +244 -0
  278. data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +378 -0
  279. data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +410 -0
  280. data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +430 -0
  281. data/lib/bandwidth-sdk/models/update_call.rb +413 -0
  282. data/lib/bandwidth-sdk/models/update_call_recording.rb +241 -0
  283. data/lib/bandwidth-sdk/models/update_conference.rb +387 -0
  284. data/lib/bandwidth-sdk/models/update_conference_member.rb +236 -0
  285. data/lib/bandwidth-sdk/models/verify_code_request.rb +341 -0
  286. data/lib/bandwidth-sdk/models/verify_code_response.rb +213 -0
  287. data/lib/bandwidth-sdk/models/voice_api_error.rb +231 -0
  288. data/lib/bandwidth-sdk/models/voice_code_response.rb +213 -0
  289. data/lib/bandwidth-sdk/version.rb +15 -0
  290. data/lib/bandwidth-sdk.rb +170 -0
  291. data/openapi-config.yml +12 -0
  292. data/openapitools.json +7 -0
  293. data/spec/api/calls_api_spec.rb +230 -0
  294. data/spec/api/conferences_api_spec.rb +393 -0
  295. data/spec/api/media_api_spec.rb +129 -0
  296. data/spec/api/messages_api_spec.rb +193 -0
  297. data/spec/api/mfa_api_spec.rb +130 -0
  298. data/spec/api/phone_number_lookup_api_spec.rb +100 -0
  299. data/spec/api/recordings_api_spec.rb +395 -0
  300. data/spec/api/statistics_api_spec.rb +45 -0
  301. data/spec/api_client_spec.rb +377 -0
  302. data/spec/api_error_spec.rb +23 -0
  303. data/spec/call_utils.rb +74 -0
  304. data/spec/configuration_spec.rb +190 -0
  305. data/spec/fixtures/ruby_cat.jpeg +0 -0
  306. data/spec/integration/calls_api_integration_spec.rb +202 -0
  307. data/spec/integration/conferences_api_integration_spec.rb +169 -0
  308. data/spec/integration/media_api_integration_spec.rb +92 -0
  309. data/spec/integration/messages_api_integration_spec.rb +138 -0
  310. data/spec/integration/mfa_api_integration_spec.rb +117 -0
  311. data/spec/integration/phone_number_lookup_api_integration_spec.rb +96 -0
  312. data/spec/integration/recordings_api_integration_spec.rb +226 -0
  313. data/spec/integration/statistics_api_integration_spec.rb +58 -0
  314. data/spec/models/bxml/bxml_spec.rb +16 -0
  315. data/spec/models/bxml/nestable_verb_spec.rb +11 -0
  316. data/spec/models/bxml/response_spec.rb +16 -0
  317. data/spec/models/bxml/verb_spec.rb +15 -0
  318. data/spec/models/bxml/verbs/bridge_spec.rb +58 -0
  319. data/spec/models/bxml/verbs/conference_spec.rb +58 -0
  320. data/spec/models/bxml/verbs/custom_param_spec.rb +36 -0
  321. data/spec/models/bxml/verbs/forward_spec.rb +44 -0
  322. data/spec/models/bxml/verbs/gather_spec.rb +86 -0
  323. data/spec/models/bxml/verbs/hangup_spec.rb +16 -0
  324. data/spec/models/bxml/verbs/pause_recording_spec.rb +16 -0
  325. data/spec/models/bxml/verbs/pause_spec.rb +34 -0
  326. data/spec/models/bxml/verbs/phone_number_spec.rb +54 -0
  327. data/spec/models/bxml/verbs/play_audio_spec.rb +36 -0
  328. data/spec/models/bxml/verbs/record_spec.rb +68 -0
  329. data/spec/models/bxml/verbs/redirect_spec.rb +50 -0
  330. data/spec/models/bxml/verbs/resume_recording_spec.rb +16 -0
  331. data/spec/models/bxml/verbs/ring_spec.rb +36 -0
  332. data/spec/models/bxml/verbs/send_dtmf_spec.rb +36 -0
  333. data/spec/models/bxml/verbs/sip_uri_spec.rb +56 -0
  334. data/spec/models/bxml/verbs/speak_sentence_spec.rb +38 -0
  335. data/spec/models/bxml/verbs/start_gather_spec.rb +42 -0
  336. data/spec/models/bxml/verbs/start_recording_spec.rb +52 -0
  337. data/spec/models/bxml/verbs/start_stream_spec.rb +72 -0
  338. data/spec/models/bxml/verbs/start_transcription_spec.rb +74 -0
  339. data/spec/models/bxml/verbs/stop_gather_spec.rb +16 -0
  340. data/spec/models/bxml/verbs/stop_recording_spec.rb +16 -0
  341. data/spec/models/bxml/verbs/stop_stream_spec.rb +34 -0
  342. data/spec/models/bxml/verbs/stop_transcription_spec.rb +34 -0
  343. data/spec/models/bxml/verbs/stream_param_spec.rb +36 -0
  344. data/spec/models/bxml/verbs/tag_spec.rb +16 -0
  345. data/spec/models/bxml/verbs/transfer_spec.rb +84 -0
  346. data/spec/models/call_state_enum_spec.rb +16 -0
  347. data/spec/models/call_state_spec.rb +168 -0
  348. data/spec/models/deferred_result_spec.rb +74 -0
  349. data/spec/models/message_spec.rb +138 -0
  350. data/spec/models/verify_code_request_spec.rb +126 -0
  351. data/spec/spec_helper.rb +171 -0
  352. metadata +430 -276
  353. data/LICENSE +0 -28
  354. data/lib/bandwidth/api_helper.rb +0 -280
  355. data/lib/bandwidth/client.rb +0 -75
  356. data/lib/bandwidth/configuration.rb +0 -209
  357. data/lib/bandwidth/exceptions/api_exception.rb +0 -20
  358. data/lib/bandwidth/http/api_response.rb +0 -38
  359. data/lib/bandwidth/http/auth/messaging_basic_auth.rb +0 -22
  360. data/lib/bandwidth/http/auth/multi_factor_auth_basic_auth.rb +0 -22
  361. data/lib/bandwidth/http/auth/phone_number_lookup_basic_auth.rb +0 -22
  362. data/lib/bandwidth/http/auth/voice_basic_auth.rb +0 -22
  363. data/lib/bandwidth/http/auth/web_rtc_basic_auth.rb +0 -22
  364. data/lib/bandwidth/http/faraday_client.rb +0 -73
  365. data/lib/bandwidth/http/http_call_back.rb +0 -24
  366. data/lib/bandwidth/http/http_client.rb +0 -104
  367. data/lib/bandwidth/http/http_method_enum.rb +0 -13
  368. data/lib/bandwidth/http/http_request.rb +0 -50
  369. data/lib/bandwidth/http/http_response.rb +0 -29
  370. data/lib/bandwidth/messaging_lib/messaging/client.rb +0 -60
  371. data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb +0 -491
  372. data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb +0 -47
  373. data/lib/bandwidth/messaging_lib/messaging/exceptions/messaging_exception.rb +0 -37
  374. data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_callback_message.rb +0 -100
  375. data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb +0 -164
  376. data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message_item.rb +0 -203
  377. data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_messages_list.rb +0 -79
  378. data/lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb +0 -60
  379. data/lib/bandwidth/messaging_lib/messaging/models/media.rb +0 -70
  380. data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb +0 -111
  381. data/lib/bandwidth/messaging_lib/messaging/models/page_info.rb +0 -82
  382. data/lib/bandwidth/messaging_lib/messaging/models/priority_enum.rb +0 -19
  383. data/lib/bandwidth/messaging_lib/messaging/models/tag.rb +0 -60
  384. data/lib/bandwidth/messaging_lib/messaging.rb +0 -25
  385. data/lib/bandwidth/models/base_model.rb +0 -58
  386. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/client.rb +0 -60
  387. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/base_controller.rb +0 -47
  388. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/mfa_controller.rb +0 -214
  389. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/error_with_request_exception.rb +0 -37
  390. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/forbidden_request_exception.rb +0 -32
  391. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/unauthorized_request_exception.rb +0 -32
  392. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_code_request_schema.rb +0 -103
  393. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_messaging_response.rb +0 -50
  394. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_code_response.rb +0 -50
  395. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_request_schema.rb +0 -94
  396. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_voice_response.rb +0 -50
  397. data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth.rb +0 -23
  398. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/client.rb +0 -60
  399. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/api_controller.rb +0 -1553
  400. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/base_controller.rb +0 -47
  401. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/exceptions/accounts_tnlookup400_error_exception.rb +0 -32
  402. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_request.rb +0 -50
  403. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb +0 -61
  404. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_status.rb +0 -95
  405. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/result.rb +0 -132
  406. data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup.rb +0 -20
  407. data/lib/bandwidth/utilities/date_time_helper.rb +0 -156
  408. data/lib/bandwidth/utilities/file_wrapper.rb +0 -16
  409. data/lib/bandwidth/voice_lib/bxml/bxml.rb +0 -36
  410. data/lib/bandwidth/voice_lib/bxml/response.rb +0 -39
  411. data/lib/bandwidth/voice_lib/bxml/verbs/bridge.rb +0 -28
  412. data/lib/bandwidth/voice_lib/bxml/verbs/conference.rb +0 -32
  413. data/lib/bandwidth/voice_lib/bxml/verbs/forward.rb +0 -18
  414. data/lib/bandwidth/voice_lib/bxml/verbs/gather.rb +0 -49
  415. data/lib/bandwidth/voice_lib/bxml/verbs/hangup.rb +0 -14
  416. data/lib/bandwidth/voice_lib/bxml/verbs/pause.rb +0 -15
  417. data/lib/bandwidth/voice_lib/bxml/verbs/pause_recording.rb +0 -14
  418. data/lib/bandwidth/voice_lib/bxml/verbs/phone_number.rb +0 -24
  419. data/lib/bandwidth/voice_lib/bxml/verbs/play_audio.rb +0 -17
  420. data/lib/bandwidth/voice_lib/bxml/verbs/record.rb +0 -33
  421. data/lib/bandwidth/voice_lib/bxml/verbs/redirect.rb +0 -24
  422. data/lib/bandwidth/voice_lib/bxml/verbs/resume_recording.rb +0 -14
  423. data/lib/bandwidth/voice_lib/bxml/verbs/ring.rb +0 -16
  424. data/lib/bandwidth/voice_lib/bxml/verbs/send_dtmf.rb +0 -16
  425. data/lib/bandwidth/voice_lib/bxml/verbs/sip_uri.rb +0 -25
  426. data/lib/bandwidth/voice_lib/bxml/verbs/speak_sentence.rb +0 -18
  427. data/lib/bandwidth/voice_lib/bxml/verbs/start_gather.rb +0 -20
  428. data/lib/bandwidth/voice_lib/bxml/verbs/start_recording.rb +0 -25
  429. data/lib/bandwidth/voice_lib/bxml/verbs/stop_gather.rb +0 -14
  430. data/lib/bandwidth/voice_lib/bxml/verbs/stop_recording.rb +0 -14
  431. data/lib/bandwidth/voice_lib/bxml/verbs/tag.rb +0 -13
  432. data/lib/bandwidth/voice_lib/bxml/verbs/transfer.rb +0 -48
  433. data/lib/bandwidth/voice_lib/bxml/verbs/xml_verb.rb +0 -26
  434. data/lib/bandwidth/voice_lib/voice/client.rb +0 -60
  435. data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb +0 -1820
  436. data/lib/bandwidth/voice_lib/voice/controllers/base_controller.rb +0 -47
  437. data/lib/bandwidth/voice_lib/voice/exceptions/api_error_exception.rb +0 -42
  438. data/lib/bandwidth/voice_lib/voice/models/answer_fallback_method_enum.rb +0 -17
  439. data/lib/bandwidth/voice_lib/voice/models/answer_method_enum.rb +0 -17
  440. data/lib/bandwidth/voice_lib/voice/models/call_callback.rb +0 -343
  441. data/lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb +0 -250
  442. data/lib/bandwidth/voice_lib/voice/models/call_state.rb +0 -301
  443. data/lib/bandwidth/voice_lib/voice/models/callback_method_enum.rb +0 -17
  444. data/lib/bandwidth/voice_lib/voice/models/conference_callback.rb +0 -211
  445. data/lib/bandwidth/voice_lib/voice/models/conference_event_method_enum.rb +0 -17
  446. data/lib/bandwidth/voice_lib/voice/models/conference_member_state.rb +0 -103
  447. data/lib/bandwidth/voice_lib/voice/models/conference_recording_metadata.rb +0 -173
  448. data/lib/bandwidth/voice_lib/voice/models/conference_state.rb +0 -153
  449. data/lib/bandwidth/voice_lib/voice/models/create_call_request.rb +0 -236
  450. data/lib/bandwidth/voice_lib/voice/models/create_call_response.rb +0 -266
  451. data/lib/bandwidth/voice_lib/voice/models/direction_enum.rb +0 -17
  452. data/lib/bandwidth/voice_lib/voice/models/disconnect_method_enum.rb +0 -17
  453. data/lib/bandwidth/voice_lib/voice/models/diversion.rb +0 -80
  454. data/lib/bandwidth/voice_lib/voice/models/fallback_method_enum.rb +0 -17
  455. data/lib/bandwidth/voice_lib/voice/models/file_format_enum.rb +0 -17
  456. data/lib/bandwidth/voice_lib/voice/models/machine_detection_configuration.rb +0 -231
  457. data/lib/bandwidth/voice_lib/voice/models/mode_enum.rb +0 -20
  458. data/lib/bandwidth/voice_lib/voice/models/modify_call_recording_request.rb +0 -48
  459. data/lib/bandwidth/voice_lib/voice/models/modify_call_request.rb +0 -156
  460. data/lib/bandwidth/voice_lib/voice/models/modify_conference_request.rb +0 -144
  461. data/lib/bandwidth/voice_lib/voice/models/redirect_fallback_method_enum.rb +0 -17
  462. data/lib/bandwidth/voice_lib/voice/models/redirect_method_enum.rb +0 -17
  463. data/lib/bandwidth/voice_lib/voice/models/state1_enum.rb +0 -20
  464. data/lib/bandwidth/voice_lib/voice/models/state_enum.rb +0 -17
  465. data/lib/bandwidth/voice_lib/voice/models/status_enum.rb +0 -17
  466. data/lib/bandwidth/voice_lib/voice/models/transcribe_recording_request.rb +0 -108
  467. data/lib/bandwidth/voice_lib/voice/models/transcript.rb +0 -60
  468. data/lib/bandwidth/voice_lib/voice/models/transcription.rb +0 -80
  469. data/lib/bandwidth/voice_lib/voice/models/transcription_metadata.rb +0 -89
  470. data/lib/bandwidth/voice_lib/voice/models/transcription_response.rb +0 -59
  471. data/lib/bandwidth/voice_lib/voice.rb +0 -48
  472. data/lib/bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb +0 -18
  473. data/lib/bandwidth/web_rtc_lib/web_rtc/client.rb +0 -60
  474. data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb +0 -703
  475. data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/base_controller.rb +0 -47
  476. data/lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb +0 -37
  477. data/lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb +0 -62
  478. data/lib/bandwidth/web_rtc_lib/web_rtc/models/device_api_version_enum.rb +0 -17
  479. data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant.rb +0 -115
  480. data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb +0 -48
  481. data/lib/bandwidth/web_rtc_lib/web_rtc/models/publish_permission_enum.rb +0 -17
  482. data/lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb +0 -60
  483. data/lib/bandwidth/web_rtc_lib/web_rtc/models/subscriptions.rb +0 -71
  484. data/lib/bandwidth/web_rtc_lib/web_rtc.rb +0 -22
  485. data/lib/bandwidth.rb +0 -73
  486. data/test/controllers/controller_test_base.rb +0 -21
  487. data/test/http_response_catcher.rb +0 -19
  488. data/test/integration/test_integration.rb +0 -691
  489. data/test/test_helper.rb +0 -94
@@ -0,0 +1,10 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Hangup < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ def initialize
6
+ super('Hangup', nil, {})
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,15 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Pause < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('Pause', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ duration: 'duration', # Optional [Number]: The time in seconds to pause. Default value is 1.
11
+ }
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,10 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class PauseRecording < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ def initialize
6
+ super('PauseRecording', nil, {})
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,26 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class PhoneNumber < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param number [String] A phone number to transfer the call to. Value must be in E.164 format (e.g. +15555555555).
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(number, attributes = {})
8
+ super('PhoneNumber', number, attributes)
9
+
10
+ @attribute_map = {
11
+ transfer_answer_url: 'transferAnswerUrl', # Optional [String]: URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None.
12
+ transfer_answer_method: 'transferAnswerMethod', # Optional [String]: The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None.
13
+ transfer_answer_fallback_url: 'transferAnswerFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None.
14
+ transfer_answer_fallback_method: 'transferAnswerFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None.
15
+ transfer_disconnect_url: 'transferDisconnectUrl', # Optional [String]: URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None.
16
+ transfer_disconnect_method: 'transferDisconnectMethod', # Optional [String]: The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None.
17
+ username: 'username', # Optional [String]: The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None.
18
+ password: 'password', # Optional [String]: The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None.
19
+ fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
20
+ fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
21
+ tag: 'tag', # Optional [String]: A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
22
+ }
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,17 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class PlayAudio < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param audio_uri [String] The URL of the audio file to play. May be a relative URL.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(audio_uri, attributes = {})
8
+ super('PlayAudio', audio_uri, attributes)
9
+
10
+ @attribute_map = {
11
+ username: 'username', # Optional [String]: The username to send in the HTTP request to audio_uri.
12
+ password: 'password', # Optional [String]: The password to send in the HTTP request to audio_uri.
13
+ }
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,32 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Record < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('Record', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ record_complete_url: 'recordCompleteUrl', # Optional [String]: URL to send the Record Complete event to once the recording has ended. Accepts BXML, and may be a relative URL. This callback will not be sent if the recording ended due to the call hanging up. Defaults to None.
11
+ record_complete_method: 'recordCompleteMethod', # Optional [String]: The HTTP method to use for the request to recordCompleteUrl. GET or POST. Default value is POST. Defaults to None.
12
+ record_complete_fallback_url: 'recordCompleteFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Record Complete callback delivery in case recordCompleteUrl fails to respond. Defaults to None.
13
+ record_complete_fallback_method: 'recordCompleteFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Record Complete callback to recordCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None.
14
+ recording_available_url: 'recordingAvailableUrl', # Optional [String]: URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
15
+ recording_available_method: 'recordingAvailableMethod', # Optional [String]: The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST. Defaults to None.
16
+ transcribe: 'transcribe', # Optional [Boolean]: A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
17
+ transcription_available_url: 'transcriptionAvailableUrl', # Optional [String]: URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
18
+ transcription_available_method: 'transcriptionAvailableMethod', # Optional [String]: The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
19
+ username: 'username', # Optional [String]: The username to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
20
+ password: 'password', # Optional [String]: The password to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
21
+ fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to recordCompleteFallbackUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
22
+ fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to recordCompleteFallbackUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
23
+ tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
24
+ terminating_digits: 'terminatingDigits', # Optional [String]: When pressed, this digit will terminate the recording. Default value is “#”. This feature can be disabled with "". Defaults to None.
25
+ max_duration: 'maxDuration', # Optional [Number]: Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None.
26
+ silence_timeout: 'silenceTimeout', # Optional [Number]: Length of silence after which to end the recording (in seconds). Max is equivalent to the maximum maxDuration value. Default value is 0, which means no timeout. Defaults to None.
27
+ file_format: 'fileFormat', # Optional [String]: The audio format that the recording will be saved as: mp3 or wav. Default value is wav. Defaults to None.
28
+ }
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,23 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Redirect < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('Redirect', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ redirect_url: 'redirectUrl', # [String]: URL to request new BXML from. A Redirect event will be sent to this endpoint. May be a relative URL. Defaults to None.
11
+ redirect_method: 'redirectMethod', # Optional [String]: The HTTP method to use for the request to redirectUrl. GET or POST. Defaults to None.
12
+ redirect_fallback_url: 'redirectFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Redirect callback delivery in case redirectUrl fails to respond. Defaults to None.
13
+ redirect_fallback_method: 'redirectFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Redirect callback to redirectFallbackUrl. GET or POST. Default value is POST. Defaults to None.
14
+ username: 'username', # Optional [String]: The username to send in the HTTP request to redirectUrl. Defaults to None.
15
+ password: 'password', # Optional [String]: The password to send in the HTTP request to redirectUrl. Defaults to None.
16
+ fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to redirectFallbackUrl. Defaults to None.
17
+ fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to redirectFallbackUrl. Defaults to None.
18
+ tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
19
+ }
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,10 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class ResumeRecording < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ def initialize
6
+ super('ResumeRecording', nil, {})
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,16 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Ring < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('Ring', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ duration: 'duration', # Optional [Number]: How many seconds to play ringing on the call. Default value is 5. Range: decimal values between 0.1 - 86400.
11
+ answer_call: 'answerCall', # Optional [Boolean]: A boolean indicating whether or not to answer the call when Ring is executed on an unanswered incoming call. Default value is 'true'.
12
+ }
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,17 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class SendDtmf < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param digits [String] String containing the DTMF characters to be sent in a call. Allows a maximum of 50 characters. The digits will be sent one-by-one with a marginal delay.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(digits, attributes = {})
8
+ super('SendDtmf', digits, attributes)
9
+
10
+ @attribute_map = {
11
+ tone_duration: 'toneDuration', # Optional [Number]: The length (in milliseconds) of each DTMF tone. Default value is 200. Range: decimal values between 50 - 5000.
12
+ tone_interval: 'toneInterval', # Optional [Number]: The duration of silence (in milliseconds) following each DTMF tone. Default value is 400. Range: decimal values between 50 - 5000.
13
+ }
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,27 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class SipUri < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param uri [String] A SIP URI to transfer the call to (e.g. sip:user@server.com)
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(uri, attributes = {})
8
+ super('SipUri', uri, attributes)
9
+
10
+ @attribute_map = {
11
+ uui: 'uui', # Optional [String]: The value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. Defaults to None.
12
+ transfer_answer_url: 'transferAnswerUrl', # Optional [String]: URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None.
13
+ transfer_answer_method: 'transferAnswerMethod', # Optional [String]: The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None.
14
+ transfer_answer_fallback_url: 'transferAnswerFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None.
15
+ transfer_answer_fallback_method: 'transferAnswerFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None.
16
+ transfer_disconnect_url: 'transferDisconnectUrl', # Optional [String]: URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None.
17
+ transfer_disconnect_method: 'transferDisconnectMethod', # Optional [String]: The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None.
18
+ username: 'username', # Optional [String]: The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None.
19
+ password: 'password', # Optional [String]: The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None.
20
+ fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
21
+ fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
22
+ tag: 'tag', # Optional [String]: A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
23
+ }
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,25 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class SpeakSentence < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param text [String] The text to speak. Cannot be blank. Can be a mixture of plain text and SSML tags.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(text, attributes = {})
8
+ super('SpeakSentence', text, attributes)
9
+
10
+ @attribute_map = {
11
+ voice: 'voice', # Optional [String]: Selects the voice of the speaker. If the voice attribute is present, gender and locale are ignored. You can find a list of supported voices here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-voices
12
+ gender: 'gender', # Optional [String]: Selects the gender of the speaker. Valid values are "male" or "female". Default "female".
13
+ locale: 'locale', # Optional [String]: Selects the locale of the speaker. Default "en_US"
14
+ }
15
+ end
16
+
17
+ # Return BXML representaion of this response
18
+ # @return [String] The XML response in string format.
19
+ def to_bxml
20
+ bxml = Ox.dump(generate_xml)
21
+ bxml.gsub(SPEAK_SENTENCE_REGEX) { |text| text.gsub(SSML_REGEX, '<\1>') }
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,19 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StartGather < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('StartGather', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ dtmf_url: 'dtmfUrl', # [String]: URL to send the DTMF event to. May be a relative URL.
11
+ dtmf_method: 'dtmfMethod', # Optional [String]: The HTTP method to use for the request to dtmfUrl. GET or POST. Default value is POST.
12
+ username: 'username', # Optional [String]: The username to send in the HTTP request to dtmfUrl. Defaults to None.
13
+ password: 'password', # Optional [String]: The password to send in the HTTP request to dtmfUrl. Defaults to None.
14
+ tag: 'tag', # Optional [String]: A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
15
+ }
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,24 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StartRecording < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('StartRecording', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ recording_available_url: 'recordingAvailableUrl', # Optional [String]: URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
11
+ recording_available_method: 'recordingAvailableMethod', # Optional [String]: The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
12
+ transcribe: 'transcribe', # Optional [Boolean]: A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
13
+ transcription_available_url: 'transcriptionAvailableUrl', # Optional [String]: URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
14
+ transcription_available_method: 'transcriptionAvailableMethod', # Optional [String]: The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
15
+ username: 'username', # Optional [String]: The username to send in the HTTP request to recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
16
+ password: 'password', # Optional [String]: The password to send in the HTTP request to recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
17
+ tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
18
+ file_format: 'fileFormat', # Optional [String]: The audio format that the recording will be saved as: mp3 or wav. Default value is wav.
19
+ multi_channel: 'multiChannel', # Optional [Boolean]: A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is false.
20
+ }
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,28 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StartStream < Bandwidth::Bxml::NestableVerb
4
+ # Initializer
5
+ # @param stream_params [Array] XML element children. Defaults to an empty array. Valid nested stream params are: StreamParam. You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(stream_params = [], attributes = {})
8
+ super('StartStream', nil, stream_params, attributes)
9
+
10
+ @attribute_map = {
11
+ name: 'name', # Optional [String]: A name to refer to this stream by. Used when sending <StopStream>. If not provided, it will default to the generated stream id as sent in the Media Stream Started webhook.
12
+ tracks: 'tracks', # Optional [String]: The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
13
+ destination: 'destination', # Optional [String]: A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio.
14
+ stream_event_url: 'streamEventUrl', # Optional [String]: URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
15
+ stream_event_method: 'streamEventMethod', # Optional [String]: The HTTP method to use for the request to streamEventUrl. GET or POST. Default value is POST.
16
+ username: 'username', # Optional [String]: The username to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
17
+ password: 'password', # Optional [String]: The password to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
18
+ }
19
+ end
20
+
21
+ # Add stream param/s to the nested verbs array
22
+ # @param stream_params [StreamParam] or [Array<StreamParam>] Verb or verbs to add to the array.
23
+ def add_stream_param(stream_params)
24
+ @nested_verbs.push(*stream_params)
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,29 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StartTranscription < Bandwidth::Bxml::NestableVerb
4
+ # Initializer
5
+ # @param custom_params [Array] XML element children. Defaults to an empty array. Valid nested custom params are: CustomParam. You may specify up to 12 <CustomParam/> elements nested within a <StartTranscription> tag.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(custom_params = [], attributes = {})
8
+ super('StartTranscription', nil, custom_params, attributes)
9
+
10
+ @attribute_map = {
11
+ name: 'name', # Optional [String]: A name to refer to this transcription by. Used when sending <StopTranscription>. If not provided, it will default to the generated transcription id as sent in the Real-Time Transcription Started webhook.
12
+ tracks: 'tracks', # Optional [String]: The part of the call to send a transcription from. inbound, outbound or both. Default is inbound.
13
+ transcription_event_url: 'transcriptionEventUrl', # Optional [String]: URL to send the associated Webhook events to during this real-time transcription's lifetime. Does not accept BXML. May be a relative URL.
14
+ transcription_event_method: 'transcriptionEventMethod', # Optional [String]: The HTTP method to use for the request to transcriptionEventUrl. GET or POST. Default value is POST.
15
+ username: 'username', # Optional [String]: The username to send in the HTTP request to transcriptionEventUrl. If specified, the transcriptionEventUrl must be TLS-encrypted (i.e., https).
16
+ password: 'password', # Optional [String]: The password to send in the HTTP request to transcriptionEventUrl. If specified, the transcriptionEventUrl must be TLS-encrypted (i.e., https).
17
+ destination: 'destination', # Optional [String]: A websocket URI to send the transcription to. A transcription of the specified tracks will be sent via websocket to this URL as a series of JSON messages. See below for more details on the websocket packet format.
18
+ stabilized: 'stabilized', # Optional [Boolean]: Whether to send transcription update events to the specified destination only after they have become stable. Requires destination. Defaults to true.
19
+ }
20
+ end
21
+
22
+ # Add custom param/s to the nested verbs array
23
+ # @param custom_params [CustomParam] or [Array<CustomParam>] Verb or verbs to add to the array.
24
+ def add_custom_param(custom_params)
25
+ @nested_verbs.push(*custom_params)
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,10 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StopGather < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ def initialize
6
+ super('StopGather', nil, {})
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,10 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StopRecording < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ def initialize
6
+ super('StopRecording', nil, {})
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,15 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StopStream < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('StopStream', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ name: 'name' # [String]: The name of the stream to stop. This is either the user selected name when sending the <StartStream> verb, or the system generated name returned in the Media Stream Started webhook if <StartStream> was sent with no name attribute.
11
+ }
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,15 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StopTranscription < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('StopTranscription', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ name: 'name' # [String]: The name of the real-time transcription to stop. This is either the user selected name when sending the <StartTranscription> verb, or the system generated name returned in the Real-Time Transcription Started webhook if <StartTranscription> was sent with no name attribute. If no name is specified, then all active call transcriptions will be stopped.
11
+ }
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,16 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class StreamParam < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
6
+ def initialize(attributes = {})
7
+ super('StreamParam', nil, attributes)
8
+
9
+ @attribute_map = {
10
+ name: 'name', # [String]: The name of this parameter, up to 256 characters.
11
+ value: 'value', # [String]: The value of this parameter, up to 2048 characters.
12
+ }
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,11 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Tag < Bandwidth::Bxml::Verb
4
+ # Initializer
5
+ # @param content [String] Custom tag value. Defaults to nil.
6
+ def initialize(content = nil)
7
+ super('Tag', content, {})
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,34 @@
1
+ module Bandwidth
2
+ module Bxml
3
+ class Transfer < Bandwidth::Bxml::NestableVerb
4
+ # Initializer
5
+ # @param transfer_to [Array] XML element children. Defaults to an empty array. Valid nested transfer verbs are: PhoneNumber, SipUri.
6
+ # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
7
+ def initialize(transfer_to = [], attributes = {})
8
+ super('Transfer', nil, transfer_to, attributes)
9
+
10
+ @attribute_map = {
11
+ transfer_caller_id: 'transferCallerId', # Optional [String]: The caller ID to use when the call is transferred, if different. Must be in E.164 format (e.g. +15555555555) or be one of the following strings Restricted, Anonymous, Private, or Unavailable. Leave as default to pass along the number of the remote party. Defaults to None.
12
+ call_timeout: 'callTimeout', # Optional [Number]:The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None.
13
+ transfer_complete_url: 'transferCompleteUrl', # Optional [String]: URL to send the Transfer Complete event to and request new BXML. Optional but recommended. See below for further details. May be a relative URL. Defaults to None.
14
+ transfer_complete_method: 'transferCompleteMethod', # Optional [String]: The HTTP method to use for the request to transferCompleteUrl. GET or POST. Default value is POST. Defaults to None.
15
+ transfer_complete_fallback_url: 'transferCompleteFallbackUrl', # Optional [String]: A fallback url which, if provided, will be used to retry the Transfer Complete callback delivery in case transferCompleteUrl fails to respond. Defaults to None.
16
+ transfer_complete_fallback_method: 'transferCompleteFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Transfer Complete callback to transferCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None.
17
+ username: 'username', # Optional [String]: The username to send in the HTTP request to transferCompleteUrl. Defaults to None.
18
+ password: 'password', # Optional [String]: The password to send in the HTTP request to transferCompleteUrl. Defaults to None.
19
+ fallback_username: 'fallbackUsername', # Optional [String]: The username to send in the HTTP request to transferCompleteFallbackUrl. Defaults to None.
20
+ fallback_password: 'fallbackPassword', # Optional [String]: The password to send in the HTTP request to transferCompleteFallbackUrl. Defaults to None.
21
+ tag: 'tag', # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
22
+ diversion_treatment: 'diversionTreatment', # Optional [String]: Can be any of the following: - none: No diversion headers are sent on the outbound leg of the transferred call. - propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. - stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None.
23
+ diversion_reason: 'diversionReason', # Optional [String]: Can be any of the following values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. This parameter is considered only when diversionTreatment is set to stack. Defaults to None.
24
+ }
25
+ end
26
+
27
+ # Add transfer recipient/s to the nested verbs array
28
+ # @param recipients [PhoneNumber] || [SipUri] or [Array<PhoneNumber || SipUri>] Verb or verbs to add to the array.
29
+ def add_transfer_recipient(recipients)
30
+ @nested_verbs.push(*recipients)
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,40 @@
1
+ =begin
2
+ #Bandwidth
3
+
4
+ #Bandwidth's Communication APIs
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: letstalk@bandwidth.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.0.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Bandwidth
17
+ class CallDirectionEnum
18
+ INBOUND = 'inbound'.freeze
19
+ OUTBOUND = 'outbound'.freeze
20
+
21
+ def self.all_vars
22
+ @all_vars ||= [INBOUND, OUTBOUND].freeze
23
+ end
24
+
25
+ # Builds the enum from string
26
+ # @param [String] The enum value in the form of the string
27
+ # @return [String] The enum value
28
+ def self.build_from_hash(value)
29
+ new.build_from_hash(value)
30
+ end
31
+
32
+ # Builds the enum from string
33
+ # @param [String] The enum value in the form of the string
34
+ # @return [String] The enum value
35
+ def build_from_hash(value)
36
+ return value if CallDirectionEnum.all_vars.include?(value)
37
+ raise "Invalid ENUM value #{value} for class #CallDirectionEnum"
38
+ end
39
+ end
40
+ end