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,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 message. One of INBOUND OUTBOUND.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const ListMessageDirectionEnum = {
24
+ Inbound: 'INBOUND',
25
+ Outbound: 'OUTBOUND'
26
+ } as const;
27
+
28
+ export type ListMessageDirectionEnum = typeof ListMessageDirectionEnum[keyof typeof ListMessageDirectionEnum];
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 { ListMessageDirectionEnum } from './list-message-direction-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import { MessageStatusEnum } from './message-status-enum';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import { MessageTypeEnum } from './message-type-enum';
25
+
26
+ /**
27
+ *
28
+ * @export
29
+ * @interface ListMessageItem
30
+ */
31
+ export interface ListMessageItem {
32
+ /**
33
+ * The message id
34
+ * @type {string}
35
+ * @memberof ListMessageItem
36
+ */
37
+ 'messageId'?: string;
38
+ /**
39
+ * The account id associated with this message.
40
+ * @type {string}
41
+ * @memberof ListMessageItem
42
+ */
43
+ 'accountId'?: string;
44
+ /**
45
+ * The source phone number of the message.
46
+ * @type {string}
47
+ * @memberof ListMessageItem
48
+ */
49
+ 'sourceTn'?: string;
50
+ /**
51
+ * The recipient phone number of the message.
52
+ * @type {string}
53
+ * @memberof ListMessageItem
54
+ */
55
+ 'destinationTn'?: string;
56
+ /**
57
+ *
58
+ * @type {MessageStatusEnum}
59
+ * @memberof ListMessageItem
60
+ */
61
+ 'messageStatus'?: MessageStatusEnum;
62
+ /**
63
+ *
64
+ * @type {ListMessageDirectionEnum}
65
+ * @memberof ListMessageItem
66
+ */
67
+ 'messageDirection'?: ListMessageDirectionEnum;
68
+ /**
69
+ *
70
+ * @type {MessageTypeEnum}
71
+ * @memberof ListMessageItem
72
+ */
73
+ 'messageType'?: MessageTypeEnum;
74
+ /**
75
+ * The number of segments the message was sent as.
76
+ * @type {number}
77
+ * @memberof ListMessageItem
78
+ */
79
+ 'segmentCount'?: number;
80
+ /**
81
+ * The numeric error code of the message.
82
+ * @type {number}
83
+ * @memberof ListMessageItem
84
+ */
85
+ 'errorCode'?: number;
86
+ /**
87
+ * The ISO 8601 datetime of the message.
88
+ * @type {string}
89
+ * @memberof ListMessageItem
90
+ */
91
+ 'receiveTime'?: string;
92
+ /**
93
+ * The name of the carrier. Not currently supported for MMS coming soon.
94
+ * @type {string}
95
+ * @memberof ListMessageItem
96
+ */
97
+ 'carrierName'?: string | null;
98
+ /**
99
+ * The size of the message including message content and headers.
100
+ * @type {number}
101
+ * @memberof ListMessageItem
102
+ */
103
+ 'messageSize'?: number | null;
104
+ /**
105
+ * The length of the message content.
106
+ * @type {number}
107
+ * @memberof ListMessageItem
108
+ */
109
+ 'messageLength'?: number;
110
+ /**
111
+ * The number of attachments the message has.
112
+ * @type {number}
113
+ * @memberof ListMessageItem
114
+ */
115
+ 'attachmentCount'?: number | null;
116
+ /**
117
+ * The number of recipients the message has.
118
+ * @type {number}
119
+ * @memberof ListMessageItem
120
+ */
121
+ 'recipientCount'?: number | null;
122
+ /**
123
+ * The campaign class of the message if it has one.
124
+ * @type {string}
125
+ * @memberof ListMessageItem
126
+ */
127
+ 'campaignClass'?: string | null;
128
+ /**
129
+ * The campaign ID of the message if it has one.
130
+ * @type {string}
131
+ * @memberof ListMessageItem
132
+ */
133
+ 'campaignId'?: string | null;
134
+ }
135
+
136
+
137
+
@@ -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
+ * Create phone number lookup request.
19
+ * @export
20
+ * @interface LookupRequest
21
+ */
22
+ export interface LookupRequest {
23
+ /**
24
+ *
25
+ * @type {Array<string>}
26
+ * @memberof LookupRequest
27
+ */
28
+ 'tns': Array<string>;
29
+ }
30
+
@@ -0,0 +1,78 @@
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
+ * Carrier information results for the specified telephone number.
19
+ * @export
20
+ * @interface LookupResult
21
+ */
22
+ export interface LookupResult {
23
+ /**
24
+ * Our vendor\'s response code.
25
+ * @type {number}
26
+ * @memberof LookupResult
27
+ */
28
+ 'Response Code'?: number;
29
+ /**
30
+ * Message associated with the response code.
31
+ * @type {string}
32
+ * @memberof LookupResult
33
+ */
34
+ 'Message'?: string;
35
+ /**
36
+ * The telephone number in E.164 format.
37
+ * @type {string}
38
+ * @memberof LookupResult
39
+ */
40
+ 'E.164 Format'?: string;
41
+ /**
42
+ * The formatted version of the telephone number.
43
+ * @type {string}
44
+ * @memberof LookupResult
45
+ */
46
+ 'Formatted'?: string;
47
+ /**
48
+ * The country of the telephone number.
49
+ * @type {string}
50
+ * @memberof LookupResult
51
+ */
52
+ 'Country'?: string;
53
+ /**
54
+ * The line type of the telephone number.
55
+ * @type {string}
56
+ * @memberof LookupResult
57
+ */
58
+ 'Line Type'?: string;
59
+ /**
60
+ * The messaging service provider of the telephone number.
61
+ * @type {string}
62
+ * @memberof LookupResult
63
+ */
64
+ 'Line Provider'?: string;
65
+ /**
66
+ * The first half of the Home Network Identity (HNI).
67
+ * @type {string}
68
+ * @memberof LookupResult
69
+ */
70
+ 'Mobile Country Code'?: string;
71
+ /**
72
+ * The second half of the HNI.
73
+ * @type {string}
74
+ * @memberof LookupResult
75
+ */
76
+ 'Mobile Network Code'?: string;
77
+ }
78
+
@@ -0,0 +1,33 @@
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 status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or FAILED).
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const LookupStatusEnum = {
24
+ InProgress: 'IN_PROGRESS',
25
+ Complete: 'COMPLETE',
26
+ PartialComplete: 'PARTIAL_COMPLETE',
27
+ Failed: 'FAILED'
28
+ } as const;
29
+
30
+ export type LookupStatusEnum = typeof LookupStatusEnum[keyof typeof LookupStatusEnum];
31
+
32
+
33
+
@@ -0,0 +1,56 @@
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 { LookupResult } from './lookup-result';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import { LookupStatusEnum } from './lookup-status-enum';
22
+
23
+ /**
24
+ * If requestId exists, the result for that request is returned. See the Examples for details on the various responses that you can receive. Generally, if you see a Response Code of 0 in a result for a TN, information will be available for it. Any other Response Code will indicate no information was available for the TN.
25
+ * @export
26
+ * @interface LookupStatus
27
+ */
28
+ export interface LookupStatus {
29
+ /**
30
+ * The requestId.
31
+ * @type {string}
32
+ * @memberof LookupStatus
33
+ */
34
+ 'requestId'?: string;
35
+ /**
36
+ *
37
+ * @type {LookupStatusEnum}
38
+ * @memberof LookupStatus
39
+ */
40
+ 'status'?: LookupStatusEnum;
41
+ /**
42
+ * The carrier information results for the specified telephone number.
43
+ * @type {Array<LookupResult>}
44
+ * @memberof LookupStatus
45
+ */
46
+ 'result'?: Array<LookupResult>;
47
+ /**
48
+ * The telephone numbers whose lookup failed.
49
+ * @type {Array<string>}
50
+ * @memberof LookupStatus
51
+ */
52
+ 'failedTelephoneNumbers'?: Array<string>;
53
+ }
54
+
55
+
56
+
@@ -0,0 +1,116 @@
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 { MachineDetectionResult } from './machine-detection-result';
22
+
23
+ /**
24
+ * This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen.
25
+ * @export
26
+ * @interface MachineDetectionCompleteCallback
27
+ */
28
+ export interface MachineDetectionCompleteCallback {
29
+ /**
30
+ * 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.
31
+ * @type {string}
32
+ * @memberof MachineDetectionCompleteCallback
33
+ */
34
+ 'eventType'?: string;
35
+ /**
36
+ * 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.
37
+ * @type {string}
38
+ * @memberof MachineDetectionCompleteCallback
39
+ */
40
+ 'eventTime'?: string;
41
+ /**
42
+ * The user account associated with the call.
43
+ * @type {string}
44
+ * @memberof MachineDetectionCompleteCallback
45
+ */
46
+ 'accountId'?: string;
47
+ /**
48
+ * The id of the application associated with the call.
49
+ * @type {string}
50
+ * @memberof MachineDetectionCompleteCallback
51
+ */
52
+ 'applicationId'?: string;
53
+ /**
54
+ * 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.
55
+ * @type {string}
56
+ * @memberof MachineDetectionCompleteCallback
57
+ */
58
+ 'from'?: string;
59
+ /**
60
+ * The phone number that received the call, in E.164 format (e.g. +15555555555).
61
+ * @type {string}
62
+ * @memberof MachineDetectionCompleteCallback
63
+ */
64
+ 'to'?: string;
65
+ /**
66
+ *
67
+ * @type {CallDirectionEnum}
68
+ * @memberof MachineDetectionCompleteCallback
69
+ */
70
+ 'direction'?: CallDirectionEnum;
71
+ /**
72
+ * The call id associated with the event.
73
+ * @type {string}
74
+ * @memberof MachineDetectionCompleteCallback
75
+ */
76
+ 'callId'?: string;
77
+ /**
78
+ * The URL of the call associated with the event.
79
+ * @type {string}
80
+ * @memberof MachineDetectionCompleteCallback
81
+ */
82
+ 'callUrl'?: string;
83
+ /**
84
+ * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
85
+ * @type {string}
86
+ * @memberof MachineDetectionCompleteCallback
87
+ */
88
+ 'enqueuedTime'?: string | null;
89
+ /**
90
+ * Time the call was started, in ISO 8601 format.
91
+ * @type {string}
92
+ * @memberof MachineDetectionCompleteCallback
93
+ */
94
+ 'startTime'?: string;
95
+ /**
96
+ * Time the call was answered, in ISO 8601 format.
97
+ * @type {string}
98
+ * @memberof MachineDetectionCompleteCallback
99
+ */
100
+ 'answerTime'?: string | null;
101
+ /**
102
+ * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
103
+ * @type {string}
104
+ * @memberof MachineDetectionCompleteCallback
105
+ */
106
+ 'tag'?: string | null;
107
+ /**
108
+ *
109
+ * @type {MachineDetectionResult}
110
+ * @memberof MachineDetectionCompleteCallback
111
+ */
112
+ 'machineDetectionResult'?: MachineDetectionResult | null;
113
+ }
114
+
115
+
116
+
@@ -0,0 +1,122 @@
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 { CallbackMethodEnum } from './callback-method-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import { MachineDetectionModeEnum } from './machine-detection-mode-enum';
22
+
23
+ /**
24
+ * The machine detection request used to perform <a href=\'/docs/voice/guides/machineDetection\'>machine detection</a> on the call.
25
+ * @export
26
+ * @interface MachineDetectionConfiguration
27
+ */
28
+ export interface MachineDetectionConfiguration {
29
+ /**
30
+ *
31
+ * @type {MachineDetectionModeEnum}
32
+ * @memberof MachineDetectionConfiguration
33
+ */
34
+ 'mode'?: MachineDetectionModeEnum;
35
+ /**
36
+ * The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent.
37
+ * @type {number}
38
+ * @memberof MachineDetectionConfiguration
39
+ */
40
+ 'detectionTimeout'?: number | null;
41
+ /**
42
+ * If no speech is detected in this period, a callback with a \'silence\' result is sent.
43
+ * @type {number}
44
+ * @memberof MachineDetectionConfiguration
45
+ */
46
+ 'silenceTimeout'?: number | null;
47
+ /**
48
+ * When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'.
49
+ * @type {number}
50
+ * @memberof MachineDetectionConfiguration
51
+ */
52
+ 'speechThreshold'?: number | null;
53
+ /**
54
+ * Amount of silence (in seconds) before assuming the callee has finished speaking.
55
+ * @type {number}
56
+ * @memberof MachineDetectionConfiguration
57
+ */
58
+ 'speechEndThreshold'?: number | null;
59
+ /**
60
+ * When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value.
61
+ * @type {number}
62
+ * @memberof MachineDetectionConfiguration
63
+ */
64
+ 'machineSpeechEndThreshold'?: number | null;
65
+ /**
66
+ * If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately.
67
+ * @type {boolean}
68
+ * @memberof MachineDetectionConfiguration
69
+ */
70
+ 'delayResult'?: boolean | null;
71
+ /**
72
+ * The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode.
73
+ * @type {string}
74
+ * @memberof MachineDetectionConfiguration
75
+ */
76
+ 'callbackUrl'?: string | null;
77
+ /**
78
+ *
79
+ * @type {CallbackMethodEnum}
80
+ * @memberof MachineDetectionConfiguration
81
+ */
82
+ 'callbackMethod'?: CallbackMethodEnum | null;
83
+ /**
84
+ * Basic auth username.
85
+ * @type {string}
86
+ * @memberof MachineDetectionConfiguration
87
+ */
88
+ 'username'?: string | null;
89
+ /**
90
+ * Basic auth password.
91
+ * @type {string}
92
+ * @memberof MachineDetectionConfiguration
93
+ */
94
+ 'password'?: string | null;
95
+ /**
96
+ * A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond
97
+ * @type {string}
98
+ * @memberof MachineDetectionConfiguration
99
+ */
100
+ 'fallbackUrl'?: string | null;
101
+ /**
102
+ *
103
+ * @type {CallbackMethodEnum}
104
+ * @memberof MachineDetectionConfiguration
105
+ */
106
+ 'fallbackMethod'?: CallbackMethodEnum | null;
107
+ /**
108
+ * Basic auth username.
109
+ * @type {string}
110
+ * @memberof MachineDetectionConfiguration
111
+ */
112
+ 'fallbackUsername'?: string | null;
113
+ /**
114
+ * Basic auth password.
115
+ * @type {string}
116
+ * @memberof MachineDetectionConfiguration
117
+ */
118
+ 'fallbackPassword'?: string | null;
119
+ }
120
+
121
+
122
+
@@ -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 machine detection mode. If set to \'async\', the detection result will be sent in a \'machineDetectionComplete\' callback. If set to \'sync\', the \'answer\' callback will wait for the machine detection to complete and will include its result.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const MachineDetectionModeEnum = {
24
+ Sync: 'sync',
25
+ Async: 'async'
26
+ } as const;
27
+
28
+ export type MachineDetectionModeEnum = typeof MachineDetectionModeEnum[keyof typeof MachineDetectionModeEnum];
29
+
30
+
31
+
@@ -0,0 +1,36 @@
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
+ * (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete
19
+ * @export
20
+ * @interface MachineDetectionResult
21
+ */
22
+ export interface MachineDetectionResult {
23
+ /**
24
+ * Possible values are answering-machine, human, silence, timeout, or error.
25
+ * @type {string}
26
+ * @memberof MachineDetectionResult
27
+ */
28
+ 'value'?: string;
29
+ /**
30
+ * The amount of time it took to determine the result.
31
+ * @type {string}
32
+ * @memberof MachineDetectionResult
33
+ */
34
+ 'duration'?: string;
35
+ }
36
+