bandwidth-sdk 0.1.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 (570) hide show
  1. package/.bandwidth/catalog-info.yaml +13 -0
  2. package/.bandwidth/component.yaml +20 -0
  3. package/.github/CODEOWNERS +5 -0
  4. package/.github/ISSUE_TEMPLATE/bug_report.md +40 -0
  5. package/.github/ISSUE_TEMPLATE/config.yml +5 -0
  6. package/.github/workflows/deploy.yml +69 -0
  7. package/.github/workflows/test-nightly.yml +64 -0
  8. package/.github/workflows/test-pr.yml +48 -0
  9. package/.github/workflows/update-sdk.yml +95 -0
  10. package/.openapi-generator/FILES +107 -0
  11. package/.openapi-generator/VERSION +1 -0
  12. package/.openapi-generator-ignore +4 -0
  13. package/README.md +45 -0
  14. package/api/calls-api.ts +539 -0
  15. package/api/conferences-api.ts +880 -0
  16. package/api/media-api.ts +410 -0
  17. package/api/messages-api.ts +351 -0
  18. package/api/mfaapi.ts +322 -0
  19. package/api/phone-number-lookup-api.ts +230 -0
  20. package/api/recordings-api.ts +962 -0
  21. package/api/statistics-api.ts +137 -0
  22. package/api.ts +25 -0
  23. package/bandwidth.yml +5726 -0
  24. package/base.ts +302 -0
  25. package/common.ts +150 -0
  26. package/configuration.ts +110 -0
  27. package/coverage/clover.xml +1636 -0
  28. package/coverage/coverage-final.json +63 -0
  29. package/coverage/lcov-report/base.css +224 -0
  30. package/coverage/lcov-report/block-navigation.js +87 -0
  31. package/coverage/lcov-report/favicon.png +0 -0
  32. package/coverage/lcov-report/index.html +191 -0
  33. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1702 -0
  34. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2725 -0
  35. package/coverage/lcov-report/node-sdk/api/index.html +221 -0
  36. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1315 -0
  37. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1138 -0
  38. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1051 -0
  39. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +775 -0
  40. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2971 -0
  41. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +496 -0
  42. package/coverage/lcov-report/node-sdk/base.ts.html +991 -0
  43. package/coverage/lcov-report/node-sdk/common.ts.html +535 -0
  44. package/coverage/lcov-report/node-sdk/configuration.ts.html +415 -0
  45. package/coverage/lcov-report/node-sdk/index.html +146 -0
  46. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +148 -0
  47. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +196 -0
  48. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +148 -0
  49. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +214 -0
  50. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +208 -0
  51. package/coverage/lcov-report/node-sdk/models/bxml/index.html +191 -0
  52. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +94 -0
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +196 -0
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +196 -0
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +160 -0
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +169 -0
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +262 -0
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +133 -0
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +154 -0
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +133 -0
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +190 -0
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +163 -0
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +205 -0
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +178 -0
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +133 -0
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +157 -0
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +163 -0
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +193 -0
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +196 -0
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +166 -0
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +181 -0
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +202 -0
  73. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +205 -0
  74. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +133 -0
  75. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +133 -0
  76. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +154 -0
  77. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +154 -0
  78. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +157 -0
  79. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +142 -0
  80. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +229 -0
  81. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +536 -0
  82. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +175 -0
  83. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +178 -0
  84. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +178 -0
  85. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +178 -0
  86. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +178 -0
  87. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +178 -0
  88. package/coverage/lcov-report/node-sdk/models/index.html +326 -0
  89. package/coverage/lcov-report/node-sdk/models/index.ts.html +352 -0
  90. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +178 -0
  91. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +184 -0
  92. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +178 -0
  93. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +178 -0
  94. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +196 -0
  95. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +178 -0
  96. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +178 -0
  97. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +178 -0
  98. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +178 -0
  99. package/coverage/lcov-report/node-sdk/tests/callUtils.js.html +334 -0
  100. package/coverage/lcov-report/node-sdk/tests/index.html +116 -0
  101. package/coverage/lcov-report/prettify.css +1 -0
  102. package/coverage/lcov-report/prettify.js +2 -0
  103. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  104. package/coverage/lcov-report/sorter.js +196 -0
  105. package/coverage/lcov.info +3845 -0
  106. package/custom_templates/modelIndex.mustache +3 -0
  107. package/custom_templates/package.mustache +44 -0
  108. package/custom_templates/tsconfig.mustache +27 -0
  109. package/dist/api/calls-api.d.ts +261 -0
  110. package/dist/api/calls-api.js +627 -0
  111. package/dist/api/conferences-api.d.ts +422 -0
  112. package/dist/api/conferences-api.js +1000 -0
  113. package/dist/api/media-api.d.ts +201 -0
  114. package/dist/api/media-api.js +502 -0
  115. package/dist/api/messages-api.d.ts +176 -0
  116. package/dist/api/messages-api.js +403 -0
  117. package/dist/api/mfaapi.d.ts +156 -0
  118. package/dist/api/mfaapi.js +395 -0
  119. package/dist/api/phone-number-lookup-api.d.ts +117 -0
  120. package/dist/api/phone-number-lookup-api.js +305 -0
  121. package/dist/api/recordings-api.d.ts +462 -0
  122. package/dist/api/recordings-api.js +1094 -0
  123. package/dist/api/statistics-api.d.ts +74 -0
  124. package/dist/api/statistics-api.js +209 -0
  125. package/dist/api.d.ts +19 -0
  126. package/dist/api.js +37 -0
  127. package/dist/base.d.ts +66 -0
  128. package/dist/base.js +303 -0
  129. package/dist/common.d.ts +65 -0
  130. package/dist/common.js +252 -0
  131. package/dist/configuration.d.ts +91 -0
  132. package/dist/configuration.js +45 -0
  133. package/dist/index.d.ts +14 -0
  134. package/dist/index.js +32 -0
  135. package/dist/models/account-statistics.d.ts +30 -0
  136. package/dist/models/account-statistics.js +15 -0
  137. package/dist/models/answer-callback.d.ts +104 -0
  138. package/dist/models/answer-callback.js +15 -0
  139. package/dist/models/bridge-complete-callback.d.ts +115 -0
  140. package/dist/models/bridge-complete-callback.js +15 -0
  141. package/dist/models/bridge-target-complete-callback.d.ts +97 -0
  142. package/dist/models/bridge-target-complete-callback.js +15 -0
  143. package/dist/models/bxml/Bxml.d.ts +17 -0
  144. package/dist/models/bxml/Bxml.js +37 -0
  145. package/dist/models/bxml/NestableVerb.d.ts +26 -0
  146. package/dist/models/bxml/NestableVerb.js +52 -0
  147. package/dist/models/bxml/Response.d.ts +17 -0
  148. package/dist/models/bxml/Response.js +37 -0
  149. package/dist/models/bxml/Root.d.ts +28 -0
  150. package/dist/models/bxml/Root.js +40 -0
  151. package/dist/models/bxml/Verb.d.ts +27 -0
  152. package/dist/models/bxml/Verb.js +38 -0
  153. package/dist/models/bxml/index.d.ts +2 -0
  154. package/dist/models/bxml/index.js +5 -0
  155. package/dist/models/bxml/verbs/Bridge.d.ts +31 -0
  156. package/dist/models/bxml/verbs/Bridge.js +38 -0
  157. package/dist/models/bxml/verbs/Conference.d.ts +33 -0
  158. package/dist/models/bxml/verbs/Conference.js +38 -0
  159. package/dist/models/bxml/verbs/CustomParam.d.ts +20 -0
  160. package/dist/models/bxml/verbs/CustomParam.js +37 -0
  161. package/dist/models/bxml/verbs/Forward.d.ts +24 -0
  162. package/dist/models/bxml/verbs/Forward.js +37 -0
  163. package/dist/models/bxml/verbs/Gather.d.ts +47 -0
  164. package/dist/models/bxml/verbs/Gather.js +53 -0
  165. package/dist/models/bxml/verbs/Hangup.d.ts +13 -0
  166. package/dist/models/bxml/verbs/Hangup.js +36 -0
  167. package/dist/models/bxml/verbs/Pause.d.ts +19 -0
  168. package/dist/models/bxml/verbs/Pause.js +37 -0
  169. package/dist/models/bxml/verbs/PauseRecording.d.ts +13 -0
  170. package/dist/models/bxml/verbs/PauseRecording.js +36 -0
  171. package/dist/models/bxml/verbs/PhoneNumber.d.ts +31 -0
  172. package/dist/models/bxml/verbs/PhoneNumber.js +38 -0
  173. package/dist/models/bxml/verbs/PlayAudio.d.ts +22 -0
  174. package/dist/models/bxml/verbs/PlayAudio.js +38 -0
  175. package/dist/models/bxml/verbs/Record.d.ts +36 -0
  176. package/dist/models/bxml/verbs/Record.js +37 -0
  177. package/dist/models/bxml/verbs/Redirect.d.ts +27 -0
  178. package/dist/models/bxml/verbs/Redirect.js +37 -0
  179. package/dist/models/bxml/verbs/ResumeRecording.d.ts +13 -0
  180. package/dist/models/bxml/verbs/ResumeRecording.js +36 -0
  181. package/dist/models/bxml/verbs/Ring.d.ts +20 -0
  182. package/dist/models/bxml/verbs/Ring.js +37 -0
  183. package/dist/models/bxml/verbs/SendDtmf.d.ts +22 -0
  184. package/dist/models/bxml/verbs/SendDtmf.js +38 -0
  185. package/dist/models/bxml/verbs/SipUri.d.ts +32 -0
  186. package/dist/models/bxml/verbs/SipUri.js +38 -0
  187. package/dist/models/bxml/verbs/SpeakSentence.d.ts +29 -0
  188. package/dist/models/bxml/verbs/SpeakSentence.js +46 -0
  189. package/dist/models/bxml/verbs/StartGather.d.ts +23 -0
  190. package/dist/models/bxml/verbs/StartGather.js +37 -0
  191. package/dist/models/bxml/verbs/StartRecording.d.ts +28 -0
  192. package/dist/models/bxml/verbs/StartRecording.js +37 -0
  193. package/dist/models/bxml/verbs/StartStream.d.ts +32 -0
  194. package/dist/models/bxml/verbs/StartStream.js +45 -0
  195. package/dist/models/bxml/verbs/StartTranscription.d.ts +33 -0
  196. package/dist/models/bxml/verbs/StartTranscription.js +45 -0
  197. package/dist/models/bxml/verbs/StopGather.d.ts +13 -0
  198. package/dist/models/bxml/verbs/StopGather.js +36 -0
  199. package/dist/models/bxml/verbs/StopRecording.d.ts +13 -0
  200. package/dist/models/bxml/verbs/StopRecording.js +36 -0
  201. package/dist/models/bxml/verbs/StopStream.d.ts +19 -0
  202. package/dist/models/bxml/verbs/StopStream.js +37 -0
  203. package/dist/models/bxml/verbs/StopTranscription.d.ts +19 -0
  204. package/dist/models/bxml/verbs/StopTranscription.js +37 -0
  205. package/dist/models/bxml/verbs/StreamParam.d.ts +20 -0
  206. package/dist/models/bxml/verbs/StreamParam.js +37 -0
  207. package/dist/models/bxml/verbs/Tag.d.ts +15 -0
  208. package/dist/models/bxml/verbs/Tag.js +37 -0
  209. package/dist/models/bxml/verbs/Transfer.d.ts +40 -0
  210. package/dist/models/bxml/verbs/Transfer.js +45 -0
  211. package/dist/models/bxml/verbs/index.d.ts +30 -0
  212. package/dist/models/bxml/verbs/index.js +46 -0
  213. package/dist/models/call-direction-enum.d.ts +21 -0
  214. package/dist/models/call-direction-enum.js +25 -0
  215. package/dist/models/call-recording-metadata.d.ts +129 -0
  216. package/dist/models/call-recording-metadata.js +15 -0
  217. package/dist/models/call-state-enum.d.ts +21 -0
  218. package/dist/models/call-state-enum.js +25 -0
  219. package/dist/models/call-state.d.ts +129 -0
  220. package/dist/models/call-state.js +15 -0
  221. package/dist/models/callback-method-enum.d.ts +21 -0
  222. package/dist/models/callback-method-enum.js +25 -0
  223. package/dist/models/code-request.d.ts +54 -0
  224. package/dist/models/code-request.js +15 -0
  225. package/dist/models/conference-completed-callback.d.ts +48 -0
  226. package/dist/models/conference-completed-callback.js +15 -0
  227. package/dist/models/conference-created-callback.d.ts +48 -0
  228. package/dist/models/conference-created-callback.js +15 -0
  229. package/dist/models/conference-member-exit-callback.d.ts +66 -0
  230. package/dist/models/conference-member-exit-callback.js +15 -0
  231. package/dist/models/conference-member-join-callback.d.ts +66 -0
  232. package/dist/models/conference-member-join-callback.js +15 -0
  233. package/dist/models/conference-member.d.ts +54 -0
  234. package/dist/models/conference-member.js +15 -0
  235. package/dist/models/conference-recording-available-callback.d.ts +103 -0
  236. package/dist/models/conference-recording-available-callback.js +15 -0
  237. package/dist/models/conference-recording-metadata.d.ts +85 -0
  238. package/dist/models/conference-recording-metadata.js +15 -0
  239. package/dist/models/conference-redirect-callback.d.ts +48 -0
  240. package/dist/models/conference-redirect-callback.js +15 -0
  241. package/dist/models/conference-state-enum.d.ts +21 -0
  242. package/dist/models/conference-state-enum.js +25 -0
  243. package/dist/models/conference.d.ts +68 -0
  244. package/dist/models/conference.js +15 -0
  245. package/dist/models/create-call-response.d.ts +145 -0
  246. package/dist/models/create-call-response.js +15 -0
  247. package/dist/models/create-call.d.ts +140 -0
  248. package/dist/models/create-call.js +15 -0
  249. package/dist/models/create-lookup-response.d.ts +31 -0
  250. package/dist/models/create-lookup-response.js +15 -0
  251. package/dist/models/create-message-request-error.d.ts +37 -0
  252. package/dist/models/create-message-request-error.js +15 -0
  253. package/dist/models/deferred-result.d.ts +30 -0
  254. package/dist/models/deferred-result.js +15 -0
  255. package/dist/models/disconnect-callback.d.ts +121 -0
  256. package/dist/models/disconnect-callback.js +15 -0
  257. package/dist/models/diversion.d.ts +60 -0
  258. package/dist/models/diversion.js +15 -0
  259. package/dist/models/dtmf-callback.d.ts +121 -0
  260. package/dist/models/dtmf-callback.js +15 -0
  261. package/dist/models/field-error.d.ts +30 -0
  262. package/dist/models/field-error.js +15 -0
  263. package/dist/models/file-format-enum.d.ts +21 -0
  264. package/dist/models/file-format-enum.js +25 -0
  265. package/dist/models/gather-callback.d.ts +127 -0
  266. package/dist/models/gather-callback.js +15 -0
  267. package/dist/models/inbound-message-callback-message.d.ts +92 -0
  268. package/dist/models/inbound-message-callback-message.js +15 -0
  269. package/dist/models/inbound-message-callback.d.ts +49 -0
  270. package/dist/models/inbound-message-callback.js +15 -0
  271. package/dist/models/index.d.ts +89 -0
  272. package/dist/models/index.js +105 -0
  273. package/dist/models/initiate-callback.d.ts +93 -0
  274. package/dist/models/initiate-callback.js +15 -0
  275. package/dist/models/list-message-direction-enum.d.ts +21 -0
  276. package/dist/models/list-message-direction-enum.js +25 -0
  277. package/dist/models/list-message-item.d.ts +123 -0
  278. package/dist/models/list-message-item.js +15 -0
  279. package/dist/models/lookup-request.d.ts +24 -0
  280. package/dist/models/lookup-request.js +15 -0
  281. package/dist/models/lookup-result.d.ts +72 -0
  282. package/dist/models/lookup-result.js +15 -0
  283. package/dist/models/lookup-status-enum.d.ts +23 -0
  284. package/dist/models/lookup-status-enum.js +27 -0
  285. package/dist/models/lookup-status.d.ts +44 -0
  286. package/dist/models/lookup-status.js +15 -0
  287. package/dist/models/machine-detection-complete-callback.d.ts +104 -0
  288. package/dist/models/machine-detection-complete-callback.js +15 -0
  289. package/dist/models/machine-detection-configuration.d.ts +110 -0
  290. package/dist/models/machine-detection-configuration.js +15 -0
  291. package/dist/models/machine-detection-mode-enum.d.ts +21 -0
  292. package/dist/models/machine-detection-mode-enum.js +25 -0
  293. package/dist/models/machine-detection-result.d.ts +30 -0
  294. package/dist/models/machine-detection-result.js +15 -0
  295. package/dist/models/media.d.ts +36 -0
  296. package/dist/models/media.js +15 -0
  297. package/dist/models/message-delivered-callback-message.d.ts +92 -0
  298. package/dist/models/message-delivered-callback-message.js +15 -0
  299. package/dist/models/message-delivered-callback.d.ts +49 -0
  300. package/dist/models/message-delivered-callback.js +15 -0
  301. package/dist/models/message-direction-enum.d.ts +21 -0
  302. package/dist/models/message-direction-enum.js +25 -0
  303. package/dist/models/message-failed-callback-message.d.ts +92 -0
  304. package/dist/models/message-failed-callback-message.js +15 -0
  305. package/dist/models/message-failed-callback.d.ts +55 -0
  306. package/dist/models/message-failed-callback.js +15 -0
  307. package/dist/models/message-request.d.ts +67 -0
  308. package/dist/models/message-request.js +15 -0
  309. package/dist/models/message-sending-callback-message.d.ts +92 -0
  310. package/dist/models/message-sending-callback-message.js +15 -0
  311. package/dist/models/message-sending-callback.d.ts +49 -0
  312. package/dist/models/message-sending-callback.js +15 -0
  313. package/dist/models/message-status-enum.d.ts +27 -0
  314. package/dist/models/message-status-enum.js +31 -0
  315. package/dist/models/message-type-enum.d.ts +21 -0
  316. package/dist/models/message-type-enum.js +25 -0
  317. package/dist/models/message.d.ts +98 -0
  318. package/dist/models/message.js +15 -0
  319. package/dist/models/messages-list.d.ts +38 -0
  320. package/dist/models/messages-list.js +15 -0
  321. package/dist/models/messaging-code-response.d.ts +24 -0
  322. package/dist/models/messaging-code-response.js +15 -0
  323. package/dist/models/messaging-request-error.d.ts +30 -0
  324. package/dist/models/messaging-request-error.js +15 -0
  325. package/dist/models/mfa-forbidden-request-error.d.ts +24 -0
  326. package/dist/models/mfa-forbidden-request-error.js +15 -0
  327. package/dist/models/mfa-request-error.d.ts +30 -0
  328. package/dist/models/mfa-request-error.js +15 -0
  329. package/dist/models/mfa-unauthorized-request-error.d.ts +24 -0
  330. package/dist/models/mfa-unauthorized-request-error.js +15 -0
  331. package/dist/models/page-info.d.ts +42 -0
  332. package/dist/models/page-info.js +15 -0
  333. package/dist/models/priority-enum.d.ts +21 -0
  334. package/dist/models/priority-enum.js +25 -0
  335. package/dist/models/recording-available-callback.d.ts +152 -0
  336. package/dist/models/recording-available-callback.js +15 -0
  337. package/dist/models/recording-complete-callback.d.ts +152 -0
  338. package/dist/models/recording-complete-callback.js +15 -0
  339. package/dist/models/recording-state-enum.d.ts +21 -0
  340. package/dist/models/recording-state-enum.js +25 -0
  341. package/dist/models/redirect-callback.d.ts +115 -0
  342. package/dist/models/redirect-callback.js +15 -0
  343. package/dist/models/redirect-method-enum.d.ts +21 -0
  344. package/dist/models/redirect-method-enum.js +25 -0
  345. package/dist/models/stir-shaken.d.ts +36 -0
  346. package/dist/models/stir-shaken.js +15 -0
  347. package/dist/models/tag.d.ts +30 -0
  348. package/dist/models/tag.js +15 -0
  349. package/dist/models/tn-lookup-request-error.d.ts +24 -0
  350. package/dist/models/tn-lookup-request-error.js +15 -0
  351. package/dist/models/transcribe-recording.d.ts +61 -0
  352. package/dist/models/transcribe-recording.js +15 -0
  353. package/dist/models/transcription-available-callback.d.ts +147 -0
  354. package/dist/models/transcription-available-callback.js +15 -0
  355. package/dist/models/transcription-list.d.ts +25 -0
  356. package/dist/models/transcription-list.js +15 -0
  357. package/dist/models/transcription-metadata.d.ts +42 -0
  358. package/dist/models/transcription-metadata.js +15 -0
  359. package/dist/models/transcription.d.ts +30 -0
  360. package/dist/models/transcription.js +15 -0
  361. package/dist/models/transfer-answer-callback.d.ts +109 -0
  362. package/dist/models/transfer-answer-callback.js +15 -0
  363. package/dist/models/transfer-complete-callback.d.ts +127 -0
  364. package/dist/models/transfer-complete-callback.js +15 -0
  365. package/dist/models/transfer-disconnect-callback.d.ts +139 -0
  366. package/dist/models/transfer-disconnect-callback.js +15 -0
  367. package/dist/models/update-call-recording.d.ts +25 -0
  368. package/dist/models/update-call-recording.js +15 -0
  369. package/dist/models/update-call.d.ts +80 -0
  370. package/dist/models/update-call.js +15 -0
  371. package/dist/models/update-conference-member.d.ts +36 -0
  372. package/dist/models/update-conference-member.js +15 -0
  373. package/dist/models/update-conference.d.ts +74 -0
  374. package/dist/models/update-conference.js +15 -0
  375. package/dist/models/verify-code-request.d.ts +42 -0
  376. package/dist/models/verify-code-request.js +15 -0
  377. package/dist/models/verify-code-response.d.ts +24 -0
  378. package/dist/models/verify-code-response.js +15 -0
  379. package/dist/models/voice-api-error.d.ts +36 -0
  380. package/dist/models/voice-api-error.js +15 -0
  381. package/dist/models/voice-code-response.d.ts +24 -0
  382. package/dist/models/voice-code-response.js +15 -0
  383. package/git_push.sh +57 -0
  384. package/index.ts +18 -0
  385. package/jest.config.js +26 -0
  386. package/models/account-statistics.ts +36 -0
  387. package/models/answer-callback.ts +116 -0
  388. package/models/bridge-complete-callback.ts +125 -0
  389. package/models/bridge-target-complete-callback.ts +107 -0
  390. package/models/bxml/Bxml.ts +21 -0
  391. package/models/bxml/NestableVerb.ts +37 -0
  392. package/models/bxml/Response.ts +21 -0
  393. package/models/bxml/Root.ts +43 -0
  394. package/models/bxml/Verb.ts +41 -0
  395. package/models/bxml/index.ts +3 -0
  396. package/models/bxml/verbs/Bridge.ts +37 -0
  397. package/models/bxml/verbs/Conference.ts +37 -0
  398. package/models/bxml/verbs/CustomParam.ts +25 -0
  399. package/models/bxml/verbs/Forward.ts +28 -0
  400. package/models/bxml/verbs/Gather.ts +59 -0
  401. package/models/bxml/verbs/Hangup.ts +16 -0
  402. package/models/bxml/verbs/Pause.ts +23 -0
  403. package/models/bxml/verbs/PauseRecording.ts +16 -0
  404. package/models/bxml/verbs/PhoneNumber.ts +35 -0
  405. package/models/bxml/verbs/PlayAudio.ts +26 -0
  406. package/models/bxml/verbs/Record.ts +40 -0
  407. package/models/bxml/verbs/Redirect.ts +31 -0
  408. package/models/bxml/verbs/ResumeRecording.ts +16 -0
  409. package/models/bxml/verbs/Ring.ts +24 -0
  410. package/models/bxml/verbs/SendDtmf.ts +26 -0
  411. package/models/bxml/verbs/SipUri.ts +36 -0
  412. package/models/bxml/verbs/SpeakSentence.ts +37 -0
  413. package/models/bxml/verbs/StartGather.ts +27 -0
  414. package/models/bxml/verbs/StartRecording.ts +32 -0
  415. package/models/bxml/verbs/StartStream.ts +39 -0
  416. package/models/bxml/verbs/StartTranscription.ts +40 -0
  417. package/models/bxml/verbs/StopGather.ts +16 -0
  418. package/models/bxml/verbs/StopRecording.ts +16 -0
  419. package/models/bxml/verbs/StopStream.ts +23 -0
  420. package/models/bxml/verbs/StopTranscription.ts +23 -0
  421. package/models/bxml/verbs/StreamParam.ts +24 -0
  422. package/models/bxml/verbs/Tag.ts +19 -0
  423. package/models/bxml/verbs/Transfer.ts +48 -0
  424. package/models/bxml/verbs/index.ts +30 -0
  425. package/models/call-direction-enum.ts +31 -0
  426. package/models/call-recording-metadata.ts +143 -0
  427. package/models/call-state-enum.ts +31 -0
  428. package/models/call-state.ts +137 -0
  429. package/models/callback-method-enum.ts +31 -0
  430. package/models/code-request.ts +60 -0
  431. package/models/conference-completed-callback.ts +54 -0
  432. package/models/conference-created-callback.ts +54 -0
  433. package/models/conference-member-exit-callback.ts +72 -0
  434. package/models/conference-member-join-callback.ts +72 -0
  435. package/models/conference-member.ts +60 -0
  436. package/models/conference-recording-available-callback.ts +113 -0
  437. package/models/conference-recording-metadata.ts +95 -0
  438. package/models/conference-redirect-callback.ts +54 -0
  439. package/models/conference-state-enum.ts +31 -0
  440. package/models/conference.ts +80 -0
  441. package/models/create-call-response.ts +155 -0
  442. package/models/create-call.ts +152 -0
  443. package/models/create-lookup-response.ts +41 -0
  444. package/models/create-message-request-error.ts +45 -0
  445. package/models/deferred-result.ts +36 -0
  446. package/models/disconnect-callback.ts +131 -0
  447. package/models/diversion.ts +66 -0
  448. package/models/dtmf-callback.ts +131 -0
  449. package/models/field-error.ts +36 -0
  450. package/models/file-format-enum.ts +31 -0
  451. package/models/gather-callback.ts +137 -0
  452. package/models/inbound-message-callback-message.ts +104 -0
  453. package/models/inbound-message-callback.ts +57 -0
  454. package/models/index.ts +89 -0
  455. package/models/initiate-callback.ts +107 -0
  456. package/models/list-message-direction-enum.ts +31 -0
  457. package/models/list-message-item.ts +137 -0
  458. package/models/lookup-request.ts +30 -0
  459. package/models/lookup-result.ts +78 -0
  460. package/models/lookup-status-enum.ts +33 -0
  461. package/models/lookup-status.ts +56 -0
  462. package/models/machine-detection-complete-callback.ts +116 -0
  463. package/models/machine-detection-configuration.ts +122 -0
  464. package/models/machine-detection-mode-enum.ts +31 -0
  465. package/models/machine-detection-result.ts +36 -0
  466. package/models/media.ts +42 -0
  467. package/models/message-delivered-callback-message.ts +104 -0
  468. package/models/message-delivered-callback.ts +57 -0
  469. package/models/message-direction-enum.ts +31 -0
  470. package/models/message-failed-callback-message.ts +104 -0
  471. package/models/message-failed-callback.ts +63 -0
  472. package/models/message-request.ts +77 -0
  473. package/models/message-sending-callback-message.ts +104 -0
  474. package/models/message-sending-callback.ts +57 -0
  475. package/models/message-status-enum.ts +37 -0
  476. package/models/message-type-enum.ts +31 -0
  477. package/models/message.ts +110 -0
  478. package/models/messages-list.ts +48 -0
  479. package/models/messaging-code-response.ts +30 -0
  480. package/models/messaging-request-error.ts +36 -0
  481. package/models/mfa-forbidden-request-error.ts +30 -0
  482. package/models/mfa-request-error.ts +36 -0
  483. package/models/mfa-unauthorized-request-error.ts +30 -0
  484. package/models/page-info.ts +48 -0
  485. package/models/priority-enum.ts +31 -0
  486. package/models/recording-available-callback.ts +164 -0
  487. package/models/recording-complete-callback.ts +164 -0
  488. package/models/recording-state-enum.ts +31 -0
  489. package/models/redirect-callback.ts +125 -0
  490. package/models/redirect-method-enum.ts +31 -0
  491. package/models/stir-shaken.ts +42 -0
  492. package/models/tag.ts +36 -0
  493. package/models/tn-lookup-request-error.ts +30 -0
  494. package/models/transcribe-recording.ts +71 -0
  495. package/models/transcription-available-callback.ts +161 -0
  496. package/models/transcription-list.ts +33 -0
  497. package/models/transcription-metadata.ts +48 -0
  498. package/models/transcription.ts +36 -0
  499. package/models/transfer-answer-callback.ts +119 -0
  500. package/models/transfer-complete-callback.ts +137 -0
  501. package/models/transfer-disconnect-callback.ts +149 -0
  502. package/models/update-call-recording.ts +35 -0
  503. package/models/update-call.ts +92 -0
  504. package/models/update-conference-member.ts +42 -0
  505. package/models/update-conference.ts +86 -0
  506. package/models/verify-code-request.ts +48 -0
  507. package/models/verify-code-response.ts +30 -0
  508. package/models/voice-api-error.ts +42 -0
  509. package/models/voice-code-response.ts +30 -0
  510. package/openapi-config.yml +8 -0
  511. package/openapitools.json +7 -0
  512. package/package.json +35 -0
  513. package/tests/callUtils.js +83 -0
  514. package/tests/fixtures/nodejs_cat.jpeg +0 -0
  515. package/tests/integration/bxml.test.js +294 -0
  516. package/tests/integration/calls-api.test.js +194 -0
  517. package/tests/integration/conferences-api.test.js +159 -0
  518. package/tests/integration/media-api.test.js +88 -0
  519. package/tests/integration/messages-api.test.js +114 -0
  520. package/tests/integration/mfaapi.test.js +97 -0
  521. package/tests/integration/phone-number-lookup-api.test.js +80 -0
  522. package/tests/integration/recordings-api.test.js +174 -0
  523. package/tests/integration/statistics-api.test.js +41 -0
  524. package/tests/unit/bxml/Bxml.test.js +13 -0
  525. package/tests/unit/bxml/NestableVerb.test.js +13 -0
  526. package/tests/unit/bxml/Response.test.js +13 -0
  527. package/tests/unit/bxml/Verb.test.js +11 -0
  528. package/tests/unit/bxml/verbs/Bridge.test.js +30 -0
  529. package/tests/unit/bxml/verbs/Conference.test.js +30 -0
  530. package/tests/unit/bxml/verbs/CustomParam.test.js +19 -0
  531. package/tests/unit/bxml/verbs/Forward.test.js +23 -0
  532. package/tests/unit/bxml/verbs/Gather.test.js +52 -0
  533. package/tests/unit/bxml/verbs/Hangup.test.js +14 -0
  534. package/tests/unit/bxml/verbs/Pause.test.js +18 -0
  535. package/tests/unit/bxml/verbs/PauseRecording.test.js +14 -0
  536. package/tests/unit/bxml/verbs/PhoneNumber.test.js +28 -0
  537. package/tests/unit/bxml/verbs/PlayAudio.test.js +19 -0
  538. package/tests/unit/bxml/verbs/Record.test.js +35 -0
  539. package/tests/unit/bxml/verbs/Redirect.test.js +26 -0
  540. package/tests/unit/bxml/verbs/ResumeRecording.test.js +14 -0
  541. package/tests/unit/bxml/verbs/Ring.test.js +19 -0
  542. package/tests/unit/bxml/verbs/SendDtmf.test.js +19 -0
  543. package/tests/unit/bxml/verbs/SipUri.test.js +29 -0
  544. package/tests/unit/bxml/verbs/SpeakSentence.test.js +20 -0
  545. package/tests/unit/bxml/verbs/StartGather.test.js +22 -0
  546. package/tests/unit/bxml/verbs/StartRecording.test.js +27 -0
  547. package/tests/unit/bxml/verbs/StartStream.test.js +44 -0
  548. package/tests/unit/bxml/verbs/StartTranscription.test.js +45 -0
  549. package/tests/unit/bxml/verbs/StopGather.test.js +14 -0
  550. package/tests/unit/bxml/verbs/StopRecording.test.js +14 -0
  551. package/tests/unit/bxml/verbs/StopStream.test.js +18 -0
  552. package/tests/unit/bxml/verbs/StopTranscription.test.js +18 -0
  553. package/tests/unit/bxml/verbs/StreamParam.test.js +19 -0
  554. package/tests/unit/bxml/verbs/Tag.test.js +14 -0
  555. package/tests/unit/bxml/verbs/Transfer.test.js +51 -0
  556. package/tests/unit/call-direction-enum.test.js +8 -0
  557. package/tests/unit/call-state-enum.test.js +8 -0
  558. package/tests/unit/callback-method-enum.test.js +8 -0
  559. package/tests/unit/conference-state-enum.test.js +8 -0
  560. package/tests/unit/file-format-enum.test.js +8 -0
  561. package/tests/unit/list-message-direction-enum.test.js +8 -0
  562. package/tests/unit/lookup-status-enum.test.js +10 -0
  563. package/tests/unit/machine-detection-mode-enum.test.js +8 -0
  564. package/tests/unit/message-direction-enum.test.js +8 -0
  565. package/tests/unit/message-status-enum.test.js +14 -0
  566. package/tests/unit/message-type-enum.test.js +8 -0
  567. package/tests/unit/priority-enum.test.js +8 -0
  568. package/tests/unit/recording-state-enum.test.js +8 -0
  569. package/tests/unit/redirect-method-enum.test.js +8 -0
  570. package/tsconfig.json +22 -0
