bandwidth-sdk 6.2.1 → 7.0.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 (561) hide show
  1. package/.github/workflows/deploy.yml +2 -2
  2. package/.github/workflows/test-pr.yml +2 -2
  3. package/.github/workflows/test-smoke.yml +4 -4
  4. package/.openapi-generator/FILES +34 -10
  5. package/.openapi-generator/VERSION +1 -1
  6. package/README.md +245 -6
  7. package/api/calls-api.ts +0 -11
  8. package/api/conferences-api.ts +0 -15
  9. package/api/media-api.ts +0 -10
  10. package/api/messages-api.ts +0 -8
  11. package/api/mfaapi.ts +0 -9
  12. package/api/multi-channel-api.ts +0 -7
  13. package/api/phone-number-lookup-api.ts +145 -76
  14. package/api/recordings-api.ts +0 -16
  15. package/api/statistics-api.ts +0 -7
  16. package/api/toll-free-verification-api.ts +0 -15
  17. package/api/transcriptions-api.ts +0 -9
  18. package/bandwidth.yml +551 -277
  19. package/base.ts +10 -28
  20. package/common.ts +5 -42
  21. package/configuration.ts +26 -20
  22. package/coverage/clover.xml +1332 -1279
  23. package/coverage/coverage-final.json +49 -45
  24. package/coverage/lcov-report/index.html +25 -25
  25. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +2 -35
  26. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +2 -47
  27. package/coverage/lcov-report/node-sdk/api/index.html +17 -17
  28. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +2 -32
  29. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +2 -26
  30. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +2 -29
  31. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +2 -23
  32. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +338 -131
  33. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +2 -50
  34. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +2 -23
  35. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2 -47
  36. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +2 -29
  37. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/base.ts.html +19 -73
  39. package/coverage/lcov-report/node-sdk/common.ts.html +25 -136
  40. package/coverage/lcov-report/node-sdk/configuration.ts.html +52 -34
  41. package/coverage/lcov-report/node-sdk/index.html +7 -7
  42. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -8
  43. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -8
  44. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -8
  82. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -8
  83. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -8
  84. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -8
  85. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -8
  86. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -17
  87. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +166 -0
  88. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -8
  89. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +169 -0
  90. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -8
  91. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +169 -0
  92. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +2 -8
  93. package/coverage/lcov-report/node-sdk/models/index.html +67 -7
  94. package/coverage/lcov-report/node-sdk/models/index.ts.html +45 -9
  95. package/coverage/lcov-report/node-sdk/models/{lookup-status-enum.ts.html → latest-message-delivery-status-enum.ts.html} +10 -19
  96. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +169 -0
  97. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -8
  98. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -8
  99. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -8
  100. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -8
  101. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -8
  102. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -8
  103. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -8
  104. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -8
  105. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -17
  106. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -8
  107. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -8
  108. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -8
  109. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -17
  110. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -8
  111. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -17
  112. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -17
  113. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -8
  114. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -17
  115. package/coverage/lcov.info +2940 -2824
  116. package/custom_templates/README.mustache +56 -6
  117. package/custom_templates/common.mustache +29 -44
  118. package/custom_templates/configuration.mustache +26 -19
  119. package/custom_templates/package.mustache +1 -1
  120. package/dist/api/calls-api.d.ts +0 -11
  121. package/dist/api/calls-api.js +0 -11
  122. package/dist/api/conferences-api.d.ts +0 -15
  123. package/dist/api/conferences-api.js +0 -15
  124. package/dist/api/media-api.d.ts +0 -10
  125. package/dist/api/media-api.js +0 -10
  126. package/dist/api/messages-api.d.ts +0 -8
  127. package/dist/api/messages-api.js +0 -8
  128. package/dist/api/mfaapi.d.ts +0 -9
  129. package/dist/api/mfaapi.js +0 -9
  130. package/dist/api/multi-channel-api.d.ts +0 -7
  131. package/dist/api/multi-channel-api.js +0 -7
  132. package/dist/api/phone-number-lookup-api.d.ts +81 -59
  133. package/dist/api/phone-number-lookup-api.js +149 -73
  134. package/dist/api/recordings-api.d.ts +0 -16
  135. package/dist/api/recordings-api.js +0 -16
  136. package/dist/api/statistics-api.d.ts +0 -7
  137. package/dist/api/statistics-api.js +0 -7
  138. package/dist/api/toll-free-verification-api.d.ts +0 -15
  139. package/dist/api/toll-free-verification-api.js +0 -15
  140. package/dist/api/transcriptions-api.d.ts +0 -9
  141. package/dist/api/transcriptions-api.js +0 -9
  142. package/dist/base.d.ts +0 -24
  143. package/dist/base.js +10 -23
  144. package/dist/common.d.ts +0 -37
  145. package/dist/common.js +0 -37
  146. package/dist/configuration.d.ts +24 -17
  147. package/dist/configuration.js +2 -2
  148. package/dist/models/account-statistics.d.ts +0 -9
  149. package/dist/models/additional-denial-reason.d.ts +0 -11
  150. package/dist/models/address.d.ts +0 -19
  151. package/dist/models/answer-callback.d.ts +0 -36
  152. package/dist/models/async-lookup-request.d.ts +17 -0
  153. package/dist/models/blocked-webhook.d.ts +0 -20
  154. package/dist/models/bridge-complete-callback.d.ts +0 -37
  155. package/dist/models/bridge-target-complete-callback.d.ts +0 -31
  156. package/dist/models/business-entity-type-enum.d.ts +0 -2
  157. package/dist/models/business-entity-type-enum.js +0 -2
  158. package/dist/models/business-registration-type-enum.d.ts +0 -2
  159. package/dist/models/business-registration-type-enum.js +0 -2
  160. package/dist/models/call-direction-enum.d.ts +0 -2
  161. package/dist/models/call-direction-enum.js +0 -2
  162. package/dist/models/call-recording-metadata.d.ts +0 -52
  163. package/dist/models/call-state-enum.d.ts +0 -2
  164. package/dist/models/call-state-enum.js +0 -2
  165. package/dist/models/call-state.d.ts +0 -44
  166. package/dist/models/call-transcription-detected-language-enum.d.ts +0 -2
  167. package/dist/models/call-transcription-detected-language-enum.js +0 -2
  168. package/dist/models/call-transcription-metadata.d.ts +0 -11
  169. package/dist/models/call-transcription-response.d.ts +0 -16
  170. package/dist/models/call-transcription-track-enum.d.ts +0 -2
  171. package/dist/models/call-transcription-track-enum.js +0 -2
  172. package/dist/models/call-transcription.d.ts +0 -19
  173. package/dist/models/callback-method-enum.d.ts +0 -2
  174. package/dist/models/callback-method-enum.js +0 -2
  175. package/dist/models/callback.d.ts +0 -1
  176. package/dist/models/card-width-enum.d.ts +0 -5
  177. package/dist/models/card-width-enum.js +0 -5
  178. package/dist/models/code-request.d.ts +0 -17
  179. package/dist/models/completed-lookup-status-enum.d.ts +17 -0
  180. package/dist/models/completed-lookup-status-enum.js +21 -0
  181. package/dist/models/conference-completed-callback.d.ts +0 -12
  182. package/dist/models/conference-created-callback.d.ts +0 -12
  183. package/dist/models/conference-member-exit-callback.d.ts +0 -18
  184. package/dist/models/conference-member-join-callback.d.ts +0 -18
  185. package/dist/models/conference-member.d.ts +0 -17
  186. package/dist/models/conference-recording-available-callback.d.ts +0 -33
  187. package/dist/models/conference-recording-metadata.d.ts +0 -32
  188. package/dist/models/conference-redirect-callback.d.ts +0 -12
  189. package/dist/models/conference-state-enum.d.ts +0 -2
  190. package/dist/models/conference-state-enum.js +0 -2
  191. package/dist/models/conference.d.ts +0 -24
  192. package/dist/models/contact.d.ts +0 -16
  193. package/dist/models/create-async-bulk-lookup-response-data.d.ts +22 -0
  194. package/dist/models/create-async-bulk-lookup-response.d.ts +22 -0
  195. package/dist/models/create-call-response.d.ts +0 -56
  196. package/dist/models/create-call.d.ts +0 -59
  197. package/dist/models/create-message-request-error.d.ts +0 -20
  198. package/dist/models/create-multi-channel-message-response.d.ts +0 -20
  199. package/dist/models/create-sync-lookup-response-data.d.ts +27 -0
  200. package/dist/models/create-sync-lookup-response.d.ts +19 -0
  201. package/dist/models/create-sync-lookup-response.js +15 -0
  202. package/dist/models/deactivation-event-enum.d.ts +18 -0
  203. package/dist/models/deactivation-event-enum.js +22 -0
  204. package/dist/models/disconnect-callback.d.ts +0 -39
  205. package/dist/models/diversion.d.ts +0 -19
  206. package/dist/models/dtmf-callback.d.ts +0 -39
  207. package/dist/models/error-object.d.ts +0 -14
  208. package/dist/models/error-source.d.ts +0 -10
  209. package/dist/models/failure-webhook.d.ts +0 -17
  210. package/dist/models/field-error.d.ts +0 -9
  211. package/dist/models/file-format-enum.d.ts +0 -2
  212. package/dist/models/file-format-enum.js +0 -2
  213. package/dist/models/gather-callback.d.ts +0 -41
  214. package/dist/models/get-async-bulk-lookup-response-data.d.ts +27 -0
  215. package/dist/models/get-async-bulk-lookup-response-data.js +15 -0
  216. package/dist/models/get-async-bulk-lookup-response.d.ts +19 -0
  217. package/dist/models/get-async-bulk-lookup-response.js +15 -0
  218. package/dist/models/{lookup-status-enum.d.ts → in-progress-lookup-status-enum.d.ts} +2 -7
  219. package/dist/models/{lookup-status-enum.js → in-progress-lookup-status-enum.js} +2 -7
  220. package/dist/models/inbound-callback-message.d.ts +0 -1
  221. package/dist/models/inbound-callback-type-enum.d.ts +0 -2
  222. package/dist/models/inbound-callback-type-enum.js +0 -2
  223. package/dist/models/inbound-callback.d.ts +0 -23
  224. package/dist/models/index.d.ts +17 -5
  225. package/dist/models/index.js +17 -5
  226. package/dist/models/initiate-callback.d.ts +0 -37
  227. package/dist/models/latest-message-delivery-status-enum.d.ts +20 -0
  228. package/dist/models/latest-message-delivery-status-enum.js +24 -0
  229. package/dist/models/line-type-enum.d.ts +18 -0
  230. package/dist/models/line-type-enum.js +22 -0
  231. package/dist/models/{lookup-request.d.ts → link-schema.d.ts} +11 -10
  232. package/dist/models/link-schema.js +15 -0
  233. package/dist/models/link.d.ts +0 -15
  234. package/dist/models/links-object.d.ts +0 -13
  235. package/dist/models/list-message-direction-enum.d.ts +0 -2
  236. package/dist/models/list-message-direction-enum.js +0 -2
  237. package/dist/models/list-message-item.d.ts +0 -60
  238. package/dist/models/lookup-error-response.d.ts +21 -0
  239. package/dist/models/lookup-error-response.js +15 -0
  240. package/dist/models/{tn-lookup-request-error.d.ts → lookup-error-schema-meta.d.ts} +7 -9
  241. package/dist/models/lookup-error-schema-meta.js +15 -0
  242. package/dist/models/lookup-error-schema.d.ts +27 -0
  243. package/dist/models/lookup-error-schema.js +15 -0
  244. package/dist/models/lookup-result.d.ts +22 -40
  245. package/dist/models/machine-detection-complete-callback.d.ts +0 -36
  246. package/dist/models/machine-detection-configuration.d.ts +0 -41
  247. package/dist/models/machine-detection-mode-enum.d.ts +0 -2
  248. package/dist/models/machine-detection-mode-enum.js +0 -2
  249. package/dist/models/machine-detection-result.d.ts +0 -6
  250. package/dist/models/media.d.ts +0 -20
  251. package/dist/models/message-direction-enum.d.ts +0 -2
  252. package/dist/models/message-direction-enum.js +0 -2
  253. package/dist/models/message-request.d.ts +0 -24
  254. package/dist/models/message-status-enum.d.ts +0 -2
  255. package/dist/models/message-status-enum.js +0 -2
  256. package/dist/models/message-type-enum.d.ts +0 -2
  257. package/dist/models/message-type-enum.js +0 -2
  258. package/dist/models/message.d.ts +0 -37
  259. package/dist/models/messages-list.d.ts +0 -17
  260. package/dist/models/messaging-code-response.d.ts +0 -7
  261. package/dist/models/messaging-request-error.d.ts +0 -15
  262. package/dist/models/mfa-forbidden-request-error.d.ts +0 -7
  263. package/dist/models/mfa-request-error.d.ts +0 -9
  264. package/dist/models/mfa-unauthorized-request-error.d.ts +0 -7
  265. package/dist/models/mms-message-content-file.d.ts +0 -7
  266. package/dist/models/mms-message-content.d.ts +0 -12
  267. package/dist/models/model-error.d.ts +0 -20
  268. package/dist/models/multi-channel-action-calendar-event.d.ts +0 -1
  269. package/dist/models/multi-channel-action.d.ts +0 -1
  270. package/dist/models/multi-channel-channel-list-object-content.d.ts +0 -1
  271. package/dist/models/multi-channel-channel-list-object.d.ts +0 -19
  272. package/dist/models/multi-channel-error.d.ts +0 -20
  273. package/dist/models/multi-channel-message-channel-enum.d.ts +0 -2
  274. package/dist/models/multi-channel-message-channel-enum.js +0 -2
  275. package/dist/models/multi-channel-message-content.d.ts +0 -12
  276. package/dist/models/multi-channel-message-request.d.ts +0 -15
  277. package/dist/models/multi-channel-message-response-data-channel-list-inner.d.ts +0 -1
  278. package/dist/models/multi-channel-message-response-data.d.ts +0 -24
  279. package/dist/models/opt-in-workflow.d.ts +0 -20
  280. package/dist/models/page-info.d.ts +0 -13
  281. package/dist/models/priority-enum.d.ts +0 -2
  282. package/dist/models/priority-enum.js +0 -2
  283. package/dist/models/product-type-enum.d.ts +0 -2
  284. package/dist/models/product-type-enum.js +0 -2
  285. package/dist/models/rbm-action-base.d.ts +0 -14
  286. package/dist/models/rbm-action-dial.d.ts +0 -1
  287. package/dist/models/rbm-action-open-url.d.ts +0 -1
  288. package/dist/models/rbm-action-type-enum.d.ts +0 -5
  289. package/dist/models/rbm-action-type-enum.js +0 -5
  290. package/dist/models/rbm-action-view-location.d.ts +0 -1
  291. package/dist/models/rbm-card-content-media.d.ts +0 -1
  292. package/dist/models/rbm-card-content.d.ts +0 -16
  293. package/dist/models/rbm-location-response.d.ts +0 -9
  294. package/dist/models/rbm-media-height-enum.d.ts +0 -2
  295. package/dist/models/rbm-media-height-enum.js +0 -2
  296. package/dist/models/rbm-message-carousel-card.d.ts +0 -17
  297. package/dist/models/rbm-message-content-file.d.ts +0 -9
  298. package/dist/models/rbm-message-content-rich-card.d.ts +0 -1
  299. package/dist/models/rbm-message-content-text.d.ts +0 -9
  300. package/dist/models/rbm-message-media.d.ts +0 -12
  301. package/dist/models/rbm-standalone-card.d.ts +0 -22
  302. package/dist/models/rbm-suggestion-response.d.ts +0 -9
  303. package/dist/models/recording-available-callback.d.ts +0 -52
  304. package/dist/models/recording-complete-callback.d.ts +0 -52
  305. package/dist/models/recording-state-enum.d.ts +0 -2
  306. package/dist/models/recording-state-enum.js +0 -2
  307. package/dist/models/recording-transcription-metadata.d.ts +0 -10
  308. package/dist/models/recording-transcriptions.d.ts +0 -10
  309. package/dist/models/redirect-callback.d.ts +0 -37
  310. package/dist/models/redirect-method-enum.d.ts +0 -2
  311. package/dist/models/redirect-method-enum.js +0 -2
  312. package/dist/models/sms-message-content.d.ts +0 -7
  313. package/dist/models/standalone-card-orientation-enum.d.ts +0 -5
  314. package/dist/models/standalone-card-orientation-enum.js +0 -5
  315. package/dist/models/status-callback-message.d.ts +0 -43
  316. package/dist/models/status-callback-type-enum.d.ts +0 -2
  317. package/dist/models/status-callback-type-enum.js +0 -2
  318. package/dist/models/status-callback.d.ts +0 -27
  319. package/dist/models/stir-shaken.d.ts +0 -11
  320. package/dist/models/sync-lookup-request.d.ts +17 -0
  321. package/dist/models/sync-lookup-request.js +15 -0
  322. package/dist/models/telephone-number.d.ts +0 -7
  323. package/dist/models/tfv-basic-authentication.d.ts +0 -15
  324. package/dist/models/tfv-callback-status-enum.d.ts +0 -5
  325. package/dist/models/tfv-callback-status-enum.js +0 -5
  326. package/dist/models/tfv-error.d.ts +0 -14
  327. package/dist/models/tfv-status-enum.d.ts +0 -5
  328. package/dist/models/tfv-status-enum.js +0 -5
  329. package/dist/models/tfv-status.d.ts +0 -31
  330. package/dist/models/tfv-submission-info.d.ts +0 -50
  331. package/dist/models/tfv-submission-wrapper.d.ts +0 -10
  332. package/dist/models/thumbnail-alignment-enum.d.ts +0 -2
  333. package/dist/models/thumbnail-alignment-enum.js +0 -2
  334. package/dist/models/transcribe-recording.d.ts +0 -22
  335. package/dist/models/transcription-available-callback.d.ts +0 -53
  336. package/dist/models/transcription.d.ts +0 -9
  337. package/dist/models/transfer-answer-callback.d.ts +0 -35
  338. package/dist/models/transfer-complete-callback.d.ts +0 -41
  339. package/dist/models/transfer-disconnect-callback.d.ts +0 -45
  340. package/dist/models/update-call-recording.d.ts +0 -10
  341. package/dist/models/update-call.d.ts +0 -34
  342. package/dist/models/update-conference-member.d.ts +0 -11
  343. package/dist/models/update-conference.d.ts +0 -32
  344. package/dist/models/verification-denial-webhook.d.ts +0 -28
  345. package/dist/models/verification-request.d.ts +0 -59
  346. package/dist/models/verification-update-request.d.ts +0 -54
  347. package/dist/models/verification-webhook.d.ts +0 -16
  348. package/dist/models/verify-code-request.d.ts +0 -13
  349. package/dist/models/verify-code-response.d.ts +0 -7
  350. package/dist/models/voice-api-error.d.ts +0 -20
  351. package/dist/models/voice-code-response.d.ts +0 -7
  352. package/dist/models/webhook-subscription-basic-authentication.d.ts +0 -12
  353. package/dist/models/webhook-subscription-request-schema.d.ts +0 -14
  354. package/dist/models/webhook-subscription-type-enum.d.ts +0 -5
  355. package/dist/models/webhook-subscription-type-enum.js +0 -5
  356. package/dist/models/webhook-subscription.d.ts +0 -34
  357. package/dist/models/webhook-subscriptions-list-body.d.ts +0 -17
  358. package/docs/{TnLookupRequestError.md → AsyncLookupRequest.md} +5 -5
  359. package/docs/CompletedLookupStatusEnum.md +12 -0
  360. package/docs/CreateAsyncBulkLookupResponse.md +24 -0
  361. package/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +5 -5
  362. package/docs/CreateSyncLookupResponse.md +24 -0
  363. package/docs/CreateSyncLookupResponseData.md +25 -0
  364. package/docs/DeactivationEventEnum.md +9 -0
  365. package/docs/GetAsyncBulkLookupResponse.md +24 -0
  366. package/docs/GetAsyncBulkLookupResponseData.md +25 -0
  367. package/docs/{LookupStatusEnum.md → InProgressLookupStatusEnum.md} +1 -2
  368. package/docs/LatestMessageDeliveryStatusEnum.md +13 -0
  369. package/docs/LineTypeEnum.md +14 -0
  370. package/docs/LinkSchema.md +24 -0
  371. package/docs/LookupErrorResponse.md +24 -0
  372. package/docs/LookupErrorSchema.md +26 -0
  373. package/docs/LookupErrorSchemaMeta.md +24 -0
  374. package/docs/LookupResult.md +22 -18
  375. package/docs/PhoneNumberLookupApi.md +81 -34
  376. package/docs/{LookupRequest.md → SyncLookupRequest.md} +5 -6
  377. package/models/account-statistics.ts +0 -9
  378. package/models/additional-denial-reason.ts +0 -11
  379. package/models/address.ts +0 -19
  380. package/models/answer-callback.ts +0 -36
  381. package/models/async-lookup-request.ts +23 -0
  382. package/models/blocked-webhook.ts +0 -20
  383. package/models/bridge-complete-callback.ts +0 -37
  384. package/models/bridge-target-complete-callback.ts +0 -31
  385. package/models/business-entity-type-enum.ts +0 -2
  386. package/models/business-registration-type-enum.ts +0 -2
  387. package/models/call-direction-enum.ts +0 -2
  388. package/models/call-recording-metadata.ts +0 -52
  389. package/models/call-state-enum.ts +0 -2
  390. package/models/call-state.ts +0 -44
  391. package/models/call-transcription-detected-language-enum.ts +0 -2
  392. package/models/call-transcription-metadata.ts +0 -11
  393. package/models/call-transcription-response.ts +0 -16
  394. package/models/call-transcription-track-enum.ts +0 -2
  395. package/models/call-transcription.ts +0 -19
  396. package/models/callback-method-enum.ts +0 -2
  397. package/models/callback.ts +0 -1
  398. package/models/card-width-enum.ts +0 -5
  399. package/models/code-request.ts +0 -17
  400. package/models/completed-lookup-status-enum.ts +27 -0
  401. package/models/conference-completed-callback.ts +0 -12
  402. package/models/conference-created-callback.ts +0 -12
  403. package/models/conference-member-exit-callback.ts +0 -18
  404. package/models/conference-member-join-callback.ts +0 -18
  405. package/models/conference-member.ts +0 -17
  406. package/models/conference-recording-available-callback.ts +0 -33
  407. package/models/conference-recording-metadata.ts +0 -32
  408. package/models/conference-redirect-callback.ts +0 -12
  409. package/models/conference-state-enum.ts +0 -2
  410. package/models/conference.ts +0 -24
  411. package/models/contact.ts +0 -16
  412. package/models/create-async-bulk-lookup-response-data.ts +32 -0
  413. package/models/create-async-bulk-lookup-response.ts +34 -0
  414. package/models/create-call-response.ts +0 -56
  415. package/models/create-call.ts +0 -59
  416. package/models/create-message-request-error.ts +0 -20
  417. package/models/create-multi-channel-message-response.ts +0 -20
  418. package/models/{create-lookup-response.ts → create-sync-lookup-response-data.ts} +9 -11
  419. package/models/create-sync-lookup-response.ts +31 -0
  420. package/models/deactivation-event-enum.ts +28 -0
  421. package/models/disconnect-callback.ts +0 -39
  422. package/models/diversion.ts +0 -19
  423. package/models/dtmf-callback.ts +0 -39
  424. package/models/error-object.ts +0 -14
  425. package/models/error-source.ts +0 -10
  426. package/models/failure-webhook.ts +0 -17
  427. package/models/field-error.ts +0 -9
  428. package/models/file-format-enum.ts +0 -2
  429. package/models/gather-callback.ts +0 -41
  430. package/models/get-async-bulk-lookup-response-data.ts +39 -0
  431. package/models/get-async-bulk-lookup-response.ts +31 -0
  432. package/models/{lookup-status-enum.ts → in-progress-lookup-status-enum.ts} +2 -7
  433. package/models/inbound-callback-message.ts +0 -1
  434. package/models/inbound-callback-type-enum.ts +0 -2
  435. package/models/inbound-callback.ts +0 -23
  436. package/models/index.ts +17 -5
  437. package/models/initiate-callback.ts +0 -37
  438. package/models/latest-message-delivery-status-enum.ts +30 -0
  439. package/models/line-type-enum.ts +28 -0
  440. package/models/{lookup-request.ts → link-schema.ts} +11 -10
  441. package/models/link.ts +0 -15
  442. package/models/links-object.ts +0 -13
  443. package/models/list-message-direction-enum.ts +0 -2
  444. package/models/list-message-item.ts +0 -60
  445. package/models/lookup-error-response.ts +31 -0
  446. package/models/{tn-lookup-request-error.ts → lookup-error-schema-meta.ts} +7 -9
  447. package/models/lookup-error-schema.ts +35 -0
  448. package/models/lookup-result.ts +30 -40
  449. package/models/machine-detection-complete-callback.ts +0 -36
  450. package/models/machine-detection-configuration.ts +0 -41
  451. package/models/machine-detection-mode-enum.ts +0 -2
  452. package/models/machine-detection-result.ts +0 -6
  453. package/models/media.ts +0 -20
  454. package/models/message-direction-enum.ts +0 -2
  455. package/models/message-request.ts +0 -24
  456. package/models/message-status-enum.ts +0 -2
  457. package/models/message-type-enum.ts +0 -2
  458. package/models/message.ts +0 -37
  459. package/models/messages-list.ts +0 -17
  460. package/models/messaging-code-response.ts +0 -7
  461. package/models/messaging-request-error.ts +0 -15
  462. package/models/mfa-forbidden-request-error.ts +0 -7
  463. package/models/mfa-request-error.ts +0 -9
  464. package/models/mfa-unauthorized-request-error.ts +0 -7
  465. package/models/mms-message-content-file.ts +0 -7
  466. package/models/mms-message-content.ts +0 -12
  467. package/models/model-error.ts +0 -20
  468. package/models/multi-channel-action-calendar-event.ts +0 -1
  469. package/models/multi-channel-action.ts +0 -1
  470. package/models/multi-channel-channel-list-object-content.ts +0 -1
  471. package/models/multi-channel-channel-list-object.ts +0 -19
  472. package/models/multi-channel-error.ts +0 -20
  473. package/models/multi-channel-message-channel-enum.ts +0 -2
  474. package/models/multi-channel-message-content.ts +0 -12
  475. package/models/multi-channel-message-request.ts +0 -15
  476. package/models/multi-channel-message-response-data-channel-list-inner.ts +0 -1
  477. package/models/multi-channel-message-response-data.ts +0 -24
  478. package/models/opt-in-workflow.ts +0 -20
  479. package/models/page-info.ts +0 -13
  480. package/models/priority-enum.ts +0 -2
  481. package/models/product-type-enum.ts +0 -2
  482. package/models/rbm-action-base.ts +0 -14
  483. package/models/rbm-action-dial.ts +0 -1
  484. package/models/rbm-action-open-url.ts +0 -1
  485. package/models/rbm-action-type-enum.ts +0 -5
  486. package/models/rbm-action-view-location.ts +0 -1
  487. package/models/rbm-card-content-media.ts +0 -1
  488. package/models/rbm-card-content.ts +0 -16
  489. package/models/rbm-location-response.ts +0 -9
  490. package/models/rbm-media-height-enum.ts +0 -2
  491. package/models/rbm-message-carousel-card.ts +0 -17
  492. package/models/rbm-message-content-file.ts +0 -9
  493. package/models/rbm-message-content-rich-card.ts +0 -1
  494. package/models/rbm-message-content-text.ts +0 -9
  495. package/models/rbm-message-media.ts +0 -12
  496. package/models/rbm-standalone-card.ts +0 -22
  497. package/models/rbm-suggestion-response.ts +0 -9
  498. package/models/recording-available-callback.ts +0 -52
  499. package/models/recording-complete-callback.ts +0 -52
  500. package/models/recording-state-enum.ts +0 -2
  501. package/models/recording-transcription-metadata.ts +0 -10
  502. package/models/recording-transcriptions.ts +0 -10
  503. package/models/redirect-callback.ts +0 -37
  504. package/models/redirect-method-enum.ts +0 -2
  505. package/models/sms-message-content.ts +0 -7
  506. package/models/standalone-card-orientation-enum.ts +0 -5
  507. package/models/status-callback-message.ts +0 -43
  508. package/models/status-callback-type-enum.ts +0 -2
  509. package/models/status-callback.ts +0 -27
  510. package/models/stir-shaken.ts +0 -11
  511. package/models/sync-lookup-request.ts +23 -0
  512. package/models/telephone-number.ts +0 -7
  513. package/models/tfv-basic-authentication.ts +0 -15
  514. package/models/tfv-callback-status-enum.ts +0 -5
  515. package/models/tfv-error.ts +0 -14
  516. package/models/tfv-status-enum.ts +0 -5
  517. package/models/tfv-status.ts +0 -31
  518. package/models/tfv-submission-info.ts +0 -50
  519. package/models/tfv-submission-wrapper.ts +0 -10
  520. package/models/thumbnail-alignment-enum.ts +0 -2
  521. package/models/transcribe-recording.ts +0 -22
  522. package/models/transcription-available-callback.ts +0 -53
  523. package/models/transcription.ts +0 -9
  524. package/models/transfer-answer-callback.ts +0 -35
  525. package/models/transfer-complete-callback.ts +0 -41
  526. package/models/transfer-disconnect-callback.ts +0 -45
  527. package/models/update-call-recording.ts +0 -10
  528. package/models/update-call.ts +0 -34
  529. package/models/update-conference-member.ts +0 -11
  530. package/models/update-conference.ts +0 -32
  531. package/models/verification-denial-webhook.ts +0 -28
  532. package/models/verification-request.ts +0 -59
  533. package/models/verification-update-request.ts +0 -54
  534. package/models/verification-webhook.ts +0 -16
  535. package/models/verify-code-request.ts +0 -13
  536. package/models/verify-code-response.ts +0 -7
  537. package/models/voice-api-error.ts +0 -20
  538. package/models/voice-code-response.ts +0 -7
  539. package/models/webhook-subscription-basic-authentication.ts +0 -12
  540. package/models/webhook-subscription-request-schema.ts +0 -14
  541. package/models/webhook-subscription-type-enum.ts +0 -5
  542. package/models/webhook-subscription.ts +0 -34
  543. package/models/webhook-subscriptions-list-body.ts +0 -17
  544. package/openapitools.json +1 -1
  545. package/package.json +2 -2
  546. package/tests/smoke/phone-number-lookup-api.test.ts +64 -61
  547. package/tests/unit/api/phone-number-lookup-api.test.ts +64 -58
  548. package/tests/unit/models/completed-lookup-status-enum.test.ts +9 -0
  549. package/tests/unit/models/deactivation-event-enum.test.ts +7 -0
  550. package/tests/unit/models/in-progress-lookup-status-enum.test.ts +11 -0
  551. package/tests/unit/models/latest-message-delivery-status-enum.test.ts +10 -0
  552. package/tests/unit/models/line-type-enum.test.ts +11 -0
  553. package/dist/models/create-lookup-response.d.ts +0 -31
  554. package/dist/models/lookup-status.d.ts +0 -44
  555. package/docs/LookupStatus.md +0 -27
  556. package/models/lookup-status.ts +0 -56
  557. package/tests/unit/models/lookup-status-enum.test.ts +0 -10
  558. /package/dist/models/{create-lookup-response.js → async-lookup-request.js} +0 -0
  559. /package/dist/models/{lookup-request.js → create-async-bulk-lookup-response-data.js} +0 -0
  560. /package/dist/models/{lookup-status.js → create-async-bulk-lookup-response.js} +0 -0
  561. /package/dist/models/{tn-lookup-request-error.js → create-sync-lookup-response-data.js} +0 -0
@@ -14,28 +14,17 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface StirShaken
21
- */
22
17
  export interface StirShaken {
23
18
  /**
24
19
  * (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
25
- * @type {string}
26
- * @memberof StirShaken
27
20
  */
28
21
  'verstat'?: string;
29
22
  /**
30
23
  * (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).
31
- * @type {string}
32
- * @memberof StirShaken
33
24
  */
34
25
  'attestationIndicator'?: string;
35
26
  /**
36
27
  * (optional) A unique origination identifier.
37
- * @type {string}
38
- * @memberof StirShaken
39
28
  */
40
29
  'originatingId'?: string;
41
30
  }
@@ -0,0 +1,23 @@
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
+ export interface SyncLookupRequest {
18
+ /**
19
+ * Telephone numbers in E.164 format.
20
+ */
21
+ 'phoneNumbers': Array<string>;
22
+ }
23
+
@@ -14,16 +14,9 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface TelephoneNumber
21
- */
22
17
  export interface TelephoneNumber {
23
18
  /**
24
19
  * Simple Telephone Number.
25
- * @type {string}
26
- * @memberof TelephoneNumber
27
20
  */
28
21
  'telephoneNumber'?: string;
29
22
  }
@@ -14,23 +14,8 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface TfvBasicAuthentication
21
- */
22
17
  export interface TfvBasicAuthentication {
23
- /**
24
- *
25
- * @type {string}
26
- * @memberof TfvBasicAuthentication
27
- */
28
18
  'username': string;
29
- /**
30
- *
31
- * @type {string}
32
- * @memberof TfvBasicAuthentication
33
- */
34
19
  'password': string;
35
20
  }
