bandwidth-sdk 11.0.0.pre.beta.1.1 → 11.0.0.pre.beta.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (380) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/Gemfile.lock +44 -20
  4. data/README.md +7 -3
  5. data/Rakefile +10 -2
  6. data/bandwidth-sdk.gemspec +12 -12
  7. data/bandwidth.yml +401 -352
  8. data/coverage/.last_run.json +5 -0
  9. data/coverage/.resultset.json +9759 -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 +108249 -0
  41. data/custom_templates/Gemfile.mustache +11 -0
  42. data/custom_templates/README.mustache +170 -0
  43. data/custom_templates/gem.mustache +99 -0
  44. data/custom_templates/gemspec.mustache +37 -0
  45. data/custom_templates/version.mustache +7 -0
  46. data/docs/AnswerCallback.md +3 -3
  47. data/docs/BridgeCompleteCallback.md +2 -2
  48. data/docs/BridgeTargetCompleteCallback.md +2 -2
  49. data/docs/CallState.md +2 -2
  50. data/docs/CallsApi.md +15 -15
  51. data/docs/Conference.md +4 -4
  52. data/docs/ConferenceCompletedCallback.md +2 -2
  53. data/docs/ConferenceCreatedCallback.md +2 -2
  54. data/docs/ConferenceMemberExitCallback.md +2 -2
  55. data/docs/ConferenceMemberJoinCallback.md +2 -2
  56. data/docs/ConferenceRecordingAvailableCallback.md +2 -2
  57. data/docs/ConferenceRedirectCallback.md +2 -2
  58. data/docs/ConferencesApi.md +42 -42
  59. data/docs/CreateCall.md +11 -11
  60. data/docs/CreateCallResponse.md +11 -11
  61. data/docs/DisconnectCallback.md +2 -2
  62. data/docs/DtmfCallback.md +2 -2
  63. data/docs/GatherCallback.md +2 -2
  64. data/docs/InitiateCallback.md +2 -2
  65. data/docs/ListMessageItem.md +5 -3
  66. data/docs/MFAApi.md +6 -6
  67. data/docs/MachineDetectionCompleteCallback.md +3 -3
  68. data/docs/MachineDetectionConfiguration.md +2 -2
  69. data/docs/MachineDetectionResult.md +20 -0
  70. data/docs/Message.md +2 -2
  71. data/docs/MessageDeliveredCallbackMessage.md +1 -1
  72. data/docs/MessageFailedCallbackMessage.md +1 -1
  73. data/docs/MessageRequest.md +1 -1
  74. data/docs/MessageSendingCallbackMessage.md +1 -1
  75. data/docs/MessagesApi.md +5 -1
  76. data/docs/MessagesList.md +1 -1
  77. data/docs/PhoneNumberLookupApi.md +4 -4
  78. data/docs/RecordingAvailableCallback.md +2 -2
  79. data/docs/RecordingCompleteCallback.md +2 -2
  80. data/docs/RecordingsApi.md +52 -52
  81. data/docs/RedirectCallback.md +2 -2
  82. data/docs/StatisticsApi.md +2 -2
  83. data/docs/TranscribeRecording.md +4 -2
  84. data/docs/TranscriptionAvailableCallback.md +2 -2
  85. data/docs/TransferAnswerCallback.md +2 -2
  86. data/docs/TransferCompleteCallback.md +2 -2
  87. data/docs/TransferDisconnectCallback.md +2 -2
  88. data/docs/UpdateCall.md +3 -3
  89. data/docs/UpdateConference.md +3 -3
  90. data/lib/bandwidth-sdk/api/calls_api.rb +18 -18
  91. data/lib/bandwidth-sdk/api/conferences_api.rb +46 -46
  92. data/lib/bandwidth-sdk/api/media_api.rb +2 -2
  93. data/lib/bandwidth-sdk/api/messages_api.rb +8 -2
  94. data/lib/bandwidth-sdk/api/mfa_api.rb +10 -10
  95. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +6 -6
  96. data/lib/bandwidth-sdk/api/recordings_api.rb +55 -55
  97. data/lib/bandwidth-sdk/api/statistics_api.rb +3 -3
  98. data/lib/bandwidth-sdk/api_client.rb +1 -1
  99. data/lib/bandwidth-sdk/api_error.rb +2 -2
  100. data/lib/bandwidth-sdk/configuration.rb +12 -10
  101. data/lib/bandwidth-sdk/models/account_statistics.rb +14 -21
  102. data/lib/bandwidth-sdk/models/answer_callback.rb +16 -24
  103. data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +15 -22
  104. data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +15 -22
  105. data/lib/bandwidth-sdk/models/bxml/bxml.rb +2 -4
  106. data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb +3 -7
  107. data/lib/bandwidth-sdk/models/bxml/response.rb +2 -4
  108. data/lib/bandwidth-sdk/models/bxml/root.rb +3 -3
  109. data/lib/bandwidth-sdk/models/bxml/verb.rb +4 -5
  110. data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb +2 -4
  111. data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb +2 -5
  112. data/lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb +16 -0
  113. data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +2 -4
  114. data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +3 -5
  115. data/lib/bandwidth-sdk/models/bxml/verbs/hangup.rb +2 -4
  116. data/lib/bandwidth-sdk/models/bxml/verbs/pause.rb +2 -4
  117. data/lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb +2 -4
  118. data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +2 -4
  119. data/lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb +2 -4
  120. data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +2 -4
  121. data/lib/bandwidth-sdk/models/bxml/verbs/redirect.rb +2 -4
  122. data/lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb +2 -4
  123. data/lib/bandwidth-sdk/models/bxml/verbs/ring.rb +2 -4
  124. data/lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb +2 -4
  125. data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +2 -4
  126. data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +3 -5
  127. data/lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb +2 -4
  128. data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +2 -4
  129. data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +2 -4
  130. data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +29 -0
  131. data/lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb +2 -4
  132. data/lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb +2 -4
  133. data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +2 -4
  134. data/lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb +15 -0
  135. data/lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb +2 -4
  136. data/lib/bandwidth-sdk/models/bxml/verbs/tag.rb +2 -4
  137. data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +2 -4
  138. data/lib/bandwidth-sdk/models/call_direction_enum.rb +3 -3
  139. data/lib/bandwidth-sdk/models/call_recording_metadata.rb +14 -21
  140. data/lib/bandwidth-sdk/models/call_state.rb +16 -23
  141. data/lib/bandwidth-sdk/models/call_state_enum.rb +3 -3
  142. data/lib/bandwidth-sdk/models/callback_method_enum.rb +3 -3
  143. data/lib/bandwidth-sdk/models/code_request.rb +29 -22
  144. data/lib/bandwidth-sdk/models/conference.rb +17 -24
  145. data/lib/bandwidth-sdk/models/conference_completed_callback.rb +15 -22
  146. data/lib/bandwidth-sdk/models/conference_created_callback.rb +15 -22
  147. data/lib/bandwidth-sdk/models/conference_member.rb +14 -21
  148. data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +15 -22
  149. data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +15 -22
  150. data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +15 -22
  151. data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +14 -21
  152. data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +15 -22
  153. data/lib/bandwidth-sdk/models/conference_state_enum.rb +3 -3
  154. data/lib/bandwidth-sdk/models/create_call.rb +34 -24
  155. data/lib/bandwidth-sdk/models/create_call_response.rb +36 -29
  156. data/lib/bandwidth-sdk/models/create_lookup_response.rb +14 -21
  157. data/lib/bandwidth-sdk/models/create_message_request_error.rb +18 -21
  158. data/lib/bandwidth-sdk/models/deferred_result.rb +14 -21
  159. data/lib/bandwidth-sdk/models/disconenct_callback.rb +1 -3
  160. data/lib/bandwidth-sdk/models/disconnect_callback.rb +15 -22
  161. data/lib/bandwidth-sdk/models/diversion.rb +14 -21
  162. data/lib/bandwidth-sdk/models/dtmf_callback.rb +15 -22
  163. data/lib/bandwidth-sdk/models/field_error.rb +14 -21
  164. data/lib/bandwidth-sdk/models/file_format_enum.rb +3 -3
  165. data/lib/bandwidth-sdk/models/gather_callback.rb +15 -22
  166. data/lib/bandwidth-sdk/models/inbound_message_callback.rb +24 -21
  167. data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +33 -21
  168. data/lib/bandwidth-sdk/models/initiate_callback.rb +15 -22
  169. data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +3 -3
  170. data/lib/bandwidth-sdk/models/list_message_item.rb +31 -27
  171. data/lib/bandwidth-sdk/models/lookup_request.rb +16 -21
  172. data/lib/bandwidth-sdk/models/lookup_result.rb +14 -21
  173. data/lib/bandwidth-sdk/models/lookup_status.rb +14 -21
  174. data/lib/bandwidth-sdk/models/lookup_status_enum.rb +5 -5
  175. data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +16 -24
  176. data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +14 -21
  177. data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +3 -3
  178. data/lib/bandwidth-sdk/models/machine_detection_result.rb +224 -0
  179. data/lib/bandwidth-sdk/models/media.rb +14 -21
  180. data/lib/bandwidth-sdk/models/message.rb +23 -22
  181. data/lib/bandwidth-sdk/models/message_delivered_callback.rb +24 -21
  182. data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +35 -21
  183. data/lib/bandwidth-sdk/models/message_direction_enum.rb +3 -3
  184. data/lib/bandwidth-sdk/models/message_failed_callback.rb +26 -21
  185. data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +37 -21
  186. data/lib/bandwidth-sdk/models/message_request.rb +26 -23
  187. data/lib/bandwidth-sdk/models/message_sending_callback.rb +24 -21
  188. data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +37 -21
  189. data/lib/bandwidth-sdk/models/message_status_enum.rb +9 -9
  190. data/lib/bandwidth-sdk/models/message_type_enum.rb +3 -3
  191. data/lib/bandwidth-sdk/models/messages_list.rb +15 -22
  192. data/lib/bandwidth-sdk/models/messaging_code_response.rb +14 -21
  193. data/lib/bandwidth-sdk/models/messaging_request_error.rb +18 -21
  194. data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +14 -21
  195. data/lib/bandwidth-sdk/models/mfa_request_error.rb +14 -21
  196. data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +14 -21
  197. data/lib/bandwidth-sdk/models/page_info.rb +14 -21
  198. data/lib/bandwidth-sdk/models/priority_enum.rb +3 -3
  199. data/lib/bandwidth-sdk/models/recording_available_callback.rb +15 -22
  200. data/lib/bandwidth-sdk/models/recording_complete_callback.rb +15 -22
  201. data/lib/bandwidth-sdk/models/recording_state_enum.rb +3 -3
  202. data/lib/bandwidth-sdk/models/redirect_callback.rb +15 -22
  203. data/lib/bandwidth-sdk/models/redirect_method_enum.rb +3 -3
  204. data/lib/bandwidth-sdk/models/stir_shaken.rb +14 -21
  205. data/lib/bandwidth-sdk/models/tag.rb +14 -21
  206. data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +14 -21
  207. data/lib/bandwidth-sdk/models/transcribe_recording.rb +32 -26
  208. data/lib/bandwidth-sdk/models/transcription.rb +14 -21
  209. data/lib/bandwidth-sdk/models/transcription_available_callback.rb +15 -22
  210. data/lib/bandwidth-sdk/models/transcription_list.rb +14 -21
  211. data/lib/bandwidth-sdk/models/transcription_metadata.rb +14 -21
  212. data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +15 -22
  213. data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +15 -22
  214. data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +15 -22
  215. data/lib/bandwidth-sdk/models/update_call.rb +24 -22
  216. data/lib/bandwidth-sdk/models/update_call_recording.rb +16 -21
  217. data/lib/bandwidth-sdk/models/update_conference.rb +15 -22
  218. data/lib/bandwidth-sdk/models/update_conference_member.rb +14 -21
  219. data/lib/bandwidth-sdk/models/verify_code_request.rb +20 -21
  220. data/lib/bandwidth-sdk/models/verify_code_response.rb +14 -21
  221. data/lib/bandwidth-sdk/models/voice_api_error.rb +14 -21
  222. data/lib/bandwidth-sdk/models/voice_code_response.rb +14 -21
  223. data/lib/bandwidth-sdk/version.rb +2 -2
  224. data/lib/bandwidth-sdk.rb +5 -1
  225. data/openapi-config.yml +1 -0
  226. data/openapitools.json +7 -0
  227. data/spec/api/calls_api_spec.rb +228 -0
  228. data/spec/api/conferences_api_spec.rb +393 -0
  229. data/spec/api/media_api_spec.rb +129 -0
  230. data/spec/api/messages_api_spec.rb +193 -0
  231. data/spec/api/mfa_api_spec.rb +130 -0
  232. data/spec/api/phone_number_lookup_api_spec.rb +100 -0
  233. data/spec/api/recordings_api_spec.rb +395 -0
  234. data/spec/api/statistics_api_spec.rb +45 -0
  235. data/spec/api_client_spec.rb +377 -0
  236. data/spec/api_error_spec.rb +23 -0
  237. data/spec/call_utils.rb +28 -28
  238. data/spec/configuration_spec.rb +190 -0
  239. data/spec/integration/calls_api_integration_spec.rb +88 -69
  240. data/spec/integration/conferences_api_integration_spec.rb +74 -68
  241. data/spec/integration/media_api_integration_spec.rb +38 -32
  242. data/spec/integration/messages_api_integration_spec.rb +63 -50
  243. data/spec/integration/mfa_api_integration_spec.rb +41 -33
  244. data/spec/integration/phone_number_lookup_api_integration_spec.rb +26 -22
  245. data/spec/integration/recordings_api_integration_spec.rb +84 -77
  246. data/spec/integration/statistics_api_integration_spec.rb +15 -14
  247. data/spec/{unit/models → models}/bxml/bxml_spec.rb +0 -2
  248. data/spec/{unit/models → models}/bxml/nestable_verb_spec.rb +1 -3
  249. data/spec/{unit/models → models}/bxml/response_spec.rb +0 -2
  250. data/spec/{unit/models → models}/bxml/verb_spec.rb +1 -14
  251. data/spec/{unit/models → models}/bxml/verbs/bridge_spec.rb +0 -2
  252. data/spec/{unit/models → models}/bxml/verbs/conference_spec.rb +0 -2
  253. data/spec/models/bxml/verbs/custom_param_spec.rb +36 -0
  254. data/spec/{unit/models → models}/bxml/verbs/forward_spec.rb +0 -2
  255. data/spec/{unit/models → models}/bxml/verbs/gather_spec.rb +0 -2
  256. data/spec/{unit/models → models}/bxml/verbs/hangup_spec.rb +0 -2
  257. data/spec/{unit/models → models}/bxml/verbs/pause_recording_spec.rb +0 -2
  258. data/spec/{unit/models → models}/bxml/verbs/pause_spec.rb +0 -2
  259. data/spec/{unit/models → models}/bxml/verbs/phone_number_spec.rb +0 -2
  260. data/spec/{unit/models → models}/bxml/verbs/play_audio_spec.rb +0 -2
  261. data/spec/{unit/models → models}/bxml/verbs/record_spec.rb +0 -2
  262. data/spec/{unit/models → models}/bxml/verbs/redirect_spec.rb +0 -2
  263. data/spec/{unit/models → models}/bxml/verbs/resume_recording_spec.rb +0 -2
  264. data/spec/{unit/models → models}/bxml/verbs/ring_spec.rb +0 -2
  265. data/spec/{unit/models → models}/bxml/verbs/send_dtmf_spec.rb +0 -2
  266. data/spec/{unit/models → models}/bxml/verbs/sip_uri_spec.rb +0 -2
  267. data/spec/{unit/models → models}/bxml/verbs/speak_sentence_spec.rb +0 -2
  268. data/spec/{unit/models → models}/bxml/verbs/start_gather_spec.rb +0 -2
  269. data/spec/{unit/models → models}/bxml/verbs/start_recording_spec.rb +0 -2
  270. data/spec/{unit/models → models}/bxml/verbs/start_stream_spec.rb +2 -4
  271. data/spec/models/bxml/verbs/start_transcription_spec.rb +74 -0
  272. data/spec/{unit/models → models}/bxml/verbs/stop_gather_spec.rb +0 -2
  273. data/spec/{unit/models → models}/bxml/verbs/stop_recording_spec.rb +0 -2
  274. data/spec/{unit/models → models}/bxml/verbs/stop_stream_spec.rb +0 -2
  275. data/spec/models/bxml/verbs/stop_transcription_spec.rb +34 -0
  276. data/spec/{unit/models → models}/bxml/verbs/stream_param_spec.rb +0 -2
  277. data/spec/{unit/models → models}/bxml/verbs/tag_spec.rb +0 -2
  278. data/spec/{unit/models → models}/bxml/verbs/transfer_spec.rb +0 -2
  279. data/spec/models/call_state_enum_spec.rb +16 -0
  280. data/spec/models/call_state_spec.rb +168 -0
  281. data/spec/models/deferred_result_spec.rb +74 -0
  282. data/spec/models/message_spec.rb +138 -0
  283. data/spec/models/verify_code_request_spec.rb +126 -0
  284. data/spec/spec_helper.rb +48 -31
  285. metadata +148 -256
  286. data/spec/unit/api/calls_api_spec.rb +0 -89
  287. data/spec/unit/api/conferences_api_spec.rb +0 -163
  288. data/spec/unit/api/media_api_spec.rb +0 -90
  289. data/spec/unit/api/messages_api_spec.rb +0 -73
  290. data/spec/unit/api/mfa_api_spec.rb +0 -74
  291. data/spec/unit/api/phone_number_lookup_api_spec.rb +0 -61
  292. data/spec/unit/api/recordings_api_spec.rb +0 -177
  293. data/spec/unit/api/statistics_api_spec.rb +0 -47
  294. data/spec/unit/models/account_statistics_spec.rb +0 -40
  295. data/spec/unit/models/answer_callback_spec.rb +0 -112
  296. data/spec/unit/models/bridge_complete_callback_spec.rb +0 -124
  297. data/spec/unit/models/bridge_target_complete_callback_spec.rb +0 -106
  298. data/spec/unit/models/call_direction_enum_spec.rb +0 -28
  299. data/spec/unit/models/call_recording_metadata_spec.rb +0 -136
  300. data/spec/unit/models/call_state_enum_spec.rb +0 -28
  301. data/spec/unit/models/call_state_spec.rb +0 -136
  302. data/spec/unit/models/callback_method_enum_spec.rb +0 -28
  303. data/spec/unit/models/code_request_spec.rb +0 -64
  304. data/spec/unit/models/conference_completed_callback_spec.rb +0 -58
  305. data/spec/unit/models/conference_created_callback_spec.rb +0 -58
  306. data/spec/unit/models/conference_member_exit_callback_spec.rb +0 -76
  307. data/spec/unit/models/conference_member_join_callback_spec.rb +0 -76
  308. data/spec/unit/models/conference_member_spec.rb +0 -64
  309. data/spec/unit/models/conference_recording_available_callback_spec.rb +0 -112
  310. data/spec/unit/models/conference_recording_metadata_spec.rb +0 -94
  311. data/spec/unit/models/conference_redirect_callback_spec.rb +0 -58
  312. data/spec/unit/models/conference_spec.rb +0 -76
  313. data/spec/unit/models/conference_state_enum_spec.rb +0 -28
  314. data/spec/unit/models/create_call_response_spec.rb +0 -154
  315. data/spec/unit/models/create_call_spec.rb +0 -142
  316. data/spec/unit/models/create_lookup_response_spec.rb +0 -40
  317. data/spec/unit/models/create_message_request_error_spec.rb +0 -46
  318. data/spec/unit/models/deferred_result_spec.rb +0 -40
  319. data/spec/unit/models/disconnect_callback_spec.rb +0 -130
  320. data/spec/unit/models/diversion_spec.rb +0 -70
  321. data/spec/unit/models/dtmf_callback_spec.rb +0 -130
  322. data/spec/unit/models/field_error_spec.rb +0 -40
  323. data/spec/unit/models/file_format_enum_spec.rb +0 -28
  324. data/spec/unit/models/gather_callback_spec.rb +0 -136
  325. data/spec/unit/models/inbound_message_callback_message_spec.rb +0 -100
  326. data/spec/unit/models/inbound_message_callback_spec.rb +0 -58
  327. data/spec/unit/models/initiate_callback_spec.rb +0 -100
  328. data/spec/unit/models/list_message_direction_enum_spec.rb +0 -28
  329. data/spec/unit/models/list_message_item_spec.rb +0 -124
  330. data/spec/unit/models/lookup_request_spec.rb +0 -34
  331. data/spec/unit/models/lookup_result_spec.rb +0 -82
  332. data/spec/unit/models/lookup_status_enum_spec.rb +0 -28
  333. data/spec/unit/models/lookup_status_spec.rb +0 -52
  334. data/spec/unit/models/machine_detection_complete_callback_spec.rb +0 -112
  335. data/spec/unit/models/machine_detection_configuration_spec.rb +0 -118
  336. data/spec/unit/models/machine_detection_mode_enum_spec.rb +0 -28
  337. data/spec/unit/models/media_spec.rb +0 -46
  338. data/spec/unit/models/message_delivered_callback_message_spec.rb +0 -100
  339. data/spec/unit/models/message_delivered_callback_spec.rb +0 -58
  340. data/spec/unit/models/message_direction_enum_spec.rb +0 -28
  341. data/spec/unit/models/message_failed_callback_message_spec.rb +0 -100
  342. data/spec/unit/models/message_failed_callback_spec.rb +0 -64
  343. data/spec/unit/models/message_request_spec.rb +0 -76
  344. data/spec/unit/models/message_sending_callback_message_spec.rb +0 -100
  345. data/spec/unit/models/message_sending_callback_spec.rb +0 -58
  346. data/spec/unit/models/message_spec.rb +0 -106
  347. data/spec/unit/models/message_status_enum_spec.rb +0 -28
  348. data/spec/unit/models/message_type_enum_spec.rb +0 -28
  349. data/spec/unit/models/messages_list_spec.rb +0 -46
  350. data/spec/unit/models/messaging_code_response_spec.rb +0 -34
  351. data/spec/unit/models/messaging_request_error_spec.rb +0 -40
  352. data/spec/unit/models/mfa_forbidden_request_error_spec.rb +0 -34
  353. data/spec/unit/models/mfa_request_error_spec.rb +0 -40
  354. data/spec/unit/models/mfa_unauthorized_request_error_spec.rb +0 -34
  355. data/spec/unit/models/page_info_spec.rb +0 -52
  356. data/spec/unit/models/priority_enum_spec.rb +0 -28
  357. data/spec/unit/models/recording_available_callback_spec.rb +0 -160
  358. data/spec/unit/models/recording_complete_callback_spec.rb +0 -160
  359. data/spec/unit/models/recording_state_enum_spec.rb +0 -28
  360. data/spec/unit/models/redirect_callback_spec.rb +0 -124
  361. data/spec/unit/models/redirect_method_enum_spec.rb +0 -28
  362. data/spec/unit/models/stir_shaken_spec.rb +0 -46
  363. data/spec/unit/models/tag_spec.rb +0 -40
  364. data/spec/unit/models/tn_lookup_request_error_spec.rb +0 -34
  365. data/spec/unit/models/transcribe_recording_spec.rb +0 -64
  366. data/spec/unit/models/transcription_available_callback_spec.rb +0 -154
  367. data/spec/unit/models/transcription_list_spec.rb +0 -34
  368. data/spec/unit/models/transcription_metadata_spec.rb +0 -52
  369. data/spec/unit/models/transcription_spec.rb +0 -40
  370. data/spec/unit/models/transfer_answer_callback_spec.rb +0 -118
  371. data/spec/unit/models/transfer_complete_callback_spec.rb +0 -136
  372. data/spec/unit/models/transfer_disconnect_callback_spec.rb +0 -148
  373. data/spec/unit/models/update_call_recording_spec.rb +0 -34
  374. data/spec/unit/models/update_call_spec.rb +0 -88
  375. data/spec/unit/models/update_conference_member_spec.rb +0 -46
  376. data/spec/unit/models/update_conference_spec.rb +0 -82
  377. data/spec/unit/models/verify_code_request_spec.rb +0 -52
  378. data/spec/unit/models/verify_code_response_spec.rb +0 -34
  379. data/spec/unit/models/voice_api_error_spec.rb +0 -46
  380. data/spec/unit/models/voice_code_response_spec.rb +0 -34
