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
@@ -36,9 +36,9 @@ Bandwidth.configure do |config|
36
36
  end
37
37
 
38
38
  api_instance = Bandwidth::ConferencesApi.new
39
- account_id = '9900000' # String | Your Bandwidth Account ID
40
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
41
- recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID
39
+ account_id = '9900000' # String | Your Bandwidth Account ID.
40
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
41
+ recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
42
42
 
43
43
  begin
44
44
  # Download Conference Recording
@@ -71,9 +71,9 @@ end
71
71
 
72
72
  | Name | Type | Description | Notes |
73
73
  | ---- | ---- | ----------- | ----- |
74
- | **account_id** | **String** | Your Bandwidth Account ID | |
75
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
76
- | **recording_id** | **String** | Programmable Voice API Recording ID | |
74
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
75
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
76
+ | **recording_id** | **String** | Programmable Voice API Recording ID. | |
77
77
 
78
78
  ### Return type
79
79
 
@@ -110,8 +110,8 @@ Bandwidth.configure do |config|
110
110
  end
111
111
 
112
112
  api_instance = Bandwidth::ConferencesApi.new
113
- account_id = '9900000' # String | Your Bandwidth Account ID
114
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
113
+ account_id = '9900000' # String | Your Bandwidth Account ID.
114
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
115
115
 
116
116
  begin
117
117
  # Get Conference Information
@@ -144,8 +144,8 @@ end
144
144
 
145
145
  | Name | Type | Description | Notes |
146
146
  | ---- | ---- | ----------- | ----- |
147
- | **account_id** | **String** | Your Bandwidth Account ID | |
148
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
147
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
148
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
149
149
 
150
150
  ### Return type
151
151
 
@@ -182,9 +182,9 @@ Bandwidth.configure do |config|
182
182
  end
183
183
 
184
184
  api_instance = Bandwidth::ConferencesApi.new
185
- account_id = '9900000' # String | Your Bandwidth Account ID
186
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
187
- member_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Conference Member ID
185
+ account_id = '9900000' # String | Your Bandwidth Account ID.
186
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
187
+ member_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Conference Member ID.
188
188
 
189
189
  begin
190
190
  # Get Conference Member
@@ -217,9 +217,9 @@ end
217
217
 
218
218
  | Name | Type | Description | Notes |
219
219
  | ---- | ---- | ----------- | ----- |
220
- | **account_id** | **String** | Your Bandwidth Account ID | |
221
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
222
- | **member_id** | **String** | Programmable Voice API Conference Member ID | |
220
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
221
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
222
+ | **member_id** | **String** | Programmable Voice API Conference Member ID. | |
223
223
 
224
224
  ### Return type
225
225
 
@@ -256,9 +256,9 @@ Bandwidth.configure do |config|
256
256
  end
257
257
 
258
258
  api_instance = Bandwidth::ConferencesApi.new
259
- account_id = '9900000' # String | Your Bandwidth Account ID
260
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
261
- recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID
259
+ account_id = '9900000' # String | Your Bandwidth Account ID.
260
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
261
+ recording_id = 'r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Recording ID.
262
262
 
263
263
  begin
264
264
  # Get Conference Recording Information
@@ -291,9 +291,9 @@ end
291
291
 
292
292
  | Name | Type | Description | Notes |
293
293
  | ---- | ---- | ----------- | ----- |
294
- | **account_id** | **String** | Your Bandwidth Account ID | |
295
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
296
- | **recording_id** | **String** | Programmable Voice API Recording ID | |
294
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
295
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
296
+ | **recording_id** | **String** | Programmable Voice API Recording ID. | |
297
297
 
298
298
  ### Return type
299
299
 
@@ -330,8 +330,8 @@ Bandwidth.configure do |config|
330
330
  end
331
331
 
332
332
  api_instance = Bandwidth::ConferencesApi.new
333
- account_id = '9900000' # String | Your Bandwidth Account ID
334
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
333
+ account_id = '9900000' # String | Your Bandwidth Account ID.
334
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
335
335
 
336
336
  begin
337
337
  # Get Conference Recordings
@@ -364,8 +364,8 @@ end
364
364
 
365
365
  | Name | Type | Description | Notes |
366
366
  | ---- | ---- | ----------- | ----- |
