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
@@ -10,70 +10,42 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { AdditionalDenialReason } from './additional-denial-reason';
13
- /**
14
- *
15
- * @export
16
- * @interface VerificationDenialWebhook
17
- */
18
13
  export interface VerificationDenialWebhook {
19
14
  /**
20
15
  * User\'s account ID.
21
- * @type {string}
22
- * @memberof VerificationDenialWebhook
23
16
  */
24
17
  'accountId'?: string;
25
18
  /**
26
19
  * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
27
- * @type {Array<AdditionalDenialReason>}
28
- * @memberof VerificationDenialWebhook
29
20
  */
30
21
  'additionalDenialReasons'?: Array<AdditionalDenialReason>;
31
22
  /**
32
23
  * Explanation for why a verification request was declined.
33
- * @type {string}
34
- * @memberof VerificationDenialWebhook
35
24
  */
36
25
  'declineReasonDescription'?: string;
37
26
  /**
38
27
  * Reason code for denial.
39
- * @type {number}
40
- * @memberof VerificationDenialWebhook
41
28
  */
42
29
  'denialStatusCode'?: number;
43
30
  /**
44
31
  * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
45
- * @type {string}
46
- * @memberof VerificationDenialWebhook
47
32
  */
48
33
  'internalTicketNumber'?: string;
49
34
  /**
50
35
  * Toll-free telephone number in E.164 format.
51
- * @type {string}
52
- * @memberof VerificationDenialWebhook
53
36
  */
54
37
  'phoneNumber'?: string;
55
38
  /**
56
39
  * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
57
- * @type {boolean}
58
- * @memberof VerificationDenialWebhook
59
40
  */
60
41
  'resubmitAllowed'?: boolean;
61
- /**
62
- *
63
- * @type {string}
64
- * @memberof VerificationDenialWebhook
65
- */
66
42
  'status'?: string;
67
43
  /**
68
44
  * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
69
- * @type {boolean}
70
- * @memberof VerificationDenialWebhook
71
45
  */
72
46
  'blocked'?: boolean;
73
47
  /**
74
48
  * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
75
- * @type {string}
76
- * @memberof VerificationDenialWebhook
77
49
  */
78
50
  'blockedReason'?: string;
79
51
  }
@@ -14,118 +14,59 @@ import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
14
14
  import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
15
15
  import type { Contact } from './contact';
16
16
  import type { OptInWorkflow } from './opt-in-workflow';
