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,255 @@
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
+ # The Conference Created event is fired whenever a new conference that specified a callbackUrl is created. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.
18
+ class ConferenceCreatedCallback
19
+ # The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
20
+ attr_accessor :event_type
21
+
22
+ # 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.
23
+ attr_accessor :event_time
24
+
25
+ # The unique, Bandwidth-generated ID of the conference that was recorded
26
+ attr_accessor :conference_id
27
+
28
+ # The user-specified name of the conference that was recorded
29
+ attr_accessor :name
30
+
31
+ # (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
32
+ attr_accessor :tag
33
+
34
+ # Attribute mapping from ruby-style variable name to JSON key.
35
+ def self.attribute_map
36
+ {
37
+ :'event_type' => :'eventType',
38
+ :'event_time' => :'eventTime',
39
+ :'conference_id' => :'conferenceId',
40
+ :'name' => :'name',
41
+ :'tag' => :'tag'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'event_type' => :'String',
54
+ :'event_time' => :'Time',
55
+ :'conference_id' => :'String',
56
+ :'name' => :'String',
57
+ :'tag' => :'String'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'tag'
65
+ ])
66
+ end
67
+
68
+ # Initializes the object
69
+ # @param [Hash] attributes Model attributes in the form of hash
70
+ def initialize(attributes = {})
71
+ if (!attributes.is_a?(Hash))
72
+ fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::ConferenceCreatedCallback` initialize method'
73
+ end
74
+
75
+ # check to see if the attribute exists and convert string to symbol for hash key
76
+ attributes = attributes.each_with_object({}) { |(k, v), h|
77
+ if (!self.class.attribute_map.key?(k.to_sym))
78
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::ConferenceCreatedCallback`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
79
+ end
80
+ h[k.to_sym] = v
81
+ }
82
+
83
+ if attributes.key?(:'event_type')
84
+ self.event_type = attributes[:'event_type']
85
+ end
86
+
87
+ if attributes.key?(:'event_time')
88
+ self.event_time = attributes[:'event_time']
89
+ end
90
+
91
+ if attributes.key?(:'conference_id')
92
+ self.conference_id = attributes[:'conference_id']
93
+ end
94
+
95
+ if attributes.key?(:'name')
96
+ self.name = attributes[:'name']
97
+ end
98
+
99
+ if attributes.key?(:'tag')
100
+ self.tag = attributes[:'tag']
101
+ end
102
+ end
103
+
104
+ # Show invalid properties with the reasons. Usually used together with valid?
105
+ # @return Array for valid properties with the reasons
106
+ def list_invalid_properties
107
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
108
+ invalid_properties = Array.new
109
+ invalid_properties
110
+ end
111
+
112
+ # Check to see if the all the properties in the model are valid
113
+ # @return true if the model is valid
114
+ def valid?
115
+ warn '[DEPRECATED] the `valid?` method is obsolete'
116
+ true
117
+ end
118
+
119
+ # Checks equality by comparing each attribute.
120
+ # @param [Object] Object to be compared
121
+ def ==(o)
122
+ return true if self.equal?(o)
123
+ self.class == o.class &&
124
+ event_type == o.event_type &&
125
+ event_time == o.event_time &&
126
+ conference_id == o.conference_id &&
127
+ name == o.name &&
128
+ tag == o.tag
129
+ end
130
+
131
+ # @see the `==` method
132
+ # @param [Object] Object to be compared
133
+ def eql?(o)
134
+ self == o
135
+ end
136
+
137
+ # Calculates hash code according to all attributes.
138
+ # @return [Integer] Hash code
139
+ def hash
140
+ [event_type, event_time, conference_id, name, tag].hash
141
+ end
142
+
143
+ # Builds the object from hash
144
+ # @param [Hash] attributes Model attributes in the form of hash
145
+ # @return [Object] Returns the model itself
146
+ def self.build_from_hash(attributes)
147
+ return nil unless attributes.is_a?(Hash)
148
+ attributes = attributes.transform_keys(&:to_sym)
149
+ transformed_hash = {}
150
+ openapi_types.each_pair do |key, type|
151
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
152
+ transformed_hash["#{key}"] = nil
153
+ elsif type =~ /\AArray<(.*)>/i
154
+ # check to ensure the input is an array given that the attribute
155
+ # is documented as an array but the input is not
156
+ if attributes[attribute_map[key]].is_a?(Array)
157
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
158
+ end
159
+ elsif !attributes[attribute_map[key]].nil?
160
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
161
+ end
162
+ end
163
+ new(transformed_hash)
164
+ end
165
+
166
+ # Deserializes the data based on type
167
+ # @param string type Data type
168
+ # @param string value Value to be deserialized
169
+ # @return [Object] Deserialized data
170
+ def self._deserialize(type, value)
171
+ case type.to_sym
172
+ when :Time
173
+ Time.parse(value)
174
+ when :Date
175
+ Date.parse(value)
176
+ when :String
177
+ value.to_s
178
+ when :Integer
179
+ value.to_i
180
+ when :Float
181
+ value.to_f
182
+ when :Boolean
183
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
184
+ true
185
+ else
186
+ false
187
+ end
188
+ when :Object
189
+ # generic object (usually a Hash), return directly
190
+ value
191
+ when /\AArray<(?<inner_type>.+)>\z/
192
+ inner_type = Regexp.last_match[:inner_type]
193
+ value.map { |v| _deserialize(inner_type, v) }
194
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
195
+ k_type = Regexp.last_match[:k_type]
196
+ v_type = Regexp.last_match[:v_type]
197
+ {}.tap do |hash|
198
+ value.each do |k, v|
199
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
200
+ end
201
+ end
202
+ else # model
203
+ # models (e.g. Pet) or oneOf
204
+ klass = Bandwidth.const_get(type)
205
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
206
+ end
207
+ end
208
+
209
+ # Returns the string representation of the object
210
+ # @return [String] String presentation of the object
211
+ def to_s
212
+ to_hash.to_s
213
+ end
214
+
215
+ # to_body is an alias to to_hash (backward compatibility)
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_body
218
+ to_hash
219
+ end
220
+
221
+ # Returns the object in the form of hash
222
+ # @return [Hash] Returns the object in the form of hash
223
+ def to_hash
224
+ hash = {}
225
+ self.class.attribute_map.each_pair do |attr, param|
226
+ value = self.send(attr)
227
+ if value.nil?
228
+ is_nullable = self.class.openapi_nullable.include?(attr)
229
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
230
+ end
231
+
232
+ hash[param] = _to_hash(value)
233
+ end
234
+ hash
235
+ end
236
+
237
+ # Outputs non-array value in the form of hash
238
+ # For object, use to_hash. Otherwise, just return the value
239
+ # @param [Object] value Any valid value
240
+ # @return [Hash] Returns the value in the form of hash
241
+ def _to_hash(value)
242
+ if value.is_a?(Array)
243
+ value.compact.map { |v| _to_hash(v) }
244
+ elsif value.is_a?(Hash)
245
+ {}.tap do |hash|
246
+ value.each { |k, v| hash[k] = _to_hash(v) }
247
+ end
248
+ elsif value.respond_to? :to_hash
249
+ value.to_hash
250
+ else
251
+ value
252
+ end
253
+ end
254
+ end
255
+ end
@@ -0,0 +1,266 @@
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 ConferenceMember
18
+ # The call id associated with the event.
19
+ attr_accessor :call_id
20
+
21
+ # The unique, Bandwidth-generated ID of the conference that was recorded
22
+ attr_accessor :conference_id
23
+
24
+ # A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
25
+ attr_accessor :member_url
26
+
27
+ # Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member's mute status. Has no effect if omitted.
28
+ attr_accessor :mute
29
+
30
+ # Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member's hold status. Has no effect if omitted.
31
+ attr_accessor :hold
32
+
33
+ # If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join.
34
+ attr_accessor :call_ids_to_coach
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'call_id' => :'callId',
40
+ :'conference_id' => :'conferenceId',
41
+ :'member_url' => :'memberUrl',
42
+ :'mute' => :'mute',
43
+ :'hold' => :'hold',
44
+ :'call_ids_to_coach' => :'callIdsToCoach'
45
+ }
46
+ end
47
+
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ attribute_map.values
51
+ end
52
+
53
+ # Attribute type mapping.
54
+ def self.openapi_types
55
+ {
56
+ :'call_id' => :'String',
57
+ :'conference_id' => :'String',
58
+ :'member_url' => :'String',
59
+ :'mute' => :'Boolean',
60
+ :'hold' => :'Boolean',
61
+ :'call_ids_to_coach' => :'Array<String>'
62
+ }
63
+ end
64
+
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ :'call_ids_to_coach'
69
+ ])
70
+ end
71
+
72
+ # Initializes the object
73
+ # @param [Hash] attributes Model attributes in the form of hash
74
+ def initialize(attributes = {})
75
+ if (!attributes.is_a?(Hash))
76
+ fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::ConferenceMember` initialize method'
77
+ end
78
+
79
+ # check to see if the attribute exists and convert string to symbol for hash key
80
+ attributes = attributes.each_with_object({}) { |(k, v), h|
81
+ if (!self.class.attribute_map.key?(k.to_sym))
82
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::ConferenceMember`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
83
+ end
84
+ h[k.to_sym] = v
85
+ }
86
+
87
+ if attributes.key?(:'call_id')
88
+ self.call_id = attributes[:'call_id']
89
+ end
90
+
91
+ if attributes.key?(:'conference_id')
92
+ self.conference_id = attributes[:'conference_id']
93
+ end
94
+
95
+ if attributes.key?(:'member_url')
96
+ self.member_url = attributes[:'member_url']
97
+ end
98
+
99
+ if attributes.key?(:'mute')
100
+ self.mute = attributes[:'mute']
101
+ end
102
+
103
+ if attributes.key?(:'hold')
104
+ self.hold = attributes[:'hold']
105
+ end
106
+
107
+ if attributes.key?(:'call_ids_to_coach')
108
+ if (value = attributes[:'call_ids_to_coach']).is_a?(Array)
109
+ self.call_ids_to_coach = value
110
+ end
111
+ end
112
+ end
113
+
114
+ # Show invalid properties with the reasons. Usually used together with valid?
115
+ # @return Array for valid properties with the reasons
116
+ def list_invalid_properties
117
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
118
+ invalid_properties = Array.new
119
+ invalid_properties
120
+ end
121
+
122
+ # Check to see if the all the properties in the model are valid
123
+ # @return true if the model is valid
124
+ def valid?
125
+ warn '[DEPRECATED] the `valid?` method is obsolete'
126
+ true
127
+ end
128
+
129
+ # Checks equality by comparing each attribute.
130
+ # @param [Object] Object to be compared
131
+ def ==(o)
132
+ return true if self.equal?(o)
133
+ self.class == o.class &&
134
+ call_id == o.call_id &&
135
+ conference_id == o.conference_id &&
136
+ member_url == o.member_url &&
137
+ mute == o.mute &&
138
+ hold == o.hold &&
139
+ call_ids_to_coach == o.call_ids_to_coach
140
+ end
141
+
142
+ # @see the `==` method
143
+ # @param [Object] Object to be compared
144
+ def eql?(o)
145
+ self == o
146
+ end
147
+
148
+ # Calculates hash code according to all attributes.
149
+ # @return [Integer] Hash code
150
+ def hash
151
+ [call_id, conference_id, member_url, mute, hold, call_ids_to_coach].hash
152
+ end
153
+
154
+ # Builds the object from hash
155
+ # @param [Hash] attributes Model attributes in the form of hash
156
+ # @return [Object] Returns the model itself
157
+ def self.build_from_hash(attributes)
158
+ return nil unless attributes.is_a?(Hash)
159
+ attributes = attributes.transform_keys(&:to_sym)
160
+ transformed_hash = {}
161
+ openapi_types.each_pair do |key, type|
162
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
163
+ transformed_hash["#{key}"] = nil
164
+ elsif type =~ /\AArray<(.*)>/i
165
+ # check to ensure the input is an array given that the attribute
166
+ # is documented as an array but the input is not
167
+ if attributes[attribute_map[key]].is_a?(Array)
168
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
169
+ end
170
+ elsif !attributes[attribute_map[key]].nil?
171
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
172
+ end
173
+ end
174
+ new(transformed_hash)
175
+ end
176
+
177
+ # Deserializes the data based on type
178
+ # @param string type Data type
179
+ # @param string value Value to be deserialized
180
+ # @return [Object] Deserialized data
181
+ def self._deserialize(type, value)
182
+ case type.to_sym
183
+ when :Time
184
+ Time.parse(value)
185
+ when :Date
186
+ Date.parse(value)
187
+ when :String
188
+ value.to_s
189
+ when :Integer
190
+ value.to_i
191
+ when :Float
192
+ value.to_f
193
+ when :Boolean
194
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
195
+ true
196
+ else
197
+ false
198
+ end
199
+ when :Object
200
+ # generic object (usually a Hash), return directly
201
+ value
202
+ when /\AArray<(?<inner_type>.+)>\z/
203
+ inner_type = Regexp.last_match[:inner_type]
204
+ value.map { |v| _deserialize(inner_type, v) }
205
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
206
+ k_type = Regexp.last_match[:k_type]
207
+ v_type = Regexp.last_match[:v_type]
208
+ {}.tap do |hash|
209
+ value.each do |k, v|
210
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
211
+ end
212
+ end
213
+ else # model
214
+ # models (e.g. Pet) or oneOf
215
+ klass = Bandwidth.const_get(type)
216
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
217
+ end
218
+ end
219
+
220
+ # Returns the string representation of the object
221
+ # @return [String] String presentation of the object
222
+ def to_s
223
+ to_hash.to_s
224
+ end
225
+
226
+ # to_body is an alias to to_hash (backward compatibility)
227
+ # @return [Hash] Returns the object in the form of hash
228
+ def to_body
229
+ to_hash
230
+ end
231
+
232
+ # Returns the object in the form of hash
233
+ # @return [Hash] Returns the object in the form of hash
234
+ def to_hash
235
+ hash = {}
236
+ self.class.attribute_map.each_pair do |attr, param|
237
+ value = self.send(attr)
238
+ if value.nil?
239
+ is_nullable = self.class.openapi_nullable.include?(attr)
240
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
241
+ end
242
+
243
+ hash[param] = _to_hash(value)
244
+ end
245
+ hash
246
+ end
247
+
248
+ # Outputs non-array value in the form of hash
249
+ # For object, use to_hash. Otherwise, just return the value
250
+ # @param [Object] value Any valid value
251
+ # @return [Hash] Returns the value in the form of hash
252
+ def _to_hash(value)
253
+ if value.is_a?(Array)
254
+ value.compact.map { |v| _to_hash(v) }
255
+ elsif value.is_a?(Hash)
256
+ {}.tap do |hash|
257
+ value.each { |k, v| hash[k] = _to_hash(v) }
258
+ end
259
+ elsif value.respond_to? :to_hash
260
+ value.to_hash
261
+ else
262
+ value
263
+ end
264
+ end
265
+ end
266
+ end