data/bandwidth.yml CHANGED
@@ -167,9 +167,11 @@ paths:
167
167
  - $ref: '#/components/parameters/errorCode'
168
168
  - $ref: '#/components/parameters/fromDateTime'
169
169
  - $ref: '#/components/parameters/toDateTime'
170
+ - $ref: '#/components/parameters/campaignId'
170
171
  - $ref: '#/components/parameters/sort'
171
172
  - $ref: '#/components/parameters/pageToken'
172
173
  - $ref: '#/components/parameters/limit'
174
+ - $ref: '#/components/parameters/limitTotalCount'
173
175
  responses:
174
176
  '200':
175
177
  $ref: '#/components/responses/listMessagesResponse'
@@ -241,7 +243,7 @@ paths:
241
243
  approximately in order, but exact ordering is not guaranteed.
242
244
  operationId: createCall
243
245
  parameters:
244
- - $ref: '#/components/parameters/accountId1'
246
+ - $ref: '#/components/parameters/accountId'
245
247
  requestBody:
246
248
  $ref: '#/components/requestBodies/createCallRequest'
247
249
  responses:
@@ -282,7 +284,7 @@ paths:
282
284
  7 days, you will get an HTTP 404 response.
283
285
  operationId: getCallState
284
286
  parameters:
285
- - $ref: '#/components/parameters/accountId1'
287
+ - $ref: '#/components/parameters/accountId'
286
288
  - $ref: '#/components/parameters/callId'