17
- /**
18
- *
19
- * @export
20
- * @interface VerificationRequest
21
- */
22
17
  export interface VerificationRequest {
23
- /**
24
- *
25
- * @type {Address}
26
- * @memberof VerificationRequest
27
- */
28
18
  'businessAddress': Address;
29
- /**
30
- *
31
- * @type {Contact}
32
- * @memberof VerificationRequest
33
- */
34
19
  'businessContact': Contact;
35
20
  /**
36
21
  * Estimated monthly volume of messages from the toll-free number.
37
- * @type {number}
38
- * @memberof VerificationRequest
39
22
  */
40
23
  'messageVolume': number;
41
- /**
42
- *
43
- * @type {Array<string>}
44
- * @memberof VerificationRequest
45
- */
46
24
  'phoneNumbers': Array<string>;
47
25
  /**
48
26
  * The category of the use case.
49
- * @type {string}
50
- * @memberof VerificationRequest
51
27
  */
52
28
  'useCase': string;
53
29
  /**
54
30
  * A general idea of the use case and customer.
55
- * @type {string}
56
- * @memberof VerificationRequest
57
31
  */
58
32
  'useCaseSummary': string;
59
33
  /**
60
34
  * Example of message content.
61
- * @type {string}
62
- * @memberof VerificationRequest
63
35
  */
64
36
  'productionMessageContent': string;
65
- /**
66
- *
67
- * @type {OptInWorkflow}
68
- * @memberof VerificationRequest
69
- */
70
37
  'optInWorkflow': OptInWorkflow;
71
38
  /**
72
39
  * Any additional information.
73
- * @type {string}
74
- * @memberof VerificationRequest
75
40
  */
76
41
  'additionalInformation'?: string | null;
77
42
  /**
78
43
  * ISV name.
79
- * @type {string}
80
- * @memberof VerificationRequest
81
44
  */
82
45
  'isvReseller'?: string | null;
83
46
  /**
84
47
  * The Toll-Free Verification request privacy policy URL.
85
- * @type {string}
86
- * @memberof VerificationRequest
87
48
  */
88
49
  'privacyPolicyUrl'?: string;
89
50
  /**
90
51
  * The Toll-Free Verification request terms and conditions policy URL.
91
- * @type {string}
92
- * @memberof VerificationRequest
93
52
  */
94
53
  'termsAndConditionsUrl'?: string;
95
54
  /**
96
55
  * The company \'Doing Business As\'.
97
- * @type {string}
98
- * @memberof VerificationRequest
99
56
  */
100
57
  'businessDba'?: string;
101
58
  /**
102
59
  * 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.
103
- * @type {string}
104
- * @memberof VerificationRequest
105
60
  */
106
61
  'businessRegistrationNumber'?: string | null;
107
- /**
108
- *
109
- * @type {BusinessRegistrationTypeEnum}
110
- * @memberof VerificationRequest
111
- */
112
62
  'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
113
- /**
114
- *
115
- * @type {BusinessEntityTypeEnum}
116
- * @memberof VerificationRequest
117
- */
118
63
  'businessEntityType'?: BusinessEntityTypeEnum | null;
119
64
  /**
120
65
  * A message that gets sent to users requesting help.
121
- * @type {string}
122
- * @memberof VerificationRequest
123
66
  */
124
67
  'helpMessageResponse'?: string | null;
125
68
  /**
126
69
  * Indicates whether the content is age-gated.
127
- * @type {boolean}
128
- * @memberof VerificationRequest
129
70
  */
130
71
  'ageGatedContent'?: boolean;
131
72
  }
@@ -14,112 +14,58 @@ import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
14
14
  import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
15
15
  import type { Contact } from './contact';
16
16
  import type { OptInWorkflow } from './opt-in-workflow';
17
- /**
18
- *
19
- * @export
20
- * @interface VerificationUpdateRequest
21
- */
22
17
  export interface VerificationUpdateRequest {
23
- /**
24
- *
25
- * @type {Address}
26
- * @memberof VerificationUpdateRequest
27
- */
28
18
  'businessAddress': Address;
29
- /**
30
- *
31
- * @type {Contact}
32
- * @memberof VerificationUpdateRequest
33
- */
34
19
  'businessContact': Contact;
35
20
  /**
36
21
  * Estimated monthly volume of messages from the toll-free number.
37
- * @type {number}
38
- * @memberof VerificationUpdateRequest
39
22
  */
40
23
  'messageVolume': number;
41
24
  /**
42
25
  * The category of the use case.
43
- * @type {string}
44
- * @memberof VerificationUpdateRequest
45
26
  */
46
27
  'useCase': string;
47
28
  /**
48
29
  * A general idea of the use case and customer.
49
- * @type {string}
50
- * @memberof VerificationUpdateRequest
51
30
  */
52
31
  'useCaseSummary': string;
53
32
  /**
54
33
  * Example of message content.
55
- * @type {string}
56
- * @memberof VerificationUpdateRequest
57
34
  */
58
35
  'productionMessageContent': string;
59
- /**
60
- *
61
- * @type {OptInWorkflow}
62
- * @memberof VerificationUpdateRequest
63
- */
64
36
  'optInWorkflow': OptInWorkflow;
65
37
  /**
66
38
  * Any additional information.
67
- * @type {string}
68
- * @memberof VerificationUpdateRequest
69
39
  */
70
40
  'additionalInformation'?: string | null;
71
41
  /**
72
42
  * ISV name.
73
- * @type {string}
74
- * @memberof VerificationUpdateRequest
75
43
  */
76
44
  'isvReseller'?: string | null;
77
45
  /**
78
46
  * The Toll-Free Verification request privacy policy URL.
79
- * @type {string}
80
- * @memberof VerificationUpdateRequest
81
47
  */
82
48
  'privacyPolicyUrl'?: string;
83
49
  /**
84
50
  * The Toll-Free Verification request terms and conditions policy URL.
85
- * @type {string}
86
- * @memberof VerificationUpdateRequest
87
51
  */
88
52
  'termsAndConditionsUrl'?: string;
89
53
  /**
90
54
  * The company \'Doing Business As\'.
91
- * @type {string}
92
- * @memberof VerificationUpdateRequest
93
55
  */
94
56
  'businessDba'?: string;
95
57
  /**
96
58
  * 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.
97
- * @type {string}
98
- * @memberof VerificationUpdateRequest
99
59
  */
100
60
  'businessRegistrationNumber'?: string | null;
101
- /**
102
- *
103
- * @type {BusinessRegistrationTypeEnum}
104
- * @memberof VerificationUpdateRequest
105
- */
106
61
  'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
107
- /**
108
- *
109
- * @type {BusinessEntityTypeEnum}
110
- * @memberof VerificationUpdateRequest
111
- */
112
62
  'businessEntityType'?: BusinessEntityTypeEnum | null;
113
63
  /**
114
64
  * A message that gets sent to users requesting help.
115
- * @type {string}
116
- * @memberof VerificationUpdateRequest
117
65
  */
118
66
  'helpMessageResponse'?: string | null;
119
67
  /**
120
68
  * Indicates whether the content is age-gated.
121
- * @type {boolean}
122
- * @memberof VerificationUpdateRequest
123
69
  */
124
70
  'ageGatedContent'?: boolean;
125
71
  }