@@ -0,0 +1,462 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CallRecordingMetadata } from '../models';
16
+ import { TranscribeRecording } from '../models';
17
+ import { TranscriptionList } from '../models';
18
+ import { UpdateCallRecording } from '../models';
19
+ /**
20
+ * RecordingsApi - axios parameter creator
21
+ * @export
22
+ */
23
+ export declare const RecordingsApiAxiosParamCreator: (configuration?: Configuration) => {
24
+ /**
25
+ * 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.
26
+ * @summary Delete Transcription
27
+ * @param {string} accountId Your Bandwidth Account ID.
28
+ * @param {string} callId Programmable Voice API Call ID.
29
+ * @param {string} recordingId Programmable Voice API Recording ID.
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ deleteCallTranscription: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ * 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.
36
+ * @summary Delete Recording
37
+ * @param {string} accountId Your Bandwidth Account ID.
38
+ * @param {string} callId Programmable Voice API Call ID.
39
+ * @param {string} recordingId Programmable Voice API Recording ID.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ deleteRecording: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * Deletes the specified recording\'s media.
46
+ * @summary Delete Recording Media
47
+ * @param {string} accountId Your Bandwidth Account ID.
48
+ * @param {string} callId Programmable Voice API Call ID.
49
+ * @param {string} recordingId Programmable Voice API Recording ID.
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ deleteRecordingMedia: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ * Downloads the specified recording.
56
+ * @summary Download Recording
57
+ * @param {string} accountId Your Bandwidth Account ID.
58
+ * @param {string} callId Programmable Voice API Call ID.
59
+ * @param {string} recordingId Programmable Voice API Recording ID.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ downloadCallRecording: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ /**
65
+ * Returns metadata for the specified recording.
66
+ * @summary Get Call Recording
67
+ * @param {string} accountId Your Bandwidth Account ID.
68
+ * @param {string} callId Programmable Voice API Call ID.
69
+ * @param {string} recordingId Programmable Voice API Recording ID.
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ getCallRecording: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
+ /**
75
+ * Downloads the specified transcription. If the transcribed 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.
76
+ * @summary Get Transcription
77
+ * @param {string} accountId Your Bandwidth Account ID.
78
+ * @param {string} callId Programmable Voice API Call ID.
79
+ * @param {string} recordingId Programmable Voice API Recording ID.
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ getCallTranscription: (accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
84
+ /**
85
+ * 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.
86
+ * @summary Get Call Recordings
87
+ * @param {string} accountId Your Bandwidth Account ID.
88
+ * @param {string} [to] Filter results by the &#x60;to&#x60; field.
89
+ * @param {string} [from] Filter results by the &#x60;from&#x60; field.
90
+ * @param {string} [minStartTime] Filter results to recordings which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).
91
+ * @param {string} [maxStartTime] Filter results to recordings which have a &#x60;startTime&#x60; before &#x60;maxStartTime&#x60; (in ISO8601 format).
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ listAccountCallRecordings: (accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
+ /**
97
+ * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
98
+ * @summary List Call Recordings
99
+ * @param {string} accountId Your Bandwidth Account ID.
100
+ * @param {string} callId Programmable Voice API Call ID.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ listCallRecordings: (accountId: string, callId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
105
+ /**
106
+ * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
107
+ * @summary Create Transcription Request
108
+ * @param {string} accountId Your Bandwidth Account ID.
109
+ * @param {string} callId Programmable Voice API Call ID.
110
+ * @param {string} recordingId Programmable Voice API Recording ID.
111
+ * @param {TranscribeRecording} transcribeRecording
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ transcribeCallRecording: (accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: AxiosRequestConfig) => Promise<RequestArgs>;
116
+ /**
117
+ * Pause or resume a recording on an active phone call.
118
+ * @summary Update Recording
119
+ * @param {string} accountId Your Bandwidth Account ID.
120
+ * @param {string} callId Programmable Voice API Call ID.
121
+ * @param {UpdateCallRecording} updateCallRecording
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ updateCallRecordingState: (accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: AxiosRequestConfig) => Promise<RequestArgs>;
126
+ };
127
+ /**
128
+ * RecordingsApi - functional programming interface
129
+ * @export
130
+ */
131
+ export declare const RecordingsApiFp: (configuration?: Configuration) => {
132
+ /**
133
+ * 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.
134
+ * @summary Delete Transcription
135
+ * @param {string} accountId Your Bandwidth Account ID.
136
+ * @param {string} callId Programmable Voice API Call ID.
137
+ * @param {string} recordingId Programmable Voice API Recording ID.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
142
+ /**
143
+ * 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.
144
+ * @summary Delete Recording
145
+ * @param {string} accountId Your Bandwidth Account ID.
146
+ * @param {string} callId Programmable Voice API Call ID.
147
+ * @param {string} recordingId Programmable Voice API Recording ID.
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
152
+ /**
153
+ * Deletes the specified recording\'s media.
154
+ * @summary Delete Recording Media
155
+ * @param {string} accountId Your Bandwidth Account ID.
156
+ * @param {string} callId Programmable Voice API Call ID.
157
+ * @param {string} recordingId Programmable Voice API Recording ID.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
162
+ /**
163
+ * Downloads the specified recording.
164
+ * @summary Download Recording
165
+ * @param {string} accountId Your Bandwidth Account ID.
166
+ * @param {string} callId Programmable Voice API Call ID.
167
+ * @param {string} recordingId Programmable Voice API Recording ID.
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
172
+ /**
173
+ * Returns metadata for the specified recording.
174
+ * @summary Get Call Recording
175
+ * @param {string} accountId Your Bandwidth Account ID.
176
+ * @param {string} callId Programmable Voice API Call ID.
177
+ * @param {string} recordingId Programmable Voice API Recording ID.
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ */
181
+ getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallRecordingMetadata>>;
182
+ /**
183
+ * Downloads the specified transcription. If the transcribed 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.
184
+ * @summary Get Transcription
185
+ * @param {string} accountId Your Bandwidth Account ID.
186
+ * @param {string} callId Programmable Voice API Call ID.
187
+ * @param {string} recordingId Programmable Voice API Recording ID.
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ getCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TranscriptionList>>;
192
+ /**
193
+ * 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.
194
+ * @summary Get Call Recordings
195
+ * @param {string} accountId Your Bandwidth Account ID.
196
+ * @param {string} [to] Filter results by the &#x60;to&#x60; field.
197
+ * @param {string} [from] Filter results by the &#x60;from&#x60; field.
198
+ * @param {string} [minStartTime] Filter results to recordings which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).
199
+ * @param {string} [maxStartTime] Filter results to recordings which have a &#x60;startTime&#x60; before &#x60;maxStartTime&#x60; (in ISO8601 format).
200
+ * @param {*} [options] Override http request option.
201
+ * @throws {RequiredError}
202
+ */
203
+ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallRecordingMetadata>>>;
204
+ /**
205
+ * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
206
+ * @summary List Call Recordings
207
+ * @param {string} accountId Your Bandwidth Account ID.
208
+ * @param {string} callId Programmable Voice API Call ID.
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ listCallRecordings(accountId: string, callId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallRecordingMetadata>>>;
213
+ /**
214
+ * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
215
+ * @summary Create Transcription Request
216
+ * @param {string} accountId Your Bandwidth Account ID.
217
+ * @param {string} callId Programmable Voice API Call ID.
218
+ * @param {string} recordingId Programmable Voice API Recording ID.
219
+ * @param {TranscribeRecording} transcribeRecording
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
224
+ /**
225
+ * Pause or resume a recording on an active phone call.
226
+ * @summary Update Recording
227
+ * @param {string} accountId Your Bandwidth Account ID.
228
+ * @param {string} callId Programmable Voice API Call ID.
229
+ * @param {UpdateCallRecording} updateCallRecording
230
+ * @param {*} [options] Override http request option.
231
+ * @throws {RequiredError}
232
+ */
233
+ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
234
+ };
235
+ /**
236
+ * RecordingsApi - factory interface
237
+ * @export
238
+ */
239
+ export declare const RecordingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
240
+ /**
241
+ * 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.
242
+ * @summary Delete Transcription
243
+ * @param {string} accountId Your Bandwidth Account ID.
244
+ * @param {string} callId Programmable Voice API Call ID.
245
+ * @param {string} recordingId Programmable Voice API Recording ID.
246
+ * @param {*} [options] Override http request option.
247
+ * @throws {RequiredError}
248
+ */
249
+ deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
250
+ /**
251
+ * 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.
252
+ * @summary Delete Recording
253
+ * @param {string} accountId Your Bandwidth Account ID.
254
+ * @param {string} callId Programmable Voice API Call ID.
255
+ * @param {string} recordingId Programmable Voice API Recording ID.
256
+ * @param {*} [options] Override http request option.
257
+ * @throws {RequiredError}
258
+ */
259
+ deleteRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
260
+ /**
261
+ * Deletes the specified recording\'s media.
262
+ * @summary Delete Recording Media
263
+ * @param {string} accountId Your Bandwidth Account ID.
264
+ * @param {string} callId Programmable Voice API Call ID.
265
+ * @param {string} recordingId Programmable Voice API Recording ID.
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<void>;
270
+ /**
271
+ * Downloads the specified recording.
272
+ * @summary Download Recording
273
+ * @param {string} accountId Your Bandwidth Account ID.
274
+ * @param {string} callId Programmable Voice API Call ID.
275
+ * @param {string} recordingId Programmable Voice API Recording ID.
276
+ * @param {*} [options] Override http request option.
277
+ * @throws {RequiredError}
278
+ */
279
+ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<File>;
280
+ /**
281
+ * Returns metadata for the specified recording.
282
+ * @summary Get Call Recording
283
+ * @param {string} accountId Your Bandwidth Account ID.
284
+ * @param {string} callId Programmable Voice API Call ID.
285
+ * @param {string} recordingId Programmable Voice API Recording ID.
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ getCallRecording(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<CallRecordingMetadata>;
290
+ /**
291
+ * Downloads the specified transcription. If the transcribed 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.
292
+ * @summary Get Transcription
293
+ * @param {string} accountId Your Bandwidth Account ID.
294
+ * @param {string} callId Programmable Voice API Call ID.
295
+ * @param {string} recordingId Programmable Voice API Recording ID.
296
+ * @param {*} [options] Override http request option.
297
+ * @throws {RequiredError}
298
+ */
299
+ getCallTranscription(accountId: string, callId: string, recordingId: string, options?: any): AxiosPromise<TranscriptionList>;
300
+ /**
301
+ * 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.
302
+ * @summary Get Call Recordings
303
+ * @param {string} accountId Your Bandwidth Account ID.
304
+ * @param {string} [to] Filter results by the &#x60;to&#x60; field.
305
+ * @param {string} [from] Filter results by the &#x60;from&#x60; field.
306
+ * @param {string} [minStartTime] Filter results to recordings which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).
307
+ * @param {string} [maxStartTime] Filter results to recordings which have a &#x60;startTime&#x60; before &#x60;maxStartTime&#x60; (in ISO8601 format).
308
+ * @param {*} [options] Override http request option.
309
+ * @throws {RequiredError}
310
+ */
311
+ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: any): AxiosPromise<Array<CallRecordingMetadata>>;
312
+ /**
313
+ * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
314
+ * @summary List Call Recordings
315
+ * @param {string} accountId Your Bandwidth Account ID.
316
+ * @param {string} callId Programmable Voice API Call ID.
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ listCallRecordings(accountId: string, callId: string, options?: any): AxiosPromise<Array<CallRecordingMetadata>>;
321
+ /**
322
+ * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
323
+ * @summary Create Transcription Request
324
+ * @param {string} accountId Your Bandwidth Account ID.
325
+ * @param {string} callId Programmable Voice API Call ID.
326
+ * @param {string} recordingId Programmable Voice API Recording ID.
327
+ * @param {TranscribeRecording} transcribeRecording
328
+ * @param {*} [options] Override http request option.
329
+ * @throws {RequiredError}
330
+ */
331
+ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: any): AxiosPromise<void>;
332
+ /**
333
+ * Pause or resume a recording on an active phone call.
334
+ * @summary Update Recording
335
+ * @param {string} accountId Your Bandwidth Account ID.
336
+ * @param {string} callId Programmable Voice API Call ID.
337
+ * @param {UpdateCallRecording} updateCallRecording
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: any): AxiosPromise<void>;
342
+ };
343
+ /**
344
+ * RecordingsApi - object-oriented interface
345
+ * @export
346
+ * @class RecordingsApi
347
+ * @extends {BaseAPI}
348
+ */
349
+ export declare class RecordingsApi extends BaseAPI {
350
+ /**
351
+ * 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.
352
+ * @summary Delete Transcription
353
+ * @param {string} accountId Your Bandwidth Account ID.
354
+ * @param {string} callId Programmable Voice API Call ID.
355
+ * @param {string} recordingId Programmable Voice API Recording ID.
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ * @memberof RecordingsApi
359
+ */
360
+ deleteCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
361
+ /**
362
+ * 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.
363
+ * @summary Delete Recording
364
+ * @param {string} accountId Your Bandwidth Account ID.
365
+ * @param {string} callId Programmable Voice API Call ID.
366
+ * @param {string} recordingId Programmable Voice API Recording ID.
367
+ * @param {*} [options] Override http request option.
368
+ * @throws {RequiredError}
369
+ * @memberof RecordingsApi
370
+ */
371
+ deleteRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
372
+ /**
373
+ * Deletes the specified recording\'s media.
374
+ * @summary Delete Recording Media
375
+ * @param {string} accountId Your Bandwidth Account ID.
376
+ * @param {string} callId Programmable Voice API Call ID.
377
+ * @param {string} recordingId Programmable Voice API Recording ID.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ * @memberof RecordingsApi
381
+ */
382
+ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
383
+ /**
384
+ * Downloads the specified recording.
385
+ * @summary Download Recording
386
+ * @param {string} accountId Your Bandwidth Account ID.
387
+ * @param {string} callId Programmable Voice API Call ID.
388
+ * @param {string} recordingId Programmable Voice API Recording ID.
389
+ * @param {*} [options] Override http request option.
390
+ * @throws {RequiredError}
391
+ * @memberof RecordingsApi
392
+ */
393
+ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
394
+ /**
395
+ * Returns metadata for the specified recording.
396
+ * @summary Get Call Recording
397
+ * @param {string} accountId Your Bandwidth Account ID.
398
+ * @param {string} callId Programmable Voice API Call ID.
399
+ * @param {string} recordingId Programmable Voice API Recording ID.
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ * @memberof RecordingsApi
403
+ */
404
+ getCallRecording(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallRecordingMetadata, any>>;
405
+ /**
406
+ * Downloads the specified transcription. If the transcribed 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.
407
+ * @summary Get Transcription
408
+ * @param {string} accountId Your Bandwidth Account ID.
409
+ * @param {string} callId Programmable Voice API Call ID.
410
+ * @param {string} recordingId Programmable Voice API Recording ID.
411
+ * @param {*} [options] Override http request option.
412
+ * @throws {RequiredError}
413
+ * @memberof RecordingsApi
414
+ */
415
+ getCallTranscription(accountId: string, callId: string, recordingId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TranscriptionList, any>>;
416
+ /**
417
+ * 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.
418
+ * @summary Get Call Recordings
419
+ * @param {string} accountId Your Bandwidth Account ID.
420
+ * @param {string} [to] Filter results by the &#x60;to&#x60; field.
421
+ * @param {string} [from] Filter results by the &#x60;from&#x60; field.
422
+ * @param {string} [minStartTime] Filter results to recordings which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).
423
+ * @param {string} [maxStartTime] Filter results to recordings which have a &#x60;startTime&#x60; before &#x60;maxStartTime&#x60; (in ISO8601 format).
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ * @memberof RecordingsApi
427
+ */
428
+ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallRecordingMetadata[], any>>;
429
+ /**
430
+ * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call.
431
+ * @summary List Call Recordings
432
+ * @param {string} accountId Your Bandwidth Account ID.
433
+ * @param {string} callId Programmable Voice API Call ID.
434
+ * @param {*} [options] Override http request option.
435
+ * @throws {RequiredError}
436
+ * @memberof RecordingsApi
437
+ */
438
+ listCallRecordings(accountId: string, callId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CallRecordingMetadata[], any>>;
439
+ /**
440
+ * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours.
441
+ * @summary Create Transcription Request
442
+ * @param {string} accountId Your Bandwidth Account ID.
443
+ * @param {string} callId Programmable Voice API Call ID.
444
+ * @param {string} recordingId Programmable Voice API Recording ID.
445
+ * @param {TranscribeRecording} transcribeRecording
446
+ * @param {*} [options] Override http request option.
447
+ * @throws {RequiredError}
448
+ * @memberof RecordingsApi
449
+ */
450
+ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
451
+ /**
452
+ * Pause or resume a recording on an active phone call.
453
+ * @summary Update Recording
454
+ * @param {string} accountId Your Bandwidth Account ID.
455
+ * @param {string} callId Programmable Voice API Call ID.
456
+ * @param {UpdateCallRecording} updateCallRecording
457
+ * @param {*} [options] Override http request option.
458
+ * @throws {RequiredError}
459
+ * @memberof RecordingsApi
460
+ */
461
+ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
462
+ }