287
289
  responses:
288
290
  '200':
@@ -312,13 +314,13 @@ paths:
312
314
  BXML document.
313
315
  operationId: updateCall
314
316
  parameters:
315
- - $ref: '#/components/parameters/accountId1'
317
+ - $ref: '#/components/parameters/accountId'
316
318
  - $ref: '#/components/parameters/callId'
317
319
  requestBody:
318
320
  $ref: '#/components/requestBodies/updateCallRequest'
319
321
  responses:
320
322
  '200':
321
- description: Call Successfully Modified
323
+ description: Call was successfully modified.
322
324
  '400':
323
325
  $ref: '#/components/responses/voiceBadRequestError'
324
326
  '401':
@@ -346,13 +348,13 @@ paths:
346
348
  description: Interrupts and replaces an active call's BXML document.
347
349
  operationId: updateCallBxml
348
350
  parameters:
349
- - $ref: '#/components/parameters/accountId1'
351
+ - $ref: '#/components/parameters/accountId'
350
352
  - $ref: '#/components/parameters/callId'
351
353
  requestBody:
352
354
  $ref: '#/components/requestBodies/updateCallBxmlRequest'
353
355
  responses:
354
356
  '204':
355
- description: Call BXML Successfully Replaced
357
+ description: Call BXML was successfully replaced.
356
358
  '400':
357
359
  $ref: '#/components/responses/voiceBadRequestError'
358
360
  '401':
@@ -388,7 +390,7 @@ paths:
388
390
  of conference records.
389
391
  operationId: listConferences
390
392
  parameters:
391
- - $ref: '#/components/parameters/accountId1'
393
+ - $ref: '#/components/parameters/accountId'
392
394
  - $ref: '#/components/parameters/name'
393
395
  - $ref: '#/components/parameters/minCreatedTime'
394
396
  - $ref: '#/components/parameters/maxCreatedTime'
@@ -422,7 +424,7 @@ paths:
422
424
  description: Returns information about the specified conference.
423
425
  operationId: getConference
424
426
  parameters:
425
- - $ref: '#/components/parameters/accountId1'
427
+ - $ref: '#/components/parameters/accountId'
426
428
  - $ref: '#/components/parameters/conferenceId'
427
429
  responses:
428
430
  '200':
@@ -450,13 +452,13 @@ paths:
450
452
  description: Update the conference state.
451
453
  operationId: updateConference
452
454
  parameters:
453
- - $ref: '#/components/parameters/accountId1'
455
+ - $ref: '#/components/parameters/accountId'
454
456
  - $ref: '#/components/parameters/conferenceId'
455
457
  requestBody:
456
458
  $ref: '#/components/requestBodies/updateConferenceRequest'
457
459
  responses:
458
460
  '204':
459
- description: Conference successfully modified
461
+ description: Conference was successfully modified.
460
462
  '400':
461
463
  $ref: '#/components/responses/voiceBadRequestError'
462
464
  '401':
@@ -482,13 +484,13 @@ paths:
482
484
  description: Update the conference BXML document.
483
485
  operationId: updateConferenceBxml
484
486
  parameters:
485
- - $ref: '#/components/parameters/accountId1'
487
+ - $ref: '#/components/parameters/accountId'
486
488
  - $ref: '#/components/parameters/conferenceId'
487
489
  requestBody:
488
490
  $ref: '#/components/requestBodies/updateConferenceBxmlRequest'
489
491
  responses:
490
492
  '204':
491
- description: Conference successfully modified
493
+ description: Conference successfully modified.
492
494
  '400':
493
495
  $ref: '#/components/responses/voiceBadRequestError'
494
496
  '401':
@@ -514,7 +516,7 @@ paths:
514
516
  description: Returns information about the specified conference member.
515
517
  operationId: getConferenceMember
516
518
  parameters:
517
- - $ref: '#/components/parameters/accountId1'
519
+ - $ref: '#/components/parameters/accountId'
518
520
  - $ref: '#/components/parameters/conferenceId'
519
521
  - $ref: '#/components/parameters/memberId'
520
522
  responses:
@@ -543,14 +545,14 @@ paths:
543
545
  description: Updates settings for a particular conference member.
544
546
  operationId: updateConferenceMember
545
547
  parameters:
546
- - $ref: '#/components/parameters/accountId1'
548
+ - $ref: '#/components/parameters/accountId'
547
549
  - $ref: '#/components/parameters/conferenceId'
548
550
  - $ref: '#/components/parameters/memberId'
549
551
  requestBody:
550
552
  $ref: '#/components/requestBodies/updateConferenceMemberRequest'
551
553
  responses:
552
554
  '204':
553
- description: Conference member successfully modified
555
+ description: Conference member was successfully modified.
554
556
  '400':
555
557
  $ref: '#/components/responses/voiceBadRequestError'
556
558
  '401':
@@ -578,7 +580,7 @@ paths:
578
580
  took place during the specified conference.