@@ -10,34 +10,18 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum';
13
- /**
14
- *
15
- * @export
16
- * @interface VerificationWebhook
17
- */
18
13
  export interface VerificationWebhook {
19
14
  /**
20
15
  * User\'s account ID.
21
- * @type {string}
22
- * @memberof VerificationWebhook
23
16
  */
24
17
  'accountId'?: string;
25
18
  /**
26
19
  * Toll-free telephone number in E.164 format.
27
- * @type {string}
28
- * @memberof VerificationWebhook
29
20
  */
30
21
  'phoneNumber'?: string;
31
- /**
32
- *
33
- * @type {TfvCallbackStatusEnum}
34
- * @memberof VerificationWebhook
35
- */
36
22
  'status'?: TfvCallbackStatusEnum;
37
23
  /**
38
24
  * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
39
- * @type {string}
40
- * @memberof VerificationWebhook
41
25
  */
42
26
  'internalTicketNumber'?: string;
43
27
  }
@@ -9,34 +9,21 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /**
13
- *
14
- * @export
15
- * @interface VerifyCodeRequest
16
- */
17
12
  export interface VerifyCodeRequest {
18
13
  /**
19
14
  * The phone number to send the mfa code to.
20
- * @type {string}
21
- * @memberof VerifyCodeRequest
22
15
  */
23
16
  'to': string;
24
17
  /**
25
18
  * An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
26
- * @type {string}
27
- * @memberof VerifyCodeRequest
28
19
  */
29
20
  'scope'?: string;
30
21
  /**
31
22
  * The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively.
32
- * @type {number}
33
- * @memberof VerifyCodeRequest
34
23
  */
35
24
  'expirationTimeInMinutes': number;
36
25
  /**
37
26
  * The generated mfa code to check if valid.
38
- * @type {string}
39
- * @memberof VerifyCodeRequest
40
27
  */
41
28
  'code': string;
42
29
  }
@@ -9,16 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /**
13
- *
14
- * @export
15
- * @interface VerifyCodeResponse
16
- */
17
12
  export interface VerifyCodeResponse {
18
13
  /**
19
14
  * Whether or not the supplied code is valid.
20
- * @type {boolean}
21
- * @memberof VerifyCodeResponse
22
15
  */
23
16
  'valid'?: boolean;
24
17
  }
