bandwidth-sdk 4.1.2 → 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 +675 -101
  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,51 @@
1
+ # RedirectCallback
2
+
3
+ The Redirect event is fired when a <Redirect> verb is executed. Its purpose is to get the next set of verbs from the calling application.
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
+ **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]
19
+ **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]
20
+ **startTime** | **string** | Time the call was started, in ISO 8601 format. | [optional] [default to undefined]
21
+ **answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
22
+ **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]
23
+ **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]
24
+ **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]
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import { RedirectCallback } from 'bandwidth-sdk';
30
+
31
+ const instance: RedirectCallback = {
32
+ eventType,
33
+ eventTime,
34
+ accountId,
35
+ applicationId,
36
+ from,
37
+ to,
38
+ direction,
39
+ callId,
40
+ callUrl,
41
+ parentCallId,
42
+ enqueuedTime,
43
+ startTime,
44
+ answerTime,
45
+ tag,
46
+ transferCallerId,
47
+ transferTo,
48
+ };
49
+ ```
50
+
51
+ [[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,11 @@
1
+ # RedirectMethodEnum
2
+
3
+ The HTTP method to use for the request to `redirectUrl`. GET or POST. Default value is POST.<br><br>Not allowed if `state` is `completed`.
4
+
5
+ ## Enum
6
+
7
+ * `Get` (value: `'GET'`)
8
+
9
+ * `Post` (value: `'POST'`)
10
+
11
+ [[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,20 @@
1
+ # SmsMessageContent
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { SmsMessageContent } from 'bandwidth-sdk';
14
+
15
+ const instance: SmsMessageContent = {
16
+ text,
17
+ };
18
+ ```
19
+
20
+ [[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,10 @@
1
+ # StandaloneCardOrientationEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Horizontal` (value: `'HORIZONTAL'`)
7
+
8
+ * `Vertical` (value: `'VERTICAL'`)
9
+
10
+ [[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,67 @@
1
+ # StatisticsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getStatistics**](#getstatistics) | **GET** /accounts/{accountId}/statistics | Get Account Statistics|
8
+
9
+ # **getStatistics**
10
+ > AccountStatistics getStatistics()
11
+
12
+ Returns details about the current state of the account.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ StatisticsApi,
19
+ Configuration
20
+ } from 'bandwidth-sdk';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new StatisticsApi(configuration);
24
+
25
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
26
+
27
+ const { status, data } = await apiInstance.getStatistics(
28
+ accountId
29
+ );
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ |Name | Type | Description | Notes|
35
+ |------------- | ------------- | ------------- | -------------|
36
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
37
+
38
+
39
+ ### Return type
40
+
41
+ **AccountStatistics**
42
+
43
+ ### Authorization
44
+
45
+ [Basic](../README.md#Basic)
46
+
47
+ ### HTTP request headers
48
+
49
+ - **Content-Type**: Not defined
50
+ - **Accept**: application/json
51
+
52
+
53
+ ### HTTP response details
54
+ | Status code | Description | Response headers |
55
+ |-------------|-------------|------------------|
56
+ |**200** | OK | - |
57
+ |**400** | Bad Request | - |
58
+ |**401** | Unauthorized | - |
59
+ |**403** | Forbidden | - |
60
+ |**404** | Not Found | - |
61
+ |**405** | Method Not Allowed | - |
62
+ |**415** | Unsupported Media Type | - |
63
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
64
+ |**500** | Internal Server Error | - |
65
+
66
+ [[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)
67
+
@@ -0,0 +1,24 @@
1
+ # StirShaken
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. | [optional] [default to undefined]
9
+ **attestationIndicator** | **string** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] [default to undefined]
10
+ **originatingId** | **string** | (optional) A unique origination identifier. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { StirShaken } from 'bandwidth-sdk';
16
+
17
+ const instance: StirShaken = {
18
+ verstat,
19
+ attestationIndicator,
20
+ originatingId,
21
+ };
22
+ ```
23
+
24
+ [[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,20 @@
1
+ # TelephoneNumber
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **telephoneNumber** | **string** | Simple Telephone Number. | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { TelephoneNumber } from 'bandwidth-sdk';
14
+
15
+ const instance: TelephoneNumber = {
16
+ telephoneNumber,
17
+ };
18
+ ```
19
+
20
+ [[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
+ # TfvBasicAuthentication
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **username** | **string** | | [default to undefined]
9
+ **password** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { TfvBasicAuthentication } from 'bandwidth-sdk';
15
+
16
+ const instance: TfvBasicAuthentication = {
17
+ username,
18
+ password,
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,10 @@
1
+ # TfvCallbackStatusEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Verified` (value: `'VERIFIED'`)
7
+
8
+ * `Unverified` (value: `'UNVERIFIED'`)
9
+
10
+ [[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,25 @@
1
+ # TfvError
2
+
3
+ A generic error object.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **type** | **string** | | [optional] [default to undefined]
10
+ **description** | **string** | | [optional] [default to undefined]
11
+ **errors** | **object** | Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field. | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TfvError } from 'bandwidth-sdk';
17
+
18
+ const instance: TfvError = {
19
+ type,
20
+ description,
21
+ errors,
22
+ };
23
+ ```
24
+
25
+ [[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,38 @@
1
+ # TfvStatus
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
9
+ **status** | [**TfvStatusEnum**](TfvStatusEnum.md) | | [optional] [default to undefined]
10
+ **internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] [default to undefined]
11
+ **declineReasonDescription** | **string** | Explanation for why a verification request was declined. | [optional] [default to undefined]
12
+ **resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined]
13
+ **createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined]
14
+ **modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined]
15
+ **submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] [default to undefined]
16
+ **blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
17
+ **blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { TfvStatus } from 'bandwidth-sdk';
23
+
24
+ const instance: TfvStatus = {
25
+ phoneNumber,
26
+ status,
27
+ internalTicketNumber,
28
+ declineReasonDescription,
29
+ resubmitAllowed,
30
+ createdDateTime,
31
+ modifiedDateTime,
32
+ submission,
33
+ blocked,
34
+ blockedReason,
35
+ };
36
+ ```
37
+
38
+ [[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,12 @@
1
+ # TfvStatusEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Verified` (value: `'VERIFIED'`)
7
+
8
+ * `Unverified` (value: `'UNVERIFIED'`)
9
+
10
+ * `Pending` (value: `'PENDING'`)
11
+
12
+ [[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,42 @@
1
+ # TfvSubmissionInfo
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **businessAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
9
+ **businessContact** | [**Contact**](Contact.md) | | [optional] [default to undefined]
10
+ **messageVolume** | **number** | Estimated monthly volume of messages from the toll-free number. | [optional] [default to undefined]
11
+ **useCase** | **string** | The category of the use case. | [optional] [default to undefined]
12
+ **useCaseSummary** | **string** | A general idea of the use case and customer. | [optional] [default to undefined]
13
+ **productionMessageContent** | **string** | Example of message content. | [optional] [default to undefined]
14
+ **optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional] [default to undefined]
15
+ **additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
16
+ **isvReseller** | **string** | ISV name. | [optional] [default to undefined]
17
+ **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
18
+ **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
19
+ **businessDBA** | **string** | The company \&#39;Doing Business As\&#39;. (Not Available Until 5/28/2025) | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { TfvSubmissionInfo } from 'bandwidth-sdk';
25
+
26
+ const instance: TfvSubmissionInfo = {
27
+ businessAddress,
28
+ businessContact,
29
+ messageVolume,
30
+ useCase,
31
+ useCaseSummary,
32
+ productionMessageContent,
33
+ optInWorkflow,
34
+ additionalInformation,
35
+ isvReseller,
36
+ privacyPolicyUrl,
37
+ termsAndConditionsUrl,
38
+ businessDBA,
39
+ };
40
+ ```
41
+
42
+ [[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,20 @@
1
+ # TfvSubmissionWrapper
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **submission** | [**VerificationUpdateRequest**](VerificationUpdateRequest.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { TfvSubmissionWrapper } from 'bandwidth-sdk';
14
+
15
+ const instance: TfvSubmissionWrapper = {
16
+ submission,
17
+ };
18
+ ```
19
+
20
+ [[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,11 @@
1
+ # ThumbnailAlignmentEnum
2
+
3
+ The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation.
4
+
5
+ ## Enum
6
+
7
+ * `Left` (value: `'LEFT'`)
8
+
9
+ * `Right` (value: `'RIGHT'`)
10
+
11
+ [[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,20 @@
1
+ # TnLookupRequestError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | A description of what validation error occurred. | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { TnLookupRequestError } from 'bandwidth-sdk';
14
+
15
+ const instance: TnLookupRequestError = {
16
+ message,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)