bandwidth-sdk 1.0.2 → 2.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 (325) hide show
  1. package/.github/workflows/deploy.yml +3 -3
  2. package/.github/workflows/test-nightly.yml +17 -22
  3. package/.github/workflows/test-pr.yml +4 -2
  4. package/.openapi-generator/FILES +6 -2
  5. package/.openapi-generator/VERSION +1 -1
  6. package/README.md +40 -0
  7. package/api/calls-api.ts +37 -37
  8. package/api/conferences-api.ts +62 -62
  9. package/api/media-api.ts +28 -28
  10. package/api/messages-api.ts +22 -22
  11. package/api/mfaapi.ts +28 -28
  12. package/api/phone-number-lookup-api.ts +18 -18
  13. package/api/recordings-api.ts +126 -126
  14. package/api/statistics-api.ts +10 -10
  15. package/api/transcriptions-api.ts +320 -0
  16. package/api.ts +1 -0
  17. package/bandwidth.yml +243 -28
  18. package/base.ts +24 -6
  19. package/coverage/clover.xml +190 -1490
  20. package/coverage/coverage-final.json +47 -62
  21. package/coverage/lcov-report/index.html +24 -69
  22. package/coverage/lcov-report/{node-sdk/models → models}/bxml/Bxml.ts.html +14 -14
  23. package/coverage/lcov-report/{node-sdk/models → models}/bxml/NestableVerb.ts.html +30 -30
  24. package/coverage/lcov-report/{node-sdk/models → models}/bxml/Response.ts.html +14 -14
  25. package/coverage/lcov-report/{node-sdk/models → models}/bxml/Root.ts.html +25 -25
  26. package/coverage/lcov-report/{node-sdk/models → models}/bxml/Verb.ts.html +20 -20
  27. package/coverage/lcov-report/{node-sdk/models → models}/bxml/index.html +24 -39
  28. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Bridge.ts.html +15 -15
  29. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Conference.ts.html +15 -15
  30. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/CustomParam.ts.html +15 -15
  31. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Forward.ts.html +15 -15
  32. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Gather.ts.html +19 -19
  33. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Hangup.ts.html +14 -14
  34. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Pause.ts.html +15 -15
  35. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/PauseRecording.ts.html +14 -14
  36. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/PhoneNumber.ts.html +15 -15
  37. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/PlayAudio.ts.html +15 -15
  38. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Record.ts.html +15 -15
  39. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Redirect.ts.html +15 -15
  40. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/ResumeRecording.ts.html +14 -14
  41. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Ring.ts.html +15 -15
  42. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/SendDtmf.ts.html +15 -15
  43. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/SipUri.ts.html +15 -15
  44. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/SpeakSentence.ts.html +17 -17
  45. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StartGather.ts.html +15 -15
  46. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StartRecording.ts.html +15 -15
  47. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StartStream.ts.html +16 -16
  48. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StartTranscription.ts.html +16 -16
  49. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StopGather.ts.html +14 -14
  50. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StopRecording.ts.html +14 -14
  51. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StopStream.ts.html +15 -15
  52. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StopTranscription.ts.html +15 -15
  53. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/StreamParam.ts.html +15 -15
  54. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Tag.ts.html +14 -14
  55. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/Transfer.ts.html +16 -16
  56. package/coverage/lcov-report/{node-sdk/models → models}/bxml/verbs/index.html +12 -27
  57. package/coverage/lcov-report/{node-sdk/models → models}/call-direction-enum.ts.html +11 -11
  58. package/coverage/lcov-report/{node-sdk/models → models}/call-state-enum.ts.html +11 -11
  59. package/coverage/lcov-report/{node-sdk/models → models}/callback-method-enum.ts.html +11 -11
  60. package/coverage/lcov-report/{node-sdk/models → models}/conference-state-enum.ts.html +11 -11
  61. package/coverage/lcov-report/{node-sdk/models → models}/file-format-enum.ts.html +11 -11
  62. package/coverage/lcov-report/{node-sdk/models → models}/index.html +12 -27
  63. package/coverage/lcov-report/{node-sdk/models → models}/list-message-direction-enum.ts.html +11 -11
  64. package/coverage/lcov-report/{node-sdk/models → models}/lookup-status-enum.ts.html +11 -11
  65. package/coverage/lcov-report/{node-sdk/models → models}/machine-detection-mode-enum.ts.html +11 -11
  66. package/coverage/lcov-report/{node-sdk/models → models}/message-direction-enum.ts.html +11 -11
  67. package/coverage/lcov-report/{node-sdk/models → models}/message-status-enum.ts.html +11 -11
  68. package/coverage/lcov-report/{node-sdk/models → models}/message-type-enum.ts.html +11 -11
  69. package/coverage/lcov-report/{node-sdk/models → models}/priority-enum.ts.html +11 -11
  70. package/coverage/lcov-report/{node-sdk/models → models}/recording-state-enum.ts.html +11 -11
  71. package/coverage/lcov-report/{node-sdk/models → models}/redirect-method-enum.ts.html +11 -11
  72. package/coverage/lcov.info +323 -3342
  73. package/custom_templates/README.mustache +40 -0
  74. package/custom_templates/package.mustache +5 -2
  75. package/dist/api/calls-api.d.ts +21 -21
  76. package/dist/api/calls-api.js +69 -40
  77. package/dist/api/conferences-api.d.ts +34 -34
  78. package/dist/api/conferences-api.js +117 -72
  79. package/dist/api/media-api.d.ts +15 -15
  80. package/dist/api/media-api.js +57 -32
  81. package/dist/api/messages-api.d.ts +14 -14
  82. package/dist/api/messages-api.js +33 -16
  83. package/dist/api/mfaapi.d.ts +16 -16
  84. package/dist/api/mfaapi.js +45 -24
  85. package/dist/api/phone-number-lookup-api.d.ts +11 -11
  86. package/dist/api/phone-number-lookup-api.js +33 -16
  87. package/dist/api/recordings-api.d.ts +68 -68
  88. package/dist/api/recordings-api.js +196 -147
  89. package/dist/api/statistics-api.d.ts +6 -6
  90. package/dist/api/statistics-api.js +21 -8
  91. package/dist/api/transcriptions-api.d.ts +161 -0
  92. package/dist/api/transcriptions-api.js +427 -0
  93. package/dist/api.d.ts +1 -0
  94. package/dist/api.js +1 -0
  95. package/dist/base.d.ts +2 -2
  96. package/dist/base.js +22 -4
  97. package/dist/models/answer-callback.d.ts +3 -3
  98. package/dist/models/bridge-complete-callback.d.ts +2 -2
  99. package/dist/models/bridge-target-complete-callback.d.ts +2 -2
  100. package/dist/models/bxml/verbs/Bridge.d.ts +1 -2
  101. package/dist/models/bxml/verbs/Conference.d.ts +1 -2
  102. package/dist/models/bxml/verbs/CustomParam.d.ts +1 -2
  103. package/dist/models/bxml/verbs/Forward.d.ts +1 -2
  104. package/dist/models/bxml/verbs/Gather.d.ts +2 -2
  105. package/dist/models/bxml/verbs/Pause.d.ts +1 -2
  106. package/dist/models/bxml/verbs/PhoneNumber.d.ts +1 -2
  107. package/dist/models/bxml/verbs/PlayAudio.d.ts +1 -2
  108. package/dist/models/bxml/verbs/Record.d.ts +1 -2
  109. package/dist/models/bxml/verbs/Redirect.d.ts +1 -2
  110. package/dist/models/bxml/verbs/Ring.d.ts +1 -2
  111. package/dist/models/bxml/verbs/SendDtmf.d.ts +1 -2
  112. package/dist/models/bxml/verbs/SipUri.d.ts +1 -2
  113. package/dist/models/bxml/verbs/SpeakSentence.d.ts +1 -2
  114. package/dist/models/bxml/verbs/StartGather.d.ts +1 -2
  115. package/dist/models/bxml/verbs/StartRecording.d.ts +1 -2
  116. package/dist/models/bxml/verbs/StartStream.d.ts +1 -2
  117. package/dist/models/bxml/verbs/StartTranscription.d.ts +1 -2
  118. package/dist/models/bxml/verbs/StopStream.d.ts +1 -2
  119. package/dist/models/bxml/verbs/StopTranscription.d.ts +1 -2
  120. package/dist/models/bxml/verbs/StreamParam.d.ts +1 -2
  121. package/dist/models/bxml/verbs/Transfer.d.ts +1 -1
  122. package/dist/models/call-recording-metadata.d.ts +7 -7
  123. package/dist/models/call-state.d.ts +1 -1
  124. package/dist/models/call-transcription-metadata.d.ts +30 -0
  125. package/dist/models/call-transcription-metadata.js +15 -0
  126. package/dist/models/call-transcription-response.d.ts +43 -0
  127. package/dist/models/call-transcription-response.js +15 -0
  128. package/dist/models/call-transcription.d.ts +53 -0
  129. package/dist/models/call-transcription.js +25 -0
  130. package/dist/models/conference-member-exit-callback.d.ts +1 -1
  131. package/dist/models/conference-member-join-callback.d.ts +1 -1
  132. package/dist/models/conference-recording-available-callback.d.ts +1 -1
  133. package/dist/models/conference-recording-metadata.d.ts +1 -1
  134. package/dist/models/conference.d.ts +2 -2
  135. package/dist/models/create-call-response.d.ts +1 -1
  136. package/dist/models/create-call.d.ts +10 -4
  137. package/dist/models/create-lookup-response.d.ts +1 -1
  138. package/dist/models/create-message-request-error.d.ts +1 -1
  139. package/dist/models/disconnect-callback.d.ts +2 -2
  140. package/dist/models/dtmf-callback.d.ts +3 -3
  141. package/dist/models/gather-callback.d.ts +3 -3
  142. package/dist/models/inbound-message-callback-message.d.ts +2 -2
  143. package/dist/models/inbound-message-callback.d.ts +1 -1
  144. package/dist/models/index.d.ts +5 -2
  145. package/dist/models/index.js +5 -2
  146. package/dist/models/initiate-callback.d.ts +4 -4
  147. package/dist/models/list-message-item.d.ts +3 -3
  148. package/dist/models/lookup-status.d.ts +2 -2
  149. package/dist/models/machine-detection-complete-callback.d.ts +3 -3
  150. package/dist/models/machine-detection-configuration.d.ts +3 -3
  151. package/dist/models/message-delivered-callback-message.d.ts +2 -2
  152. package/dist/models/message-delivered-callback.d.ts +1 -1
  153. package/dist/models/message-failed-callback-message.d.ts +2 -2
  154. package/dist/models/message-failed-callback.d.ts +1 -1
  155. package/dist/models/message-request.d.ts +1 -1
  156. package/dist/models/message-sending-callback-message.d.ts +2 -2
  157. package/dist/models/message-sending-callback.d.ts +1 -1
  158. package/dist/models/message.d.ts +2 -2
  159. package/dist/models/messages-list.d.ts +2 -2
  160. package/dist/models/recording-available-callback.d.ts +7 -7
  161. package/dist/models/recording-complete-callback.d.ts +4 -4
  162. package/dist/models/recording-transcription-metadata.d.ts +42 -0
  163. package/dist/models/recording-transcription-metadata.js +15 -0
  164. package/dist/models/recording-transcriptions.d.ts +25 -0
  165. package/dist/models/recording-transcriptions.js +15 -0
  166. package/dist/models/redirect-callback.d.ts +3 -3
  167. package/dist/models/transcribe-recording.d.ts +1 -1
  168. package/dist/models/transcription-available-callback.d.ts +5 -5
  169. package/dist/models/transfer-answer-callback.d.ts +3 -3
  170. package/dist/models/transfer-complete-callback.d.ts +3 -3
  171. package/dist/models/transfer-disconnect-callback.d.ts +3 -3
  172. package/dist/models/update-call-recording.d.ts +1 -1
  173. package/dist/models/update-call.d.ts +2 -2
  174. package/dist/models/update-conference.d.ts +2 -2
  175. package/models/answer-callback.ts +3 -3
  176. package/models/bridge-complete-callback.ts +2 -2
  177. package/models/bridge-target-complete-callback.ts +2 -2
  178. package/models/bxml/verbs/Bridge.ts +1 -1
  179. package/models/bxml/verbs/Conference.ts +1 -1
  180. package/models/bxml/verbs/CustomParam.ts +1 -1
  181. package/models/bxml/verbs/Forward.ts +1 -1
  182. package/models/bxml/verbs/Gather.ts +2 -2
  183. package/models/bxml/verbs/Pause.ts +1 -1
  184. package/models/bxml/verbs/PhoneNumber.ts +1 -1
  185. package/models/bxml/verbs/PlayAudio.ts +1 -1
  186. package/models/bxml/verbs/Record.ts +1 -1
  187. package/models/bxml/verbs/Redirect.ts +1 -1
  188. package/models/bxml/verbs/Ring.ts +1 -1
  189. package/models/bxml/verbs/SendDtmf.ts +1 -1
  190. package/models/bxml/verbs/SipUri.ts +1 -1
  191. package/models/bxml/verbs/SpeakSentence.ts +1 -1
  192. package/models/bxml/verbs/StartGather.ts +1 -1
  193. package/models/bxml/verbs/StartRecording.ts +1 -1
  194. package/models/bxml/verbs/StartStream.ts +1 -1
  195. package/models/bxml/verbs/StartTranscription.ts +1 -1
  196. package/models/bxml/verbs/StopStream.ts +1 -1
  197. package/models/bxml/verbs/StopTranscription.ts +1 -1
  198. package/models/bxml/verbs/StreamParam.ts +1 -1
  199. package/models/bxml/verbs/Transfer.ts +1 -1
  200. package/models/call-recording-metadata.ts +7 -7
  201. package/models/call-state.ts +1 -1
  202. package/models/call-transcription-metadata.ts +36 -0
  203. package/models/call-transcription-response.ts +51 -0
  204. package/models/call-transcription.ts +63 -0
  205. package/models/conference-member-exit-callback.ts +1 -1
  206. package/models/conference-member-join-callback.ts +1 -1
  207. package/models/conference-recording-available-callback.ts +1 -1
  208. package/models/conference-recording-metadata.ts +1 -1
  209. package/models/conference.ts +2 -2
  210. package/models/create-call-response.ts +1 -1
  211. package/models/create-call.ts +10 -4
  212. package/models/create-lookup-response.ts +1 -1
  213. package/models/create-message-request-error.ts +1 -1
  214. package/models/disconnect-callback.ts +2 -2
  215. package/models/dtmf-callback.ts +3 -3
  216. package/models/gather-callback.ts +3 -3
  217. package/models/inbound-message-callback-message.ts +2 -2
  218. package/models/inbound-message-callback.ts +1 -1
  219. package/models/index.ts +5 -2
  220. package/models/initiate-callback.ts +4 -4
  221. package/models/list-message-item.ts +3 -3
  222. package/models/lookup-status.ts +2 -2
  223. package/models/machine-detection-complete-callback.ts +3 -3
  224. package/models/machine-detection-configuration.ts +3 -3
  225. package/models/message-delivered-callback-message.ts +2 -2
  226. package/models/message-delivered-callback.ts +1 -1
  227. package/models/message-failed-callback-message.ts +2 -2
  228. package/models/message-failed-callback.ts +1 -1
  229. package/models/message-request.ts +1 -1
  230. package/models/message-sending-callback-message.ts +2 -2
  231. package/models/message-sending-callback.ts +1 -1
  232. package/models/message.ts +2 -2
  233. package/models/messages-list.ts +2 -2
  234. package/models/recording-available-callback.ts +7 -7
  235. package/models/recording-complete-callback.ts +4 -4
  236. package/models/recording-transcription-metadata.ts +48 -0
  237. package/models/recording-transcriptions.ts +33 -0
  238. package/models/redirect-callback.ts +3 -3
  239. package/models/transcribe-recording.ts +1 -1
  240. package/models/transcription-available-callback.ts +5 -5
  241. package/models/transfer-answer-callback.ts +3 -3
  242. package/models/transfer-complete-callback.ts +3 -3
  243. package/models/transfer-disconnect-callback.ts +3 -3
  244. package/models/update-call-recording.ts +1 -1
  245. package/models/update-call.ts +2 -2
  246. package/models/update-conference.ts +2 -2
  247. package/openapitools.json +1 -1
  248. package/package.json +6 -3
  249. package/tests/callUtils.ts +84 -0
  250. package/tests/{integration/bxml.test.js → smoke/bxml.test.ts} +59 -40
  251. package/tests/{integration/calls-api.test.js → smoke/calls-api.test.ts} +56 -48
  252. package/tests/{integration/conferences-api.test.js → smoke/conferences-api.test.ts} +28 -29
  253. package/tests/{integration/media-api.test.js → smoke/media-api.test.ts} +18 -17
  254. package/tests/smoke/messages-api.test.ts +115 -0
  255. package/tests/{integration/mfaapi.test.js → smoke/mfaapi.test.ts} +27 -25
  256. package/tests/{integration/phone-number-lookup-api.test.js → smoke/phone-number-lookup-api.test.ts} +9 -7
  257. package/tests/{integration/recordings-api.test.js → smoke/recordings-api.test.ts} +41 -41
  258. package/tests/{integration/statistics-api.test.js → smoke/statistics-api.test.ts} +9 -8
  259. package/tests/smoke/transcriptions-api.test.ts +85 -0
  260. package/tests/unit/{bxml/Bxml.test.js → models/bxml/Bxml.test.ts} +3 -3
  261. package/tests/unit/{bxml/NestableVerb.test.js → models/bxml/NestableVerb.test.ts} +2 -2
  262. package/tests/unit/{bxml/Response.test.js → models/bxml/Response.test.ts} +3 -3
  263. package/tests/unit/{bxml/Verb.test.js → models/bxml/Verb.test.ts} +1 -1
  264. package/tests/unit/{bxml/verbs/Bridge.test.js → models/bxml/verbs/Bridge.test.ts} +3 -3
  265. package/tests/unit/{bxml/verbs/Conference.test.js → models/bxml/verbs/Conference.test.ts} +3 -3
  266. package/tests/unit/{bxml/verbs/CustomParam.test.js → models/bxml/verbs/CustomParam.test.ts} +3 -3
  267. package/tests/unit/{bxml/verbs/Forward.test.js → models/bxml/verbs/Forward.test.ts} +3 -3
  268. package/tests/unit/{bxml/verbs/Gather.test.js → models/bxml/verbs/Gather.test.ts} +5 -5
  269. package/tests/unit/{bxml/verbs/Hangup.test.js → models/bxml/verbs/Hangup.test.ts} +2 -2
  270. package/tests/unit/{bxml/verbs/Pause.test.js → models/bxml/verbs/Pause.test.ts} +3 -3
  271. package/tests/unit/{bxml/verbs/PauseRecording.test.js → models/bxml/verbs/PauseRecording.test.ts} +2 -2
  272. package/tests/unit/{bxml/verbs/PhoneNumber.test.js → models/bxml/verbs/PhoneNumber.test.ts} +3 -3
  273. package/tests/unit/{bxml/verbs/PlayAudio.test.js → models/bxml/verbs/PlayAudio.test.ts} +3 -3
  274. package/tests/unit/{bxml/verbs/Record.test.js → models/bxml/verbs/Record.test.ts} +3 -3
  275. package/tests/unit/{bxml/verbs/Redirect.test.js → models/bxml/verbs/Redirect.test.ts} +3 -3
  276. package/tests/unit/{bxml/verbs/ResumeRecording.test.js → models/bxml/verbs/ResumeRecording.test.ts} +2 -2
  277. package/tests/unit/{bxml/verbs/Ring.test.js → models/bxml/verbs/Ring.test.ts} +3 -3
  278. package/tests/unit/{bxml/verbs/SendDtmf.test.js → models/bxml/verbs/SendDtmf.test.ts} +3 -3
  279. package/tests/unit/{bxml/verbs/SipUri.test.js → models/bxml/verbs/SipUri.test.ts} +3 -3
  280. package/tests/unit/{bxml/verbs/SpeakSentence.test.js → models/bxml/verbs/SpeakSentence.test.ts} +3 -3
  281. package/tests/unit/{bxml/verbs/StartGather.test.js → models/bxml/verbs/StartGather.test.ts} +3 -3
  282. package/tests/unit/{bxml/verbs/StartRecording.test.js → models/bxml/verbs/StartRecording.test.ts} +3 -3
  283. package/tests/unit/{bxml/verbs/StartStream.test.js → models/bxml/verbs/StartStream.test.ts} +4 -4
  284. package/tests/unit/{bxml/verbs/StartTranscription.test.js → models/bxml/verbs/StartTranscription.test.ts} +4 -4
  285. package/tests/unit/{bxml/verbs/StopGather.test.js → models/bxml/verbs/StopGather.test.ts} +2 -2
  286. package/tests/unit/{bxml/verbs/StopRecording.test.js → models/bxml/verbs/StopRecording.test.ts} +2 -2
  287. package/tests/unit/{bxml/verbs/StopStream.test.js → models/bxml/verbs/StopStream.test.ts} +3 -3
  288. package/tests/unit/{bxml/verbs/StopTranscription.test.js → models/bxml/verbs/StopTranscription.test.ts} +3 -3
  289. package/tests/unit/{bxml/verbs/StreamParam.test.js → models/bxml/verbs/StreamParam.test.ts} +3 -3
  290. package/tests/unit/{bxml/verbs/Tag.test.js → models/bxml/verbs/Tag.test.ts} +2 -2
  291. package/tests/unit/{bxml/verbs/Transfer.test.js → models/bxml/verbs/Transfer.test.ts} +5 -5
  292. package/tests/unit/{call-direction-enum.test.js → models/call-direction-enum.test.ts} +1 -1
  293. package/tests/unit/{call-state-enum.test.js → models/call-state-enum.test.ts} +1 -1
  294. package/tests/unit/{callback-method-enum.test.js → models/callback-method-enum.test.ts} +1 -1
  295. package/tests/unit/{conference-state-enum.test.js → models/conference-state-enum.test.ts} +1 -1
  296. package/tests/unit/{file-format-enum.test.js → models/file-format-enum.test.ts} +1 -1
  297. package/tests/unit/{list-message-direction-enum.test.js → models/list-message-direction-enum.test.ts} +1 -1
  298. package/tests/unit/{lookup-status-enum.test.js → models/lookup-status-enum.test.ts} +1 -1
  299. package/tests/unit/{machine-detection-mode-enum.test.js → models/machine-detection-mode-enum.test.ts} +1 -1
  300. package/tests/unit/{message-direction-enum.test.js → models/message-direction-enum.test.ts} +1 -1
  301. package/tests/unit/{message-status-enum.test.js → models/message-status-enum.test.ts} +1 -1
  302. package/tests/unit/{message-type-enum.test.js → models/message-type-enum.test.ts} +1 -1
  303. package/tests/unit/{priority-enum.test.js → models/priority-enum.test.ts} +1 -1
  304. package/tests/unit/{recording-state-enum.test.js → models/recording-state-enum.test.ts} +1 -1
  305. package/tests/unit/{redirect-method-enum.test.js → models/redirect-method-enum.test.ts} +1 -1
  306. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +0 -1702
  307. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +0 -2725
  308. package/coverage/lcov-report/node-sdk/api/index.html +0 -221
  309. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +0 -1315
  310. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +0 -1138
  311. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +0 -1051
  312. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +0 -775
  313. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +0 -2971
  314. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +0 -496
  315. package/coverage/lcov-report/node-sdk/base.ts.html +0 -991
  316. package/coverage/lcov-report/node-sdk/common.ts.html +0 -535
  317. package/coverage/lcov-report/node-sdk/configuration.ts.html +0 -415
  318. package/coverage/lcov-report/node-sdk/index.html +0 -146
  319. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +0 -94
  320. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +0 -175
  321. package/coverage/lcov-report/node-sdk/models/index.ts.html +0 -352
  322. package/coverage/lcov-report/node-sdk/tests/callUtils.js.html +0 -334
  323. package/coverage/lcov-report/node-sdk/tests/index.html +0 -116
  324. package/tests/callUtils.js +0 -83
  325. package/tests/integration/messages-api.test.js +0 -114