36
21
 
@@ -14,11 +14,6 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @enum {string}
21
- */
22
17
 
23
18
  export const TfvCallbackStatusEnum = {
24
19
  Verified: 'VERIFIED',
@@ -16,26 +16,12 @@
16
16
 
17
17
  /**
18
18
  * A generic error object.
19
- * @export
20
- * @interface TfvError
21
19
  */
22
20
  export interface TfvError {
23
- /**
24
- *
25
- * @type {string}
26
- * @memberof TfvError
27
- */
28
21
  'type'?: string;
29
- /**
30
- *
31
- * @type {string}
32
- * @memberof TfvError
33
- */
34
22
  'description'?: string;
35
23
  /**
36
24
  * Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field.
37
- * @type {object}
38
- * @memberof TfvError
39
25
  */
40
26
  'errors'?: object;
41
27
  }
@@ -14,11 +14,6 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @enum {string}
21
- */
22
17
 
23
18
  export const TfvStatusEnum = {
24
19
  Verified: 'VERIFIED',
@@ -20,70 +20,39 @@ import type { TfvStatusEnum } from './tfv-status-enum';
20
20
  // @ts-ignore
21
21
  import type { TfvSubmissionInfo } from './tfv-submission-info';
22
22
 
23
- /**
24
- *
25
- * @export
26
- * @interface TfvStatus
27
- */
28
23
  export interface TfvStatus {
29
24
  /**
30
25
  * Toll-free telephone number in E.164 format.
31
- * @type {string}
32
- * @memberof TfvStatus
33
26
  */
34
27
  'phoneNumber'?: string;
35
- /**
36
- *
37
- * @type {TfvStatusEnum}
38
- * @memberof TfvStatus
39
- */
40
28
  'status'?: TfvStatusEnum;
41
29
  /**
42
30
  * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.
43
- * @type {string}
44
- * @memberof TfvStatus
45
31
  */
46
32
  'internalTicketNumber'?: string;
47
33
  /**
48
34
  * Explanation for why a verification request was declined.
49
- * @type {string}
50
- * @memberof TfvStatus
51
35
  */
52
36
  'declineReasonDescription'?: string;
53
37
  /**
54
38
  * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
55
- * @type {boolean}
56
- * @memberof TfvStatus
57
39
  */
58
40
  'resubmitAllowed'?: boolean;
59
41
  /**
60
42
  * Date and time the verification request was created.
61
- * @type {string}
62
- * @memberof TfvStatus
63
43
  */
64
44
  'createdDateTime'?: string;
65
45
  /**
66
46
  * Date and time the verification request was last modified.
67
- * @type {string}
68
- * @memberof TfvStatus
69
47
  */
70
48
  'modifiedDateTime'?: string;
71
- /**
72
- *
73
- * @type {TfvSubmissionInfo}
74
- * @memberof TfvStatus
75
- */
76
49
  'submission'?: TfvSubmissionInfo;
77
50
  /**
78
51
  * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
79
- * @type {boolean}
80
- * @memberof TfvStatus
81
52
  */
82
53
  'blocked'?: boolean;
83
54
  /**
84
55
  * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
85
- * @type {string}
86
- * @memberof TfvStatus
87
56
  */
88
57
  'blockedReason'?: string;
89
58
  }
@@ -29,101 +29,51 @@ import type { Contact } from './contact';
29
29
  // @ts-ignore
30
30
  import type { OptInWorkflow } from './opt-in-workflow';
31
31
 
32
- /**
33
- *
34
- * @export
35
- * @interface TfvSubmissionInfo
36
- */
37
32
  export interface TfvSubmissionInfo {
38
- /**
39
- *
40
- * @type {Address}
41
- * @memberof TfvSubmissionInfo
42
- */
43
33
  'businessAddress'?: Address;
44
- /**
45
- *
46
- * @type {Contact}
47
- * @memberof TfvSubmissionInfo
48
- */
49
34
  'businessContact'?: Contact;
50
35
  /**
51
36
  * Estimated monthly volume of messages from the toll-free number.
52
- * @type {number}
53
- * @memberof TfvSubmissionInfo
54
37
  */
55
38
  'messageVolume'?: number;
56
39
  /**
57
40
  * The category of the use case.
58
- * @type {string}
59
- * @memberof TfvSubmissionInfo
60
41
  */
61
42
  'useCase'?: string;
62
43
  /**
63
44
  * A general idea of the use case and customer.
64
- * @type {string}
65
- * @memberof TfvSubmissionInfo
66
45
  */
67
46
  'useCaseSummary'?: string;
68
47
  /**
69
48
  * Example of message content.
70
- * @type {string}
71
- * @memberof TfvSubmissionInfo
72
49
  */
73
50
  'productionMessageContent'?: string;
74
- /**
75
- *
76
- * @type {OptInWorkflow}
77
- * @memberof TfvSubmissionInfo
78
- */
79
51
  'optInWorkflow'?: OptInWorkflow;
80
52
  /**
81
53
  * Any additional information.
82
- * @type {string}
83
- * @memberof TfvSubmissionInfo
84
54
  */
85
55
  'additionalInformation'?: string | null;
86
56
  /**
87
57
  * ISV name.
88
- * @type {string}
89
- * @memberof TfvSubmissionInfo
90
58
  */
91
59
  'isvReseller'?: string | null;
92
60
  /**
93
61
  * The Toll-Free Verification request privacy policy URL.
94
- * @type {string}
95
- * @memberof TfvSubmissionInfo
96
62
  */
97
63
  'privacyPolicyUrl'?: string;
98
64
  /**
99
65
  * The Toll-Free Verification request terms and conditions policy URL.
100
- * @type {string}
101
- * @memberof TfvSubmissionInfo
102
66
  */
103
67
  'termsAndConditionsUrl'?: string;
104
68
  /**
105
69
  * The company \'Doing Business As\'.
106
- * @type {string}
107
- * @memberof TfvSubmissionInfo
108
70
  */
109
71
  'businessDba'?: string;
110
72
  /**
111
73
  * US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
112
- * @type {string}
113
- * @memberof TfvSubmissionInfo
114
74
  */
115
75
  'businessRegistrationNumber'?: string | null;
116
- /**
117
- *
118
- * @type {BusinessRegistrationTypeEnum}
119
- * @memberof TfvSubmissionInfo
120
- */
121
76
  'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
122
- /**
123
- *
124
- * @type {BusinessEntityTypeEnum}
125
- * @memberof TfvSubmissionInfo
126
- */
127
77
  'businessEntityType'?: BusinessEntityTypeEnum | null;
128
78
  }
129
79
 
@@ -17,17 +17,7 @@
17
17
  // @ts-ignore
18
18
  import type { VerificationUpdateRequest } from './verification-update-request';
19
19
 
20
- /**
21
- *
22
- * @export
23
- * @interface TfvSubmissionWrapper
24
- */
25
20
  export interface TfvSubmissionWrapper {
26
- /**
27
- *
28
- * @type {VerificationUpdateRequest}
29
- * @memberof TfvSubmissionWrapper
30
- */
31
21
  'submission'?: VerificationUpdateRequest;
32
22
  }
33
23
 
@@ -16,8 +16,6 @@
16
16
 
17
17
  /**
18
18
  * The alignment of the thumbnail image in the card. Only applicable if the card using horizontal orientation.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
 
23
21
  export const ThumbnailAlignmentEnum = {
@@ -17,52 +17,30 @@
17
17
  // @ts-ignore
18
18
  import type { CallbackMethodEnum } from './callback-method-enum';
19
19
 
20
- /**
21
- *
22
- * @export
23
- * @interface TranscribeRecording
24
- */
25
20
  export interface TranscribeRecording {
26
21
  /**
27
22
  * The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization.
28
- * @type {string}
29
- * @memberof TranscribeRecording
30
23
  */
31
24
  'callbackUrl'?: string;
32
- /**
33
- *
34
- * @type {CallbackMethodEnum}
35
- * @memberof TranscribeRecording
36
- */
37
25
  'callbackMethod'?: CallbackMethodEnum | null;
38
26
  /**
39
27
  * Basic auth username.
40
- * @type {string}
41
- * @memberof TranscribeRecording
42
28
  */
43
29
  'username'?: string | null;
44
30
  /**
45
31
  * Basic auth password.
46
- * @type {string}
47
- * @memberof TranscribeRecording
48
32
  */
49
33
  'password'?: string | null;
50
34
  /**
51
35
  * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
52
- * @type {string}
53
- * @memberof TranscribeRecording
54
36
  */
55
37
  'tag'?: string | null;
56
38
  /**
57
39
  * This is the timeout (in seconds) to use when delivering the webhook to `callbackUrl`. Can be any numeric value (including decimals) between 1 and 25.
58
- * @type {number}
59
- * @memberof TranscribeRecording
60
40
  */
61
41
  'callbackTimeout'?: number | null;
62
42
  /**
63
43
  * A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish.
64
- * @type {boolean}
65
- * @memberof TranscribeRecording
66
44
  */
67
45
  'detectLanguage'?: boolean | null;
68
46
  }
@@ -25,134 +25,81 @@ import type { Transcription } from './transcription';
25
25
 
26
26
  /**
27
27
  * The Transcription Available event is sent when the recording transcription is available to be downloaded.
28
- * @export
29
- * @interface TranscriptionAvailableCallback
30
28
  */
31
29
  export interface TranscriptionAvailableCallback {
32
30
  /**
33
31
  * 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.
34
- * @type {string}
35
- * @memberof TranscriptionAvailableCallback
36
32
  */
37
33
  'eventType'?: string;
38
34
  /**
39
35
  * 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.
40
- * @type {string}
41
- * @memberof TranscriptionAvailableCallback
42
36
  */
43
37
  'eventTime'?: string;
44
38
  /**
45
39
  * The user account associated with the call.
46
- * @type {string}
47
- * @memberof TranscriptionAvailableCallback
48
40
  */
49
41
  'accountId'?: string;
50
42
  /**
51
43
  * The id of the application associated with the call.
52
- * @type {string}
53
- * @memberof TranscriptionAvailableCallback
54
44
  */
55
45
  'applicationId'?: string;
56
46
  /**
57
47
  * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
58
- * @type {string}
59
- * @memberof TranscriptionAvailableCallback
60
48
  */
61
49
  'from'?: string;
62
50
  /**
63
51
  * The phone number that received the call, in E.164 format (e.g. +15555555555).
64
- * @type {string}
65
- * @memberof TranscriptionAvailableCallback
66
52
  */
67
53
  'to'?: string;
68
- /**
69
- *
70
- * @type {CallDirectionEnum}
71
- * @memberof TranscriptionAvailableCallback
72
- */
73
54
  'direction'?: CallDirectionEnum;
74
55
  /**
75
56
  * The call id associated with the event.
76
- * @type {string}
77
- * @memberof TranscriptionAvailableCallback
78
57
  */
79
58
  'callId'?: string;
80
59
  /**
81
60
  * The URL of the call associated with the event.
82
- * @type {string}
83
- * @memberof TranscriptionAvailableCallback
84
61
  */
85
62
  'callUrl'?: string;
86
63
  /**
87
64
  * The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
88
- * @type {string}
89
- * @memberof TranscriptionAvailableCallback
90
65
  */
91
66
  'mediaUrl'?: string | null;
92
67
  /**
93
68
  * (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
94
- * @type {string}
95
- * @memberof TranscriptionAvailableCallback
96
69
  */
97
70
  'parentCallId'?: string;
98
71
  /**
99
72
  * The unique ID of this recording
100
- * @type {string}
101
- * @memberof TranscriptionAvailableCallback
102
73
  */
103
74
  'recordingId'?: string;
104
75
  /**
105
76
  * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
106
- * @type {string}
107
- * @memberof TranscriptionAvailableCallback
108
77
  */
109
78
  'enqueuedTime'?: string | null;
110
79
  /**
111
80
  * Time the call was started, in ISO 8601 format.
112
- * @type {string}
113
- * @memberof TranscriptionAvailableCallback
114
81
  */
115
82
  'startTime'?: string;
116
83
  /**
117
84
  * The time that the recording ended in ISO-8601 format
118
- * @type {string}
119
- * @memberof TranscriptionAvailableCallback
120
85
  */
121
86
  'endTime'?: string;
122
87
  /**
123
88
  * The duration of the recording in ISO-8601 format
124
- * @type {string}
125
- * @memberof TranscriptionAvailableCallback
126
89
  */
127
90
  'duration'?: string;
128
- /**
129
- *
130
- * @type {FileFormatEnum}
131
- * @memberof TranscriptionAvailableCallback
132
- */
133
91
  'fileFormat'?: FileFormatEnum;
134
92
  /**
135
93
  * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
136
- * @type {string}
137
- * @memberof TranscriptionAvailableCallback
138
94
  */
139
95
  'tag'?: string | null;
140
- /**
141
- *
142
- * @type {Transcription}
143
- * @memberof TranscriptionAvailableCallback
144
- */
145
96
  'transcription'?: Transcription;
146
97
  /**
147
98
  * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
148
- * @type {string}
149
- * @memberof TranscriptionAvailableCallback
150
99
  */
151
100
  'transferCallerId'?: string;
152
101
  /**
153
102
  * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
154
- * @type {string}
155
- * @memberof TranscriptionAvailableCallback
156
103
  */
157
104
  'transferTo'?: string;
158
105
  }
@@ -14,22 +14,13 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface Transcription
21
- */
22
17
  export interface Transcription {
23
18
  /**
24
19
  * The transcribed text
25
- * @type {string}
26
- * @memberof Transcription
27
20
  */
28
21
  'text'?: string;
29
22
  /**
30
23
  * The confidence on the recognized content, ranging from `0.0` to `1.0` with `1.0` being the highest confidence.
31
- * @type {number}
32
- * @memberof Transcription
33
24
  */
34
25
  'confidence'?: number;
35
26
  }
@@ -19,98 +19,63 @@ import type { CallDirectionEnum } from './call-direction-enum';
19
19
 
20
20
  /**
21
21
  * When processing a <Transfer> verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the <PhoneNumber> tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed.
22
- * @export
23
- * @interface TransferAnswerCallback
24
22
  */
25
23
  export interface TransferAnswerCallback {
26
24
  /**
27
25
  * 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.
28
- * @type {string}
29
- * @memberof TransferAnswerCallback
30
26
  */
31
27
  'eventType'?: string;
32
28
  /**
33
29
  * 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.
34
- * @type {string}
35
- * @memberof TransferAnswerCallback
36
30
  */
37
31
  'eventTime'?: string;
38
32
  /**
39
33
  * The user account associated with the call.
40
- * @type {string}
41
- * @memberof TransferAnswerCallback
42
34
  */
43
35
  'accountId'?: string;
44
36
  /**
45
37
  * The id of the application associated with the call.
46
- * @type {string}
47
- * @memberof TransferAnswerCallback
48
38
  */
49
39
  'applicationId'?: string;
50
40
  /**
51
41
  * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
52
- * @type {string}
53
- * @memberof TransferAnswerCallback
54
42
  */
55
43
  'from'?: string;
56
44
  /**
57
45
  * The phone number that received the call, in E.164 format (e.g. +15555555555).
58
- * @type {string}
59
- * @memberof TransferAnswerCallback
60
46
  */
61
47
  'to'?: string;
62
- /**
63
- *
64
- * @type {CallDirectionEnum}
65
- * @memberof TransferAnswerCallback
66
- */
67
48
  'direction'?: CallDirectionEnum;
68
49
  /**
69
50
  * The call id associated with the event.
70
- * @type {string}
71
- * @memberof TransferAnswerCallback
72
51
  */
73
52
  'callId'?: string;
74
53
  /**
75
54
  * The URL of the call associated with the event.
76
- * @type {string}
77
- * @memberof TransferAnswerCallback
78
55
  */
79
56
  'callUrl'?: string;
80
57
  /**
81
58
  * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
82
- * @type {string}
83
- * @memberof TransferAnswerCallback
84
59
  */
85
60
  'enqueuedTime'?: string | null;
86
61
  /**
87
62
  * Time the call was started, in ISO 8601 format.
88
- * @type {string}
89
- * @memberof TransferAnswerCallback
90
63
  */
91
64
  'startTime'?: string;
92
65
  /**
93
66
  * Time the call was answered, in ISO 8601 format.
94
- * @type {string}
95
- * @memberof TransferAnswerCallback
96
67
  */
97
68
  'answerTime'?: string | null;
98
69
  /**
99
70
  * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
100
- * @type {string}
101
- * @memberof TransferAnswerCallback
102
71
  */
103
72
  'tag'?: string | null;
104
73
  /**
105
74
  * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
106
- * @type {string}
107
- * @memberof TransferAnswerCallback
108
75
  */
109
76
  'transferCallerId'?: string;
110
77
  /**
111
78
  * The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
112
- * @type {string}
113
- * @memberof TransferAnswerCallback
114
79
  */
115
80
  'transferTo'?: string;
116
81
  }