367
- | **account_id** | **String** | Your Bandwidth Account ID | |
368
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
367
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
368
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
369
369
 
370
370
  ### Return type
371
371
 
@@ -402,7 +402,7 @@ Bandwidth.configure do |config|
402
402
  end
403
403
 
404
404
  api_instance = Bandwidth::ConferencesApi.new
405
- account_id = '9900000' # String | Your Bandwidth Account ID
405
+ account_id = '9900000' # String | Your Bandwidth Account ID.
406
406
  opts = {
407
407
  name: 'my-custom-name', # String | Filter results by the `name` field.
408
408
  min_created_time: '2022-06-21T19:13:21Z', # String | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format).
@@ -442,7 +442,7 @@ end
442
442
 
443
443
  | Name | Type | Description | Notes |
444
444
  | ---- | ---- | ----------- | ----- |
445
- | **account_id** | **String** | Your Bandwidth Account ID | |
445
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
446
446
  | **name** | **String** | Filter results by the `name` field. | [optional] |
447
447
  | **min_created_time** | **String** | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). | [optional] |
448
448
  | **max_created_time** | **String** | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). | [optional] |
@@ -484,8 +484,8 @@ Bandwidth.configure do |config|
484
484
  end
485
485
 
486
486
  api_instance = Bandwidth::ConferencesApi.new
487
- account_id = '9900000' # String | Your Bandwidth Account ID
488
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
487
+ account_id = '9900000' # String | Your Bandwidth Account ID.
488
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
489
489
  update_conference = Bandwidth::UpdateConference.new # UpdateConference |
490
490
 
491
491
  begin
@@ -518,8 +518,8 @@ end
518
518
 
519
519
  | Name | Type | Description | Notes |
520
520
  | ---- | ---- | ----------- | ----- |
521
- | **account_id** | **String** | Your Bandwidth Account ID | |
522
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
521
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
522
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
523
523
  | **update_conference** | [**UpdateConference**](UpdateConference.md) | | |
524
524
 
525
525
  ### Return type
@@ -557,8 +557,8 @@ Bandwidth.configure do |config|
557
557
  end
558
558
 
559
559
  api_instance = Bandwidth::ConferencesApi.new
560
- account_id = '9900000' # String | Your Bandwidth Account ID
561
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
560
+ account_id = '9900000' # String | Your Bandwidth Account ID.
561
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
562
562
  body = '<?xml version="1.0" encoding="UTF-8"?>
563
563
  <Bxml>
564
564
  <StopRecording/>
@@ -594,8 +594,8 @@ end
594
594
 
595
595
  | Name | Type | Description | Notes |
596
596
  | ---- | ---- | ----------- | ----- |
597
- | **account_id** | **String** | Your Bandwidth Account ID | |
598
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
597
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
598
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
599
599
  | **body** | **String** | | |
600
600
 
601
601
  ### Return type
@@ -633,9 +633,9 @@ Bandwidth.configure do |config|
633
633
  end
634
634
 
635
635
  api_instance = Bandwidth::ConferencesApi.new
636
- account_id = '9900000' # String | Your Bandwidth Account ID
637
- conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID
638
- member_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Conference Member ID
636
+ account_id = '9900000' # String | Your Bandwidth Account ID.
637
+ conference_id = 'conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9' # String | Programmable Voice API Conference ID.
638
+ member_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Conference Member ID.
639
639
  update_conference_member = Bandwidth::UpdateConferenceMember.new # UpdateConferenceMember |
640
640
 
641
641
  begin
@@ -668,9 +668,9 @@ end
668
668
 
669
669
  | Name | Type | Description | Notes |
670
670
  | ---- | ---- | ----------- | ----- |
671
- | **account_id** | **String** | Your Bandwidth Account ID | |
672
- | **conference_id** | **String** | Programmable Voice API Conference ID | |
673
- | **member_id** | **String** | Programmable Voice API Conference Member ID | |
671
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
672
+ | **conference_id** | **String** | Programmable Voice API Conference ID. | |
673
+ | **member_id** | **String** | Programmable Voice API Conference Member ID. | |
674
674
  | **update_conference_member** | [**UpdateConferenceMember**](UpdateConferenceMember.md) | | |
675
675
 
676
676
  ### Return type