package/bandwidth.yml CHANGED
@@ -16,6 +16,7 @@ tags:
16
16
  - name: Conferences
17
17
  - name: Recordings
18
18
  - name: Statistics
19
+ - name: Transcriptions
19
20
  - name: MFA
20
21
  - name: Phone Number Lookup
21
22
  paths:
@@ -962,9 +963,7 @@ paths:
962
963
  description: >-
963
964
  Downloads the specified transcription.
964
965
 
965
-
966
- If the transcribed recording was multi-channel, then there will be 2
967
- transcripts.
966
+ If the recording was multi-channel, then there will be 2 transcripts.
968
967
 
969
968
  The caller/called party transcript will be the first item while
970
969
  [`<PlayAudio>`](/docs/voice/bxml/playAudio) and
@@ -974,14 +973,14 @@ paths:
974
973
  During a [`<Transfer>`](/docs/voice/bxml/transfer) the A-leg transcript
975
974
  will be the first item while the B-leg transcript will be the second
976
975
  item.
977
- operationId: getCallTranscription
976
+ operationId: getRecordingTranscription
978
977
  parameters:
979
978
  - $ref: '#/components/parameters/accountId'
980
979
  - $ref: '#/components/parameters/callId'
981
980
  - $ref: '#/components/parameters/recordingId'
