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,20 @@
1
+ # RecordingTranscriptions
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **transcripts** | [**Array<Transcription>**](Transcription.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { RecordingTranscriptions } from 'bandwidth-sdk';
14
+
15
+ const instance: RecordingTranscriptions = {
16
+ transcripts,
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,675 @@
1
+ # RecordingsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**deleteRecording**](#deleterecording) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Delete Recording|
8
+ |[**deleteRecordingMedia**](#deleterecordingmedia) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Delete Recording Media|
9
+ |[**deleteRecordingTranscription**](#deleterecordingtranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Delete Transcription|
10
+ |[**downloadCallRecording**](#downloadcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media | Download Recording|
11
+ |[**getCallRecording**](#getcallrecording) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId} | Get Call Recording|
12
+ |[**getRecordingTranscription**](#getrecordingtranscription) | **GET** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Get Transcription|
13
+ |[**listAccountCallRecordings**](#listaccountcallrecordings) | **GET** /accounts/{accountId}/recordings | Get Call Recordings|
14
+ |[**listCallRecordings**](#listcallrecordings) | **GET** /accounts/{accountId}/calls/{callId}/recordings | List Call Recordings|
15
+ |[**transcribeCallRecording**](#transcribecallrecording) | **POST** /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription | Create Transcription Request|
16
+ |[**updateCallRecordingState**](#updatecallrecordingstate) | **PUT** /accounts/{accountId}/calls/{callId}/recording | Update Recording|
17
+
18
+ # **deleteRecording**
19
+ > deleteRecording()
20
+
21
+ Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
22
+
23
+ ### Example
24
+
25
+ ```typescript
26
+ import {
27
+ RecordingsApi,
28
+ Configuration
29
+ } from 'bandwidth-sdk';
30
+
31
+ const configuration = new Configuration();
32
+ const apiInstance = new RecordingsApi(configuration);
33
+
34
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
35
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
36
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
37
+
38
+ const { status, data } = await apiInstance.deleteRecording(
39
+ accountId,
40
+ callId,
41
+ recordingId
42
+ );
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ |Name | Type | Description | Notes|
48
+ |------------- | ------------- | ------------- | -------------|
49
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
50
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
51
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
52
+
53
+
54
+ ### Return type
55
+
56
+ void (empty response body)
57
+
58
+ ### Authorization
59
+
60
+ [Basic](../README.md#Basic)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: Not defined
65
+ - **Accept**: application/json
66
+
67
+
68
+ ### HTTP response details
69
+ | Status code | Description | Response headers |
70
+ |-------------|-------------|------------------|
71
+ |**204** | Recording was deleted. | - |
72
+ |**400** | Bad Request | - |
73
+ |**401** | Unauthorized | - |
74
+ |**403** | Forbidden | - |
75
+ |**404** | Not Found | - |
76
+ |**405** | Method Not Allowed | - |
77
+ |**415** | Unsupported Media Type | - |
78
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
79
+ |**500** | Internal Server Error | - |
80
+
81
+ [[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)
82
+
83
+ # **deleteRecordingMedia**
84
+ > deleteRecordingMedia()
85
+
86
+ Deletes the specified recording\'s media.
87
+
88
+ ### Example
89
+
90
+ ```typescript
91
+ import {
92
+ RecordingsApi,
93
+ Configuration
94
+ } from 'bandwidth-sdk';
95
+
96
+ const configuration = new Configuration();
97
+ const apiInstance = new RecordingsApi(configuration);
98
+
99
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
100
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
101
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
102
+
103
+ const { status, data } = await apiInstance.deleteRecordingMedia(
104
+ accountId,
105
+ callId,
106
+ recordingId
107
+ );
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ |Name | Type | Description | Notes|
113
+ |------------- | ------------- | ------------- | -------------|
114
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
115
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
116
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
117
+
118
+
119
+ ### Return type
120
+
121
+ void (empty response body)
122
+
123
+ ### Authorization
124
+
125
+ [Basic](../README.md#Basic)
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: Not defined
130
+ - **Accept**: application/json
131
+
132
+
133
+ ### HTTP response details
134
+ | Status code | Description | Response headers |
135
+ |-------------|-------------|------------------|
136
+ |**204** | The recording media was successfully deleted. | - |
137
+ |**400** | Bad Request | - |
138
+ |**401** | Unauthorized | - |
139
+ |**403** | Forbidden | - |
140
+ |**404** | Not Found | - |
141
+ |**405** | Method Not Allowed | - |
142
+ |**415** | Unsupported Media Type | - |
143
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
144
+ |**500** | Internal Server Error | - |
145
+
146
+ [[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)
147
+
148
+ # **deleteRecordingTranscription**
149
+ > deleteRecordingTranscription()
150
+
151
+ Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
152
+
153
+ ### Example
154
+
155
+ ```typescript
156
+ import {
157
+ RecordingsApi,
158
+ Configuration
159
+ } from 'bandwidth-sdk';
160
+
161
+ const configuration = new Configuration();
162
+ const apiInstance = new RecordingsApi(configuration);
163
+
164
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
165
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
166
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
167
+
168
+ const { status, data } = await apiInstance.deleteRecordingTranscription(
169
+ accountId,
170
+ callId,
171
+ recordingId
172
+ );
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ |Name | Type | Description | Notes|
178
+ |------------- | ------------- | ------------- | -------------|
179
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
180
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
181
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
182
+
183
+
184
+ ### Return type
185
+
186
+ void (empty response body)
187
+
188
+ ### Authorization
189
+
190
+ [Basic](../README.md#Basic)
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: Not defined
195
+ - **Accept**: application/json
196
+
197
+
198
+ ### HTTP response details
199
+ | Status code | Description | Response headers |
200
+ |-------------|-------------|------------------|
201
+ |**204** | The transcription was successfully deleted. | - |
202
+ |**400** | Bad Request | - |
203
+ |**401** | Unauthorized | - |
204
+ |**403** | Forbidden | - |
205
+ |**404** | Not Found | - |
206
+ |**405** | Method Not Allowed | - |
207
+ |**415** | Unsupported Media Type | - |
208
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
209
+ |**500** | Internal Server Error | - |
210
+
211
+ [[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)
212
+
213
+ # **downloadCallRecording**
214
+ > File downloadCallRecording()
215
+
216
+ Downloads the specified recording.
217
+
218
+ ### Example
219
+
220
+ ```typescript
221
+ import {
222
+ RecordingsApi,
223
+ Configuration
224
+ } from 'bandwidth-sdk';
225
+
226
+ const configuration = new Configuration();
227
+ const apiInstance = new RecordingsApi(configuration);
228
+
229
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
230
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
231
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
232
+
233
+ const { status, data } = await apiInstance.downloadCallRecording(
234
+ accountId,
235
+ callId,
236
+ recordingId
237
+ );
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ |Name | Type | Description | Notes|
243
+ |------------- | ------------- | ------------- | -------------|
244
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
245
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
246
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
247
+
248
+
249
+ ### Return type
250
+
251
+ **File**
252
+
253
+ ### Authorization
254
+
255
+ [Basic](../README.md#Basic)
256
+
257
+ ### HTTP request headers
258
+
259
+ - **Content-Type**: Not defined
260
+ - **Accept**: audio/vnd.wave, audio/mpeg, application/json
261
+
262
+
263
+ ### HTTP response details
264
+ | Status code | Description | Response headers |
265
+ |-------------|-------------|------------------|
266
+ |**200** | OK | - |
267
+ |**400** | Bad Request | - |
268
+ |**401** | Unauthorized | - |
269
+ |**403** | Forbidden | - |
270
+ |**404** | Not Found | - |
271
+ |**405** | Method Not Allowed | - |
272
+ |**415** | Unsupported Media Type | - |
273
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
274
+ |**500** | Internal Server Error | - |
275
+
276
+ [[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)
277
+
278
+ # **getCallRecording**
279
+ > CallRecordingMetadata getCallRecording()
280
+
281
+ Returns metadata for the specified recording.
282
+
283
+ ### Example
284
+
285
+ ```typescript
286
+ import {
287
+ RecordingsApi,
288
+ Configuration
289
+ } from 'bandwidth-sdk';
290
+
291
+ const configuration = new Configuration();
292
+ const apiInstance = new RecordingsApi(configuration);
293
+
294
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
295
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
296
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
297
+
298
+ const { status, data } = await apiInstance.getCallRecording(
299
+ accountId,
300
+ callId,
301
+ recordingId
302
+ );
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ |Name | Type | Description | Notes|
308
+ |------------- | ------------- | ------------- | -------------|
309
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
310
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
311
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
312
+
313
+
314
+ ### Return type
315
+
316
+ **CallRecordingMetadata**
317
+
318
+ ### Authorization
319
+
320
+ [Basic](../README.md#Basic)
321
+
322
+ ### HTTP request headers
323
+
324
+ - **Content-Type**: Not defined
325
+ - **Accept**: application/json
326
+
327
+
328
+ ### HTTP response details
329
+ | Status code | Description | Response headers |
330
+ |-------------|-------------|------------------|
331
+ |**200** | OK | - |
332
+ |**400** | Bad Request | - |
333
+ |**401** | Unauthorized | - |
334
+ |**403** | Forbidden | - |
335
+ |**404** | Not Found | - |
336
+ |**405** | Method Not Allowed | - |
337
+ |**415** | Unsupported Media Type | - |
338
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
339
+ |**500** | Internal Server Error | - |
340
+
341
+ [[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)
342
+
343
+ # **getRecordingTranscription**
344
+ > RecordingTranscriptions getRecordingTranscription()
345
+
346
+ Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [`<PlayAudio>`](/docs/voice/bxml/playAudio) and [`<SpeakSentence>`](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item.
347
+
348
+ ### Example
349
+
350
+ ```typescript
351
+ import {
352
+ RecordingsApi,
353
+ Configuration
354
+ } from 'bandwidth-sdk';
355
+
356
+ const configuration = new Configuration();
357
+ const apiInstance = new RecordingsApi(configuration);
358
+
359
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
360
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
361
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
362
+
363
+ const { status, data } = await apiInstance.getRecordingTranscription(
364
+ accountId,
365
+ callId,
366
+ recordingId
367
+ );
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ |Name | Type | Description | Notes|
373
+ |------------- | ------------- | ------------- | -------------|
374
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
375
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
376
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
377
+
378
+
379
+ ### Return type
380
+
381
+ **RecordingTranscriptions**
382
+
383
+ ### Authorization
384
+
385
+ [Basic](../README.md#Basic)
386
+
387
+ ### HTTP request headers
388
+
389
+ - **Content-Type**: Not defined
390
+ - **Accept**: application/json
391
+
392
+
393
+ ### HTTP response details
394
+ | Status code | Description | Response headers |
395
+ |-------------|-------------|------------------|
396
+ |**200** | OK | - |
397
+ |**400** | Bad Request | - |
398
+ |**401** | Unauthorized | - |
399
+ |**403** | Forbidden | - |
400
+ |**404** | Not Found | - |
401
+ |**405** | Method Not Allowed | - |
402
+ |**415** | Unsupported Media Type | - |
403
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
404
+ |**500** | Internal Server Error | - |
405
+
406
+ [[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)
407
+
408
+ # **listAccountCallRecordings**
409
+ > Array<CallRecordingMetadata> listAccountCallRecordings()
410
+
411
+ Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria.
412
+
413
+ ### Example
414
+
415
+ ```typescript
416
+ import {
417
+ RecordingsApi,
418
+ Configuration
419
+ } from 'bandwidth-sdk';
420
+
421
+ const configuration = new Configuration();
422
+ const apiInstance = new RecordingsApi(configuration);
423
+
424
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
425
+ let to: string; //Filter results by the `to` field. (optional) (default to undefined)
426
+ let from: string; //Filter results by the `from` field. (optional) (default to undefined)
427
+ let minStartTime: string; //Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). (optional) (default to undefined)
428
+ let maxStartTime: string; //Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). (optional) (default to undefined)
429
+
430
+ const { status, data } = await apiInstance.listAccountCallRecordings(
431
+ accountId,
432
+ to,
433
+ from,
434
+ minStartTime,
435
+ maxStartTime
436
+ );
437
+ ```
438
+
439
+ ### Parameters
440
+
441
+ |Name | Type | Description | Notes|
442
+ |------------- | ------------- | ------------- | -------------|
443
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
444
+ | **to** | [**string**] | Filter results by the &#x60;to&#x60; field. | (optional) defaults to undefined|
445
+ | **from** | [**string**] | Filter results by the &#x60;from&#x60; field. | (optional) defaults to undefined|
446
+ | **minStartTime** | [**string**] | Filter results to recordings which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format). | (optional) defaults to undefined|
447
+ | **maxStartTime** | [**string**] | Filter results to recordings which have a &#x60;startTime&#x60; before &#x60;maxStartTime&#x60; (in ISO8601 format). | (optional) defaults to undefined|
448
+
449
+
450
+ ### Return type
451
+
452
+ **Array<CallRecordingMetadata>**
453
+
454
+ ### Authorization
455
+
456
+ [Basic](../README.md#Basic)
457
+
458
+ ### HTTP request headers
459
+
460
+ - **Content-Type**: Not defined
461
+ - **Accept**: application/json
462
+
463
+
464
+ ### HTTP response details
465
+ | Status code | Description | Response headers |
466
+ |-------------|-------------|------------------|
467
+ |**200** | OK | - |
468
+ |**400** | Bad Request | - |
469
+ |**401** | Unauthorized | - |
470
+ |**403** | Forbidden | - |
471
+ |**404** | Not Found | - |
472
+ |**405** | Method Not Allowed | - |
473
+ |**415** | Unsupported Media Type | - |
474
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
475
+ |**500** | Internal Server Error | - |
476
+
477
+ [[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)
478
+
479
+ # **listCallRecordings**
480
+ > Array<CallRecordingMetadata> listCallRecordings()
481
+
482
+ Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
483
+
484
+ ### Example
485
+
486
+ ```typescript
487
+ import {
488
+ RecordingsApi,
489
+ Configuration
490
+ } from 'bandwidth-sdk';
491
+
492
+ const configuration = new Configuration();
493
+ const apiInstance = new RecordingsApi(configuration);
494
+
495
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
496
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
497
+
498
+ const { status, data } = await apiInstance.listCallRecordings(
499
+ accountId,
500
+ callId
501
+ );
502
+ ```
503
+
504
+ ### Parameters
505
+
506
+ |Name | Type | Description | Notes|
507
+ |------------- | ------------- | ------------- | -------------|
508
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
509
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
510
+
511
+
512
+ ### Return type
513
+
514
+ **Array<CallRecordingMetadata>**
515
+
516
+ ### Authorization
517
+
518
+ [Basic](../README.md#Basic)
519
+
520
+ ### HTTP request headers
521
+
522
+ - **Content-Type**: Not defined
523
+ - **Accept**: application/json
524
+
525
+
526
+ ### HTTP response details
527
+ | Status code | Description | Response headers |
528
+ |-------------|-------------|------------------|
529
+ |**200** | OK | - |
530
+ |**400** | Bad Request | - |
531
+ |**401** | Unauthorized | - |
532
+ |**403** | Forbidden | - |
533
+ |**404** | Not Found | - |
534
+ |**405** | Method Not Allowed | - |
535
+ |**415** | Unsupported Media Type | - |
536
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
537
+ |**500** | Internal Server Error | - |
538
+
539
+ [[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)
540
+
541
+ # **transcribeCallRecording**
542
+ > transcribeCallRecording(transcribeRecording)
543
+
544
+ Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
545
+
546
+ ### Example
547
+
548
+ ```typescript
549
+ import {
550
+ RecordingsApi,
551
+ Configuration,
552
+ TranscribeRecording
553
+ } from 'bandwidth-sdk';
554
+
555
+ const configuration = new Configuration();
556
+ const apiInstance = new RecordingsApi(configuration);
557
+
558
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
559
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
560
+ let recordingId: string; //Programmable Voice API Recording ID. (default to undefined)
561
+ let transcribeRecording: TranscribeRecording; //
562
+
563
+ const { status, data } = await apiInstance.transcribeCallRecording(
564
+ accountId,
565
+ callId,
566
+ recordingId,
567
+ transcribeRecording
568
+ );
569
+ ```
570
+
571
+ ### Parameters
572
+
573
+ |Name | Type | Description | Notes|
574
+ |------------- | ------------- | ------------- | -------------|
575
+ | **transcribeRecording** | **TranscribeRecording**| | |
576
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
577
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
578
+ | **recordingId** | [**string**] | Programmable Voice API Recording ID. | defaults to undefined|
579
+
580
+
581
+ ### Return type
582
+
583
+ void (empty response body)
584
+
585
+ ### Authorization
586
+
587
+ [Basic](../README.md#Basic)
588
+
589
+ ### HTTP request headers
590
+
591
+ - **Content-Type**: application/json
592
+ - **Accept**: application/json
593
+
594
+
595
+ ### HTTP response details
596
+ | Status code | Description | Response headers |
597
+ |-------------|-------------|------------------|
598
+ |**204** | Transcription was successfully requested. | - |
599
+ |**400** | Bad Request | - |
600
+ |**401** | Unauthorized | - |
601
+ |**403** | Forbidden | - |
602
+ |**404** | Not Found | - |
603
+ |**405** | Method Not Allowed | - |
604
+ |**415** | Unsupported Media Type | - |
605
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
606
+ |**500** | Internal Server Error | - |
607
+
608
+ [[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)
609
+
610
+ # **updateCallRecordingState**
611
+ > updateCallRecordingState(updateCallRecording)
612
+
613
+ Pause or resume a recording on an active phone call.
614
+
615
+ ### Example
616
+
617
+ ```typescript
618
+ import {
619
+ RecordingsApi,
620
+ Configuration,
621
+ UpdateCallRecording
622
+ } from 'bandwidth-sdk';
623
+
624
+ const configuration = new Configuration();
625
+ const apiInstance = new RecordingsApi(configuration);
626
+
627
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
628
+ let callId: string; //Programmable Voice API Call ID. (default to undefined)
629
+ let updateCallRecording: UpdateCallRecording; //
630
+
631
+ const { status, data } = await apiInstance.updateCallRecordingState(
632
+ accountId,
633
+ callId,
634
+ updateCallRecording
635
+ );
636
+ ```
637
+
638
+ ### Parameters
639
+
640
+ |Name | Type | Description | Notes|
641
+ |------------- | ------------- | ------------- | -------------|
642
+ | **updateCallRecording** | **UpdateCallRecording**| | |
643
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
644
+ | **callId** | [**string**] | Programmable Voice API Call ID. | defaults to undefined|
645
+
646
+
647
+ ### Return type
648
+
649
+ void (empty response body)
650
+
651
+ ### Authorization
652
+
653
+ [Basic](../README.md#Basic)
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: application/json
658
+ - **Accept**: application/json
659
+
660
+
661
+ ### HTTP response details
662
+ | Status code | Description | Response headers |
663
+ |-------------|-------------|------------------|
664
+ |**200** | OK | - |
665
+ |**400** | Bad Request | - |
666
+ |**401** | Unauthorized | - |
667
+ |**403** | Forbidden | - |
668
+ |**404** | Not Found | - |
669
+ |**405** | Method Not Allowed | - |
670
+ |**415** | Unsupported Media Type | - |
671
+ |**429** | Too Many Requests | * Retry-After - When you should try your request again. <br> |
672
+ |**500** | Internal Server Error | - |
673
+
674
+ [[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)
675
+