data/docs/CreateCall.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **to** | **String** | The destination to call (must be an E.164 formatted number (e.g. &#x60;+15555551212&#x60;) or a SIP URI (e.g. &#x60;sip:user@server.com&#x60;)). | |
7
+ | **to** | **String** | The destination to call (must be an E.164 formatted number (e.g. &#x60;+15555551212&#x60;) or a SIP URI (e.g. &#x60;sip:user@server.example&#x60;)). | |
8
8
  | **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like &#x60;+15555551212&#x60;, or be one of the following strings: &#x60;Restricted&#x60;, &#x60;Anonymous&#x60;, &#x60;Private&#x60;, or &#x60;Unavailable&#x60;). | |
9
9
  | **uui** | **String** | A comma-separated list of &#39;User-To-User&#39; headers to be sent in the INVITE when calling a SIP URI. Each value must end with an &#39;encoding&#39; parameter as described in &lt;a href&#x3D;&#39;https://tools.ietf.org/html/rfc7433&#39;&gt;RFC 7433&lt;/a&gt;. Only &#39;jwt&#39; and &#39;base64&#39; encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the &#x60;from&#x60; number. | |
11
- | **answer_url** | **String** | The full URL to send the &lt;a href&#x3D;&#39;/docs/voice/webhooks/answer&#39;&gt;Answer&lt;/a&gt; event to when the called party answers. This endpoint should return the first &lt;a href&#x3D;&#39;/docs/voice/bxml&#39;&gt;BXML document&lt;/a&gt; to be executed in the call. Must use &#x60;https&#x60; if specifying &#x60;username&#x60; and &#x60;password&#x60; | |
11
+ | **answer_url** | **String** | The full URL to send the &lt;a href&#x3D;&#39;/docs/voice/webhooks/answer&#39;&gt;Answer&lt;/a&gt; event to when the called party answers. This endpoint should return the first &lt;a href&#x3D;&#39;/docs/voice/bxml&#39;&gt;BXML document&lt;/a&gt; to be executed in the call. Must use &#x60;https&#x60; if specifying &#x60;username&#x60; and &#x60;password&#x60;. | |
12
12
  | **answer_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to &#39;POST&#39;] |
13
13
  | **username** | **String** | Basic auth username. | [optional] |
14
14
  | **password** | **String** | Basic auth password. | [optional] |
15
- | **answer_fallback_url** | **String** | A fallback url which, if provided, will be used to retry the &#x60;answer&#x60; webhook delivery in case &#x60;answerUrl&#x60; fails to respond Must use &#x60;https&#x60; if specifying &#x60;fallbackUsername&#x60; and &#x60;fallbackPassword&#x60; | [optional] |
15
+ | **answer_fallback_url** | **String** | A fallback url which, if provided, will be used to retry the &#x60;answer&#x60; webhook delivery in case &#x60;answerUrl&#x60; fails to respond Must use &#x60;https&#x60; if specifying &#x60;fallbackUsername&#x60; and &#x60;fallbackPassword&#x60;. | [optional] |
16
16
  | **answer_fallback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to &#39;POST&#39;] |
17
17
  | **fallback_username** | **String** | Basic auth username. | [optional] |
18
18
  | **fallback_password** | **String** | Basic auth password. | [optional] |
@@ -32,23 +32,23 @@ require 'bandwidth-sdk'
32
32
  instance = Bandwidth::CreateCall.new(
33
33
  to: +19195551234,
34
34
  from: +19195554321,
35
- uui: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding&#x3D;jwt,aGVsbG8gd29ybGQ&#x3D;;encoding&#x3D;base64,
35
+ uui: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding&#x3D;jwt,aGVsbG8gd29ybGQ;encoding&#x3D;base64,
36
36
  application_id: 1234-qwer-5679-tyui,
37
- answer_url: https://www.myCallbackServer.com/webhooks/answer,
37
+ answer_url: https://www.myCallbackServer.example/webhooks/answer,
38
38
  answer_method: null,
39
39
  username: mySecretUsername,
40
40
  password: mySecretPassword1!,
41
- answer_fallback_url: https://www.myFallbackServer.com/webhooks/answer,
41
+ answer_fallback_url: https://www.myFallbackServer.example/webhooks/answer,
42
42
  answer_fallback_method: null,
43
43
  fallback_username: mySecretUsername,
44
44
  fallback_password: mySecretPassword1!,
45
- disconnect_url: null,
45
+ disconnect_url: https://www.myCallbackServer.example/webhooks/disconnect,
46
46
  disconnect_method: null,
47
- call_timeout: null,
48
- callback_timeout: null,
47
+ call_timeout: 30,
48
+ callback_timeout: 15,
49
49
  machine_detection: null,
50
- priority: null,
51
- tag: null
50
+ priority: 5,
51
+ tag: arbitrary text here
52
52
  )
53
53
  ```
54
54
 
@@ -5,15 +5,15 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **application_id** | **String** | The id of the application associated with the &#x60;from&#x60; number. | |
8
- | **account_id** | **String** | The bandwidth account ID associated with the call | |
9
- | **call_id** | **String** | Programmable Voice API Call ID | |
10
- | **to** | **String** | Recipient of the outgoing call | |
11
- | **from** | **String** | Phone number that created the outbound call | |
12
- | **enqueued_time** | **Time** | Time the call was accepted into the queue | [optional] |
13
- | **call_url** | **String** | The URL to update call state | |
8
+ | **account_id** | **String** | The bandwidth account ID associated with the call. | |
9
+ | **call_id** | **String** | Programmable Voice API Call ID. | |
10
+ | **to** | **String** | Recipient of the outgoing call. | |
11
+ | **from** | **String** | Phone number that created the outbound call. | |
12
+ | **enqueued_time** | **Time** | The time at which the call was accepted into the queue. | [optional] |
13
+ | **call_url** | **String** | The URL to update this call&#39;s state. | |
14
14
  | **call_timeout** | **Float** | The timeout (in seconds) for the callee to answer the call after it starts ringing. | [optional] |
15
15
  | **callback_timeout** | **Float** | This is the timeout (in seconds) to use when delivering webhooks for the call. | [optional] |
16
- | **tag** | **String** | Custom tag value | [optional] |
16
+ | **tag** | **String** | Custom tag value. | [optional] |
17
17
  | **answer_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [default to &#39;POST&#39;] |
18
18
  | **answer_url** | **String** | URL to deliver the &#x60;answer&#x60; event webhook. | |
19
19
  | **answer_fallback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to &#39;POST&#39;] |
@@ -24,7 +24,7 @@
24
24
  | **password** | **String** | Basic auth password. | [optional] |
25
25
  | **fallback_username** | **String** | Basic auth username. | [optional] |
26
26
  | **fallback_password** | **String** | Basic auth password. | [optional] |
27
- | **priority** | **Float** | The priority of this call over other calls from your account. | [optional] |
27
+ | **priority** | **Integer** | The priority of this call over other calls from your account. | [optional] |
28
28
 
29
29
  ## Example
30
30
 
@@ -43,11 +43,11 @@ instance = Bandwidth::CreateCallResponse.new(
43
43
  callback_timeout: 15,
44
44
  tag: My custom tag value,
45
45
  answer_method: null,
46
- answer_url: https://myServer.com/bandwidth/webhooks/answer,
46
+ answer_url: https://myServer.example/bandwidth/webhooks/answer,
47
47
  answer_fallback_method: null,
48
- answer_fallback_url: https://myFallbackServer.com/bandwidth/webhooks/answer,
48
+ answer_fallback_url: https://myFallbackServer.example/bandwidth/webhooks/answer,
49
49
  disconnect_method: null,
50
- disconnect_url: https://myServer.com/bandwidth/webhooks/disconnect,
50
+ disconnect_url: https://myServer.example/bandwidth/webhooks/disconnect,
51
51
  username: mySecretUsername,
52
52
  password: mySecretPassword1!,
53
53
  fallback_username: mySecretUsername,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
8
+ | **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
11
  | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
@@ -29,7 +29,7 @@ require 'bandwidth-sdk'
29
29
 
30
30
  instance = Bandwidth::DisconnectCallback.new(
31
31
  event_type: bridgeComplete,
32
- event_time: null,
32
+ event_time: 2022-06-17T22:19:40.375Z,
33
33
  account_id: 920012,
34
34
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
35
35
  from: +15555555555,
data/docs/DtmfCallback.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
8
+ | **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
11
  | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
@@ -29,7 +29,7 @@ require 'bandwidth-sdk'
29
29
 
30
30
  instance = Bandwidth::DtmfCallback.new(
31
31
  event_type: bridgeComplete,
32
- event_time: null,
32
+ event_time: 2022-06-17T22:19:40.375Z,
33
33
  account_id: 920012,
34
34
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
35
35
  from: +15555555555,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
8
+ | **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
11
  | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
@@ -30,7 +30,7 @@ require 'bandwidth-sdk'
30
30
 
31
31
  instance = Bandwidth::GatherCallback.new(
32
32
  event_type: bridgeComplete,
33
- event_time: null,
33
+ event_time: 2022-06-17T22:19:40.375Z,
34
34
  account_id: 920012,
35
35
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
36
36
  from: +15555555555,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
8
+ | **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
11
  | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
@@ -24,7 +24,7 @@ require 'bandwidth-sdk'
24
24
 
25
25
  instance = Bandwidth::InitiateCallback.new(
26
26
  event_type: bridgeComplete,
27
- event_time: null,
27
+ event_time: 2022-06-17T22:19:40.375Z,
28
28
  account_id: 920012,
29
29
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
30
30
  from: +15555555555,
@@ -13,13 +13,14 @@
13
13
  | **message_type** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] |
14
14
  | **segment_count** | **Integer** | The number of segments the message was sent as. | [optional] |
15
15
  | **error_code** | **Integer** | The numeric error code of the message. | [optional] |
16
- | **receive_time** | **String** | The ISO 8601 datetime of the message. | [optional] |
16
+ | **receive_time** | **Time** | The ISO 8601 datetime of the message. | [optional] |
17
17
  | **carrier_name** | **String** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] |
18
18
  | **message_size** | **Integer** | The size of the message including message content and headers. | [optional] |
19
19
  | **message_length** | **Integer** | The length of the message content. | [optional] |
20
20
  | **attachment_count** | **Integer** | The number of attachments the message has. | [optional] |
21
21
  | **recipient_count** | **Integer** | The number of recipients the message has. | [optional] |
22
22
  | **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
23
+ | **campaign_id** | **String** | The campaign ID of the message if it has one. | [optional] |
23
24
 
24
25
  ## Example
25
26
 
@@ -36,13 +37,14 @@ instance = Bandwidth::ListMessageItem.new(
36
37
  message_type: null,
37
38
  segment_count: 1,
38
39
  error_code: 9902,
39
- receive_time: 2020-04-07T14:03:07.000Z,
40
+ receive_time: 2020-04-07T14:03:07Z,
40
41
  carrier_name: other,
41
42
  message_size: 27,
42
43
  message_length: 18,
43
44
  attachment_count: 1,
44
45
  recipient_count: 1,
45
- campaign_class: T
46
+ campaign_class: T,
47
+ campaign_id: CJEUMDK
46
48
  )
47
49
  ```
48
50
 
data/docs/MFAApi.md CHANGED
@@ -30,7 +30,7 @@ Bandwidth.configure do |config|
30
30
  end
31
31
 
32
32
  api_instance = Bandwidth::MFAApi.new
33
- account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
33
+ account_id = '9900000' # String | Your Bandwidth Account ID.
34
34
  code_request = Bandwidth::CodeRequest.new({to: '+19195551234', from: '+19195554321', application_id: '66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1', message: 'Your temporary {NAME} {SCOPE} code is {CODE}', digits: 6}) # CodeRequest | MFA code request body.
35
35
 
36
36
  begin
@@ -64,7 +64,7 @@ end
64
64
 
65
65
  | Name | Type | Description | Notes |
66
66
  | ---- | ---- | ----------- | ----- |
67
- | **account_id** | **String** | Bandwidth Account ID with Voice service enabled. | |
67
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
68
68
  | **code_request** | [**CodeRequest**](CodeRequest.md) | MFA code request body. | |
69
69
 
70
70
  ### Return type
@@ -102,7 +102,7 @@ Bandwidth.configure do |config|
102
102
  end
103
103
 
104
104
  api_instance = Bandwidth::MFAApi.new
105
- account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
105
+ account_id = '9900000' # String | Your Bandwidth Account ID.
106
106
  code_request = Bandwidth::CodeRequest.new({to: '+19195551234', from: '+19195554321', application_id: '66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1', message: 'Your temporary {NAME} {SCOPE} code is {CODE}', digits: 6}) # CodeRequest | MFA code request body.
107
107
 
108
108
  begin
@@ -136,7 +136,7 @@ end
136
136
 
137
137
  | Name | Type | Description | Notes |
138
138
  | ---- | ---- | ----------- | ----- |
139
- | **account_id** | **String** | Bandwidth Account ID with Voice service enabled. | |
139
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
140
140
  | **code_request** | [**CodeRequest**](CodeRequest.md) | MFA code request body. | |
141
141
 
142
142
  ### Return type
@@ -174,7 +174,7 @@ Bandwidth.configure do |config|
174
174
  end
175
175
 
176
176
  api_instance = Bandwidth::MFAApi.new
177
- account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
177
+ account_id = '9900000' # String | Your Bandwidth Account ID.
178
178
  verify_code_request = Bandwidth::VerifyCodeRequest.new({to: '+19195551234', expiration_time_in_minutes: 3, code: '123456'}) # VerifyCodeRequest | MFA code verify request body.
179
179
 
180
180
  begin
@@ -208,7 +208,7 @@ end
208
208
 
209
209
  | Name | Type | Description | Notes |
210
210
  | ---- | ---- | ----------- | ----- |
211
- | **account_id** | **String** | Bandwidth Account ID with Voice service enabled. | |
211
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
212
212
  | **verify_code_request** | [**VerifyCodeRequest**](VerifyCodeRequest.md) | MFA code verify request body. | |
213
213
 
214
214
  ### Return type
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
8
+ | **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
9
  | **account_id** | **String** | The user account associated with the call. | [optional] |
10
10
  | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
11
  | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
@@ -17,7 +17,7 @@
17
17
  | **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
18
18
  | **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
19
19
  | **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
20
- | **machine_detection_result** | **String** | (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete | [optional] |
20
+ | **machine_detection_result** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] |
21
21
 
22
22
  ## Example
23
23
 
@@ -26,7 +26,7 @@ require 'bandwidth-sdk'
26
26
 
27
27
  instance = Bandwidth::MachineDetectionCompleteCallback.new(
28
28
  event_type: bridgeComplete,
29
- event_time: null,
29
+ event_time: 2022-06-17T22:19:40.375Z,
30
30
  account_id: 920012,
31
31
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
32
32
  from: +15555555555,
@@ -33,11 +33,11 @@ instance = Bandwidth::MachineDetectionConfiguration.new(
33
33
  speech_end_threshold: 5,
34
34
  machine_speech_end_threshold: 5,
35
35
  delay_result: false,
36
- callback_url: https://myServer.com/bandwidth/webhooks/machineDetectionComplete,
36
+ callback_url: https://myServer.example/bandwidth/webhooks/machineDetectionComplete,
37
37
  callback_method: null,
38
38
  username: mySecretUsername,
39
39
  password: mySecretPassword1!,
40
- fallback_url: https://myFallbackServer.com/bandwidth/webhooks/machineDetectionComplete,
40
+ fallback_url: https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete,
41
41
  fallback_method: null,
42
42
  fallback_username: mySecretUsername,
43
43
  fallback_password: mySecretPassword1!
@@ -0,0 +1,20 @@
1
+ # Bandwidth::MachineDetectionResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **value** | **String** | Possible values are answering-machine, human, silence, timeout, or error. | [optional] |
8
+ | **duration** | **String** | The amount of time it took to determine the result. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bandwidth-sdk'
14
+
15
+ instance = Bandwidth::MachineDetectionResult.new(
16
+ value: answering-machine,
17
+ duration: PT4.9891287S
18
+ )
19
+ ```
20
+
data/docs/Message.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The id of the message. | [optional] |
8
8
  | **owner** | **String** | The Bandwidth phone number associated with the message. | [optional] |
9
9
  | **application_id** | **String** | The application ID associated with the message. | [optional] |
10
- | **time** | **String** | The datetime stamp of the message in ISO 8601 | [optional] |
10
+ | **time** | **Time** | The datetime stamp of the message in ISO 8601 | [optional] |
11
11
  | **segment_count** | **Integer** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] |
12
12
  | **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] |
13
13
  | **to** | **Array&lt;String&gt;** | The phone number recipients of the message. | [optional] |
@@ -27,7 +27,7 @@ instance = Bandwidth::Message.new(
27
27
  id: 1589228074636lm4k2je7j7jklbn2,
28
28
  owner: +15554443333,
29
29
  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
30
- time: 2022-09-14T18:20:16.000Z,
30
+ time: 2022-09-14T18:20:16Z,
31
31
  segment_count: 2,
32
32
  direction: null,
33
33
  to: [&quot;+15552223333&quot;],
@@ -31,7 +31,7 @@ instance = Bandwidth::MessageDeliveredCallbackMessage.new(
31
31
  direction: null,
32
32
  to: [&quot;+15552223333&quot;],
33
33
  from: +15553332222,
34
- text: ,
34
+ text: Hello world,
35
35
  tag: custom string,
36
36
  media: [&quot;https://dev.bandwidth.com/images/bandwidth-logo.png&quot;,&quot;https://dev.bandwidth.com/images/github_logo.png&quot;],
37
37
  priority: null
@@ -31,7 +31,7 @@ instance = Bandwidth::MessageFailedCallbackMessage.new(
31
31
  direction: null,
32
32
  to: [&quot;+15552223333&quot;],
33
33
  from: +15553332222,
34
- text: ,
34
+ text: Hello world,
35
35
  tag: custom string,
36
36
  media: [&quot;https://dev.bandwidth.com/images/bandwidth-logo.png&quot;,&quot;https://dev.bandwidth.com/images/github_logo.png&quot;],
37
37
  priority: null
@@ -11,7 +11,7 @@
11
11
  | **media** | **Array&lt;String&gt;** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
12
12
  | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
13
13
  | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
14
- | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] |
14
+ | **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. | [optional] |
15
15
 
16
16
  ## Example
17
17
 
@@ -31,7 +31,7 @@ instance = Bandwidth::MessageSendingCallbackMessage.new(
31
31
  direction: null,
32
32
  to: [&quot;+15552223333&quot;],
33
33
  from: +15553332222,
34
- text: ,
34
+ text: Hello world,
35
35
  tag: custom string,
36
36
  media: [&quot;https://dev.bandwidth.com/images/bandwidth-logo.png&quot;,&quot;https://dev.bandwidth.com/images/github_logo.png&quot;],
37
37
  priority: null
data/docs/MessagesApi.md CHANGED
@@ -113,9 +113,11 @@ opts = {
113
113
  error_code: 9902, # Integer | The error code of the message.
114
114
  from_date_time: '2022-09-14T18:20:16.000Z', # String | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
115
115
  to_date_time: '2022-09-14T18:20:16.000Z', # String | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
116
+ campaign_id: 'CJEUMDK', # String | The campaign ID of the message.
116
117
  sort: 'sourceTn:desc', # String | The field and direction to sort by combined with a colon. Direction is either asc or desc.
117
118
  page_token: 'gdEewhcJLQRB5', # String | A base64 encoded value used for pagination of results.
118
- limit: 50 # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
119
+ limit: 50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
120
+ limit_total_count: true # Boolean | When set to true, the response's totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
119
121
  }
120
122
 
121
123
  begin
@@ -160,9 +162,11 @@ end
160
162
  | **error_code** | **Integer** | The error code of the message. | [optional] |
161
163
  | **from_date_time** | **String** | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
162
164
  | **to_date_time** | **String** | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
165
+ | **campaign_id** | **String** | The campaign ID of the message. | [optional] |
163
166
  | **sort** | **String** | The field and direction to sort by combined with a colon. Direction is either asc or desc. | [optional] |
164
167
  | **page_token** | **String** | A base64 encoded value used for pagination of results. | [optional] |
165
168
  | **limit** | **Integer** | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | [optional] |
169
+ | **limit_total_count** | **Boolean** | When set to true, the response&#39;s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results. | [optional] |
166
170
 
167
171
  ### Return type
168
172
 
data/docs/MessagesList.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **total_count** | **Integer** | Total number of messages matched by the search. | [optional] |
7
+ | **total_count** | **Integer** | The total number of messages matched by the search. When the request has limitTotalCount set to true this value is limited to 10,000. | [optional] |
8
8
  | **page_info** | [**PageInfo**](PageInfo.md) | | [optional] |
9
9
  | **messages** | [**Array&lt;ListMessageItem&gt;**](ListMessageItem.md) | | [optional] |
10
10