982
981
  responses:
983
982
  '200':
984
- $ref: '#/components/responses/getCallTranscriptionResponse'
983
+ $ref: '#/components/responses/getRecordingTranscriptionResponse'
985
984
  '400':
986
985
  $ref: '#/components/responses/voiceBadRequestError'
987
986
  '401':
@@ -1047,7 +1046,7 @@ paths:
1047
1046
  transcription will not be accessible anymore. However, it is not deleted
1048
1047
  immediately. This deletion process, while transparent and irreversible,
1049
1048
  can take an additional 24 to 48 hours.
1050
- operationId: deleteCallTranscription
1049
+ operationId: deleteRecordingTranscription
1051
1050
  parameters:
1052
1051
  - $ref: '#/components/parameters/accountId'
1053
1052
  - $ref: '#/components/parameters/callId'
@@ -1101,6 +1100,108 @@ paths:
1101
1100
  '500':
1102
1101
  $ref: '#/components/responses/voiceInternalServerError'
1103
1102
  servers: *ref_1
1103
+ /accounts/{accountId}/calls/{callId}/transcriptions:
1104
+ get:
1105
+ tags:
1106
+ - Transcriptions
1107
+ summary: Enumerate transcriptions made with StartTranscription
1108
+ description: >-
1109
+ Enumerates the transcriptions created on this call via
1110
+ [startTranscription](/docs/voice/bxml/startTranscription).
1111
+ operationId: listRealTimeTranscriptions
1112
+ parameters:
1113
+ - $ref: '#/components/parameters/accountId'
1114
+ - $ref: '#/components/parameters/callId'
1115
+ responses:
1116
+ '200':
1117
+ $ref: '#/components/responses/listTranscriptionsResponse'
1118
+ '400':
1119
+ $ref: '#/components/responses/voiceBadRequestError'
1120
+ '401':
1121
+ $ref: '#/components/responses/voiceUnauthorizedError'
1122
+ '403':
1123
+ $ref: '#/components/responses/voiceForbiddenError'
1124
+ '404':
1125
+ $ref: '#/components/responses/voiceNotFoundError'
1126
+ '405':
1127
+ $ref: '#/components/responses/voiceNotAllowedError'
1128
+ '415':
1129
+ $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
1130
+ '429':
1131
+ $ref: '#/components/responses/voiceTooManyRequestsError'
1132
+ '500':
1133
+ $ref: '#/components/responses/voiceInternalServerError'
1134
+ servers: *ref_1
1135
+ /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}:
1136
+ get:
1137
+ tags:
1138
+ - Transcriptions
1139
+ summary: Retrieve a specific transcription
1140
+ description: >-
1141
+ Retrieve the specified transcription that was created on this call via
1142
+ [startTranscription](/docs/voice/bxml/startTranscription).
1143
+ operationId: getRealTimeTranscription
1144
+ parameters:
1145
+ - $ref: '#/components/parameters/accountId'
1146
+ - $ref: '#/components/parameters/callId'
1147
+ - $ref: '#/components/parameters/transcriptionId'
1148
+ responses:
1149
+ '200':
1150
+ $ref: '#/components/responses/getCallTranscriptionResponse'
1151
+ '400':
1152
+ $ref: '#/components/responses/voiceBadRequestError'
1153
+ '401':
1154
+ $ref: '#/components/responses/voiceUnauthorizedError'
1155
+ '403':
1156
+ $ref: '#/components/responses/voiceForbiddenError'
1157
+ '404':
1158
+ $ref: '#/components/responses/voiceNotFoundError'
1159
+ '405':
1160
+ $ref: '#/components/responses/voiceNotAllowedError'
1161
+ '415':
1162
+ $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
1163
+ '429':
1164
+ $ref: '#/components/responses/voiceTooManyRequestsError'
1165
+ '500':
1166
+ $ref: '#/components/responses/voiceInternalServerError'
1167
+ delete:
1168
+ tags:
1169
+ - Transcriptions
1170
+ summary: Delete a specific transcription
1171
+ description: >-
1172
+ Delete the specified transcription that was created on this call via
1173
+ [startTranscription](/docs/voice/bxml/startTranscription).
1174
+
1175
+
1176
+ Note: After the deletion is requested and a `204` is returned, the
1177
+ transcription will not be accessible anymore. However, it is not deleted
1178
+ immediately. This deletion process, while transparent and irreversible,
1179
+ can take an additional 24 to 48 hours.
1180
+ operationId: deleteRealTimeTranscription
1181
+ parameters:
1182
+ - $ref: '#/components/parameters/accountId'
1183
+ - $ref: '#/components/parameters/callId'
1184
+ - $ref: '#/components/parameters/transcriptionId'
1185
+ responses:
1186
+ '204':
1187
+ $ref: '#/components/responses/deleteCallTranscriptionResponse'
1188
+ '400':
1189
+ $ref: '#/components/responses/voiceBadRequestError'
1190
+ '401':
1191
+ $ref: '#/components/responses/voiceUnauthorizedError'
1192
+ '403':
1193
+ $ref: '#/components/responses/voiceForbiddenError'
1194
+ '404':
1195
+ $ref: '#/components/responses/voiceNotFoundError'
1196
+ '405':
1197
+ $ref: '#/components/responses/voiceNotAllowedError'
1198
+ '415':
1199
+ $ref: '#/components/responses/voiceUnsupportedMediaTypeError'
1200
+ '429':
1201
+ $ref: '#/components/responses/voiceTooManyRequestsError'
1202
+ '500':
1203
+ $ref: '#/components/responses/voiceInternalServerError'
1204
+ servers: *ref_1
1104
1205
  /accounts/{accountId}/code/voice:
1105
1206
  post:
1106
1207
  tags:
@@ -2051,11 +2152,16 @@ components:
2051
2152
  description: >-
2052
2153
  A Bandwidth phone number on your account the call should come
2053
2154
 
2054
- from (must be in E.164 format, like `+15555551212`, or be one of the
2055
- following
2056
-
2057
- strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`).
2058
- example: '+19195554321'
2155
+ from (must be in E.164 format, like `+15555551212`) even if
2156
+ `privacy` is set to true.
2157
+ example: '+15555551212'
2158
+ privacy:
2159
+ nullable: true
2160
+ type: boolean
2161
+ description: >-
2162
+ Hide the calling number. The `displayName` field can be used to
2163
+ customize the displayed name.
2164
+ example: false
2059
2165
  displayName:
2060
2166
  nullable: true
2061
2167
  type: string
@@ -2064,6 +2170,9 @@ components:
2064
2170
 
2065
2171
  May not exceed 256 characters nor contain control characters such as
2066
2172
  new lines.
2173
+
2174
+ If `privacy` is true, only the following values are valid:
2175
+ `Restricted`, `Anonymous`, `Private`, or `Unavailable`.
2067
2176
  maxLength: 256
2068
2177
  example: John Doe
2069
2178
  uui:
@@ -2677,7 +2786,7 @@ components:
2677
2786
  mediaUrl:
2678
2787
  $ref: '#/components/schemas/mediaUrl'
2679
2788
  transcription:
2680
- $ref: '#/components/schemas/transcriptionMetadata'
2789
+ $ref: '#/components/schemas/recordingTranscriptionMetadata'
2681
2790
  conference:
2682
2791
  type: object
2683
2792
  properties:
@@ -2922,7 +3031,10 @@ components:
2922
3031
  description: >-
2923
3032
  The machine detection request used to perform <a
2924
3033
  href='/docs/voice/guides/machineDetection'>machine detection</a> on the
2925
- call.
3034
+ call. Currently, there is an issue where decimal values are not getting
3035
+ processed correctly. Please use whole number values. We are working to
3036
+ resolve this issue. Please contact Bandwidth Support if you need more
3037
+ information.
2926
3038
  properties:
2927
3039
  mode:
2928
3040
  $ref: '#/components/schemas/machineDetectionModeEnum'
@@ -3114,14 +3226,95 @@ components:
3114
3226
  Current supported languages are English, French, and Spanish.
3115
3227
  default: false
3116
3228
  example: true
3117
- transcriptionList:
3229
+ recordingTranscriptions:
3118
3230
  type: object
3119
3231
  properties:
3120
3232
  transcripts:
3121
3233
  type: array
3122
3234
  items:
3123
3235
  $ref: '#/components/schemas/transcription'
3124
- transcriptionMetadata:
3236
+ callTranscriptionMetadataList:
3237
+ type: array
3238
+ items:
3239
+ $ref: '#/components/schemas/callTranscriptionMetadata'
3240
+ example:
3241
+ - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3242
+ transcriptionUrl: >-
3243
+ https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3244
+ callTranscriptionMetadata:
3245
+ type: object
3246
+ properties:
3247
+ transcriptionId:
3248
+ type: string
3249
+ description: The programmable voice API transcription ID.
3250
+ example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3251
+ transcriptionUrl:
3252
+ type: string
3253
+ description: >-
3254
+ A URL that may be used to retrieve the transcription itself. This
3255
+ points to the
3256
+
3257
+ [Get Call
3258
+ Transcription](/apis/voice/#operation/getCallTranscription)
3259
+ endpoint.
3260
+ example: >-
3261
+ https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3262
+ callTranscriptionResponse:
3263
+ type: object
3264
+ properties:
3265
+ accountId:
3266
+ type: string
3267
+ description: The user account associated with the call.
3268
+ example: '920012'
3269
+ callId:
3270
+ type: string
3271
+ description: The call id associated with the event.
3272
+ example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
3273
+ transcriptionId:
3274
+ type: string
3275
+ description: The programmable voice API transcription ID.
3276
+ example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
3277
+ tracks:
3278
+ type: array
3279
+ items:
3280
+ $ref: '#/components/schemas/callTranscription'
3281
+ example:
3282
+ - detectedLanguage: en-US
3283
+ track: inbound
3284
+ text: Hello World! This is an example.
3285
+ confidence: 0.9
3286
+ callTranscription:
3287
+ type: object
3288
+ properties:
3289
+ detectedLanguage:
3290
+ type: string
3291
+ enum:
3292
+ - en-US
3293
+ - es-US
3294
+ - fr-FR
3295
+ description: The detected language for this transcription.
3296
+ example: en-US
3297
+ track:
3298
+ type: string
3299
+ enum:
3300
+ - inbound
3301
+ - outbound
3302
+ description: Which `track` this transcription is derived from.
3303
+ example: inbound
3304
+ text:
3305
+ type: string
3306
+ description: The transcription itself.
3307
+ example: Hello World! This is an example.
3308
+ confidence:
3309
+ type: number
3310
+ format: double
3311
+ minimum: 0
3312
+ maximum: 1
3313
+ description: >-
3314
+ How confident the transcription engine was in transcribing the
3315
+ associated audio (from `0` to `1`).
3316
+ example: 0.9
3317
+ recordingTranscriptionMetadata:
3125
3318
  nullable: true
3126
3319
  type: object
3127
3320
  description: If the recording was transcribed, metadata about the transcription
@@ -3693,7 +3886,7 @@ components:
3693
3886
  fileFormat:
3694
3887
  $ref: '#/components/schemas/fileFormatEnum'
3695
3888
  channels:
3696
- $ref: '#/components/schemas/status'
3889
+ $ref: '#/components/schemas/channels'
3697
3890
  tag:
3698
3891
  $ref: '#/components/schemas/tag1'
3699
3892
  status:
@@ -3960,9 +4153,8 @@ components:
3960
4153
  from:
3961
4154
  type: string
3962
4155
  description: >-
3963
- The provided identifier of the caller: can be a phone number in E.164
3964
- format (e.g. +15555555555) or one of Private, Restricted, Unavailable,
3965
- or Anonymous.
4156
+ The provided identifier of the caller. Must be a phone number in E.164
4157
+ format (e.g. +15555555555).
3966
4158
  example: '+15555555555'
3967
4159
  conferenceId:
3968
4160
  type: string
@@ -4041,8 +4233,7 @@ components:
4041
4233
  type: string
4042
4234
  description: >-
4043
4235
  The phone number used as the from field of the B-leg call, in E.164
4044
- format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or
4045
- Unavailable.
4236
+ format (e.g. +15555555555).
4046
4237
  example: '+15555555555'
4047
4238
  transferTo:
4048
4239
  type: string
@@ -4582,12 +4773,26 @@ components:
4582
4773
  schema:
4583
4774
  type: string
4584
4775
  format: binary
4776
+ getRecordingTranscriptionResponse:
4777
+ description: Transcription found.
4778
+ content:
4779
+ application/json:
4780
+ schema:
4781
+ $ref: '#/components/schemas/recordingTranscriptions'
4782
+ listTranscriptionsResponse:
4783
+ description: Transcription found.
4784
+ content:
4785
+ application/json:
4786
+ schema:
4787
+ $ref: '#/components/schemas/callTranscriptionMetadataList'
4585
4788
  getCallTranscriptionResponse:
4586
- description: Transcription found
4789
+ description: Transcription found.
4587
4790
  content:
4588
4791
  application/json:
4589
4792
  schema:
4590
- $ref: '#/components/schemas/transcriptionList'
4793
+ $ref: '#/components/schemas/callTranscriptionResponse'
4794
+ deleteCallTranscriptionResponse:
4795
+ description: Transcription data was deleted.
4591
4796
  listConferencesResponse:
4592
4797
  description: Conferences retrieved successfully
4593
4798
  content:
@@ -5090,6 +5295,14 @@ components:
5090
5295
  type: string
5091
5296
  description: Programmable Voice API Conference Member ID.
5092
5297
  example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
5298
+ transcriptionId:
5299
+ name: transcriptionId
5300
+ in: path
5301
+ required: true
5302
+ schema:
5303
+ type: string
5304
+ description: Programmable Voice API Transcription ID.
5305
+ example: t-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
5093
5306
  to:
5094
5307
  name: to
5095
5308
  in: query
@@ -5517,12 +5730,14 @@ components:
5517
5730
  Basic:
5518
5731
  type: http
5519
5732
  scheme: basic
5520
- description: |-
5733
+ description: >-
5521
5734
  Basic authentication is a simple authentication scheme built into the
5522
- HTTP protocol. To use it, send your HTTP requests with an Authorization
5523
- header that contains the word Basic followed by a space and a
5524
- base64-encoded string `username:password`Example: `Authorization: Basic
5525
- ZGVtbZpwQDU1dzByZA==`
5735
+ HTTP protocol. To use it, send your HTTP requests with an
5736
+ `Authorization` header that contains the word `Basic` followed by a
5737
+ space and a Base64-encoded string `username:password`.
5738
+
5739
+
5740
+ - Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==`
5526
5741
  callbacks:
5527
5742
  inboundCallback:
5528
5743
  '{inboundCallbackUrl}':
package/base.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  import type { Configuration } from './configuration';
17
17
  // Some imports not used depending on template conditions
18
18
  // @ts-ignore
19
- import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
19
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
20
20
  import globalAxios from 'axios';
21
21
 
22
22
  export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
@@ -39,7 +39,7 @@ export const COLLECTION_FORMATS = {
39
39
  */
40
40
  export interface RequestArgs {
41
41
  url: string;
42
- options: AxiosRequestConfig;
42
+ options: RawAxiosRequestConfig;
43
43
  }
44
44
 
45
45
  /**
@@ -233,19 +233,19 @@ export const operationServerMap: ServerMap = {
233
233
  description: "Production",
234
234
  }
235
235
  ],
236
- "RecordingsApi.deleteCallTranscription": [
236
+ "RecordingsApi.deleteRecording": [
237
237
  {
238
238
  url: "https://voice.bandwidth.com/api/v2",
239
239
  description: "Production",
240
240
  }
241
241
  ],
242
- "RecordingsApi.deleteRecording": [
242
+ "RecordingsApi.deleteRecordingMedia": [
243
243
  {
244
244
  url: "https://voice.bandwidth.com/api/v2",
245
245
  description: "Production",
246
246
  }
247
247
  ],
248
- "RecordingsApi.deleteRecordingMedia": [
248
+ "RecordingsApi.deleteRecordingTranscription": [
249
249
  {
250
250
  url: "https://voice.bandwidth.com/api/v2",
251
251
  description: "Production",
@@ -263,7 +263,7 @@ export const operationServerMap: ServerMap = {
263
263
  description: "Production",
264
264
  }
265
265
  ],
266
- "RecordingsApi.getCallTranscription": [
266
+ "RecordingsApi.getRecordingTranscription": [
267
267
  {
268
268
  url: "https://voice.bandwidth.com/api/v2",
269
269
  description: "Production",
@@ -299,4 +299,22 @@ export const operationServerMap: ServerMap = {
299
299
  description: "Production",
300
300
  }
301
301
  ],
302
+ "TranscriptionsApi.deleteRealTimeTranscription": [
303
+ {
304
+ url: "https://voice.bandwidth.com/api/v2",
305
+ description: "Production",
306
+ }
307
+ ],
308
+ "TranscriptionsApi.getRealTimeTranscription": [
309
+ {
310
+ url: "https://voice.bandwidth.com/api/v2",
311
+ description: "Production",
312
+ }
313
+ ],
314
+ "TranscriptionsApi.listRealTimeTranscriptions": [
315
+ {
316
+ url: "https://voice.bandwidth.com/api/v2",
317
+ description: "Production",
318
+ }
319
+ ],
302
320
  }