579
581
  operationId: listConferenceRecordings
580
582
  parameters:
581
- - $ref: '#/components/parameters/accountId1'
583
+ - $ref: '#/components/parameters/accountId'
582
584
  - $ref: '#/components/parameters/conferenceId'
583
585
  responses:
584
586
  '200':
@@ -608,7 +610,7 @@ paths:
608
610
  description: Returns metadata for the specified recording.
609
611
  operationId: getConferenceRecording
610
612
  parameters:
611
- - $ref: '#/components/parameters/accountId1'
613
+ - $ref: '#/components/parameters/accountId'
612
614
  - $ref: '#/components/parameters/conferenceId'
613
615
  - $ref: '#/components/parameters/recordingId'
614
616
  responses:
@@ -639,7 +641,7 @@ paths:
639
641
  description: Downloads the specified recording file.
640
642
  operationId: downloadConferenceRecording
641
643
  parameters:
642
- - $ref: '#/components/parameters/accountId1'
644
+ - $ref: '#/components/parameters/accountId'
643
645
  - $ref: '#/components/parameters/conferenceId'
644
646
  - $ref: '#/components/parameters/recordingId'
645
647
  responses:
@@ -679,7 +681,7 @@ paths:
679
681
  empty if no recordings match the specified criteria.
680
682
  operationId: listAccountCallRecordings
681
683
  parameters:
682
- - $ref: '#/components/parameters/accountId1'
684
+ - $ref: '#/components/parameters/accountId'
683
685
  - $ref: '#/components/parameters/to'
684
686
  - $ref: '#/components/parameters/from'
685
687
  - $ref: '#/components/parameters/minStartTime'
@@ -712,13 +714,13 @@ paths:
712
714
  description: Pause or resume a recording on an active phone call.
713
715
  operationId: updateCallRecordingState
714
716
  parameters:
715
- - $ref: '#/components/parameters/accountId1'
717
+ - $ref: '#/components/parameters/accountId'
716
718
  - $ref: '#/components/parameters/callId'
717
719
  requestBody:
718
720
  $ref: '#/components/requestBodies/updateCallRecordingRequest'
719
721
  responses:
720
722
  '200':
721
- description: Recording state successfully modified
723
+ description: Recording state was successfully modified.
722
724
  '400':
723
725
  $ref: '#/components/responses/voiceBadRequestError'
724
726
  '401':
@@ -746,7 +748,7 @@ paths:
746
748
  that took place during the specified call.
747
749
  operationId: listCallRecordings
748
750
  parameters:
749
- - $ref: '#/components/parameters/accountId1'
751
+ - $ref: '#/components/parameters/accountId'
750
752
  - $ref: '#/components/parameters/callId'
751
753
  responses:
752
754
  '200':
@@ -776,7 +778,7 @@ paths:
776
778
  description: Returns metadata for the specified recording.
777
779
  operationId: getCallRecording
778
780
  parameters:
779
- - $ref: '#/components/parameters/accountId1'
781
+ - $ref: '#/components/parameters/accountId'
780
782
  - $ref: '#/components/parameters/callId'
781
783
  - $ref: '#/components/parameters/recordingId'
782
784
  responses:
@@ -813,12 +815,12 @@ paths:
813
815
  irreversible, can take an additional 24 to 48 hours.
814
816
  operationId: deleteRecording
815
817
  parameters:
816
- - $ref: '#/components/parameters/accountId1'
818
+ - $ref: '#/components/parameters/accountId'
817
819
  - $ref: '#/components/parameters/callId'
818
820
  - $ref: '#/components/parameters/recordingId'
819
821
  responses:
820
822
  '204':
821
- description: Recording Deleted
823
+ description: Recording was deleted.
822
824
  '400':
823
825
  $ref: '#/components/responses/voiceBadRequestError'
824
826
  '401':
@@ -844,7 +846,7 @@ paths:
844
846
  description: Downloads the specified recording.
845
847
  operationId: downloadCallRecording
846
848
  parameters:
847
- - $ref: '#/components/parameters/accountId1'
849
+ - $ref: '#/components/parameters/accountId'
848
850
  - $ref: '#/components/parameters/callId'
849
851
  - $ref: '#/components/parameters/recordingId'
850
852
  responses:
@@ -873,12 +875,12 @@ paths:
873
875
  description: Deletes the specified recording's media.
874
876
  operationId: deleteRecordingMedia
875
877
  parameters:
876
- - $ref: '#/components/parameters/accountId1'
878
+ - $ref: '#/components/parameters/accountId'
877
879
  - $ref: '#/components/parameters/callId'
878
880
  - $ref: '#/components/parameters/recordingId'
879
881
  responses:
880
882
  '204':
881
- description: The recording media was successfully deleted
883
+ description: The recording media was successfully deleted.
882
884
  '400':
883
885
  $ref: '#/components/responses/voiceBadRequestError'
884
886
  '401':
@@ -918,7 +920,7 @@ paths:
918
920
  item.
919
921
  operationId: getCallTranscription
920
922
  parameters:
921
- - $ref: '#/components/parameters/accountId1'
923
+ - $ref: '#/components/parameters/accountId'
922
924
  - $ref: '#/components/parameters/callId'
923
925
  - $ref: '#/components/parameters/recordingId'
924
926
  responses:
@@ -953,14 +955,14 @@ paths:
953
955
  less than 4 hours.
954
956
  operationId: transcribeCallRecording
955
957
  parameters:
956
- - $ref: '#/components/parameters/accountId1'
958
+ - $ref: '#/components/parameters/accountId'
957
959
  - $ref: '#/components/parameters/callId'
958
960
  - $ref: '#/components/parameters/recordingId'
959
961
  requestBody:
960
962
  $ref: '#/components/requestBodies/transcribeRecordingRequest'
961
963
  responses:
962
964
  '204':
963
- description: Transcription successfully requested
965
+ description: Transcription was successfully requested.
964
966
  '400':
965
967
  $ref: '#/components/responses/voiceBadRequestError'
966
968
  '401':
@@ -991,12 +993,12 @@ paths:
991
993
  can take an additional 24 to 48 hours.
992
994
  operationId: deleteCallTranscription
993
995
  parameters:
994
- - $ref: '#/components/parameters/accountId1'
996
+ - $ref: '#/components/parameters/accountId'
995
997
  - $ref: '#/components/parameters/callId'
996
998
  - $ref: '#/components/parameters/recordingId'
997
999
  responses:
998
1000
  '204':
999
- description: The transcription was successfully deleted
1001
+ description: The transcription was successfully deleted.
1000
1002
  '400':
1001
1003
  $ref: '#/components/responses/voiceBadRequestError'
1002
1004
  '401':
@@ -1022,7 +1024,7 @@ paths:
1022
1024
  description: Returns details about the current state of the account.
1023
1025
  operationId: getStatistics
1024
1026
  parameters:
1025
- - $ref: '#/components/parameters/accountId1'
1027
+ - $ref: '#/components/parameters/accountId'
1026
1028
  responses:
1027
1029
  '200':
1028
1030
  $ref: '#/components/responses/getStatisticsResponse'
@@ -1051,7 +1053,7 @@ paths:
1051
1053
  description: Send an MFA Code via a phone call.
1052
1054
  operationId: generateVoiceCode
1053
1055
  parameters:
1054
- - $ref: '#/components/parameters/accountId2'
1056
+ - $ref: '#/components/parameters/accountId'
1055
1057
  requestBody:
1056
1058
  $ref: '#/components/requestBodies/codeRequest'
1057
1059
  responses:
@@ -1076,7 +1078,7 @@ paths:
1076
1078
  description: Send an MFA code via text message (SMS).
1077
1079
  operationId: generateMessagingCode
1078
1080
  parameters:
1079
- - $ref: '#/components/parameters/accountId2'
1081
+ - $ref: '#/components/parameters/accountId'
1080
1082
  requestBody:
1081
1083
  $ref: '#/components/requestBodies/codeRequest'
1082
1084
  responses:
@@ -1099,7 +1101,7 @@ paths:
1099
1101
  description: Verify a previously sent MFA code.
1100
1102
  operationId: verifyCode
1101
1103
  parameters:
1102
- - $ref: '#/components/parameters/accountId2'
1104
+ - $ref: '#/components/parameters/accountId'
1103
1105
  requestBody:
1104
1106
  $ref: '#/components/requestBodies/codeVerify'
1105
1107
  responses:
@@ -1124,7 +1126,7 @@ paths:
1124
1126
  tags:
1125
1127
  - Phone Number Lookup
1126
1128
  parameters:
1127
- - $ref: '#/components/parameters/accountId3'
1129
+ - $ref: '#/components/parameters/accountId'
1128
1130
  requestBody:
1129
1131
  $ref: '#/components/requestBodies/createLookupRequest'
1130
1132
  responses:
@@ -1153,7 +1155,7 @@ paths:
1153
1155
  tags:
1154
1156
  - Phone Number Lookup
1155
1157
  parameters:
1156
- - $ref: '#/components/parameters/accountId3'
1158
+ - $ref: '#/components/parameters/accountId'
1157
1159
  - $ref: '#/components/parameters/requestId'
1158
1160
  responses:
1159
1161
  '200':
@@ -1175,7 +1177,10 @@ components:
1175
1177
  schemas:
1176
1178
  priorityEnum:
1177
1179
  type: string
1178
- description: The priority specified by the user.
1180
+ description: |-
1181
+ The priority specified by the user.
1182
+
1183
+ Not supported on MMS.
1179
1184
  enum:
1180
1185
  - default
1181
1186
  - high
@@ -1233,7 +1238,9 @@ components:
1233
1238
  properties:
1234
1239
  totalCount:
1235
1240
  type: integer
1236
- description: Total number of messages matched by the search.
1241
+ description: >-
1242
+ The total number of messages matched by the search. When the request
1243
+ has limitTotalCount set to true this value is limited to 10,000.
1237
1244
  example: 100
1238
1245
  pageInfo:
1239
1246
  $ref: '#/components/schemas/pageInfo'
@@ -1277,6 +1284,7 @@ components:
1277
1284
  example: 9902
1278
1285
  receiveTime:
1279
1286
  type: string
1287
+ format: date-time
1280
1288
  description: The ISO 8601 datetime of the message.
1281
1289
  example: 2020-04-07T14:03:07.000Z
1282
1290
  carrierName:
@@ -1310,6 +1318,11 @@ components:
1310
1318
  description: The campaign class of the message if it has one.
1311
1319
  nullable: true
1312
1320
  example: T
1321
+ campaignId:
1322
+ type: string
1323
+ description: The campaign ID of the message if it has one.
1324
+ nullable: true
1325
+ example: CJEUMDK
1313
1326
  pageInfo:
1314
1327
  title: PageInfo
1315
1328
  type: object
@@ -1402,6 +1415,7 @@ components:
1402
1415
  example: 93de2206-9669-4e07-948d-329f4b722ee2
1403
1416
  time:
1404
1417
  type: string
1418
+ format: date-time
1405
1419
  description: The datetime stamp of the message in ISO 8601
1406
1420
  example: 2022-09-14T18:20:16.000Z
1407
1421
  segmentCount:
@@ -1515,6 +1529,8 @@ components:
1515
1529
  automatically expire by. This must be a valid RFC-3339 value, e.g.,
1516
1530
  2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a
1517
1531
  date-time in the future.
1532
+
1533
+ Not supported on MMS.
1518
1534
  example: '2021-02-01T11:29:18-05:00'
1519
1535
  inboundMessageCallback:
1520
1536
  description: Inbound Message Callback
@@ -1534,68 +1550,71 @@ components:
1534
1550
  type: string
1535
1551
  example: Incoming message received
1536
1552
  message:
1537
- type: object
1538
- properties:
1539
- id:
1540
- type: string
1541
- example: 1661365814859loidf7mcwd4qacn7
1542
- owner:
1543
- type: string
1544
- example: '+15553332222'
1545
- applicationId:
1546
- type: string
1547
- example: 93de2206-9669-4e07-948d-329f4b722ee2
1548
- time:
1549
- type: string
1550
- format: date-time
1551
- example: 2016-09-14T18:20:16.000Z
1552
- segmentCount:
1553
- type: integer
1554
- example: 1
1555
- direction:
1556
- $ref: '#/components/schemas/messageDirectionEnum'
1557
- to:
1558
- uniqueItems: true
1559
- type: array
1560
- items:
1561
- type: string
1562
- example:
1563
- - '+15552223333'
1564
- from:
1565
- type: string
1566
- example: '+15553332222'
1567
- text:
1568
- type: string
1569
- example: Hello world
1570
- tag:
1571
- type: string
1572
- example: custom string
1573
- media:
1574
- type: array
1575
- items:
1576
- type: string
1577
- format: uri
1578
- example:
1579
- - https://dev.bandwidth.com/images/bandwidth-logo.png
1580
- - https://dev.bandwidth.com/images/github_logo.png
1581
- priority:
1582
- $ref: '#/components/schemas/priorityEnum'
1583
- required:
1584
- - id
1585
- - owner
1586
- - applicationId
1587
- - time
1588
- - segmentCount
1589
- - direction
1590
- - to
1591
- - from
1592
- - text
1553
+ $ref: '#/components/schemas/inboundMessageCallbackMessage'
1593
1554
  required:
1594
1555
  - time
1595
1556
  - type
1596
1557
  - to
1597
1558
  - description
1598
1559
  - message
1560
+ inboundMessageCallbackMessage:
1561
+ description: Inbound Message Callback Message Schema
1562
+ type: object
1563
+ properties:
1564
+ id:
1565
+ type: string
1566
+ example: 1661365814859loidf7mcwd4qacn7
1567
+ owner:
1568
+ type: string
1569
+ example: '+15553332222'
1570
+ applicationId:
1571
+ type: string
1572
+ example: 93de2206-9669-4e07-948d-329f4b722ee2
1573
+ time:
1574
+ type: string
1575
+ format: date-time
1576
+ example: 2016-09-14T18:20:16.000Z
1577
+ segmentCount:
1578
+ type: integer
1579
+ example: 1
1580
+ direction:
1581
+ $ref: '#/components/schemas/messageDirectionEnum'
1582
+ to:
1583
+ uniqueItems: true
1584
+ type: array
1585
+ items:
1586
+ type: string
1587
+ example:
1588
+ - '+15552223333'
1589
+ from:
1590
+ type: string
1591
+ example: '+15553332222'
1592
+ text:
1593
+ type: string
1594
+ example: Hello world
1595
+ tag:
1596
+ type: string
1597
+ example: custom string
1598
+ media:
1599
+ type: array
1600
+ items:
1601
+ type: string
1602
+ format: uri
1603
+ example:
1604
+ - https://dev.bandwidth.com/images/bandwidth-logo.png
1605
+ - https://dev.bandwidth.com/images/github_logo.png
1606
+ priority:
1607
+ $ref: '#/components/schemas/priorityEnum'
1608
+ required:
1609
+ - id
1610
+ - owner
1611
+ - applicationId
1612
+ - time
1613
+ - segmentCount
1614
+ - direction
1615
+ - to
1616
+ - from
1617
+ - text
1599
1618
  messageSendingCallback:
1600
1619
  type: object
1601
1620
  description: Message Sending Callback
@@ -1614,70 +1633,73 @@ components:
1614
1633
  type: string
1615
1634
  example: Message is sending to carrier
1616
1635
  message:
1617
- type: object
1618
- properties:
1619
- id:
1620
- type: string
1621
- example: 1661365814859loidf7mcwd4qacn7
1622
- owner:
1623
- type: string
1624
- example: '+15553332222'
1625
- applicationId:
1626
- type: string
1627
- example: 93de2206-9669-4e07-948d-329f4b722ee2
1628
- time:
1629
- type: string
1630
- format: date-time
1631
- example: 2016-09-14T18:20:16.000Z
1632
- segmentCount:
1633
- type: integer
1634
- example: 1
1635
- direction:
1636
- $ref: '#/components/schemas/messageDirectionEnum'
1637
- to:
1638
- uniqueItems: true
1639
- type: array
1640
- items:
1641
- type: string
1642
- example:
1643
- - '+15552223333'
1644
- from:
1645
- type: string
1646
- example: '+15553332222'
1647
- text:
1648
- type: string
1649
- example: ''
1650
- tag:
1651
- type: string
1652
- example: custom string
1653
- media:
1654
- type: array
1655
- items:
1656
- type: string
1657
- format: uri
1658
- example:
1659
- - https://dev.bandwidth.com/images/bandwidth-logo.png
1660
- - https://dev.bandwidth.com/images/github_logo.png
1661
- priority:
1662
- $ref: '#/components/schemas/priorityEnum'
1663
- required:
1664
- - id
1665
- - owner
1666
- - applicationId
1667
- - time
1668
- - segmentCount
1669
- - direction
1670
- - to
1671
- - from
1672
- - text
1673
- - media
1674
- - priority
1636
+ $ref: '#/components/schemas/messageSendingCallbackMessage'
1675
1637
  required:
1676
1638
  - time
1677
1639
  - type
1678
1640
  - to
1679
1641
  - description
1680
1642
  - message
1643
+ messageSendingCallbackMessage:
1644
+ description: Message Sending Callback Message Schema
1645
+ type: object
1646
+ properties:
1647
+ id:
1648
+ type: string
1649
+ example: 1661365814859loidf7mcwd4qacn7
1650
+ owner:
1651
+ type: string
1652
+ example: '+15553332222'
1653
+ applicationId:
1654
+ type: string
1655
+ example: 93de2206-9669-4e07-948d-329f4b722ee2
1656
+ time:
1657
+ type: string
1658
+ format: date-time
1659
+ example: 2016-09-14T18:20:16.000Z
1660
+ segmentCount:
1661
+ type: integer
1662
+ example: 1
1663
+ direction:
1664
+ $ref: '#/components/schemas/messageDirectionEnum'
1665
+ to:
1666
+ uniqueItems: true
1667
+ type: array
1668
+ items:
1669
+ type: string
1670
+ example:
1671
+ - '+15552223333'
1672
+ from:
1673
+ type: string
1674
+ example: '+15553332222'
1675
+ text:
1676
+ type: string
1677
+ example: Hello world
1678
+ tag:
1679
+ type: string
1680
+ example: custom string
1681
+ media:
1682
+ type: array
1683
+ items:
1684
+ type: string
1685
+ format: uri
1686
+ example:
1687
+ - https://dev.bandwidth.com/images/bandwidth-logo.png
1688
+ - https://dev.bandwidth.com/images/github_logo.png
1689
+ priority:
1690
+ $ref: '#/components/schemas/priorityEnum'
1691
+ required:
1692
+ - id
1693
+ - owner
1694
+ - applicationId
1695
+ - time
1696
+ - segmentCount
1697
+ - direction
1698
+ - to
1699
+ - from
1700
+ - text
1701
+ - media
1702
+ - priority
1681
1703
  messageDeliveredCallback:
1682
1704
  description: Message Delivered Callback
1683
1705
  type: object
@@ -1696,69 +1718,72 @@ components:
1696
1718
  type: string
1697
1719
  example: Message delivered to carrier.
1698
1720
  message:
1699
- type: object
1700
- properties:
1701
- id:
1702
- type: string
1703
- example: 1661365814859loidf7mcwd4qacn7
1704
- owner:
1705
- type: string
1706
- example: '+15553332222'
1707
- applicationId:
1708
- type: string
1709
- example: 93de2206-9669-4e07-948d-329f4b722ee2
1710
- time:
1711
- type: string
1712
- format: date-time
1713
- example: 2016-09-14T18:20:16.000Z
1714
- segmentCount:
1715
- type: integer
1716
- example: 1
1717
- direction:
1718
- $ref: '#/components/schemas/messageDirectionEnum'
1719
- to:
1720
- uniqueItems: true
1721
- type: array
1722
- items:
1723
- type: string
1724
- example:
1725
- - '+15552223333'
1726
- from:
1727
- type: string
1728
- example: '+15553332222'
1729
- text:
1730
- type: string
1731
- example: ''
1732
- tag:
1733
- type: string
1734
- example: custom string
1735
- media:
1736
- type: array
1737
- items:
1738
- type: string
1739
- format: uri
1740
- example:
1741
- - https://dev.bandwidth.com/images/bandwidth-logo.png
1742
- - https://dev.bandwidth.com/images/github_logo.png
1743
- priority:
1744
- $ref: '#/components/schemas/priorityEnum'
1745
- required:
1746
- - id
1747
- - owner
1748
- - applicationId
1749
- - time
1750
- - segmentCount
1751
- - direction
1752
- - to
1753
- - from
1754
- - text
1755
- - tag
1721
+ $ref: '#/components/schemas/messageDeliveredCallbackMessage'
1756
1722
  required:
1757
1723
  - time
1758
1724
  - type
1759
1725
  - to
1760
1726
  - description
1761
1727
  - message
1728
+ messageDeliveredCallbackMessage:
1729
+ description: Message Delivered Callback Message Schema
1730
+ type: object
1731
+ properties:
1732
+ id:
1733
+ type: string
1734
+ example: 1661365814859loidf7mcwd4qacn7
1735
+ owner:
1736
+ type: string
1737
+ example: '+15553332222'
1738
+ applicationId:
1739
+ type: string
1740
+ example: 93de2206-9669-4e07-948d-329f4b722ee2
1741
+ time:
1742
+ type: string
1743
+ format: date-time
1744
+ example: 2016-09-14T18:20:16.000Z
1745
+ segmentCount:
1746
+ type: integer
1747
+ example: 1
1748
+ direction:
1749
+ $ref: '#/components/schemas/messageDirectionEnum'
1750
+ to:
1751
+ uniqueItems: true
1752
+ type: array
1753
+ items:
1754
+ type: string
1755
+ example:
1756
+ - '+15552223333'
1757
+ from:
1758
+ type: string
1759
+ example: '+15553332222'
1760
+ text:
1761
+ type: string
1762
+ example: Hello world
1763
+ tag:
1764
+ type: string
1765
+ example: custom string
1766
+ media:
1767
+ type: array
1768
+ items:
1769
+ type: string
1770
+ format: uri
1771
+ example:
1772
+ - https://dev.bandwidth.com/images/bandwidth-logo.png
1773
+ - https://dev.bandwidth.com/images/github_logo.png
1774
+ priority:
1775
+ $ref: '#/components/schemas/priorityEnum'
1776
+ required:
1777
+ - id
1778
+ - owner
1779
+ - applicationId
1780
+ - time
1781
+ - segmentCount
1782
+ - direction
1783
+ - to
1784
+ - from
1785
+ - text
1786
+ - tag
1762
1787
  messageFailedCallback:
1763
1788
  description: Message Failed Callback
1764
1789
  type: object
@@ -1777,64 +1802,7 @@ components:
1777
1802
  type: string
1778
1803
  example: rejected-unallocated-from-number
1779
1804
  message:
1780
- type: object
1781
- properties:
1782
- id:
1783
- type: string
1784
- example: 1661365814859loidf7mcwd4qacn7
1785
- owner:
1786
- type: string
1787
- example: '+15553332222'
1788
- applicationId:
1789
- type: string
1790
- example: 93de2206-9669-4e07-948d-329f4b722ee2
1791
- time:
1792
- type: string
1793
- format: date-time
1794
- example: 2016-09-14T18:20:16.000Z
1795
- segmentCount:
1796
- type: integer
1797
- example: 1
1798
- direction:
1799
- $ref: '#/components/schemas/messageDirectionEnum'
1800
- to:
1801
- uniqueItems: true
1802
- type: array
1803
- items:
1804
- type: string
1805
- example:
1806
- - '+15552223333'
1807
- from:
1808
- type: string
1809
- example: '+15553332222'
1810
- text:
1811
- type: string
1812
- example: ''
1813
- tag:
1814
- type: string
1815
- example: custom string
1816
- media:
1817
- type: array
1818
- items:
1819
- type: string
1820
- format: uri
1821
- example:
1822
- - https://dev.bandwidth.com/images/bandwidth-logo.png
1823
- - https://dev.bandwidth.com/images/github_logo.png
1824
- priority:
1825
- $ref: '#/components/schemas/priorityEnum'
1826
- required:
1827
- - id
1828
- - owner
1829
- - applicationId
1830
- - time
1831
- - segmentCount
1832
- - direction
1833
- - to
1834
- - from
1835
- - text
1836
- - tag
1837
- - priority
1805
+ $ref: '#/components/schemas/messageFailedCallbackMessage'
1838
1806
  errorCode:
1839
1807
  type: integer
1840
1808
  example: 9902
@@ -1845,6 +1813,66 @@ components:
1845
1813
  - description
1846
1814
  - message
1847
1815
  - errorCode
1816
+ messageFailedCallbackMessage:
1817
+ description: Message Failed Callback Message Schema
1818
+ type: object
1819
+ properties:
1820
+ id:
1821
+ type: string
1822
+ example: 1661365814859loidf7mcwd4qacn7
1823
+ owner:
1824
+ type: string
1825
+ example: '+15553332222'
1826
+ applicationId:
1827
+ type: string
1828
+ example: 93de2206-9669-4e07-948d-329f4b722ee2
1829
+ time:
1830
+ type: string
1831
+ format: date-time
1832
+ example: 2016-09-14T18:20:16.000Z
1833
+ segmentCount:
1834
+ type: integer
1835
+ example: 1
1836
+ direction:
1837
+ $ref: '#/components/schemas/messageDirectionEnum'
1838
+ to:
1839
+ uniqueItems: true
1840
+ type: array
1841
+ items:
1842
+ type: string
1843
+ example:
1844
+ - '+15552223333'
1845
+ from:
1846
+ type: string
1847
+ example: '+15553332222'
1848
+ text:
1849
+ type: string
1850
+ example: Hello world
1851
+ tag:
1852
+ type: string
1853
+ example: custom string
1854
+ media:
1855
+ type: array
1856
+ items:
1857
+ type: string
1858
+ format: uri
1859
+ example:
1860
+ - https://dev.bandwidth.com/images/bandwidth-logo.png
1861
+ - https://dev.bandwidth.com/images/github_logo.png
1862
+ priority:
1863
+ $ref: '#/components/schemas/priorityEnum'
1864
+ required:
1865
+ - id
1866
+ - owner
1867
+ - applicationId
1868
+ - time
1869
+ - segmentCount
1870
+ - direction
1871
+ - to
1872
+ - from
1873
+ - text
1874
+ - tag
1875
+ - priority
1848
1876
  callbackMethodEnum:
1849
1877
  type: string
1850
1878
  nullable: true
@@ -1867,7 +1895,7 @@ components:
1867
1895
  The HTTP method to use for the request to `redirectUrl`. GET
1868
1896
 
1869
1897
  or POST. Default value is POST.<br><br>Not allowed if `state` is
1870
- `completed`
1898
+ `completed`.
1871
1899
  example: POST
1872
1900
  recordingStateEnum:
1873
1901
  type: string
@@ -1880,18 +1908,21 @@ components:
1880
1908
  `paused` to pause an active recording
1881
1909
 
1882
1910
  `recording` to resume a paused recording
1911
+ example: paused
1883
1912
  callDirectionEnum:
1884
1913
  type: string
1885
1914
  enum:
1886
1915
  - inbound
1887
1916
  - outbound
1888
1917
  description: The direction of the call.
1918
+ example: inbound
1889
1919
  fileFormatEnum:
1890
1920
  type: string
1891
1921
  enum:
1892
1922
  - mp3
1893
1923
  - wav
1894
- description: The format that the recording is stored in
1924
+ description: The format that the recording is stored in.
1925
+ example: wav
1895
1926
  callStateEnum:
1896
1927
  nullable: true
1897
1928
  type: string
@@ -1909,6 +1940,7 @@ components:
1909
1940
  unanswered
1910
1941
 
1911
1942
  inbound call
1943
+ example: completed
1912
1944
  conferenceStateEnum:
1913
1945
  nullable: true
1914
1946
  type: string
@@ -1918,7 +1950,8 @@ components:
1918
1950
  - completed
1919
1951
  description: >-
1920
1952
  Setting the conference state to `completed` ends the conference and
1921
- ejects all members
1953
+ ejects all members.
1954
+ example: completed
1922
1955
  machineDetectionModeEnum:
1923
1956
  type: string
1924
1957
  default: async
@@ -1934,6 +1967,7 @@ components:
1934
1967
  complete
1935
1968
 
1936
1969
  and will include its result.
1970
+ example: async
1937
1971
  createCall:
1938
1972
  type: object
1939
1973
  required:
@@ -1944,9 +1978,11 @@ components:
1944
1978
  properties:
1945
1979
  to:
1946
1980
  type: string
