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,434 @@
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 CodeRequest
18
+ # The phone number to send the mfa code to.
19
+ attr_accessor :to
20
+
21
+ # The application phone number, the sender of the mfa code.
22
+ attr_accessor :from
23
+
24
+ # The application unique ID, obtained from Bandwidth.
25
+ attr_accessor :application_id
26
+
27
+ # An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
28
+ attr_accessor :scope
29
+
30
+ # The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.
31
+ attr_accessor :message
32
+
33
+ # The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.
34
+ attr_accessor :digits
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'to' => :'to',
40
+ :'from' => :'from',
41
+ :'application_id' => :'applicationId',
42
+ :'scope' => :'scope',
43
+ :'message' => :'message',
44
+ :'digits' => :'digits'
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
+ :'to' => :'String',
57
+ :'from' => :'String',
58
+ :'application_id' => :'String',
59
+ :'scope' => :'String',
60
+ :'message' => :'String',
61
+ :'digits' => :'Integer'
62
+ }
63
+ end
64
+
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ ])
69
+ end
70
+
71
+ # Initializes the object
72
+ # @param [Hash] attributes Model attributes in the form of hash
73
+ def initialize(attributes = {})
74
+ if (!attributes.is_a?(Hash))
75
+ fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::CodeRequest` initialize method'
76
+ end
77
+
78
+ # check to see if the attribute exists and convert string to symbol for hash key
79
+ attributes = attributes.each_with_object({}) { |(k, v), h|
80
+ if (!self.class.attribute_map.key?(k.to_sym))
81
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::CodeRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
82
+ end
83
+ h[k.to_sym] = v
84
+ }
85
+
86
+ if attributes.key?(:'to')
87
+ self.to = attributes[:'to']
88
+ else
89
+ self.to = nil
90
+ end
91
+
92
+ if attributes.key?(:'from')
93
+ self.from = attributes[:'from']
94
+ else
95
+ self.from = nil
96
+ end
97
+
98
+ if attributes.key?(:'application_id')
99
+ self.application_id = attributes[:'application_id']
100
+ else
101
+ self.application_id = nil
102
+ end
103
+
104
+ if attributes.key?(:'scope')
105
+ self.scope = attributes[:'scope']
106
+ end
107
+
108
+ if attributes.key?(:'message')
109
+ self.message = attributes[:'message']
110
+ else
111
+ self.message = nil
112
+ end
113
+
114
+ if attributes.key?(:'digits')
115
+ self.digits = attributes[:'digits']
116
+ else
117
+ self.digits = nil
118
+ end
119
+ end
120
+
121
+ # Show invalid properties with the reasons. Usually used together with valid?
122
+ # @return Array for valid properties with the reasons
123
+ def list_invalid_properties
124
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
125
+ invalid_properties = Array.new
126
+ if @to.nil?
127
+ invalid_properties.push('invalid value for "to", to cannot be nil.')
128
+ end
129
+
130
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
131
+ if @to !~ pattern
132
+ invalid_properties.push("invalid value for \"to\", must conform to the pattern #{pattern}.")
133
+ end
134
+
135
+ if @from.nil?
136
+ invalid_properties.push('invalid value for "from", from cannot be nil.')
137
+ end
138
+
139
+ if @from.to_s.length > 32
140
+ invalid_properties.push('invalid value for "from", the character length must be smaller than or equal to 32.')
141
+ end
142
+
143
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
144
+ if @from !~ pattern
145
+ invalid_properties.push("invalid value for \"from\", must conform to the pattern #{pattern}.")
146
+ end
147
+
148
+ if @application_id.nil?
149
+ invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
150
+ end
151
+
152
+ if @application_id.to_s.length > 50
153
+ invalid_properties.push('invalid value for "application_id", the character length must be smaller than or equal to 50.')
154
+ end
155
+
156
+ if !@scope.nil? && @scope.to_s.length > 25
157
+ invalid_properties.push('invalid value for "scope", the character length must be smaller than or equal to 25.')
158
+ end
159
+
160
+ if @message.nil?
161
+ invalid_properties.push('invalid value for "message", message cannot be nil.')
162
+ end
163
+
164
+ if @message.to_s.length > 2048
165
+ invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 2048.')
166
+ end
167
+
168
+ if @digits.nil?
169
+ invalid_properties.push('invalid value for "digits", digits cannot be nil.')
170
+ end
171
+
172
+ if @digits > 8
173
+ invalid_properties.push('invalid value for "digits", must be smaller than or equal to 8.')
174
+ end
175
+
176
+ if @digits < 4
177
+ invalid_properties.push('invalid value for "digits", must be greater than or equal to 4.')
178
+ end
179
+
180
+ invalid_properties
181
+ end
182
+
183
+ # Check to see if the all the properties in the model are valid
184
+ # @return true if the model is valid
185
+ def valid?
186
+ warn '[DEPRECATED] the `valid?` method is obsolete'
187
+ return false if @to.nil?
188
+ return false if @to !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
189
+ return false if @from.nil?
190
+ return false if @from.to_s.length > 32
191
+ return false if @from !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
192
+ return false if @application_id.nil?
193
+ return false if @application_id.to_s.length > 50
194
+ return false if !@scope.nil? && @scope.to_s.length > 25
195
+ return false if @message.nil?
196
+ return false if @message.to_s.length > 2048
197
+ return false if @digits.nil?
198
+ return false if @digits > 8
199
+ return false if @digits < 4
200
+ true
201
+ end
202
+
203
+ # Custom attribute writer method with validation
204
+ # @param [Object] to Value to be assigned
205
+ def to=(to)
206
+ if to.nil?
207
+ fail ArgumentError, 'to cannot be nil'
208
+ end
209
+
210
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
211
+ if to !~ pattern
212
+ fail ArgumentError, "invalid value for \"to\", must conform to the pattern #{pattern}."
213
+ end
214
+
215
+ @to = to
216
+ end
217
+
218
+ # Custom attribute writer method with validation
219
+ # @param [Object] from Value to be assigned
220
+ def from=(from)
221
+ if from.nil?
222
+ fail ArgumentError, 'from cannot be nil'
223
+ end
224
+
225
+ if from.to_s.length > 32
226
+ fail ArgumentError, 'invalid value for "from", the character length must be smaller than or equal to 32.'
227
+ end
228
+
229
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
230
+ if from !~ pattern
231
+ fail ArgumentError, "invalid value for \"from\", must conform to the pattern #{pattern}."
232
+ end
233
+
234
+ @from = from
235
+ end
236
+
237
+ # Custom attribute writer method with validation
238
+ # @param [Object] application_id Value to be assigned
239
+ def application_id=(application_id)
240
+ if application_id.nil?
241
+ fail ArgumentError, 'application_id cannot be nil'
242
+ end
243
+
244
+ if application_id.to_s.length > 50
245
+ fail ArgumentError, 'invalid value for "application_id", the character length must be smaller than or equal to 50.'
246
+ end
247
+
248
+ @application_id = application_id
249
+ end
250
+
251
+ # Custom attribute writer method with validation
252
+ # @param [Object] scope Value to be assigned
253
+ def scope=(scope)
254
+ if scope.nil?
255
+ fail ArgumentError, 'scope cannot be nil'
256
+ end
257
+
258
+ if scope.to_s.length > 25
259
+ fail ArgumentError, 'invalid value for "scope", the character length must be smaller than or equal to 25.'
260
+ end
261
+
262
+ @scope = scope
263
+ end
264
+
265
+ # Custom attribute writer method with validation
266
+ # @param [Object] message Value to be assigned
267
+ def message=(message)
268
+ if message.nil?
269
+ fail ArgumentError, 'message cannot be nil'
270
+ end
271
+
272
+ if message.to_s.length > 2048
273
+ fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 2048.'
274
+ end
275
+
276
+ @message = message
277
+ end
278
+
279
+ # Custom attribute writer method with validation
280
+ # @param [Object] digits Value to be assigned
281
+ def digits=(digits)
282
+ if digits.nil?
283
+ fail ArgumentError, 'digits cannot be nil'
284
+ end
285
+
286
+ if digits > 8
287
+ fail ArgumentError, 'invalid value for "digits", must be smaller than or equal to 8.'
288
+ end
289
+
290
+ if digits < 4
291
+ fail ArgumentError, 'invalid value for "digits", must be greater than or equal to 4.'
292
+ end
293
+
294
+ @digits = digits
295
+ end
296
+
297
+ # Checks equality by comparing each attribute.
298
+ # @param [Object] Object to be compared
299
+ def ==(o)
300
+ return true if self.equal?(o)
301
+ self.class == o.class &&
302
+ to == o.to &&
303
+ from == o.from &&
304
+ application_id == o.application_id &&
305
+ scope == o.scope &&
306
+ message == o.message &&
307
+ digits == o.digits
308
+ end
309
+
310
+ # @see the `==` method
311
+ # @param [Object] Object to be compared
312
+ def eql?(o)
313
+ self == o
314
+ end
315
+
316
+ # Calculates hash code according to all attributes.
317
+ # @return [Integer] Hash code
318
+ def hash
319
+ [to, from, application_id, scope, message, digits].hash
320
+ end
321
+
322
+ # Builds the object from hash
323
+ # @param [Hash] attributes Model attributes in the form of hash
324
+ # @return [Object] Returns the model itself
325
+ def self.build_from_hash(attributes)
326
+ return nil unless attributes.is_a?(Hash)
327
+ attributes = attributes.transform_keys(&:to_sym)
328
+ transformed_hash = {}
329
+ openapi_types.each_pair do |key, type|
330
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
331
+ transformed_hash["#{key}"] = nil
332
+ elsif type =~ /\AArray<(.*)>/i
333
+ # check to ensure the input is an array given that the attribute
334
+ # is documented as an array but the input is not
335
+ if attributes[attribute_map[key]].is_a?(Array)
336
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
337
+ end
338
+ elsif !attributes[attribute_map[key]].nil?
339
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
340
+ end
341
+ end
342
+ new(transformed_hash)
343
+ end
344
+
345
+ # Deserializes the data based on type
346
+ # @param string type Data type
347
+ # @param string value Value to be deserialized
348
+ # @return [Object] Deserialized data
349
+ def self._deserialize(type, value)
350
+ case type.to_sym
351
+ when :Time
352
+ Time.parse(value)
353
+ when :Date
354
+ Date.parse(value)
355
+ when :String
356
+ value.to_s
357
+ when :Integer
358
+ value.to_i
359
+ when :Float
360
+ value.to_f
361
+ when :Boolean
362
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
363
+ true
364
+ else
365
+ false
366
+ end
367
+ when :Object
368
+ # generic object (usually a Hash), return directly
369
+ value
370
+ when /\AArray<(?<inner_type>.+)>\z/
371
+ inner_type = Regexp.last_match[:inner_type]
372
+ value.map { |v| _deserialize(inner_type, v) }
373
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
374
+ k_type = Regexp.last_match[:k_type]
375
+ v_type = Regexp.last_match[:v_type]
376
+ {}.tap do |hash|
377
+ value.each do |k, v|
378
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
379
+ end
380
+ end
381
+ else # model
382
+ # models (e.g. Pet) or oneOf
383
+ klass = Bandwidth.const_get(type)
384
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
385
+ end
386
+ end
387
+
388
+ # Returns the string representation of the object
389
+ # @return [String] String presentation of the object
390
+ def to_s
391
+ to_hash.to_s
392
+ end
393
+
394
+ # to_body is an alias to to_hash (backward compatibility)
395
+ # @return [Hash] Returns the object in the form of hash
396
+ def to_body
397
+ to_hash
398
+ end
399
+
400
+ # Returns the object in the form of hash
401
+ # @return [Hash] Returns the object in the form of hash
402
+ def to_hash
403
+ hash = {}
404
+ self.class.attribute_map.each_pair do |attr, param|
405
+ value = self.send(attr)
406
+ if value.nil?
407
+ is_nullable = self.class.openapi_nullable.include?(attr)
408
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
409
+ end
410
+
411
+ hash[param] = _to_hash(value)
412
+ end
413
+ hash
414
+ end
415
+
416
+ # Outputs non-array value in the form of hash
417
+ # For object, use to_hash. Otherwise, just return the value
418
+ # @param [Object] value Any valid value
419
+ # @return [Hash] Returns the value in the form of hash
420
+ def _to_hash(value)
421
+ if value.is_a?(Array)
422
+ value.compact.map { |v| _to_hash(v) }
423
+ elsif value.is_a?(Hash)
424
+ {}.tap do |hash|
425
+ value.each { |k, v| hash[k] = _to_hash(v) }
426
+ end
427
+ elsif value.respond_to? :to_hash
428
+ value.to_hash
429
+ else
430
+ value
431
+ end
432
+ end
433
+ end
434
+ end