@@ -9,28 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /**
13
- *
14
- * @export
15
- * @interface VoiceApiError
16
- */
17
12
  export interface VoiceApiError {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof VoiceApiError
22
- */
23
13
  'type'?: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof VoiceApiError
28
- */
29
14
  'description'?: string;
30
- /**
31
- *
32
- * @type {string}
33
- * @memberof VoiceApiError
34
- */
35
15
  'id'?: string | null;
36
16
  }
@@ -9,16 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /**
13
- *
14
- * @export
15
- * @interface VoiceCodeResponse
16
- */
17
12
  export interface VoiceCodeResponse {
18
13
  /**
19
14
  * Programmable Voice API Call ID.
20
- * @type {string}
21
- * @memberof VoiceCodeResponse
22
15
  */
23
16
  'callId'?: string;
24
17
  }
@@ -11,20 +11,8 @@
11
11
  */
12
12
  /**
13
13
  * Basic authentication credentials are not required, but if present, both username and password must be provided.
14
- * @export
15
- * @interface WebhookSubscriptionBasicAuthentication
16
14
  */
17
15
  export interface WebhookSubscriptionBasicAuthentication {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof WebhookSubscriptionBasicAuthentication
22
- */
23
16
  'username': string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof WebhookSubscriptionBasicAuthentication
28
- */
29
17
  'password': string;
30
18
  }
@@ -10,28 +10,14 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { TfvBasicAuthentication } from './tfv-basic-authentication';
13
- /**
14
- *
15
- * @export
16
- * @interface WebhookSubscriptionRequestSchema
17
- */
18
13
  export interface WebhookSubscriptionRequestSchema {
19
- /**
20
- *
21
- * @type {TfvBasicAuthentication}
22
- * @memberof WebhookSubscriptionRequestSchema
23
- */
24
14
  'basicAuthentication'?: TfvBasicAuthentication;
25
15
  /**
26
16
  * Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
27
- * @type {string}
28
- * @memberof WebhookSubscriptionRequestSchema
29
17
  */
30
18
  'callbackUrl': string | null;
31
19
  /**
32
20
  * An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks.
33
- * @type {string}
34
- * @memberof WebhookSubscriptionRequestSchema
35
21
  */
36
22
  'sharedSecretKey'?: string | null;
37
23
  }
@@ -9,11 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /**
13
- *
14
- * @export
15
- * @enum {string}
16
- */
17
12
  export declare const WebhookSubscriptionTypeEnum: {
18
13
  readonly TollfreeVerificationStatus: "TOLLFREE_VERIFICATION_STATUS";
19
14
  readonly MessagingPortoutApprovalStatus: "MESSAGING_PORTOUT_APPROVAL_STATUS";
@@ -14,11 +14,6 @@
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.WebhookSubscriptionTypeEnum = void 0;
17
- /**
18
- *
19
- * @export
20
- * @enum {string}
21
- */
22
17
  exports.WebhookSubscriptionTypeEnum = {
23
18
  TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS',
24
19
  MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS'
@@ -13,50 +13,16 @@ import type { WebhookSubscriptionBasicAuthentication } from './webhook-subscript
13
13
  import type { WebhookSubscriptionTypeEnum } from './webhook-subscription-type-enum';
14
14
  /**
15
15
  * Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.
16
- * @export
17
- * @interface WebhookSubscription
18
16
  */
19
17
  export interface WebhookSubscription {
20
- /**
21
- *
22
- * @type {string}
23
- * @memberof WebhookSubscription
24
- */
25
18
  'id'?: string;
26
- /**
27
- *
28
- * @type {string}
29
- * @memberof WebhookSubscription
30
- */
31
19
  'accountId'?: string;
32
20
  /**
33
21
  * Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
34
- * @type {string}
35
- * @memberof WebhookSubscription
36
22
  */
37
23
  'callbackUrl': string | null;
38
- /**
39
- *
40
- * @type {WebhookSubscriptionTypeEnum}
41
- * @memberof WebhookSubscription
42
- */
43
24
  'type'?: WebhookSubscriptionTypeEnum;
44
- /**
45
- *
46
- * @type {WebhookSubscriptionBasicAuthentication}
47
- * @memberof WebhookSubscription
48
- */
49
25
  'basicAuthentication'?: WebhookSubscriptionBasicAuthentication;
50
- /**
51
- *
52
- * @type {string}
53
- * @memberof WebhookSubscription
54
- */
55
26
  'createdDate'?: string;
56
- /**
57
- *
58
- * @type {string}
59
- * @memberof WebhookSubscription
60
- */
61
27
  'modifiedDate'?: string;
62
28
  }
@@ -14,26 +14,9 @@ import type { ModelError } from './model-error';
14
14
  import type { WebhookSubscription } from './webhook-subscription';
15
15
  /**
16
16
  * A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated).
17
- * @export
18
- * @interface WebhookSubscriptionsListBody
19
17
  */
20
18
  export interface WebhookSubscriptionsListBody {
21
- /**
22
- *
23
- * @type {LinksObject}
24
- * @memberof WebhookSubscriptionsListBody
25
- */
26
19
  'links'?: LinksObject;
27
- /**
28
- *
29
- * @type {Array<ModelError>}
30
- * @memberof WebhookSubscriptionsListBody
31
- */
32
20
  'errors'?: Array<ModelError>;
33
- /**
34
- *
35
- * @type {Array<WebhookSubscription>}
36
- * @memberof WebhookSubscriptionsListBody
37
- */
38
21
  'data': Array<WebhookSubscription>;
39
22
  }
@@ -1,19 +1,19 @@
1
- # TnLookupRequestError
1
+ # AsyncLookupRequest
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **message** | **string** | A description of what validation error occurred. | [optional] [default to undefined]
8
+ **phoneNumbers** | **Array&lt;string&gt;** | Telephone numbers in E.164 format. | [default to undefined]
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import { TnLookupRequestError } from 'bandwidth-sdk';
13
+ import { AsyncLookupRequest } from 'bandwidth-sdk';
14
14
 
15
- const instance: TnLookupRequestError = {
16
- message,
15
+ const instance: AsyncLookupRequest = {
16
+ phoneNumbers,
17
17
  };
18
18
  ```
19
19
 
@@ -0,0 +1,12 @@
1
+ # CompletedLookupStatusEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Complete` (value: `'COMPLETE'`)
7
+
8
+ * `PartialComplete` (value: `'PARTIAL_COMPLETE'`)
9
+
10
+ * `Failed` (value: `'FAILED'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # CreateAsyncBulkLookupResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **links** | [**Array&lt;LinkSchema&gt;**](LinkSchema.md) | Links for pagination (if applicable) | [optional] [default to undefined]
9
+ **data** | [**CreateAsyncBulkLookupResponseData**](CreateAsyncBulkLookupResponseData.md) | | [optional] [default to undefined]
10
+ **errors** | [**Array&lt;LookupErrorSchema&gt;**](LookupErrorSchema.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateAsyncBulkLookupResponse } from 'bandwidth-sdk';
16
+
17
+ const instance: CreateAsyncBulkLookupResponse = {
18
+ links,
19
+ data,
20
+ errors,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +1,20 @@
1
- # CreateLookupResponse
1
+ # CreateAsyncBulkLookupResponseData
2
2
 
3
- The request has been accepted for processing but not yet finished and in a terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED).
3
+ The phone number lookup response data
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **requestId** | **string** | The phone number lookup request ID from Bandwidth. | [optional] [default to undefined]
10
- **status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] [default to undefined]
10
+ **status** | [**InProgressLookupStatusEnum**](InProgressLookupStatusEnum.md) | | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import { CreateLookupResponse } from 'bandwidth-sdk';
15
+ import { CreateAsyncBulkLookupResponseData } from 'bandwidth-sdk';
16
16
 
17
- const instance: CreateLookupResponse = {
17
+ const instance: CreateAsyncBulkLookupResponseData = {
18
18
  requestId,
19
19
  status,
20
20
  };