1947
- description: |-
1981
+ description: >-
1948
1982
  The destination to call (must be an E.164 formatted number
1949
- (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.com`)).
1983
+
1984
+ (e.g. `+15555551212`) or a SIP URI (e.g.
1985
+ `sip:user@server.example`)).
1950
1986
  example: '+19195551234'
1951
1987
  from:
1952
1988
  type: string
@@ -1962,7 +1998,7 @@ components:
1962
1998
  nullable: true
1963
1999
  type: string
1964
2000
  example: >-
1965
- eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ=;encoding=base64
2001
+ eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64
1966
2002
  description: >-
1967
2003
  A comma-separated list of 'User-To-User' headers to be sent
1968
2004
 
@@ -1996,9 +2032,9 @@ components:
1996
2032
  call.
1997
2033
 
1998
2034
 
1999
- Must use `https` if specifying `username` and `password`
2035
+ Must use `https` if specifying `username` and `password`.
2000
2036
  maxLength: 2048
2001
- example: https://www.myCallbackServer.com/webhooks/answer
2037
+ example: https://www.myCallbackServer.example/webhooks/answer
2002
2038
  answerMethod:
2003
2039
  $ref: '#/components/schemas/callbackMethodEnum'
2004
2040
  username:
@@ -2024,9 +2060,9 @@ components:
2024
2060
 
2025
2061
 
2026
2062
  Must use `https` if specifying `fallbackUsername` and
2027
- `fallbackPassword`
2063
+ `fallbackPassword`.
2028
2064
  maxLength: 2048
2029
- example: https://www.myFallbackServer.com/webhooks/answer
2065
+ example: https://www.myFallbackServer.example/webhooks/answer
2030
2066
  answerFallbackMethod:
2031
2067
  $ref: '#/components/schemas/callbackMethodEnum'
2032
2068
  fallbackUsername:
@@ -2050,6 +2086,7 @@ components:
2050
2086
  href='/docs/voice/webhooks/disconnect'>Disconnect</a> event to when
2051
2087
  the call ends. This event does not expect a BXML response.
2052
2088
  maxLength: 2048
2089
+ example: https://www.myCallbackServer.example/webhooks/disconnect
2053
2090
  disconnectMethod:
2054
2091
  $ref: '#/components/schemas/callbackMethodEnum'
2055
2092
  callTimeout:
@@ -2069,6 +2106,7 @@ components:
2069
2106
  minimum: 1
2070
2107
  maximum: 300
2071
2108
  default: 30
2109
+ example: 30
2072
2110
  callbackTimeout:
2073
2111
  nullable: true
2074
2112
  type: number
@@ -2083,6 +2121,7 @@ components:
2083
2121
  minimum: 1
2084
2122
  maximum: 25
2085
2123
  default: 15
2124
+ example: 15
2086
2125
  machineDetection:
2087
2126
  $ref: '#/components/schemas/machineDetectionConfiguration'
2088
2127
  priority:
@@ -2108,6 +2147,7 @@ components:
2108
2147
  takes
2109
2148
 
2110
2149
  precedence over a priority 2 call.
2150
+ example: 5
2111
2151
  tag:
2112
2152
  nullable: true
2113
2153
  type: string
@@ -2124,7 +2164,8 @@ components:
2124
2164
 
2125
2165
 
2126
2166
  Max length 256 characters.
2127
- maximum: 256
2167
+ maxLength: 256
2168
+ example: arbitrary text here
2128
2169
  createCallResponse:
2129
2170
  type: object
2130
2171
  required:
@@ -2145,31 +2186,31 @@ components:
2145
2186
  accountId:
2146
2187
  type: string
2147
2188
  example: '9900000'
2148
- description: The bandwidth account ID associated with the call
2189
+ description: The bandwidth account ID associated with the call.
2149
2190
  callId:
2150
2191
  type: string
2151
2192
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
2152
- description: Programmable Voice API Call ID
2193
+ description: Programmable Voice API Call ID.
2153
2194
  to:
2154
2195
  type: string
2155
2196
  example: '+19195551234'
2156
- description: Recipient of the outgoing call
2197
+ description: Recipient of the outgoing call.
2157
2198
  from:
2158
2199
  type: string
2159
2200
  example: '+19195554321'
2160
- description: Phone number that created the outbound call
2201
+ description: Phone number that created the outbound call.
2161
2202
  enqueuedTime:
2162
2203
  nullable: true
2163
2204
  type: string
2164
2205
  format: date-time
2165
- description: Time the call was accepted into the queue
2206
+ description: The time at which the call was accepted into the queue.
2166
2207
  example: '2022-06-16T13:15:07.160Z'
2167
2208
  callUrl:
2168
2209
  type: string
2169
2210
  format: uri
2170
2211
  example: >-
2171
2212
  https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
2172
- description: The URL to update call state
2213
+ description: The URL to update this call's state.
2173
2214
  callTimeout:
2174
2215
  type: number
2175
2216
  format: double
@@ -2188,13 +2229,13 @@ components:
2188
2229
  nullable: true
2189
2230
  type: string
2190
2231
  example: My custom tag value
2191
- description: Custom tag value
2232
+ description: Custom tag value.
2192
2233
  answerMethod:
2193
2234
  $ref: '#/components/schemas/callbackMethodEnum'
2194
2235
  answerUrl:
2195
2236
  type: string
2196
2237
  format: uri
2197
- example: https://myServer.com/bandwidth/webhooks/answer
2238
+ example: https://myServer.example/bandwidth/webhooks/answer
2198
2239
  description: URL to deliver the `answer` event webhook.
2199
2240
  answerFallbackMethod:
2200
2241
  $ref: '#/components/schemas/callbackMethodEnum'
@@ -2202,7 +2243,7 @@ components:
2202
2243
  nullable: true
2203
2244
  type: string
2204
2245
  format: uri
2205
- example: https://myFallbackServer.com/bandwidth/webhooks/answer
2246
+ example: https://myFallbackServer.example/bandwidth/webhooks/answer
2206
2247
  description: Fallback URL to deliver the `answer` event webhook.
2207
2248
  disconnectMethod:
2208
2249
  $ref: '#/components/schemas/callbackMethodEnum'
@@ -2210,7 +2251,7 @@ components:
2210
2251
  nullable: true
2211
2252
  type: string
2212
2253
  format: uri
2213
- example: https://myServer.com/bandwidth/webhooks/disconnect
2254
+ example: https://myServer.example/bandwidth/webhooks/disconnect
2214
2255
  description: URL to deliver the `disconnect` event webhook.
2215
2256
  username:
2216
2257
  type: string
@@ -2238,8 +2279,7 @@ components:
2238
2279
  example: mySecretPassword1!
2239
2280
  priority:
2240
2281
  nullable: true
2241
- type: number
2242
- format: integer
2282
+ type: integer
2243
2283
  example: 5
2244
2284
  description: The priority of this call over other calls from your account.
2245
2285
  callState:
@@ -2268,7 +2308,7 @@ components:
2268
2308
  type: string
2269
2309
  description: >-
2270
2310
  The phone number that received the call, in E.164 format (e.g.
2271
- +15555555555), or if the call was to a SIP URI, the SIP URI
2311
+ +15555555555), or if the call was to a SIP URI, the SIP URI.
2272
2312
  example: '+19195551234'
2273
2313
  from:
2274
2314
  type: string
@@ -2323,7 +2363,7 @@ components:
2323
2363
 
2324
2364
 
2325
2365
  More information: [Understanding
2326
- STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken)
2366
+ STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
2327
2367
  additionalProperties:
2328
2368
  type: string
2329
2369
  example:
@@ -2449,7 +2489,7 @@ components:
2449
2489
  nullable: true
2450
2490
  type: string
2451
2491
  format: uri
2452
- example: https://myServer.com/bandwidth/webhooks/redirect
2492
+ example: https://myServer.example/bandwidth/webhooks/redirect
2453
2493
  redirectMethod:
2454
2494
  $ref: '#/components/schemas/redirectMethodEnum'
2455
2495
  username:
@@ -2470,8 +2510,8 @@ components:
2470
2510
  format: uri
2471
2511
  description: |-
2472
2512
  A fallback url which, if provided, will be used to retry the
2473
- redirect callback delivery in case `redirectUrl` fails to respond
2474
- example: https://myFallbackServer.com/bandwidth/webhooks/redirect
2513
+ redirect callback delivery in case `redirectUrl` fails to respond.
2514
+ example: https://myFallbackServer.example/bandwidth/webhooks/redirect
2475
2515
  redirectFallbackMethod:
2476
2516
  $ref: '#/components/schemas/redirectMethodEnum'
2477
2517
  fallbackUsername:
@@ -2505,7 +2545,7 @@ components:
2505
2545
 
2506
2546
 
2507
2547
  Not allowed if `state` is `completed`.
2508
- maximum: 256
2548
+ maxLength: 256
2509
2549
  example: My Custom Tag
2510
2550
  updateCallRecording:
2511
2551
  type: object
@@ -2571,11 +2611,11 @@ components:
2571
2611
  properties:
2572
2612
  id:
2573
2613
  type: string
2574
- description: The Bandwidth-generated conference ID
2614
+ description: The Bandwidth-generated conference ID.
2575
2615
  example: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
2576
2616
  name:
2577
2617
  type: string
2578
- description: The name of the conference, as specified by your application
2618
+ description: The name of the conference, as specified by your application.
2579
2619
  example: my-conference-name
2580
2620
  createdTime:
2581
2621
  type: string
@@ -2593,7 +2633,7 @@ components:
2593
2633
  type: string
2594
2634
  format: uri
2595
2635
  description: The URL to send the conference-related events.
2596
- example: https://myServer.com/bandwidth/webhooks/conferenceEvent
2636
+ example: https://myServer.example/bandwidth/webhooks/conferenceEvent
2597
2637
  conferenceEventMethod:
2598
2638
  $ref: '#/components/schemas/callbackMethodEnum'
2599
2639
  tag:
@@ -2612,7 +2652,7 @@ components:
2612
2652
  A list of active members of the conference. Omitted if this
2613
2653
 
2614
2654
  is a response to the [Get Conferences
2615
- endpoint](/apis/voice#tag/Conferences/operation/listConferences)
2655
+ endpoint](/apis/voice#tag/Conferences/operation/listConferences).
2616
2656
  updateConference:
2617
2657
  type: object
2618
2658
  properties:
@@ -2629,8 +2669,8 @@ components:
2629
2669
  event which will provide new BXML. Not allowed if `state` is
2630
2670
  `completed`,
2631
2671
 
2632
- but required if `state` is `active`
2633
- example: https://myServer.com/bandwidth/webhooks/conferenceRedirect
2672
+ but required if `state` is `active`.
2673
+ example: https://myServer.example/bandwidth/webhooks/conferenceRedirect
2634
2674
  redirectMethod:
2635
2675
  $ref: '#/components/schemas/redirectMethodEnum'
2636
2676
  username:
@@ -2656,7 +2696,8 @@ components:
2656
2696
  respond. Not
2657
2697
 
2658
2698
  allowed if `state` is `completed`.
2659
- example: https://myFallbackServer.com/bandwidth/webhooks/conferenceRedirect
2699
+ example: >-
2700
+ https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect
2660
2701
  redirectFallbackMethod:
2661
2702
  $ref: '#/components/schemas/redirectMethodEnum'
2662
2703
  fallbackUsername:
@@ -2899,7 +2940,7 @@ components:
2899
2940
  type: string
2900
2941
  format: uri
2901
2942
  maxLength: 2048
2902
- example: https://myServer.com/bandwidth/webhooks/machineDetectionComplete
2943
+ example: https://myServer.example/bandwidth/webhooks/machineDetectionComplete
2903
2944
  callbackMethod:
2904
2945
  $ref: '#/components/schemas/callbackMethodEnum'
2905
2946
  username:
@@ -2927,7 +2968,7 @@ components:
2927
2968
  to respond
2928
2969
  maxLength: 2048
2929
2970
  example: >-
2930
- https://myFallbackServer.com/bandwidth/webhooks/machineDetectionComplete
2971
+ https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete
2931
2972
  fallbackMethod:
2932
2973
  $ref: '#/components/schemas/callbackMethodEnum'
2933
2974
  fallbackUsername:
@@ -2959,7 +3000,7 @@ components:
2959
3000
  and
2960
3001
 
2961
3002
  password fields for authorization.
2962
- example: https://myServer.com/bandwidth/webhooks/transcriptionAvailable
3003
+ example: https://myServer.example/bandwidth/webhooks/transcriptionAvailable
2963
3004
  callbackMethod:
2964
3005
  $ref: '#/components/schemas/callbackMethodEnum'
2965
3006
  username:
@@ -2991,6 +3032,16 @@ components:
2991
3032
 
2992
3033
  between 1 and 25.
2993
3034
  example: 5.5
3035
+ detectLanguage:
3036
+ type: boolean
3037
+ nullable: true
3038
+ description: >-
3039
+ A boolean value to indicate that the recording may not be in
3040
+ English, and the transcription service will need to detect the
3041
+ dominant language the recording is in and transcribe accordingly.
3042
+ Current supported languages are English, French, and Spanish.
3043
+ default: false
3044
+ example: true
2994
3045
  transcriptionList:
2995
3046
  type: object
2996
3047
  properties:
@@ -3814,10 +3865,12 @@ components:
3814
3865
  example: bridgeComplete
3815
3866
  eventTime:
3816
3867
  type: string
3868
+ format: date-time
3817
3869
  description: >-
3818
3870
  The approximate UTC date and time when the event was generated by the
3819
3871
  Bandwidth server, in ISO 8601 format. This may not be exactly the time
3820
3872
  of event execution.
3873
+ example: '2022-06-17T22:19:40.375Z'
3821
3874
  accountId:
3822
3875
  type: string
3823
3876
  description: The user account associated with the call.
@@ -3979,7 +4032,7 @@ components:
3979
4032
  example: 4642074b-7b58-478b-96e4-3a60955c6765
3980
4033
  nullable: true
3981
4034
  machineDetectionResult:
3982
- type: string
4035
+ type: object
3983
4036
  description: >-
3984
4037
  (optional) if machine detection was requested in sync mode, the result
3985
4038
  will be specified here. Possible values are the same as the async
@@ -4553,7 +4606,7 @@ components:
4553
4606
  description: Too Many Requests
4554
4607
  headers:
4555
4608
  Retry-After:
4556
- description: When you should try your request again
4609
+ description: When you should try your request again.
4557
4610
  schema:
4558
4611
  type: string
4559
4612
  content:
@@ -4870,6 +4923,14 @@ components:
4870
4923
  example: 2022-09-14T18:20:16.000Z
4871
4924
  schema:
4872
4925
  type: string
4926
+ campaignId:
4927
+ in: query
4928
+ name: campaignId
4929
+ required: false
4930
+ description: The campaign ID of the message.
4931
+ example: CJEUMDK
4932
+ schema:
4933
+ type: string
4873
4934
  sort:
4874
4935
  in: query
4875
4936
  name: sort
@@ -4898,21 +4959,26 @@ components:
4898
4959
  schema:
4899
4960
  type: integer
4900
4961
  example: 50
4901
- accountId1:
4902
- name: accountId
4903
- in: path
4904
- required: true
4962
+ limitTotalCount:
4963
+ in: query
4964
+ name: limitTotalCount
4965
+ required: false
4966
+ description: >-
4967
+ When set to true, the response's totalCount field will have a maximum
4968
+ value of 10,000. When set to false, or excluded, this will give an
4969
+ accurate totalCount of all messages that match the provided filters. If
4970
+ you are experiencing latency, try using this parameter to limit your
4971
+ results.
4972
+ example: true
4905
4973
  schema:
4906
- type: string
4907
- description: Your Bandwidth Account ID
4908
- example: '9900000'
4974
+ type: boolean
4909
4975
  callId:
4910
4976
  name: callId
4911
4977
  in: path
4912
4978
  required: true
4913
4979
  schema:
4914
4980
  type: string
4915
- description: Programmable Voice API Call ID
4981
+ description: Programmable Voice API Call ID.
4916
4982
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
4917
4983
  recordingId:
4918
4984
  name: recordingId
@@ -4920,7 +4986,7 @@ components:
4920
4986
  required: true
4921
4987
  schema:
4922
4988
  type: string
4923
- description: Programmable Voice API Recording ID
4989
+ description: Programmable Voice API Recording ID.
4924
4990
  example: r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
4925
4991
  conferenceId:
4926
4992
  name: conferenceId
@@ -4928,7 +4994,7 @@ components:
4928
4994
  required: true
4929
4995
  schema:
4930
4996
  type: string
4931
- description: Programmable Voice API Conference ID
4997
+ description: Programmable Voice API Conference ID.
4932
4998
  example: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
4933
4999
  memberId:
4934
5000
  name: memberId
@@ -4936,7 +5002,7 @@ components:
4936
5002
  required: true
4937
5003
  schema:
4938
5004
  type: string
4939
- description: Programmable Voice API Conference Member ID
5005
+ description: Programmable Voice API Conference Member ID.
4940
5006
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
4941
5007
  to:
4942
5008
  name: to
@@ -5024,23 +5090,6 @@ components:
5024
5090
  Not intended for explicit use. To use pagination, follow the links in
5025
5091
  the `Link` header of the response, as indicated in the endpoint
5026
5092
  description.
5027
- accountId2:
5028
- name: accountId
5029
- description: Bandwidth Account ID with Voice service enabled.
5030
- in: path
5031
- required: true
5032
- style: simple
5033
- explode: false
5034
- schema:
5035
- type: string
5036
- accountId3:
5037
- name: accountId
5038
- in: path
5039
- required: true
5040
- schema:
5041
- type: string
5042
- description: The ID of the Bandwidth account that the user belongs to.
5043
- example: '9900000'
5044
5093
  requestId:
5045
5094
  name: requestId
5046
5095
  in: path
@@ -5271,7 +5320,7 @@ components:
5271
5320
  value: |-
5272
5321
  <?xml version=\"1.0\" encoding=\"UTF-8\"?>
5273
5322
  <Bxml>
5274
- <Redirect redirectUrl="https://test.com" redirectMethod="GET"/>
5323
+ <Redirect redirectUrl="https://test.example" redirectMethod="GET"/>
5275
5324
  </Bxml>
5276
5325
  updateCallRecordingRequest:
5277
5326
  required: true
@@ -5395,10 +5444,10 @@ components:
5395
5444
  callbackTimeout: 15
5396
5445
  tag: My custom tag value
5397
5446
  answerMethod: POST
5398
- answerUrl: https://myServer.com/bandwidth/webhooks/answer
5447
+ answerUrl: https://myServer.example/bandwidth/webhooks/answer
5399
5448
  answerFallbackMethod: POST
5400
5449
  disconnectMethod: POST
5401
- disconnectUrl: https://myServer.com/bandwidth/webhooks/disconnect
5450
+ disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect
5402
5451
  username: mySecretUsername
5403
5452
  password: '*****'
5404
5453
  fallbackUsername: mySecretUsername
@@ -5411,54 +5460,54 @@ components:
5411
5460
  name: my-conference-name
5412
5461
  createdTime: '2022-06-17T22:19:40.375Z'
5413
5462
  completedTime: '2022-06-17T22:20:00.000Z'
5414
- conferenceEventUrl: https://myServer.com/bandwidth/webhooks/conferenceEvent
5463
+ conferenceEventUrl: https://myServer.example/bandwidth/webhooks/conferenceEvent
5415
5464
  conferenceEventMethod: POST
5416
5465
  tag: my custom tag
5417
5466
  voiceBadRequestErrorExample:
5418
5467
  summary: Example of a Bad Request (400) Error
5419
5468
  value:
5420
5469
  type: validation
5421
- description: 'Invalid answerUrl: only http and https are allowed'
5470
+ description: 'Invalid answerUrl: only http and https are allowed.'
5422
5471
  voiceUnauthorizedErrorExample:
5423
5472
  summary: Example of an Unauthorized (401) Error
5424
5473
  value:
5425
5474
  type: validation
5426
- description: 'Invalid answerUrl: only http and https are allowed'
5475
+ description: 'Invalid answerUrl: only http and https are allowed.'
5427
5476
  voiceForbiddenErrorExample:
5428
5477
  summary: Example of a Forbidden (403) Error
5429
5478
  value:
5430
5479
  type: validation
5431
- description: 'Invalid answerUrl: only http and https are allowed'
5480
+ description: 'Invalid answerUrl: only http and https are allowed.'
5432
5481
  voiceNotFoundErrorExample:
5433
5482
  summary: Example of a Not Found (404) Error
5434
5483
  value:
5435
5484
  type: validation
5436
- description: 'Invalid answerUrl: only http and https are allowed'
5485
+ description: 'Invalid answerUrl: only http and https are allowed.'
5437
5486
  voiceNotAllowedErrorExample:
5438
5487
  summary: Example of a Not Allowed (405) Error
5439
5488
  value:
5440
5489
  type: validation
5441
- description: 'Invalid answerUrl: only http and https are allowed'
5490
+ description: 'Invalid answerUrl: only http and https are allowed.'
5442
5491
  voiceConflictErrorExample:
5443
5492
  summary: Example of a Conflict (409) Error
5444
5493
  value:
5445
5494
  type: validation
5446
- description: 'Invalid answerUrl: only http and https are allowed'
5495
+ description: 'Invalid answerUrl: only http and https are allowed.'
5447
5496
  voiceUnsupportedMediaTypeErrorExample:
5448
5497
  summary: Example of an Unsupported Media Type (415) Error
5449
5498
  value:
5450
5499
  type: validation
5451
- description: 'Invalid answerUrl: only http and https are allowed'
5500
+ description: 'Invalid answerUrl: only http and https are allowed.'
5452
5501
  voiceTooManyRequestsErrorExample:
5453
5502
  summary: Example of a Too Many Requests (429) Error
5454
5503
  value:
5455
5504
  type: validation
5456
- description: 'Invalid answerUrl: only http and https are allowed'
5505
+ description: 'Invalid answerUrl: only http and https are allowed.'
5457
5506
  voiceInternalServerErrorExample:
5458
5507
  summary: Example of an Internal Server (500) Error
5459
5508
  value:
5460
5509
  type: validation
5461
- description: 'Invalid answerUrl: only http and https are allowed'
5510
+ description: 'Invalid answerUrl: only http and https are allowed.'
5462
5511
  singleNumberRequestExample:
5463
5512
  summary: Example Number Lookup Request for One Number
5464
5513
  value: