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,86 @@
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 { ConferenceStateEnum } from './conference-state-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import { RedirectMethodEnum } from './redirect-method-enum';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface UpdateConference
27
+ */
28
+ export interface UpdateConference {
29
+ /**
30
+ *
31
+ * @type {ConferenceStateEnum}
32
+ * @memberof UpdateConference
33
+ */
34
+ 'status'?: ConferenceStateEnum | null;
35
+ /**
36
+ * The URL to send the [conferenceRedirect](/docs/voice/webhooks/conferenceRedirect) event which will provide new BXML. Not allowed if `state` is `completed`, but required if `state` is `active`.
37
+ * @type {string}
38
+ * @memberof UpdateConference
39
+ */
40
+ 'redirectUrl'?: string | null;
41
+ /**
42
+ *
43
+ * @type {RedirectMethodEnum}
44
+ * @memberof UpdateConference
45
+ */
46
+ 'redirectMethod'?: RedirectMethodEnum | null;
47
+ /**
48
+ * Basic auth username.
49
+ * @type {string}
50
+ * @memberof UpdateConference
51
+ */
52
+ 'username'?: string | null;
53
+ /**
54
+ * Basic auth password.
55
+ * @type {string}
56
+ * @memberof UpdateConference
57
+ */
58
+ 'password'?: string | null;
59
+ /**
60
+ * A fallback url which, if provided, will be used to retry the `conferenceRedirect` webhook delivery in case `redirectUrl` fails to respond. Not allowed if `state` is `completed`.
61
+ * @type {string}
62
+ * @memberof UpdateConference
63
+ */
64
+ 'redirectFallbackUrl'?: string | null;
65
+ /**
66
+ *
67
+ * @type {RedirectMethodEnum}
68
+ * @memberof UpdateConference
69
+ */
70
+ 'redirectFallbackMethod'?: RedirectMethodEnum | null;
71
+ /**
72
+ * Basic auth username.
73
+ * @type {string}
74
+ * @memberof UpdateConference
75
+ */
76
+ 'fallbackUsername'?: string | null;
77
+ /**
78
+ * Basic auth password.
79
+ * @type {string}
80
+ * @memberof UpdateConference
81
+ */
82
+ 'fallbackPassword'?: string | null;
83
+ }
84
+
85
+
86
+
@@ -0,0 +1,48 @@
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 VerifyCodeRequest
21
+ */
22
+ export interface VerifyCodeRequest {
23
+ /**
24
+ * The phone number to send the mfa code to.
25
+ * @type {string}
26
+ * @memberof VerifyCodeRequest
27
+ */
28
+ 'to': string;
29
+ /**
30
+ * An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
31
+ * @type {string}
32
+ * @memberof VerifyCodeRequest
33
+ */
34
+ 'scope'?: string;
35
+ /**
36
+ * The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively.
37
+ * @type {number}
38
+ * @memberof VerifyCodeRequest
39
+ */
40
+ 'expirationTimeInMinutes': number;
41
+ /**
42
+ * The generated mfa code to check if valid.
43
+ * @type {string}
44
+ * @memberof VerifyCodeRequest
45
+ */
46
+ 'code': string;
47
+ }
48
+
@@ -0,0 +1,30 @@
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 VerifyCodeResponse
21
+ */
22
+ export interface VerifyCodeResponse {
23
+ /**
24
+ * Whether or not the supplied code is valid.
25
+ * @type {boolean}
26
+ * @memberof VerifyCodeResponse
27
+ */
28
+ 'valid'?: boolean;
29
+ }
30
+
@@ -0,0 +1,42 @@
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 VoiceApiError
21
+ */
22
+ export interface VoiceApiError {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof VoiceApiError
27
+ */
28
+ 'type'?: string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof VoiceApiError
33
+ */
34
+ 'description'?: string;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof VoiceApiError
39
+ */
40
+ 'id'?: string | null;
41
+ }
42
+
@@ -0,0 +1,30 @@
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 VoiceCodeResponse
21
+ */
22
+ export interface VoiceCodeResponse {
23
+ /**
24
+ * Programmable Voice API Call ID.
25
+ * @type {string}
26
+ * @memberof VoiceCodeResponse
27
+ */
28
+ 'callId'?: string;
29
+ }
30
+
@@ -0,0 +1,8 @@
1
+ npmName: bandwidth-sdk
2
+ withSeparateModelsAndApi: true
3
+ modelPackage: models
4
+ apiPackage: api
5
+ gitHost: github.com
6
+ gitUserId: Bandwidth
7
+ gitRepoId: node-sdk
8
+ templateDir: custom_templates
@@ -0,0 +1,7 @@
1
+ {
2
+ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
+ "spaces": 2,
4
+ "generator-cli": {
5
+ "version": "7.1.0"
6
+ }
7
+ }
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "bandwidth-sdk",
3
+ "version": "0.1.0",
4
+ "description": "OpenAPI client for bandwidth-sdk",
5
+ "author": "OpenAPI-Generator Contributors",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/Bandwidth/node-sdk.git"
9
+ },
10
+ "keywords": [
11
+ "axios",
12
+ "typescript",
13
+ "openapi-client",
14
+ "openapi-generator",
15
+ "bandwidth-sdk"
16
+ ],
17
+ "license": "Unlicense",
18
+ "main": "./dist/index.js",
19
+ "typings": "./dist/index.d.ts",
20
+ "scripts": {
21
+ "build": "tsc ",
22
+ "prepare": "npm run build",
23
+ "test": "jest --coverage --detectOpenHandles"
24
+ },
25
+ "dependencies": {
26
+ "axios": "^0.27.2",
27
+ "xmlbuilder2": "^3.1.1"
28
+ },
29
+ "devDependencies": {
30
+ "@types/node": "^12.11.5",
31
+ "jest": "^29.7.0",
32
+ "ts-jest": "^29.1.1",
33
+ "typescript": "^4.0"
34
+ }
35
+ }
@@ -0,0 +1,83 @@
1
+ /* Helper functions for voice calls
2
+ * These are reused in multiple tests
3
+ */
4
+
5
+ const axios = require('axios');
6
+
7
+ const sleep = (s) => {
8
+ return new Promise(r => setTimeout(r, s * 1000));
9
+ };
10
+
11
+ const setupManteca = async (type) => {
12
+ const mantecaBody = {
13
+ os: OPERATING_SYSTEM,
14
+ language: 'nodejs',
15
+ type: type
16
+ };
17
+
18
+ const mantecaTestUrl = `${MANTECA_BASE_URL}/tests`;
19
+ const mantecaHeader = { 'Content-Type': 'application/json' };
20
+
21
+ try {
22
+ const { data } = await axios.post(mantecaTestUrl, JSON.stringify(mantecaBody), mantecaHeader);
23
+ return data;
24
+ } catch (e) {
25
+ console.log(e);
26
+ }
27
+ };
28
+
29
+ const createMantecaCall = async (callsApi, tag = 'nodejs', answerPath = '/bxml/pause') => {
30
+ const mantecaCallBody = {
31
+ applicationId: MANTECA_APPLICATION_ID,
32
+ to: MANTECA_IDLE_NUMBER,
33
+ from: MANTECA_ACTIVE_NUMBER,
34
+ answerUrl: `${MANTECA_BASE_URL}${answerPath}`,
35
+ tag: tag
36
+ };
37
+
38
+ const { data } = await callsApi.createCall(BW_ACCOUNT_ID, mantecaCallBody);
39
+ return data.callId;
40
+ };
41
+
42
+ const getMantecaTestStatus = async (testId) => {
43
+ mantecaStatusUrl = `${MANTECA_BASE_URL}/tests/${testId}`;
44
+ const { data } = await axios.get(mantecaStatusUrl);
45
+ return data;
46
+ };
47
+
48
+ const cleanupCalls = async (calls, callsApi) => {
49
+ let attempts = 0;
50
+
51
+ while (calls.length > 0 && attempts < 10) {
52
+ for (let i = calls.length - 1; i >= 0; i--) {
53
+ if (await callEnded(calls[i], callsApi)) { calls.splice(i, 1); }
54
+ }
55
+ sleep(SLEEP_TIME_S);
56
+ attempts += 1;
57
+ }
58
+
59
+ if (calls.length > 0) {
60
+ errorMessage = `Failed to terminate all calls: ${calls.toString()}`;
61
+ throw new Error(errorMessage);
62
+ }
63
+ };
64
+
65
+ const callEnded = async (callId, callsApi) => {
66
+ try {
67
+ const { data } = await callsApi.getCallState(BW_ACCOUNT_ID, callId);
68
+ if (data.state != 'disconnected') {
69
+ try {
70
+ callsApi.updateCall(BW_ACCOUNT_ID, callId, { state: 'completed' });
71
+ return true;
72
+ } catch { return false; }
73
+ } else { return true; }
74
+ } catch { return false; }
75
+ }
76
+
77
+ module.exports = {
78
+ sleep,
79
+ setupManteca,
80
+ createMantecaCall,
81
+ getMantecaTestStatus,
82
+ cleanupCalls
83
+ };
Binary file
@@ -0,0 +1,294 @@
1
+ const { CallsApi } = require('../../api/calls-api');
2
+ const { Configuration } = require('../../configuration');
3
+ const { Bxml, CallStateEnum } = require('../../models');
4
+ const { createMantecaCall, sleep, cleanupCalls } = require('../callUtils');
5
+
6
+ describe('BXML Integration Tests', () => {
7
+ jest.setTimeout(20000);
8
+
9
+ const config = new Configuration({username: BW_USERNAME, password: BW_PASSWORD});
10
+ const callsApi = new CallsApi(config);
11
+ let activeCalls = [];
12
+
13
+ afterAll(async () => {
14
+ await cleanupCalls(activeCalls, callsApi);
15
+ });
16
+
17
+ test('test one-off verbs', async () => {
18
+ const updateCallId = await createMantecaCall(callsApi);
19
+ const bridgeCallId = await createMantecaCall(callsApi);
20
+ activeCalls.push(updateCallId, bridgeCallId);
21
+ await sleep(SLEEP_TIME_S);
22
+
23
+ const conferenceAttributes = {
24
+ mute: true,
25
+ hold: true,
26
+ callIdsToCoach: updateCallId,
27
+ conferenceEventUrl: 'https://initial.com',
28
+ conferenceEventMethod: 'POST',
29
+ conferenceEventFallbackUrl: 'https://initial.com',
30
+ conferenceEventFallbackMethod: 'POST',
31
+ username: 'initialUsername',
32
+ password: 'initialPassword',
33
+ fallbackUsername: 'initialFallbackUsername',
34
+ fallbackPassword: 'initialFallbackPassword',
35
+ tag: 'initialTag',
36
+ callbackTimeout: 1.1
37
+ };
38
+
39
+ const gatherAttributes = {
40
+ gatherUrl: 'https://initial.com',
41
+ gatherMethod: 'POST',
42
+ gatherFallbackUrl: 'https://initial.com',
43
+ gatherFallbackMethod: 'POST',
44
+ username: 'initialUsername',
45
+ password: 'initialPassword',
46
+ fallbackUsername: 'initialFallbackUsername',
47
+ fallbackPassword: 'initialFallbackPassword',
48
+ tag: 'initialTag',
49
+ terminatingDigits: '5',
50
+ maxDigits: 1,
51
+ interDigitTimeout: 1.1,
52
+ firstDigitTimeout: 1.1,
53
+ repeatCount: 1
54
+ };
55
+
56
+ const speakSentenceAttributes = {
57
+ voice: 'julie',
58
+ gender: 'female',
59
+ locale: 'en_US'
60
+ };
61
+
62
+ const recordAttributes = {
63
+ recordCompleteUrl: 'https://initial.com',
64
+ recordCompleteMethod: 'POST',
65
+ recordCompleteFallbackUrl: 'https://initial.com',
66
+ recordCompleteFallbackMethod: 'POST',
67
+ recordingAvailableUrl: 'https://initial.com',
68
+ recordingAvailableMethod: 'POST',
69
+ transcribe: true,
70
+ transcriptionAvailableUrl: 'https://initial.com',
71
+ transcriptionAvailableMethod: 'POST',
72
+ username: 'initialUsername',
73
+ password: 'initialPassword',
74
+ fallbackUsername: 'initialFallbackUsername',
75
+ fallbackPassword: 'initialFallbackPassword',
76
+ tag: 'initialTag',
77
+ terminatingDigits: '#',
78
+ maxDuration: 2,
79
+ silenceTimeout: 2,
80
+ fileFormat: 'wav'
81
+ };
82
+
83
+ const sendDtmfAttributes = {
84
+ toneDuration: 50,
85
+ toneInterval: 50
86
+ };
87
+
88
+ const ringAttributes = {
89
+ duration: 5.1,
90
+ answerCall: true
91
+ };
92
+
93
+ const bridgeAttributes = {
94
+ bridgeCompleteUrl: 'https://initial.com',
95
+ bridgeCompleteMethod: 'POST',
96
+ bridgeCompleteFallbackUrl: 'https://initial.com',
97
+ bridgeCompleteFallbackMethod: 'POST',
98
+ bridgeTargetCompleteUrl: 'https://initial.com',
99
+ bridgeTargetCompleteMethod: 'POST',
100
+ bridgeTargetCompleteFallbackUrl: 'https://initial.com',
101
+ bridgeTargetCompleteFallbackMethod: 'POST',
102
+ username: 'initialUsername',
103
+ password: 'initialPassword',
104
+ fallbackUsername: 'initialFallbackUsername',
105
+ fallbackPassword: 'initialFallbackPassword',
106
+ tag: 'initialTag'
107
+ };
108
+
109
+ const transferAttributes = {
110
+ transferCallerId: '+19195551234',
111
+ callTimeout: 5,
112
+ transferCompleteUrl: 'https://initial.com',
113
+ transferCompleteMethod: 'POST',
114
+ transferCompleteFallbackUrl: 'https://initial.com',
115
+ transferCompleteFallbackMethod: 'POST',
116
+ username: 'initialUsername',
117
+ password: 'initialPassword',
118
+ fallbackUsername: 'initialFallbackUsername',
119
+ fallbackPassword: 'initialFallbackPassword',
120
+ tag: 'initialTag',
121
+ diversionTreatment: 'propagate',
122
+ diversionReason: 'user-busy'
123
+ };
124
+
125
+ const phoneNumber = new Bxml.PhoneNumber('+19195551234');
126
+ const sipUri = new Bxml.SipUri('sip:1-999-123-4567@voip-provider.example.net');
127
+
128
+ const conference = new Bxml.Conference('my-conference', conferenceAttributes);
129
+ const gather = new Bxml.Gather(gatherAttributes);
130
+ const speakSentence = new Bxml.SpeakSentence('<lang xml:lang="es-MX">Hola</lang>nodejs speak sentence <emphasis>SSML test</emphasis>', speakSentenceAttributes);
131
+ const nestedGather = new Bxml.Gather(gatherAttributes, [speakSentence]);
132
+ const pause = new Bxml.Pause({ duration: 2 });
133
+ const playAudio = new Bxml.PlayAudio('https://www.example.com/file.wav', { username: 'initialUsername', password: 'initialPassword' });
134
+ const record = new Bxml.Record(recordAttributes);
135
+ const sendDtmf = new Bxml.SendDtmf('1234', sendDtmfAttributes);
136
+ const tag = new Bxml.Tag('testTag');
137
+ const ring = new Bxml.Ring(ringAttributes);
138
+ const hangup = new Bxml.Hangup();
139
+ const bridge = new Bxml.Bridge(bridgeCallId, bridgeAttributes);
140
+ const transfer = new Bxml.Transfer(transferAttributes, [phoneNumber, sipUri]);
141
+
142
+ const bxml = new Bxml.Response([tag, conference, speakSentence, gather, sendDtmf, nestedGather, pause, record, playAudio, sendDtmf, ring, bridge, transfer, hangup]);
143
+
144
+ const { status: updateStatus } =
145
+ await callsApi.updateCallBxml(BW_ACCOUNT_ID, updateCallId, bxml.toBxml());
146
+ expect(updateStatus).toEqual(204);
147
+ await sleep(SLEEP_TIME_S);
148
+
149
+ const { status: completeStatus } =
150
+ await callsApi.updateCall(BW_ACCOUNT_ID, updateCallId, { state: CallStateEnum.Completed });
151
+ expect(completeStatus).toEqual(200);
152
+ });
153
+
154
+ test('test start and stop verbs', async () => {
155
+ const updateCallId = await createMantecaCall(callsApi);
156
+ activeCalls.push(updateCallId);
157
+ await sleep(SLEEP_TIME_S);
158
+
159
+ const startGatherAttributes = {
160
+ dtmfUrl: 'https://initial.com',
161
+ dtmfMethod: 'POST',
162
+ username: 'initialUsername',
163
+ password: 'initialPassword',
164
+ tag: 'initialTag'
165
+ };
166
+
167
+ const startRecordingAttributes = {
168
+ recordingAvailableUrl: 'https://initial.com',
169
+ recordingAvailableMethod: 'POST',
170
+ transcribe: true,
171
+ transcriptionAvailableUrl: 'https://initial.com',
172
+ transcriptionAvailableMethod: 'POST',
173
+ username: 'initialUsername',
174
+ password: 'initialPassword',
175
+ tag: 'initialTag',
176
+ fileFormat: 'wav',
177
+ multiChannel: true
178
+ };
179
+
180
+ const startStreamAttributes = {
181
+ name: 'initialName',
182
+ tracks: 'inbound',
183
+ destination: 'wss://initial.com',
184
+ streamEventUrl: 'https://initial.com',
185
+ streamEventMethod: 'POST',
186
+ username: 'initialUsername',
187
+ password: 'initialPassword'
188
+ };
189
+
190
+ const startTranscriptionAttributes = {
191
+ name: 'initialName',
192
+ tracks: 'inbound',
193
+ transcriptionEventUrl: 'https://initial.com',
194
+ transcriptionEventMethod: 'POST',
195
+ username: 'initialUsername',
196
+ password: 'initialPassword',
197
+ destination: 'wss://initial.com',
198
+ stabilized: true
199
+ };
200
+
201
+ const stopStreamAttributes = {
202
+ name: 'initialName'
203
+ };
204
+
205
+ const stopTranscriptionAttributes = {
206
+ name: 'initialName'
207
+ };
208
+
209
+ const customParam1 = new Bxml.CustomParam({ name: 'customParamName1', value: 'customParamValue1' });
210
+ const streamParam1 = new Bxml.StreamParam({ name: 'streamParamName1', value: 'streamParamValue1' });
211
+
212
+ const startGather = new Bxml.StartGather(startGatherAttributes);
213
+ const startRecording = new Bxml.StartRecording(startRecordingAttributes);
214
+ const pauseRecording = new Bxml.PauseRecording();
215
+ const resumeRecording = new Bxml.ResumeRecording();
216
+ const startStream = new Bxml.StartStream(startStreamAttributes, [streamParam1]);
217
+ const startTranscription = new Bxml.StartTranscription(startTranscriptionAttributes, [customParam1]);
218
+ const stopGather = new Bxml.StopGather();
219
+ const stopRecording = new Bxml.StopRecording();
220
+ const stopStream = new Bxml.StopStream(stopStreamAttributes);
221
+ const stopTranscription = new Bxml.StopTranscription(stopTranscriptionAttributes);
222
+
223
+ const bxml = new Bxml.Bxml([startGather, stopGather, startRecording, pauseRecording, resumeRecording, stopRecording, startStream, stopStream, startTranscription, stopTranscription]);
224
+
225
+ const { status: updateStatus } =
226
+ await callsApi.updateCallBxml(BW_ACCOUNT_ID, updateCallId, bxml.toBxml());
227
+ expect(updateStatus).toEqual(204);
228
+ await sleep(SLEEP_TIME_S);
229
+
230
+ const { status: completeStatus } =
231
+ await callsApi.updateCall(BW_ACCOUNT_ID, updateCallId, { state: CallStateEnum.Completed });
232
+ expect(completeStatus).toEqual(200);
233
+ });
234
+
235
+ test('test forward', async () => {
236
+ const updateCallId = await createMantecaCall(callsApi);
237
+ activeCalls.push(updateCallId);
238
+ await sleep(SLEEP_TIME_S);
239
+
240
+ const forwardAttributes = {
241
+ to: '+19195551234',
242
+ from: '+19195554321',
243
+ callTimeout: 5,
244
+ diversionTreatment: 'propagate',
245
+ diversionReason: 'user-busy',
246
+ uui: '93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt'
247
+ };
248
+
249
+ const forward = new Bxml.Forward(forwardAttributes);
250
+
251
+ const bxml = new Bxml.Response([forward]);
252
+
253
+ const { status: updateStatus } =
254
+ await callsApi.updateCallBxml(BW_ACCOUNT_ID, updateCallId, bxml.toBxml());
255
+ expect(updateStatus).toEqual(204);
256
+ await sleep(SLEEP_TIME_S);
257
+
258
+ const { status: completeStatus } =
259
+ await callsApi.updateCall(BW_ACCOUNT_ID, updateCallId, { state: CallStateEnum.Completed });
260
+ expect(completeStatus).toEqual(200);
261
+
262
+ });
263
+
264
+ test('test redirect', async () => {
265
+ const updateCallId = await createMantecaCall(callsApi);
266
+ activeCalls.push(updateCallId);
267
+ await sleep(SLEEP_TIME_S);
268
+
269
+ const redirectAttributes = {
270
+ redirectUrl: 'https://initial.com',
271
+ redirectMethod: 'POST',
272
+ redirectFallbackUrl: 'https://initial.com',
273
+ redirectFallbackMethod: 'POST',
274
+ username: 'initialUsername',
275
+ password: 'initialPassword',
276
+ fallbackUsername: 'initialFallbackUsername',
277
+ fallbackPassword: 'initialFallbackPassword',
278
+ tag: 'initialTag'
279
+ };
280
+
281
+ const redirect = new Bxml.Redirect(redirectAttributes);
282
+
283
+ const bxml = new Bxml.Response([redirect]);
284
+
285
+ const { status: updateStatus } =
286
+ await callsApi.updateCallBxml(BW_ACCOUNT_ID, updateCallId, bxml.toBxml());
287
+ expect(updateStatus).toEqual(204);
288
+ await sleep(SLEEP_TIME_S);
289
+
290
+ const { status: completeStatus } =
291
+ await callsApi.updateCall(BW_ACCOUNT_ID, updateCallId, { state: CallStateEnum.Completed });
292
+ expect(completeStatus).toEqual(200);
293
+ });
294
+ });