bandwidth-sdk 4.1.3 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (402) hide show
  1. package/.openapi-generator/FILES +189 -1
  2. package/.openapi-generator/VERSION +1 -1
  3. package/api/multi-channel-api.ts +150 -0
  4. package/api.ts +1 -0
  5. package/bandwidth.yml +640 -58
  6. package/base.ts +6 -0
  7. package/configuration.ts +1 -1
  8. package/coverage/clover.xml +565 -460
  9. package/coverage/coverage-final.json +79 -70
  10. package/coverage/lcov-report/index.html +27 -27
  11. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
  12. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
  13. package/coverage/lcov-report/node-sdk/api/index.html +24 -9
  14. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
  15. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
  16. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
  17. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +535 -0
  18. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +11 -11
  19. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
  20. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
  21. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +17 -17
  22. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
  23. package/coverage/lcov-report/node-sdk/api.ts.html +17 -14
  24. package/coverage/lcov-report/node-sdk/base.ts.html +32 -14
  25. package/coverage/lcov-report/node-sdk/common.ts.html +11 -11
  26. package/coverage/lcov-report/node-sdk/configuration.ts.html +14 -14
  27. package/coverage/lcov-report/node-sdk/index.html +7 -7
  28. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
  29. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
  30. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
  31. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
  32. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +7 -4
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
  65. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  66. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
  67. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
  68. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
  69. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
  70. package/coverage/lcov-report/node-sdk/models/callback-type-enum.ts.html +6 -6
  71. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +178 -0
  72. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
  73. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
  74. package/coverage/lcov-report/node-sdk/models/index.html +125 -5
  75. package/coverage/lcov-report/node-sdk/models/index.ts.html +213 -117
  76. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
  77. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
  78. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
  79. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
  80. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
  81. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
  82. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +181 -0
  83. package/coverage/lcov-report/node-sdk/models/multi-channel-message-direction-enum.ts.html +178 -0
  84. package/coverage/lcov-report/node-sdk/models/multi-channel-status-enum.ts.html +184 -0
  85. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +3 -3
  86. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +190 -0
  87. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +181 -0
  88. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
  89. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
  90. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +178 -0
  91. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
  92. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +4 -10
  93. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +178 -0
  94. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
  95. package/coverage/lcov.info +723 -517
  96. package/dist/api/multi-channel-api.d.ts +79 -0
  97. package/dist/api/multi-channel-api.js +230 -0
  98. package/dist/api.d.ts +1 -0
  99. package/dist/api.js +1 -0
  100. package/dist/base.js +6 -0
  101. package/dist/configuration.js +1 -1
  102. package/dist/models/bxml/verbs/PhoneNumber.d.ts +1 -0
  103. package/dist/models/callback-type-enum.d.ts +4 -4
  104. package/dist/models/callback-type-enum.js +4 -4
  105. package/dist/models/card-width-enum.d.ts +21 -0
  106. package/dist/models/card-width-enum.js +25 -0
  107. package/dist/models/create-multi-channel-message-response.d.ts +39 -0
  108. package/dist/models/create-multi-channel-message-response.js +15 -0
  109. package/dist/models/error-object.d.ts +30 -0
  110. package/dist/models/error-object.js +15 -0
  111. package/dist/models/index.d.ts +33 -1
  112. package/dist/models/index.js +33 -1
  113. package/dist/models/link.d.ts +30 -0
  114. package/dist/models/link.js +15 -0
  115. package/dist/models/message-callback.d.ts +6 -0
  116. package/dist/models/message-request.d.ts +1 -1
  117. package/dist/models/message.d.ts +1 -1
  118. package/dist/models/mms-message-content.d.ts +30 -0
  119. package/dist/models/mms-message-content.js +15 -0
  120. package/dist/models/multi-channel-action-calendar-event.d.ts +17 -0
  121. package/dist/models/multi-channel-action-calendar-event.js +15 -0
  122. package/dist/models/multi-channel-action.d.ts +33 -0
  123. package/dist/models/multi-channel-action.js +15 -0
  124. package/dist/models/multi-channel-callback-data.d.ts +50 -0
  125. package/dist/models/multi-channel-callback-data.js +15 -0
  126. package/dist/models/multi-channel-channel-list-object-content.d.ts +22 -0
  127. package/dist/models/multi-channel-channel-list-object-content.js +15 -0
  128. package/dist/models/multi-channel-channel-list-object.d.ts +44 -0
  129. package/dist/models/multi-channel-channel-list-object.js +15 -0
  130. package/dist/models/multi-channel-message-callback-data.d.ts +69 -0
  131. package/dist/models/multi-channel-message-callback-data.js +15 -0
  132. package/dist/models/multi-channel-message-channel-enum.d.ts +22 -0
  133. package/dist/models/multi-channel-message-channel-enum.js +26 -0
  134. package/dist/models/multi-channel-message-data.d.ts +75 -0
  135. package/dist/models/multi-channel-message-data.js +15 -0
  136. package/dist/models/multi-channel-message-direction-enum.d.ts +21 -0
  137. package/dist/models/multi-channel-message-direction-enum.js +25 -0
  138. package/dist/models/multi-channel-message-request.d.ts +50 -0
  139. package/dist/models/multi-channel-message-request.js +15 -0
  140. package/dist/models/multi-channel-status-enum.d.ts +23 -0
  141. package/dist/models/multi-channel-status-enum.js +27 -0
  142. package/dist/models/priority-enum.d.ts +1 -1
  143. package/dist/models/priority-enum.js +1 -1
  144. package/dist/models/rbm-action-base.d.ts +37 -0
  145. package/dist/models/rbm-action-base.js +15 -0
  146. package/dist/models/rbm-action-dial.d.ts +17 -0
  147. package/dist/models/rbm-action-dial.js +15 -0
  148. package/dist/models/rbm-action-open-url.d.ts +17 -0
  149. package/dist/models/rbm-action-open-url.js +15 -0
  150. package/dist/models/rbm-action-type-enum.d.ts +25 -0
  151. package/dist/models/rbm-action-type-enum.js +29 -0
  152. package/dist/models/rbm-action-view-location.d.ts +17 -0
  153. package/dist/models/rbm-action-view-location.js +15 -0
  154. package/dist/models/rbm-card-content-media.d.ts +17 -0
  155. package/dist/models/rbm-card-content-media.js +15 -0
  156. package/dist/models/rbm-card-content.d.ts +44 -0
  157. package/dist/models/rbm-card-content.js +15 -0
  158. package/dist/models/rbm-media-height-enum.d.ts +22 -0
  159. package/dist/models/rbm-media-height-enum.js +26 -0
  160. package/dist/models/rbm-message-carousel-card.d.ts +39 -0
  161. package/dist/models/rbm-message-carousel-card.js +15 -0
  162. package/dist/models/rbm-message-content-file.d.ts +30 -0
  163. package/dist/models/rbm-message-content-file.js +15 -0
  164. package/dist/models/rbm-message-content-rich-card.d.ts +18 -0
  165. package/dist/models/rbm-message-content-rich-card.js +15 -0
  166. package/dist/models/rbm-message-content-text.d.ts +31 -0
  167. package/dist/models/rbm-message-content-text.js +15 -0
  168. package/dist/models/rbm-message-media.d.ts +32 -0
  169. package/dist/models/rbm-message-media.js +15 -0
  170. package/dist/models/rbm-standalone-card.d.ts +46 -0
  171. package/dist/models/rbm-standalone-card.js +15 -0
  172. package/dist/models/sms-message-content.d.ts +24 -0
  173. package/dist/models/sms-message-content.js +15 -0
  174. package/dist/models/standalone-card-orientation-enum.d.ts +21 -0
  175. package/dist/models/standalone-card-orientation-enum.js +25 -0
  176. package/dist/models/tfv-status-enum.d.ts +0 -2
  177. package/dist/models/tfv-status-enum.js +1 -3
  178. package/dist/models/tfv-status.d.ts +12 -0
  179. package/dist/models/tfv-submission-info.d.ts +18 -0
  180. package/dist/models/thumbnail-alignment-enum.d.ts +21 -0
  181. package/dist/models/thumbnail-alignment-enum.js +25 -0
  182. package/dist/models/verification-denial-webhook.d.ts +12 -0
  183. package/dist/models/verification-request.d.ts +18 -0
  184. package/dist/models/verification-update-request.d.ts +18 -0
  185. package/docs/AccountStatistics.md +22 -0
  186. package/docs/AdditionalDenialReason.md +24 -0
  187. package/docs/Address.md +32 -0
  188. package/docs/AnswerCallback.md +47 -0
  189. package/docs/BridgeCompleteCallback.md +51 -0
  190. package/docs/BridgeTargetCompleteCallback.md +45 -0
  191. package/docs/CallDirectionEnum.md +11 -0
  192. package/docs/CallRecordingMetadata.md +56 -0
  193. package/docs/CallState.md +54 -0
  194. package/docs/CallStateEnum.md +11 -0
  195. package/docs/CallTranscription.md +26 -0
  196. package/docs/CallTranscriptionDetectedLanguageEnum.md +13 -0
  197. package/docs/CallTranscriptionMetadata.md +24 -0
  198. package/docs/CallTranscriptionResponse.md +26 -0
  199. package/docs/CallTranscriptionTrackEnum.md +11 -0
  200. package/docs/CallbackMethodEnum.md +11 -0
  201. package/docs/CallbackTypeEnum.md +15 -0
  202. package/docs/CallsApi.md +350 -0
  203. package/docs/CardWidthEnum.md +10 -0
  204. package/docs/CodeRequest.md +30 -0
  205. package/docs/Conference.md +34 -0
  206. package/docs/ConferenceCompletedCallback.md +29 -0
  207. package/docs/ConferenceCreatedCallback.md +29 -0
  208. package/docs/ConferenceMember.md +30 -0
  209. package/docs/ConferenceMemberExitCallback.md +35 -0
  210. package/docs/ConferenceMemberJoinCallback.md +35 -0
  211. package/docs/ConferenceRecordingAvailableCallback.md +47 -0
  212. package/docs/ConferenceRecordingMetadata.md +42 -0
  213. package/docs/ConferenceRedirectCallback.md +29 -0
  214. package/docs/ConferenceStateEnum.md +11 -0
  215. package/docs/ConferencesApi.md +609 -0
  216. package/docs/Contact.md +26 -0
  217. package/docs/CreateCall.md +60 -0
  218. package/docs/CreateCallResponse.md +60 -0
  219. package/docs/CreateLookupResponse.md +23 -0
  220. package/docs/CreateMessageRequestError.md +24 -0
  221. package/docs/CreateMultiChannelMessageResponse.md +24 -0
  222. package/docs/DeferredResult.md +22 -0
  223. package/docs/DisconnectCallback.md +53 -0
  224. package/docs/Diversion.md +32 -0
  225. package/docs/DtmfCallback.md +53 -0
  226. package/docs/Error.md +24 -0
  227. package/docs/ErrorObject.md +22 -0
  228. package/docs/FailureWebhook.md +30 -0
  229. package/docs/FieldError.md +22 -0
  230. package/docs/FileFormatEnum.md +11 -0
  231. package/docs/GatherCallback.md +55 -0
  232. package/docs/InitiateCallback.md +45 -0
  233. package/docs/Link.md +22 -0
  234. package/docs/LinksObject.md +26 -0
  235. package/docs/ListMessageDirectionEnum.md +11 -0
  236. package/docs/ListMessageItem.md +52 -0
  237. package/docs/LookupRequest.md +21 -0
  238. package/docs/LookupResult.md +37 -0
  239. package/docs/LookupStatus.md +27 -0
  240. package/docs/LookupStatusEnum.md +15 -0
  241. package/docs/MFAApi.md +188 -0
  242. package/docs/MachineDetectionCompleteCallback.md +47 -0
  243. package/docs/MachineDetectionConfiguration.md +49 -0
  244. package/docs/MachineDetectionModeEnum.md +11 -0
  245. package/docs/MachineDetectionResult.md +23 -0
  246. package/docs/Media.md +24 -0
  247. package/docs/MediaApi.md +268 -0
  248. package/docs/Message.md +44 -0
  249. package/docs/MessageCallback.md +33 -0
  250. package/docs/MessageCallbackMessage.md +43 -0
  251. package/docs/MessageDirectionEnum.md +11 -0
  252. package/docs/MessageRequest.md +34 -0
  253. package/docs/MessageStatusEnum.md +23 -0
  254. package/docs/MessageTypeEnum.md +11 -0
  255. package/docs/MessagesApi.md +175 -0
  256. package/docs/MessagesList.md +24 -0
  257. package/docs/MessagingCodeResponse.md +20 -0
  258. package/docs/MessagingRequestError.md +22 -0
  259. package/docs/MfaForbiddenRequestError.md +20 -0
  260. package/docs/MfaRequestError.md +22 -0
  261. package/docs/MfaUnauthorizedRequestError.md +20 -0
  262. package/docs/MmsMessageContent.md +22 -0
  263. package/docs/MultiChannelAction.md +42 -0
  264. package/docs/MultiChannelActionCalendarEvent.md +32 -0
  265. package/docs/MultiChannelApi.md +71 -0
  266. package/docs/MultiChannelCallbackData.md +28 -0
  267. package/docs/MultiChannelChannelListObject.md +26 -0
  268. package/docs/MultiChannelChannelListObjectContent.md +35 -0
  269. package/docs/MultiChannelMessageCallbackData.md +34 -0
  270. package/docs/MultiChannelMessageChannelEnum.md +13 -0
  271. package/docs/MultiChannelMessageData.md +36 -0
  272. package/docs/MultiChannelMessageDirectionEnum.md +10 -0
  273. package/docs/MultiChannelMessageRequest.md +29 -0
  274. package/docs/MultiChannelStatusEnum.md +14 -0
  275. package/docs/OptInWorkflow.md +22 -0
  276. package/docs/PageInfo.md +26 -0
  277. package/docs/PhoneNumberLookupApi.md +130 -0
  278. package/docs/PriorityEnum.md +11 -0
  279. package/docs/RbmActionBase.md +24 -0
  280. package/docs/RbmActionDial.md +26 -0
  281. package/docs/RbmActionOpenUrl.md +26 -0
  282. package/docs/RbmActionTypeEnum.md +18 -0
  283. package/docs/RbmActionViewLocation.md +30 -0
  284. package/docs/RbmCardContent.md +26 -0
  285. package/docs/RbmCardContentMedia.md +24 -0
  286. package/docs/RbmMediaHeightEnum.md +13 -0
  287. package/docs/RbmMessageCarouselCard.md +24 -0
  288. package/docs/RbmMessageContentFile.md +22 -0
  289. package/docs/RbmMessageContentRichCard.md +30 -0
  290. package/docs/RbmMessageContentText.md +22 -0
  291. package/docs/RbmMessageMedia.md +22 -0
  292. package/docs/RbmStandaloneCard.md +26 -0
  293. package/docs/RecordingAvailableCallback.md +63 -0
  294. package/docs/RecordingCompleteCallback.md +63 -0
  295. package/docs/RecordingStateEnum.md +11 -0
  296. package/docs/RecordingTranscriptionMetadata.md +27 -0
  297. package/docs/RecordingTranscriptions.md +20 -0
  298. package/docs/RecordingsApi.md +675 -0
  299. package/docs/RedirectCallback.md +51 -0
  300. package/docs/RedirectMethodEnum.md +11 -0
  301. package/docs/SmsMessageContent.md +20 -0
  302. package/docs/StandaloneCardOrientationEnum.md +10 -0
  303. package/docs/StatisticsApi.md +67 -0
  304. package/docs/StirShaken.md +24 -0
  305. package/docs/TelephoneNumber.md +20 -0
  306. package/docs/TfvBasicAuthentication.md +22 -0
  307. package/docs/TfvCallbackStatusEnum.md +10 -0
  308. package/docs/TfvError.md +25 -0
  309. package/docs/TfvStatus.md +38 -0
  310. package/docs/TfvStatusEnum.md +12 -0
  311. package/docs/TfvSubmissionInfo.md +42 -0
  312. package/docs/TfvSubmissionWrapper.md +20 -0
  313. package/docs/ThumbnailAlignmentEnum.md +11 -0
  314. package/docs/TnLookupRequestError.md +20 -0
  315. package/docs/TollFreeVerificationApi.md +505 -0
  316. package/docs/TranscribeRecording.md +32 -0
  317. package/docs/Transcription.md +22 -0
  318. package/docs/TranscriptionAvailableCallback.md +61 -0
  319. package/docs/TranscriptionsApi.md +202 -0
  320. package/docs/TransferAnswerCallback.md +49 -0
  321. package/docs/TransferCompleteCallback.md +55 -0
  322. package/docs/TransferDisconnectCallback.md +59 -0
  323. package/docs/UpdateCall.md +38 -0
  324. package/docs/UpdateCallRecording.md +20 -0
  325. package/docs/UpdateConference.md +36 -0
  326. package/docs/UpdateConferenceMember.md +24 -0
  327. package/docs/VerificationDenialWebhook.md +38 -0
  328. package/docs/VerificationRequest.md +44 -0
  329. package/docs/VerificationUpdateRequest.md +42 -0
  330. package/docs/VerificationWebhook.md +26 -0
  331. package/docs/VerifyCodeRequest.md +26 -0
  332. package/docs/VerifyCodeResponse.md +20 -0
  333. package/docs/VoiceApiError.md +24 -0
  334. package/docs/VoiceCodeResponse.md +20 -0
  335. package/docs/WebhookSubscription.md +33 -0
  336. package/docs/WebhookSubscriptionBasicAuthentication.md +23 -0
  337. package/docs/WebhookSubscriptionRequestSchema.md +24 -0
  338. package/docs/WebhookSubscriptionTypeEnum.md +10 -0
  339. package/docs/WebhookSubscriptionsListBody.md +25 -0
  340. package/models/bxml/verbs/PhoneNumber.ts +1 -0
  341. package/models/callback-type-enum.ts +4 -4
  342. package/models/card-width-enum.ts +31 -0
  343. package/models/create-multi-channel-message-response.ts +51 -0
  344. package/models/error-object.ts +36 -0
  345. package/models/index.ts +33 -1
  346. package/models/link.ts +36 -0
  347. package/models/message-callback.ts +6 -0
  348. package/models/message-request.ts +1 -1
  349. package/models/message.ts +1 -1
  350. package/models/mms-message-content.ts +36 -0
  351. package/models/multi-channel-action-calendar-event.ts +29 -0
  352. package/models/multi-channel-action.ts +41 -0
  353. package/models/multi-channel-callback-data.ts +62 -0
  354. package/models/multi-channel-channel-list-object-content.ts +54 -0
  355. package/models/multi-channel-channel-list-object.ts +56 -0
  356. package/models/multi-channel-message-callback-data.ts +83 -0
  357. package/models/multi-channel-message-channel-enum.ts +32 -0
  358. package/models/multi-channel-message-data.ts +89 -0
  359. package/models/multi-channel-message-direction-enum.ts +31 -0
  360. package/models/multi-channel-message-request.ts +62 -0
  361. package/models/multi-channel-status-enum.ts +33 -0
  362. package/models/priority-enum.ts +1 -1
  363. package/models/rbm-action-base.ts +47 -0
  364. package/models/rbm-action-dial.ts +29 -0
  365. package/models/rbm-action-open-url.ts +29 -0
  366. package/models/rbm-action-type-enum.ts +35 -0
  367. package/models/rbm-action-view-location.ts +29 -0
  368. package/models/rbm-card-content-media.ts +29 -0
  369. package/models/rbm-card-content.ts +54 -0
  370. package/models/rbm-media-height-enum.ts +32 -0
  371. package/models/rbm-message-carousel-card.ts +53 -0
  372. package/models/rbm-message-content-file.ts +36 -0
  373. package/models/rbm-message-content-rich-card.ts +44 -0
  374. package/models/rbm-message-content-text.ts +39 -0
  375. package/models/rbm-message-media.ts +42 -0
  376. package/models/rbm-standalone-card.ts +62 -0
  377. package/models/sms-message-content.ts +30 -0
  378. package/models/standalone-card-orientation-enum.ts +31 -0
  379. package/models/tfv-status-enum.ts +1 -3
  380. package/models/tfv-status.ts +12 -0
  381. package/models/tfv-submission-info.ts +18 -0
  382. package/models/thumbnail-alignment-enum.ts +31 -0
  383. package/models/verification-denial-webhook.ts +12 -0
  384. package/models/verification-request.ts +18 -0
  385. package/models/verification-update-request.ts +18 -0
  386. package/openapitools.json +1 -1
  387. package/package.json +1 -1
  388. package/tests/smoke/conferences-api.test.ts +4 -4
  389. package/tests/smoke/multi-channel-api.test.ts +44 -0
  390. package/tests/smoke/transcriptions-api.test.ts +1 -1
  391. package/tests/unit/api/multi-channel-api.test.ts +45 -0
  392. package/tests/unit/models/bxml/verbs/PhoneNumber.test.ts +3 -2
  393. package/tests/unit/models/callback-type-enum.test.ts +4 -4
  394. package/tests/unit/models/card-width-enum.test.ts +8 -0
  395. package/tests/unit/models/multi-channel-message-channel-enum.test.ts +9 -0
  396. package/tests/unit/models/multi-channel-message-direction-enum.test.ts +8 -0
  397. package/tests/unit/models/multi-channel-status-enum.test.ts +10 -0
  398. package/tests/unit/models/rbm-action-type-enum.test.ts +12 -0
  399. package/tests/unit/models/rbm-media-height-enum.test.ts +9 -0
  400. package/tests/unit/models/standalone-card-orientation-enum.test.ts +8 -0
  401. package/tests/unit/models/tfv-status-enum.test.ts +0 -2
  402. package/tests/unit/models/thumbnail-alignment-enum.test.ts +7 -0
