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,16 @@
1
+ import { Verb } from '../Verb';
2
+
3
+ /**
4
+ * @export
5
+ * @class StopRecording
6
+ * @extends {Verb}
7
+ * Represents a StopRecording verb
8
+ */
9
+ export class StopRecording extends Verb {
10
+ /**
11
+ * Creates an instance of StopRecording
12
+ */
13
+ constructor() {
14
+ super('StopRecording');
15
+ }
16
+ }
@@ -0,0 +1,23 @@
1
+ import { Verb } from '../Verb';
2
+
3
+ interface StopStreamAttributes {
4
+ name: string;
5
+ }
6
+
7
+ /**
8
+ * @export
9
+ * @class StopStream
10
+ * @extends {Verb}
11
+ * Represents a StopStream verb
12
+ */
13
+ export class StopStream extends Verb {
14
+ attributes: StopStreamAttributes;
15
+
16
+ /**
17
+ * Creates an instance of StopStream
18
+ * @param {StopStreamAttributes} attributes The attributes to add to the element
19
+ */
20
+ constructor(attributes: StopStreamAttributes) {
21
+ super('StopStream', undefined , attributes);
22
+ }
23
+ }
@@ -0,0 +1,23 @@
1
+ import { Verb } from '../Verb';
2
+
3
+ interface StopTranscriptionAttributes {
4
+ name: string;
5
+ }
6
+
7
+ /**
8
+ * @export
9
+ * @class StopTranscription
10
+ * @extends {Verb}
11
+ * Represents a StopTranscription verb
12
+ */
13
+ export class StopTranscription extends Verb {
14
+ attributes: StopTranscriptionAttributes;
15
+
16
+ /**
17
+ * Creates an instance of StopTranscription
18
+ * @param {StopTranscriptionAttributes} attributes The attributes to add to the element
19
+ */
20
+ constructor(attributes: StopTranscriptionAttributes) {
21
+ super('StopTranscription', undefined , attributes);
22
+ }
23
+ }
@@ -0,0 +1,24 @@
1
+ import { Verb } from '../Verb';
2
+
3
+ interface StreamParamAttributes {
4
+ name: string;
5
+ value: string;
6
+ }
7
+
8
+ /**
9
+ * @export
10
+ * @class StreamParam
11
+ * @extends {Verb}
12
+ * Represents a StreamParam verb
13
+ */
14
+ export class StreamParam extends Verb {
15
+ attributes: StreamParamAttributes;
16
+
17
+ /**
18
+ * Creates an instance of StreamParam
19
+ * @param {StreamParamAttributes} attributes The attributes to add to the element
20
+ */
21
+ constructor(attributes: StreamParamAttributes) {
22
+ super('StreamParam', undefined , attributes);
23
+ }
24
+ }
@@ -0,0 +1,19 @@
1
+ import { Verb } from '../Verb';
2
+
3
+ /**
4
+ * @export
5
+ * @class Tag
6
+ * @extends {Verb}
7
+ * Represents a Tag verb
8
+ */
9
+ export class Tag extends Verb {
10
+ content: string;
11
+
12
+ /**
13
+ * @param {string} content The content of the tag
14
+ * Creates an instance of Tag
15
+ */
16
+ constructor(content: string) {
17
+ super('Tag', content);
18
+ }
19
+ }
@@ -0,0 +1,48 @@
1
+ import { NestableVerb } from '../NestableVerb';
2
+ import { PhoneNumber } from './PhoneNumber';
3
+ import { SipUri } from './SipUri';
4
+
5
+ type NumberEntities = Array<PhoneNumber | SipUri>;
6
+
7
+ interface TransferAttributes {
8
+ transferCallerId?: string;
9
+ callTimeout?: number;
10
+ transferCompleteUrl?: string;
11
+ transferCompleteMethod?: string;
12
+ transferCompleteFallbackUrl?: string;
13
+ transferCompleteFallbackMethod?: string;
14
+ username?: string;
15
+ password?: string;
16
+ fallbackUsername?: string;
17
+ fallbackPassword?: string;
18
+ tag?: string;
19
+ diversionTreatment?: string;
20
+ diversionReason?: string;
21
+ }
22
+
23
+ /**
24
+ * @export
25
+ * @class Transfer
26
+ * @extends {NestableVerb}
27
+ * Represents a Transfer verb
28
+ */
29
+ export class Transfer extends NestableVerb {
30
+ attributes: TransferAttributes;
31
+
32
+ /**
33
+ * Creates an instance of Transfer
34
+ * @param {TransferAttributes} attributes The attributes to add to the element
35
+ * @param {NumberEntities} transferTo The number entities to transfer to
36
+ */
37
+ constructor(attributes?: TransferAttributes, transferTo?: NumberEntities) {
38
+ super('Transfer', undefined, attributes, transferTo);
39
+ }
40
+
41
+ /**
42
+ * Add a number entity to the transfer
43
+ * @param {NumberEntities} recipient The number entity or entities to add
44
+ */
45
+ addTransferRecipient(recipient: PhoneNumber | SipUri | NumberEntities): void {
46
+ this.nestedVerbs = this.nestedVerbs.concat(recipient);
47
+ }
48
+ }
@@ -0,0 +1,30 @@
1
+ export * from './Bridge';
2
+ export * from './Conference';
3
+ export * from './CustomParam';
4
+ export * from './Forward';
5
+ export * from './Gather';
6
+ export * from './Hangup';
7
+ export * from './Pause';
8
+ export * from './PauseRecording';
9
+ export * from './PhoneNumber';
10
+ export * from './PlayAudio';
11
+ export * from './Record';
12
+ export * from './Redirect';
13
+ export * from './ResumeRecording';
14
+ export * from './Ring';
15
+ export * from './SendDtmf';
16
+ export * from './SipUri';
17
+ export * from './SpeakSentence';
18
+ export * from './StartGather';
19
+ export * from './StartRecording';
20
+ export * from './StartStream';
21
+ export * from './StartTranscription';
22
+ export * from './StopGather';
23
+ export * from './StopRecording';
24
+ export * from './StopStream';
25
+ export * from './StopTranscription';
26
+ export * from './StreamParam';
27
+ export * from './Tag';
28
+ export * from './Transfer';
29
+ export * from '../Bxml';
30
+ export * from '../Response';
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The direction of the call.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallDirectionEnum = {
24
+ Inbound: 'inbound',
25
+ Outbound: 'outbound'
26
+ } as const;
27
+
28
+ export type CallDirectionEnum = typeof CallDirectionEnum[keyof typeof CallDirectionEnum];
29
+
30
+
31
+
@@ -0,0 +1,143 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import { CallDirectionEnum } from './call-direction-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import { FileFormatEnum } from './file-format-enum';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import { TranscriptionMetadata } from './transcription-metadata';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface CallRecordingMetadata
30
+ */
31
+ export interface CallRecordingMetadata {
32
+ /**
33
+ * The id of the application associated with the call.
34
+ * @type {string}
35
+ * @memberof CallRecordingMetadata
36
+ */
37
+ 'applicationId'?: string;
38
+ /**
39
+ * The user account associated with the call.
40
+ * @type {string}
41
+ * @memberof CallRecordingMetadata
42
+ */
43
+ 'accountId'?: string;
44
+ /**
45
+ * The call id associated with the event.
46
+ * @type {string}
47
+ * @memberof CallRecordingMetadata
48
+ */
49
+ 'callId'?: string;
50
+ /**
51
+ * (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
52
+ * @type {string}
53
+ * @memberof CallRecordingMetadata
54
+ */
55
+ 'parentCallId'?: string;
56
+ /**
57
+ * The unique ID of this recording
58
+ * @type {string}
59
+ * @memberof CallRecordingMetadata
60
+ */
61
+ 'recordingId'?: string;
62
+ /**
63
+ * The phone number that received the call, in E.164 format (e.g. +15555555555).
64
+ * @type {string}
65
+ * @memberof CallRecordingMetadata
66
+ */
67
+ 'to'?: string;
68
+ /**
69
+ * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
70
+ * @type {string}
71
+ * @memberof CallRecordingMetadata
72
+ */
73
+ 'from'?: string;
74
+ /**
75
+ * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable.
76
+ * @type {string}
77
+ * @memberof CallRecordingMetadata
78
+ */
79
+ 'transferCallerId'?: string;
80
+ /**
81
+ * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
82
+ * @type {string}
83
+ * @memberof CallRecordingMetadata
84
+ */
85
+ 'transferTo'?: string;
86
+ /**
87
+ * The duration of the recording in ISO-8601 format
88
+ * @type {string}
89
+ * @memberof CallRecordingMetadata
90
+ */
91
+ 'duration'?: string;
92
+ /**
93
+ *
94
+ * @type {CallDirectionEnum}
95
+ * @memberof CallRecordingMetadata
96
+ */
97
+ 'direction'?: CallDirectionEnum;
98
+ /**
99
+ * Always `1` for conference recordings; multi-channel recordings are not supported on conferences.
100
+ * @type {number}
101
+ * @memberof CallRecordingMetadata
102
+ */
103
+ 'channels'?: number;
104
+ /**
105
+ * Time the call was started, in ISO 8601 format.
106
+ * @type {string}
107
+ * @memberof CallRecordingMetadata
108
+ */
109
+ 'startTime'?: string;
110
+ /**
111
+ * The time that the recording ended in ISO-8601 format
112
+ * @type {string}
113
+ * @memberof CallRecordingMetadata
114
+ */
115
+ 'endTime'?: string;
116
+ /**
117
+ *
118
+ * @type {FileFormatEnum}
119
+ * @memberof CallRecordingMetadata
120
+ */
121
+ 'fileFormat'?: FileFormatEnum;
122
+ /**
123
+ * The current status of the process. For recording, current possible values are \'processing\', \'partial\', \'complete\', \'deleted\', and \'error\'. For transcriptions, current possible values are \'none\', \'processing\', \'available\', \'error\', \'timeout\', \'file-size-too-big\', and \'file-size-too-small\'. Additional states may be added in the future, so your application must be tolerant of unknown values.
124
+ * @type {string}
125
+ * @memberof CallRecordingMetadata
126
+ */
127
+ 'status'?: string;
128
+ /**
129
+ * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
130
+ * @type {string}
131
+ * @memberof CallRecordingMetadata
132
+ */
133
+ 'mediaUrl'?: string | null;
134
+ /**
135
+ *
136
+ * @type {TranscriptionMetadata}
137
+ * @memberof CallRecordingMetadata
138
+ */
139
+ 'transcription'?: TranscriptionMetadata | null;
140
+ }
141
+
142
+
143
+
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The call state. Possible values:<br>`active` to redirect the call (default)<br>`completed` to hang up the call if it is answered, cancel it if it is an unanswered outbound call, or reject it if it an unanswered inbound call
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallStateEnum = {
24
+ Active: 'active',
25
+ Completed: 'completed'
26
+ } as const;
27
+
28
+ export type CallStateEnum = typeof CallStateEnum[keyof typeof CallStateEnum];
29
+
30
+
31
+
@@ -0,0 +1,137 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import { CallDirectionEnum } from './call-direction-enum';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface CallState
24
+ */
25
+ export interface CallState {
26
+ /**
27
+ * The application id associated with the call.
28
+ * @type {string}
29
+ * @memberof CallState
30
+ */
31
+ 'applicationId'?: string;
32
+ /**
33
+ * The account id associated with the call.
34
+ * @type {string}
35
+ * @memberof CallState
36
+ */
37
+ 'accountId'?: string;
38
+ /**
39
+ * The programmable voice API call ID.
40
+ * @type {string}
41
+ * @memberof CallState
42
+ */
43
+ 'callId'?: string;
44
+ /**
45
+ * The A-leg call id, set only if this call is the B-leg of a [`<Transfer>`](/docs/voice/bxml/transfer).
46
+ * @type {string}
47
+ * @memberof CallState
48
+ */
49
+ 'parentCallId'?: string | null;
50
+ /**
51
+ * The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI.
52
+ * @type {string}
53
+ * @memberof CallState
54
+ */
55
+ 'to'?: string;
56
+ /**
57
+ * The phone number that made the call, in E.164 format (e.g. +15555555555).
58
+ * @type {string}
59
+ * @memberof CallState
60
+ */
61
+ 'from'?: string;
62
+ /**
63
+ *
64
+ * @type {CallDirectionEnum}
65
+ * @memberof CallState
66
+ */
67
+ 'direction'?: CallDirectionEnum;
68
+ /**
69
+ * The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values.
70
+ * @type {string}
71
+ * @memberof CallState
72
+ */
73
+ 'state'?: string;
74
+ /**
75
+ * For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
76
+ * @type {{ [key: string]: string; }}
77
+ * @memberof CallState
78
+ */
79
+ 'stirShaken'?: { [key: string]: string; } | null;
80
+ /**
81
+ * The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header.
82
+ * @type {string}
83
+ * @memberof CallState
84
+ */
85
+ 'identity'?: string | null;
86
+ /**
87
+ * The time this call was placed in queue.
88
+ * @type {string}
89
+ * @memberof CallState
90
+ */
91
+ 'enqueuedTime'?: string | null;
92
+ /**
93
+ * The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue.
94
+ * @type {string}
95
+ * @memberof CallState
96
+ */
97
+ 'startTime'?: string | null;
98
+ /**
99
+ * Populated once the call has been answered, with the time in ISO 8601 format.
100
+ * @type {string}
101
+ * @memberof CallState
102
+ */
103
+ 'answerTime'?: string | null;
104
+ /**
105
+ * Populated once the call has ended, with the time in ISO 8601 format.
106
+ * @type {string}
107
+ * @memberof CallState
108
+ */
109
+ 'endTime'?: string | null;
110
+ /**
111
+ * | Cause | Description | |:------|:------------| | `hangup`| One party hung up the call, a [`<Hangup>`](../../bxml/verbs/hangup.md) verb was executed, or there was no more BXML to execute; it indicates that the call ended normally. | | `busy` | Callee was busy. | | `timeout` | Call wasn\'t answered before the `callTimeout` was reached. | | `cancel` | Call was cancelled by its originator while it was ringing. | | `rejected` | Call was rejected by the callee. | | `callback-error` | BXML callback couldn\'t be delivered to your callback server. | | `invalid-bxml` | Invalid BXML was returned in response to a callback. | | `application-error` | An unsupported action was tried on the call, e.g. trying to play a .ogg audio. | | `account-limit` | Account rate limits were reached. | | `node-capacity-exceeded` | System maximum capacity was reached. | | `error` | Some error not described in any of the other causes happened on the call. | | `unknown` | Unknown error happened on the call. | Note: This list is not exhaustive and other values can appear in the future.
112
+ * @type {string}
113
+ * @memberof CallState
114
+ */
115
+ 'disconnectCause'?: string | null;
116
+ /**
117
+ * Populated only if the call ended with an error, with text explaining the reason.
118
+ * @type {string}
119
+ * @memberof CallState
120
+ */
121
+ 'errorMessage'?: string | null;
122
+ /**
123
+ * Populated only if the call ended with an error, with a Bandwidth internal id that references the error event.
124
+ * @type {string}
125
+ * @memberof CallState
126
+ */
127
+ 'errorId'?: string | null;
128
+ /**
129
+ * The last time the call had a state update, in ISO 8601 format.
130
+ * @type {string}
131
+ * @memberof CallState
132
+ */
133
+ 'lastUpdate'?: string;
134
+ }
135
+
136
+
137
+
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The HTTP method to use to deliver the callback. GET or POST. Default value is POST.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallbackMethodEnum = {
24
+ Get: 'GET',
25
+ Post: 'POST'
26
+ } as const;
27
+
28
+ export type CallbackMethodEnum = typeof CallbackMethodEnum[keyof typeof CallbackMethodEnum];
29
+
30
+
31
+
@@ -0,0 +1,60 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CodeRequest
21
+ */
22
+ export interface CodeRequest {
23
+ /**
24
+ * The phone number to send the mfa code to.
25
+ * @type {string}
26
+ * @memberof CodeRequest
27
+ */
28
+ 'to': string;
29
+ /**
30
+ * The application phone number, the sender of the mfa code.
31
+ * @type {string}
32
+ * @memberof CodeRequest
33
+ */
34
+ 'from': string;
35
+ /**
36
+ * The application unique ID, obtained from Bandwidth.
37
+ * @type {string}
38
+ * @memberof CodeRequest
39
+ */
40
+ 'applicationId': string;
41
+ /**
42
+ * An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
43
+ * @type {string}
44
+ * @memberof CodeRequest
45
+ */
46
+ 'scope'?: string;
47
+ /**
48
+ * The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server.
49
+ * @type {string}
50
+ * @memberof CodeRequest
51
+ */
52
+ 'message': string;
53
+ /**
54
+ * The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively.
55
+ * @type {number}
56
+ * @memberof CodeRequest
57
+ */
58
+ 'digits': number;
59
+ }
60
+
@@ -0,0 +1,54 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The Conference Completed event is fired when the last member leaves the conference. The response to this event may not contain BXML.
19
+ * @export
20
+ * @interface ConferenceCompletedCallback
21
+ */
22
+ export interface ConferenceCompletedCallback {
23
+ /**
24
+ * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
25
+ * @type {string}
26
+ * @memberof ConferenceCompletedCallback
27
+ */
28
+ 'eventType'?: string;
29
+ /**
30
+ * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
31
+ * @type {string}
32
+ * @memberof ConferenceCompletedCallback
33
+ */
34
+ 'eventTime'?: string;
35
+ /**
36
+ * The unique, Bandwidth-generated ID of the conference that was recorded
37
+ * @type {string}
38
+ * @memberof ConferenceCompletedCallback
39
+ */
40
+ 'conferenceId'?: string;
41
+ /**
42
+ * The user-specified name of the conference that was recorded
43
+ * @type {string}
44
+ * @memberof ConferenceCompletedCallback
45
+ */
46
+ 'name'?: string;
47
+ /**
48
+ * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
49
+ * @type {string}
50
+ * @memberof ConferenceCompletedCallback
51
+ */
52
+ 'tag'?: string | null;
53
+ }
54
+