@@ -0,0 +1,505 @@
1
+ # TollFreeVerificationApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createWebhookSubscription**](#createwebhooksubscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription|
8
+ |[**deleteWebhookSubscription**](#deletewebhooksubscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription|
9
+ |[**getTollFreeVerificationStatus**](#gettollfreeverificationstatus) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status|
10
+ |[**listTollFreeUseCases**](#listtollfreeusecases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases|
11
+ |[**listWebhookSubscriptions**](#listwebhooksubscriptions) | **GET** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | List Webhook Subscriptions|
12
+ |[**requestTollFreeVerification**](#requesttollfreeverification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification|
13
+ |[**updateTollFreeVerificationRequest**](#updatetollfreeverificationrequest) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request|
14
+ |[**updateWebhookSubscription**](#updatewebhooksubscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription|
15
+
16
+ # **createWebhookSubscription**
17
+ > WebhookSubscription createWebhookSubscription(webhookSubscriptionRequestSchema)
18
+
19
+ Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
20
+
21
+ ### Example
22
+
23
+ ```typescript
24
+ import {
25
+ TollFreeVerificationApi,
26
+ Configuration,
27
+ WebhookSubscriptionRequestSchema
28
+ } from 'bandwidth-sdk';
29
+
30
+ const configuration = new Configuration();
31
+ const apiInstance = new TollFreeVerificationApi(configuration);
32
+
33
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
34
+ let webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema; //Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
35
+
36
+ const { status, data } = await apiInstance.createWebhookSubscription(
37
+ accountId,
38
+ webhookSubscriptionRequestSchema
39
+ );
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ |Name | Type | Description | Notes|
45
+ |------------- | ------------- | ------------- | -------------|
46
+ | **webhookSubscriptionRequestSchema** | **WebhookSubscriptionRequestSchema**| Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | |
47
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
48
+
49
+
50
+ ### Return type
51
+
52
+ **WebhookSubscription**
53
+
54
+ ### Authorization
55
+
56
+ [Basic](../README.md#Basic)
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: application/json
62
+
63
+
64
+ ### HTTP response details
65
+ | Status code | Description | Response headers |
66
+ |-------------|-------------|------------------|
67
+ |**201** | Created | - |
68
+ |**400** | Bad Request | - |
69
+ |**401** | Unauthorized | - |
70
+ |**403** | Forbidden | - |
71
+ |**404** | Cannot find the requested resource. | - |
72
+ |**405** | Method Not Allowed | - |
73
+ |**429** | Too Many Requests | - |
74
+ |**500** | Internal Server Error | - |
75
+ |**503** | Service Unavailable | - |
76
+
77
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
78
+
79
+ # **deleteWebhookSubscription**
80
+ > deleteWebhookSubscription()
81
+
82
+ Delete a webhook subscription by ID.
83
+
84
+ ### Example
85
+
86
+ ```typescript
87
+ import {
88
+ TollFreeVerificationApi,
89
+ Configuration
90
+ } from 'bandwidth-sdk';
91
+
92
+ const configuration = new Configuration();
93
+ const apiInstance = new TollFreeVerificationApi(configuration);
94
+
95
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
96
+ let id: string; //Webhook subscription ID (default to undefined)
97
+
98
+ const { status, data } = await apiInstance.deleteWebhookSubscription(
99
+ accountId,
100
+ id
101
+ );
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ |Name | Type | Description | Notes|
107
+ |------------- | ------------- | ------------- | -------------|
108
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
109
+ | **id** | [**string**] | Webhook subscription ID | defaults to undefined|
110
+
111
+
112
+ ### Return type
113
+
114
+ void (empty response body)
115
+
116
+ ### Authorization
117
+
118
+ [Basic](../README.md#Basic)
119
+
120
+ ### HTTP request headers
121
+
122
+ - **Content-Type**: Not defined
123
+ - **Accept**: application/json
124
+
125
+
126
+ ### HTTP response details
127
+ | Status code | Description | Response headers |
128
+ |-------------|-------------|------------------|
129
+ |**204** | No Content | - |
130
+ |**400** | Bad Request | - |
131
+ |**401** | Unauthorized | - |
132
+ |**403** | Forbidden | - |
133
+ |**404** | Cannot find the requested resource. | - |
134
+ |**405** | Method Not Allowed | - |
135
+ |**429** | Too Many Requests | - |
136
+ |**500** | Internal Server Error | - |
137
+ |**503** | Service Unavailable | - |
138
+
139
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
140
+
141
+ # **getTollFreeVerificationStatus**
142
+ > TfvStatus getTollFreeVerificationStatus()
143
+
144
+ Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
145
+
146
+ ### Example
147
+
148
+ ```typescript
149
+ import {
150
+ TollFreeVerificationApi,
151
+ Configuration
152
+ } from 'bandwidth-sdk';
153
+
154
+ const configuration = new Configuration();
155
+ const apiInstance = new TollFreeVerificationApi(configuration);
156
+
157
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
158
+ let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined)
159
+
160
+ const { status, data } = await apiInstance.getTollFreeVerificationStatus(
161
+ accountId,
162
+ phoneNumber
163
+ );
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+ |Name | Type | Description | Notes|
169
+ |------------- | ------------- | ------------- | -------------|
170
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
171
+ | **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined|
172
+
173
+
174
+ ### Return type
175
+
176
+ **TfvStatus**
177
+
178
+ ### Authorization
179
+
180
+ [Basic](../README.md#Basic)
181
+
182
+ ### HTTP request headers
183
+
184
+ - **Content-Type**: Not defined
185
+ - **Accept**: application/json
186
+
187
+
188
+ ### HTTP response details
189
+ | Status code | Description | Response headers |
190
+ |-------------|-------------|------------------|
191
+ |**200** | OK | - |
192
+ |**400** | Bad Request | - |
193
+ |**401** | Unauthorized | - |
194
+ |**403** | Forbidden | - |
195
+ |**404** | Cannot find the requested resource. | - |
196
+ |**405** | Method Not Allowed | - |
197
+ |**429** | Too Many Requests | - |
198
+ |**500** | Internal Server Error | - |
199
+ |**503** | Service Unavailable | - |
200
+
201
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
202
+
203
+ # **listTollFreeUseCases**
204
+ > Array<string> listTollFreeUseCases()
205
+
206
+ Lists valid toll-free use cases.
207
+
208
+ ### Example
209
+
210
+ ```typescript
211
+ import {
212
+ TollFreeVerificationApi,
213
+ Configuration
214
+ } from 'bandwidth-sdk';
215
+
216
+ const configuration = new Configuration();
217
+ const apiInstance = new TollFreeVerificationApi(configuration);
218
+
219
+ const { status, data } = await apiInstance.listTollFreeUseCases();
220
+ ```
221
+
222
+ ### Parameters
223
+ This endpoint does not have any parameters.
224
+
225
+
226
+ ### Return type
227
+
228
+ **Array<string>**
229
+
230
+ ### Authorization
231
+
232
+ [Basic](../README.md#Basic)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: Not defined
237
+ - **Accept**: application/json
238
+
239
+
240
+ ### HTTP response details
241
+ | Status code | Description | Response headers |
242
+ |-------------|-------------|------------------|
243
+ |**200** | OK | - |
244
+ |**400** | Bad Request | - |
245
+ |**401** | Unauthorized | - |
246
+ |**403** | Forbidden | - |
247
+ |**404** | Cannot find the requested resource. | - |
248
+ |**405** | Method Not Allowed | - |
249
+ |**429** | Too Many Requests | - |
250
+ |**500** | Internal Server Error | - |
251
+ |**503** | Service Unavailable | - |
252
+
253
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
254
+
255
+ # **listWebhookSubscriptions**
256
+ > WebhookSubscriptionsListBody listWebhookSubscriptions()
257
+
258
+ Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
259
+
260
+ ### Example
261
+
262
+ ```typescript
263
+ import {
264
+ TollFreeVerificationApi,
265
+ Configuration
266
+ } from 'bandwidth-sdk';
267
+
268
+ const configuration = new Configuration();
269
+ const apiInstance = new TollFreeVerificationApi(configuration);
270
+
271
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
272
+
273
+ const { status, data } = await apiInstance.listWebhookSubscriptions(
274
+ accountId
275
+ );
276
+ ```
277
+
278
+ ### Parameters
279
+
280
+ |Name | Type | Description | Notes|
281
+ |------------- | ------------- | ------------- | -------------|
282
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
283
+
284
+
285
+ ### Return type
286
+
287
+ **WebhookSubscriptionsListBody**
288
+
289
+ ### Authorization
290
+
291
+ [Basic](../README.md#Basic)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: Not defined
296
+ - **Accept**: application/json
297
+
298
+
299
+ ### HTTP response details
300
+ | Status code | Description | Response headers |
301
+ |-------------|-------------|------------------|
302
+ |**200** | OK | - |
303
+ |**400** | Bad Request | - |
304
+ |**401** | Unauthorized | - |
305
+ |**403** | Forbidden | - |
306
+ |**405** | Method Not Allowed | - |
307
+ |**429** | Too Many Requests | - |
308
+ |**500** | Internal Server Error | - |
309
+ |**503** | Service Unavailable | - |
310
+
311
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
312
+
313
+ # **requestTollFreeVerification**
314
+ > requestTollFreeVerification(verificationRequest)
315
+
316
+ Submit a request for verification of a toll-free phone number.
317
+
318
+ ### Example
319
+
320
+ ```typescript
321
+ import {
322
+ TollFreeVerificationApi,
323
+ Configuration,
324
+ VerificationRequest
325
+ } from 'bandwidth-sdk';
326
+
327
+ const configuration = new Configuration();
328
+ const apiInstance = new TollFreeVerificationApi(configuration);
329
+
330
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
331
+ let verificationRequest: VerificationRequest; //Request for verification of a toll-free phone number.
332
+
333
+ const { status, data } = await apiInstance.requestTollFreeVerification(
334
+ accountId,
335
+ verificationRequest
336
+ );
337
+ ```
338
+
339
+ ### Parameters
340
+
341
+ |Name | Type | Description | Notes|
342
+ |------------- | ------------- | ------------- | -------------|
343
+ | **verificationRequest** | **VerificationRequest**| Request for verification of a toll-free phone number. | |
344
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
345
+
346
+
347
+ ### Return type
348
+
349
+ void (empty response body)
350
+
351
+ ### Authorization
352
+
353
+ [Basic](../README.md#Basic)
354
+
355
+ ### HTTP request headers
356
+
357
+ - **Content-Type**: application/json
358
+ - **Accept**: application/json
359
+
360
+
361
+ ### HTTP response details
362
+ | Status code | Description | Response headers |
363
+ |-------------|-------------|------------------|
364
+ |**202** | Accepted | - |
365
+ |**400** | Bad Request | - |
366
+ |**401** | Unauthorized | - |
367
+ |**403** | Forbidden | - |
368
+ |**405** | Method Not Allowed | - |
369
+ |**429** | Too Many Requests | - |
370
+ |**500** | Internal Server Error | - |
371
+ |**503** | Service Unavailable | - |
372
+
373
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
374
+
375
+ # **updateTollFreeVerificationRequest**
376
+ > updateTollFreeVerificationRequest(tfvSubmissionWrapper)
377
+
378
+ Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
379
+
380
+ ### Example
381
+
382
+ ```typescript
383
+ import {
384
+ TollFreeVerificationApi,
385
+ Configuration,
386
+ TfvSubmissionWrapper
387
+ } from 'bandwidth-sdk';
388
+
389
+ const configuration = new Configuration();
390
+ const apiInstance = new TollFreeVerificationApi(configuration);
391
+
392
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
393
+ let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined)
394
+ let tfvSubmissionWrapper: TfvSubmissionWrapper; //Update a request for verification of a toll-free phone number.
395
+
396
+ const { status, data } = await apiInstance.updateTollFreeVerificationRequest(
397
+ accountId,
398
+ phoneNumber,
399
+ tfvSubmissionWrapper
400
+ );
401
+ ```
402
+
403
+ ### Parameters
404
+
405
+ |Name | Type | Description | Notes|
406
+ |------------- | ------------- | ------------- | -------------|
407
+ | **tfvSubmissionWrapper** | **TfvSubmissionWrapper**| Update a request for verification of a toll-free phone number. | |
408
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
409
+ | **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined|
410
+
411
+
412
+ ### Return type
413
+
414
+ void (empty response body)
415
+
416
+ ### Authorization
417
+
418
+ [Basic](../README.md#Basic)
419
+
420
+ ### HTTP request headers
421
+
422
+ - **Content-Type**: application/json
423
+ - **Accept**: application/json
424
+
425
+
426
+ ### HTTP response details
427
+ | Status code | Description | Response headers |
428
+ |-------------|-------------|------------------|
429
+ |**202** | Accepted | - |
430
+ |**400** | Bad Request | - |
431
+ |**401** | Unauthorized | - |
432
+ |**403** | Forbidden | - |
433
+ |**405** | Method Not Allowed | - |
434
+ |**429** | Too Many Requests | - |
435
+ |**500** | Internal Server Error | - |
436
+ |**503** | Service Unavailable | - |
437
+
438
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
439
+
440
+ # **updateWebhookSubscription**
441
+ > WebhookSubscription updateWebhookSubscription(webhookSubscriptionRequestSchema)
442
+
443
+ Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
444
+
445
+ ### Example
446
+
447
+ ```typescript
448
+ import {
449
+ TollFreeVerificationApi,
450
+ Configuration,
451
+ WebhookSubscriptionRequestSchema
452
+ } from 'bandwidth-sdk';
453
+
454
+ const configuration = new Configuration();
455
+ const apiInstance = new TollFreeVerificationApi(configuration);
456
+
457
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
458
+ let id: string; //Webhook subscription ID (default to undefined)
459
+ let webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema; //Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
460
+
461
+ const { status, data } = await apiInstance.updateWebhookSubscription(
462
+ accountId,
463
+ id,
464
+ webhookSubscriptionRequestSchema
465
+ );
466
+ ```
467
+
468
+ ### Parameters
469
+
470
+ |Name | Type | Description | Notes|
471
+ |------------- | ------------- | ------------- | -------------|
472
+ | **webhookSubscriptionRequestSchema** | **WebhookSubscriptionRequestSchema**| Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | |
473
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
474
+ | **id** | [**string**] | Webhook subscription ID | defaults to undefined|
475
+
476
+
477
+ ### Return type
478
+
479
+ **WebhookSubscription**
480
+
481
+ ### Authorization
482
+
483
+ [Basic](../README.md#Basic)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: application/json
488
+ - **Accept**: application/json
489
+
490
+
491
+ ### HTTP response details
492
+ | Status code | Description | Response headers |
493
+ |-------------|-------------|------------------|
494
+ |**200** | OK | - |
495
+ |**400** | Bad Request | - |
496
+ |**401** | Unauthorized | - |
497
+ |**403** | Forbidden | - |
498
+ |**404** | Cannot find the requested resource. | - |
499
+ |**405** | Method Not Allowed | - |
500
+ |**429** | Too Many Requests | - |
501
+ |**500** | Internal Server Error | - |
502
+ |**503** | Service Unavailable | - |
503
+
504
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
505
+
@@ -0,0 +1,32 @@
1
+ # TranscribeRecording
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **callbackUrl** | **string** | The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization. | [optional] [default to undefined]
9
+ **callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
10
+ **username** | **string** | Basic auth username. | [optional] [default to undefined]
11
+ **password** | **string** | Basic auth password. | [optional] [default to undefined]
12
+ **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] [default to undefined]
13
+ **callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering the webhook to &#x60;callbackUrl&#x60;. Can be any numeric value (including decimals) between 1 and 25. | [optional] [default to 15]
14
+ **detectLanguage** | **boolean** | A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish. | [optional] [default to false]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { TranscribeRecording } from 'bandwidth-sdk';
20
+
21
+ const instance: TranscribeRecording = {
22
+ callbackUrl,
23
+ callbackMethod,
24
+ username,
25
+ password,
26
+ tag,
27
+ callbackTimeout,
28
+ detectLanguage,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # Transcription
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **text** | **string** | The transcribed text | [optional] [default to undefined]
9
+ **confidence** | **number** | The confidence on the recognized content, ranging from &#x60;0.0&#x60; to &#x60;1.0&#x60; with &#x60;1.0&#x60; being the highest confidence. | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { Transcription } from 'bandwidth-sdk';
15
+
16
+ const instance: Transcription = {
17
+ text,
18
+ confidence,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,61 @@
1
+ # TranscriptionAvailableCallback
2
+
3
+ The Transcription Available event is sent when the recording transcription is available to be downloaded.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **eventType** | **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] [default to undefined]
10
+ **eventTime** | **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] [default to undefined]
11
+ **accountId** | **string** | The user account associated with the call. | [optional] [default to undefined]
12
+ **applicationId** | **string** | The id of the application associated with the call. | [optional] [default to undefined]
13
+ **from** | **string** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
14
+ **to** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
15
+ **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
16
+ **callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
17
+ **callUrl** | **string** | The URL of the call associated with the event. | [optional] [default to undefined]
18
+ **mediaUrl** | **string** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] [default to undefined]
19
+ **parentCallId** | **string** | (optional) If the event is related to the B leg of a &lt;Transfer&gt;, the call id of the original call leg that executed the &lt;Transfer&gt;. Otherwise, this field will not be present. | [optional] [default to undefined]
20
+ **recordingId** | **string** | The unique ID of this recording | [optional] [default to undefined]
21
+ **enqueuedTime** | **string** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] [default to undefined]
22
+ **startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
23
+ **endTime** | **string** | The time that the recording ended in ISO-8601 format | [optional] [default to undefined]
24
+ **duration** | **string** | The duration of the recording in ISO-8601 format | [optional] [default to undefined]
25
+ **fileFormat** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] [default to undefined]
26
+ **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] [default to undefined]
27
+ **transcription** | [**Transcription**](Transcription.md) | | [optional] [default to undefined]
28
+ **transferCallerId** | **string** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
29
+ **transferTo** | **string** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
30
+
31
+ ## Example
32
+
33
+ ```typescript
34
+ import { TranscriptionAvailableCallback } from 'bandwidth-sdk';
35
+
36
+ const instance: TranscriptionAvailableCallback = {
37
+ eventType,
38
+ eventTime,
39
+ accountId,
40
+ applicationId,
41
+ from,
42
+ to,
43
+ direction,
44
+ callId,
45
+ callUrl,
46
+ mediaUrl,
47
+ parentCallId,
48
+ recordingId,
49
+ enqueuedTime,
50
+ startTime,
51
+ endTime,
52
+ duration,
53
+ fileFormat,
54
+ tag,
55
+ transcription,
56
+ transferCallerId,
57
+ transferTo,
58
+ };
59
+ ```
60
+
61
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)