bandwidth-sdk 6.2.1 → 7.0.1

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 (603) 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 +56 -16
  5. package/.openapi-generator/VERSION +1 -1
  6. package/README.md +253 -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 +629 -299
  19. package/base.ts +10 -28
  20. package/common.ts +5 -42
  21. package/configuration.ts +26 -20
  22. package/coverage/clover.xml +1344 -1283
  23. package/coverage/coverage-final.json +49 -45
  24. package/coverage/lcov-report/index.html +26 -26
  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 +28 -28
  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 +65 -86
  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 +13 -124
  40. package/coverage/lcov-report/node-sdk/configuration.ts.html +54 -36
  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 +72 -12
  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 +2959 -2835
  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/{multi-channel-message-response-data-channel-list-inner.d.ts → deactivation-event-enum.d.ts} +5 -4
  202. package/dist/models/deactivation-event-enum.js +22 -0
  203. package/dist/models/disconnect-callback.d.ts +0 -39
  204. package/dist/models/diversion.d.ts +0 -19
  205. package/dist/models/dtmf-callback.d.ts +0 -39
  206. package/dist/models/error-object.d.ts +0 -14
  207. package/dist/models/error-source.d.ts +0 -10
  208. package/dist/models/failure-webhook.d.ts +0 -17
  209. package/dist/models/field-error.d.ts +0 -9
  210. package/dist/models/file-format-enum.d.ts +0 -2
  211. package/dist/models/file-format-enum.js +0 -2
  212. package/dist/models/gather-callback.d.ts +0 -41
  213. package/dist/models/get-async-bulk-lookup-response-data.d.ts +27 -0
  214. package/dist/models/get-async-bulk-lookup-response.d.ts +19 -0
  215. package/dist/models/{lookup-status-enum.d.ts → in-progress-lookup-status-enum.d.ts} +2 -7
  216. package/dist/models/{lookup-status-enum.js → in-progress-lookup-status-enum.js} +2 -7
  217. package/dist/models/inbound-callback-message.d.ts +0 -1
  218. package/dist/models/inbound-callback-type-enum.d.ts +0 -2
  219. package/dist/models/inbound-callback-type-enum.js +0 -2
  220. package/dist/models/inbound-callback.d.ts +0 -23
  221. package/dist/models/index.d.ts +28 -8
  222. package/dist/models/index.js +28 -8
  223. package/dist/models/initiate-callback.d.ts +0 -37
  224. package/dist/models/latest-message-delivery-status-enum.d.ts +20 -0
  225. package/dist/models/latest-message-delivery-status-enum.js +24 -0
  226. package/dist/models/line-type-enum.d.ts +18 -0
  227. package/dist/models/line-type-enum.js +22 -0
  228. package/dist/models/link-schema.d.ts +25 -0
  229. package/dist/models/link-schema.js +15 -0
  230. package/dist/models/link.d.ts +0 -15
  231. package/dist/models/links-object.d.ts +0 -13
  232. package/dist/models/list-message-direction-enum.d.ts +0 -2
  233. package/dist/models/list-message-direction-enum.js +0 -2
  234. package/dist/models/list-message-item.d.ts +0 -60
  235. package/dist/models/lookup-error-response.d.ts +21 -0
  236. package/dist/models/lookup-error-response.js +15 -0
  237. package/dist/models/{tn-lookup-request-error.d.ts → lookup-error-schema-meta.d.ts} +7 -9
  238. package/dist/models/lookup-error-schema-meta.js +15 -0
  239. package/dist/models/lookup-error-schema.d.ts +27 -0
  240. package/dist/models/lookup-error-schema.js +15 -0
  241. package/dist/models/lookup-result.d.ts +22 -40
  242. package/dist/models/machine-detection-complete-callback.d.ts +0 -36
  243. package/dist/models/machine-detection-configuration.d.ts +0 -41
  244. package/dist/models/machine-detection-mode-enum.d.ts +0 -2
  245. package/dist/models/machine-detection-mode-enum.js +0 -2
  246. package/dist/models/machine-detection-result.d.ts +0 -6
  247. package/dist/models/media.d.ts +0 -20
  248. package/dist/models/message-direction-enum.d.ts +0 -2
  249. package/dist/models/message-direction-enum.js +0 -2
  250. package/dist/models/message-request.d.ts +0 -24
  251. package/dist/models/message-status-enum.d.ts +0 -2
  252. package/dist/models/message-status-enum.js +0 -2
  253. package/dist/models/message-type-enum.d.ts +0 -2
  254. package/dist/models/message-type-enum.js +0 -2
  255. package/dist/models/message.d.ts +0 -37
  256. package/dist/models/messages-list.d.ts +0 -17
  257. package/dist/models/messaging-code-response.d.ts +0 -7
  258. package/dist/models/messaging-request-error.d.ts +0 -15
  259. package/dist/models/mfa-forbidden-request-error.d.ts +0 -7
  260. package/dist/models/mfa-request-error.d.ts +0 -9
  261. package/dist/models/mfa-unauthorized-request-error.d.ts +0 -7
  262. package/dist/models/mms-message-content-file.d.ts +0 -7
  263. package/dist/models/mms-message-content.d.ts +0 -12
  264. package/dist/models/model-error.d.ts +0 -20
  265. package/dist/models/multi-channel-action-calendar-event.d.ts +0 -1
  266. package/dist/models/multi-channel-action.d.ts +48 -22
  267. package/dist/models/{lookup-request.d.ts → multi-channel-channel-list-mmsobject.d.ts} +3 -11
  268. package/dist/models/multi-channel-channel-list-mmsobject.js +15 -0
  269. package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +17 -0
  270. package/dist/models/multi-channel-channel-list-mmsresponse-object.js +15 -0
  271. package/dist/models/multi-channel-channel-list-object-base.d.ts +23 -0
  272. package/dist/models/multi-channel-channel-list-object-base.js +15 -0
  273. package/dist/models/multi-channel-channel-list-owner-object.d.ts +17 -0
  274. package/dist/models/multi-channel-channel-list-owner-object.js +15 -0
  275. package/dist/models/{multi-channel-channel-list-object-content.d.ts → multi-channel-channel-list-rbmobject-all-of-content.d.ts} +2 -5
  276. package/dist/models/multi-channel-channel-list-rbmobject-all-of-content.js +15 -0
  277. package/dist/models/multi-channel-channel-list-rbmobject.d.ts +16 -0
  278. package/dist/models/multi-channel-channel-list-rbmobject.js +15 -0
  279. package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +17 -0
  280. package/dist/models/multi-channel-channel-list-rbmresponse-object.js +15 -0
  281. package/dist/models/multi-channel-channel-list-request-object.d.ts +25 -0
  282. package/dist/models/multi-channel-channel-list-request-object.js +15 -0
  283. package/dist/models/{multi-channel-channel-list-object.d.ts → multi-channel-channel-list-response-object.d.ts} +5 -20
  284. package/dist/models/multi-channel-channel-list-response-object.js +15 -0
  285. package/dist/models/multi-channel-channel-list-smsobject.d.ts +16 -0
  286. package/dist/models/multi-channel-channel-list-smsobject.js +15 -0
  287. package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +17 -0
  288. package/dist/models/multi-channel-channel-list-smsresponse-object.js +15 -0
  289. package/dist/models/multi-channel-error.d.ts +0 -20
  290. package/dist/models/multi-channel-message-channel-enum.d.ts +0 -2
  291. package/dist/models/multi-channel-message-channel-enum.js +0 -2
  292. package/dist/models/multi-channel-message-content.d.ts +0 -12
  293. package/dist/models/multi-channel-message-request.d.ts +2 -17
  294. package/dist/models/multi-channel-message-response-data.d.ts +2 -26
  295. package/dist/models/opt-in-workflow.d.ts +0 -20
  296. package/dist/models/page-info.d.ts +0 -13
  297. package/dist/models/priority-enum.d.ts +0 -2
  298. package/dist/models/priority-enum.js +0 -2
  299. package/dist/models/product-type-enum.d.ts +0 -2
  300. package/dist/models/product-type-enum.js +0 -2
  301. package/dist/models/rbm-action-base.d.ts +0 -14
  302. package/dist/models/rbm-action-dial.d.ts +0 -1
  303. package/dist/models/rbm-action-open-url.d.ts +0 -1
  304. package/dist/models/rbm-action-type-enum.d.ts +0 -5
  305. package/dist/models/rbm-action-type-enum.js +0 -5
  306. package/dist/models/rbm-action-view-location.d.ts +0 -1
  307. package/dist/models/rbm-card-content-media.d.ts +0 -1
  308. package/dist/models/rbm-card-content.d.ts +0 -16
  309. package/dist/models/rbm-location-response.d.ts +0 -9
  310. package/dist/models/rbm-media-height-enum.d.ts +0 -2
  311. package/dist/models/rbm-media-height-enum.js +0 -2
  312. package/dist/models/rbm-message-carousel-card.d.ts +0 -17
  313. package/dist/models/rbm-message-content-file.d.ts +0 -9
  314. package/dist/models/rbm-message-content-rich-card.d.ts +0 -1
  315. package/dist/models/rbm-message-content-text.d.ts +0 -9
  316. package/dist/models/rbm-message-media.d.ts +0 -12
  317. package/dist/models/rbm-standalone-card.d.ts +0 -22
  318. package/dist/models/rbm-suggestion-response.d.ts +0 -9
  319. package/dist/models/recording-available-callback.d.ts +0 -52
  320. package/dist/models/recording-complete-callback.d.ts +0 -52
  321. package/dist/models/recording-state-enum.d.ts +0 -2
  322. package/dist/models/recording-state-enum.js +0 -2
  323. package/dist/models/recording-transcription-metadata.d.ts +0 -10
  324. package/dist/models/recording-transcriptions.d.ts +0 -10
  325. package/dist/models/redirect-callback.d.ts +0 -37
  326. package/dist/models/redirect-method-enum.d.ts +0 -2
  327. package/dist/models/redirect-method-enum.js +0 -2
  328. package/dist/models/sms-message-content.d.ts +0 -7
  329. package/dist/models/standalone-card-orientation-enum.d.ts +0 -5
  330. package/dist/models/standalone-card-orientation-enum.js +0 -5
  331. package/dist/models/status-callback-message.d.ts +0 -43
  332. package/dist/models/status-callback-type-enum.d.ts +0 -2
  333. package/dist/models/status-callback-type-enum.js +0 -2
  334. package/dist/models/status-callback.d.ts +0 -27
  335. package/dist/models/stir-shaken.d.ts +0 -11
  336. package/dist/models/sync-lookup-request.d.ts +17 -0
  337. package/dist/models/sync-lookup-request.js +15 -0
  338. package/dist/models/telephone-number.d.ts +0 -7
  339. package/dist/models/tfv-basic-authentication.d.ts +0 -15
  340. package/dist/models/tfv-callback-status-enum.d.ts +0 -5
  341. package/dist/models/tfv-callback-status-enum.js +0 -5
  342. package/dist/models/tfv-error.d.ts +0 -14
  343. package/dist/models/tfv-status-enum.d.ts +0 -5
  344. package/dist/models/tfv-status-enum.js +0 -5
  345. package/dist/models/tfv-status.d.ts +0 -31
  346. package/dist/models/tfv-submission-info.d.ts +0 -50
  347. package/dist/models/tfv-submission-wrapper.d.ts +0 -10
  348. package/dist/models/thumbnail-alignment-enum.d.ts +0 -2
  349. package/dist/models/thumbnail-alignment-enum.js +0 -2
  350. package/dist/models/transcribe-recording.d.ts +0 -22
  351. package/dist/models/transcription-available-callback.d.ts +0 -53
  352. package/dist/models/transcription.d.ts +0 -9
  353. package/dist/models/transfer-answer-callback.d.ts +0 -35
  354. package/dist/models/transfer-complete-callback.d.ts +0 -41
  355. package/dist/models/transfer-disconnect-callback.d.ts +0 -45
  356. package/dist/models/update-call-recording.d.ts +0 -10
  357. package/dist/models/update-call.d.ts +0 -34
  358. package/dist/models/update-conference-member.d.ts +0 -11
  359. package/dist/models/update-conference.d.ts +0 -32
  360. package/dist/models/verification-denial-webhook.d.ts +0 -28
  361. package/dist/models/verification-request.d.ts +0 -59
  362. package/dist/models/verification-update-request.d.ts +0 -54
  363. package/dist/models/verification-webhook.d.ts +0 -16
  364. package/dist/models/verify-code-request.d.ts +0 -13
  365. package/dist/models/verify-code-response.d.ts +0 -7
  366. package/dist/models/voice-api-error.d.ts +0 -20
  367. package/dist/models/voice-code-response.d.ts +0 -7
  368. package/dist/models/webhook-subscription-basic-authentication.d.ts +0 -12
  369. package/dist/models/webhook-subscription-request-schema.d.ts +0 -14
  370. package/dist/models/webhook-subscription-type-enum.d.ts +0 -5
  371. package/dist/models/webhook-subscription-type-enum.js +0 -5
  372. package/dist/models/webhook-subscription.d.ts +0 -34
  373. package/dist/models/webhook-subscriptions-list-body.d.ts +0 -17
  374. package/docs/{TnLookupRequestError.md → AsyncLookupRequest.md} +5 -5
  375. package/docs/CompletedLookupStatusEnum.md +12 -0
  376. package/docs/CreateAsyncBulkLookupResponse.md +24 -0
  377. package/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +5 -5
  378. package/docs/CreateSyncLookupResponse.md +24 -0
  379. package/docs/CreateSyncLookupResponseData.md +25 -0
  380. package/docs/DeactivationEventEnum.md +9 -0
  381. package/docs/GetAsyncBulkLookupResponse.md +24 -0
  382. package/docs/GetAsyncBulkLookupResponseData.md +25 -0
  383. package/docs/{LookupStatusEnum.md → InProgressLookupStatusEnum.md} +1 -2
  384. package/docs/LatestMessageDeliveryStatusEnum.md +13 -0
  385. package/docs/LineTypeEnum.md +14 -0
  386. package/docs/LinkSchema.md +24 -0
  387. package/docs/LookupErrorResponse.md +24 -0
  388. package/docs/LookupErrorSchema.md +26 -0
  389. package/docs/LookupErrorSchemaMeta.md +24 -0
  390. package/docs/LookupResult.md +22 -18
  391. package/docs/{MultiChannelChannelListObject.md → MultiChannelChannelListMMSObject.md} +4 -4
  392. package/docs/{MultiChannelMessageResponseDataChannelListInner.md → MultiChannelChannelListMMSResponseObject.md} +4 -4
  393. package/docs/MultiChannelChannelListObjectBase.md +24 -0
  394. package/docs/MultiChannelChannelListOwnerObject.md +20 -0
  395. package/docs/MultiChannelChannelListRBMObject.md +26 -0
  396. package/docs/{MultiChannelChannelListObjectContent.md → MultiChannelChannelListRBMObjectAllOfContent.md} +5 -5
  397. package/docs/MultiChannelChannelListRBMResponseObject.md +28 -0
  398. package/docs/MultiChannelChannelListRequestObject.md +26 -0
  399. package/docs/MultiChannelChannelListResponseObject.md +28 -0
  400. package/docs/MultiChannelChannelListSMSObject.md +26 -0
  401. package/docs/MultiChannelChannelListSMSResponseObject.md +28 -0
  402. package/docs/MultiChannelMessageRequest.md +1 -1
  403. package/docs/MultiChannelMessageResponseData.md +1 -1
  404. package/docs/PhoneNumberLookupApi.md +81 -34
  405. package/docs/{LookupRequest.md → SyncLookupRequest.md} +5 -6
  406. package/models/account-statistics.ts +0 -9
  407. package/models/additional-denial-reason.ts +0 -11
  408. package/models/address.ts +0 -19
  409. package/models/answer-callback.ts +0 -36
  410. package/models/async-lookup-request.ts +23 -0
  411. package/models/blocked-webhook.ts +0 -20
  412. package/models/bridge-complete-callback.ts +0 -37
  413. package/models/bridge-target-complete-callback.ts +0 -31
  414. package/models/business-entity-type-enum.ts +0 -2
  415. package/models/business-registration-type-enum.ts +0 -2
  416. package/models/call-direction-enum.ts +0 -2
  417. package/models/call-recording-metadata.ts +0 -52
  418. package/models/call-state-enum.ts +0 -2
  419. package/models/call-state.ts +0 -44
  420. package/models/call-transcription-detected-language-enum.ts +0 -2
  421. package/models/call-transcription-metadata.ts +0 -11
  422. package/models/call-transcription-response.ts +0 -16
  423. package/models/call-transcription-track-enum.ts +0 -2
  424. package/models/call-transcription.ts +0 -19
  425. package/models/callback-method-enum.ts +0 -2
  426. package/models/callback.ts +0 -1
  427. package/models/card-width-enum.ts +0 -5
  428. package/models/code-request.ts +0 -17
  429. package/models/completed-lookup-status-enum.ts +27 -0
  430. package/models/conference-completed-callback.ts +0 -12
  431. package/models/conference-created-callback.ts +0 -12
  432. package/models/conference-member-exit-callback.ts +0 -18
  433. package/models/conference-member-join-callback.ts +0 -18
  434. package/models/conference-member.ts +0 -17
  435. package/models/conference-recording-available-callback.ts +0 -33
  436. package/models/conference-recording-metadata.ts +0 -32
  437. package/models/conference-redirect-callback.ts +0 -12
  438. package/models/conference-state-enum.ts +0 -2
  439. package/models/conference.ts +0 -24
  440. package/models/contact.ts +0 -16
  441. package/models/create-async-bulk-lookup-response-data.ts +32 -0
  442. package/models/create-async-bulk-lookup-response.ts +34 -0
  443. package/models/create-call-response.ts +0 -56
  444. package/models/create-call.ts +0 -59
  445. package/models/create-message-request-error.ts +0 -20
  446. package/models/create-multi-channel-message-response.ts +0 -20
  447. package/models/{create-lookup-response.ts → create-sync-lookup-response-data.ts} +9 -11
  448. package/models/create-sync-lookup-response.ts +31 -0
  449. package/models/deactivation-event-enum.ts +28 -0
  450. package/models/disconnect-callback.ts +0 -39
  451. package/models/diversion.ts +0 -19
  452. package/models/dtmf-callback.ts +0 -39
  453. package/models/error-object.ts +0 -14
  454. package/models/error-source.ts +0 -10
  455. package/models/failure-webhook.ts +0 -17
  456. package/models/field-error.ts +0 -9
  457. package/models/file-format-enum.ts +0 -2
  458. package/models/gather-callback.ts +0 -41
  459. package/models/get-async-bulk-lookup-response-data.ts +39 -0
  460. package/models/get-async-bulk-lookup-response.ts +31 -0
  461. package/models/{lookup-status-enum.ts → in-progress-lookup-status-enum.ts} +2 -7
  462. package/models/inbound-callback-message.ts +0 -1
  463. package/models/inbound-callback-type-enum.ts +0 -2
  464. package/models/inbound-callback.ts +0 -23
  465. package/models/index.ts +28 -8
  466. package/models/initiate-callback.ts +0 -37
  467. package/models/latest-message-delivery-status-enum.ts +30 -0
  468. package/models/line-type-enum.ts +28 -0
  469. package/models/{lookup-request.ts → link-schema.ts} +11 -10
  470. package/models/link.ts +0 -15
  471. package/models/links-object.ts +0 -13
  472. package/models/list-message-direction-enum.ts +0 -2
  473. package/models/list-message-item.ts +0 -60
  474. package/models/lookup-error-response.ts +31 -0
  475. package/models/{tn-lookup-request-error.ts → lookup-error-schema-meta.ts} +7 -9
  476. package/models/lookup-error-schema.ts +35 -0
  477. package/models/lookup-result.ts +30 -40
  478. package/models/machine-detection-complete-callback.ts +0 -36
  479. package/models/machine-detection-configuration.ts +0 -41
  480. package/models/machine-detection-mode-enum.ts +0 -2
  481. package/models/machine-detection-result.ts +0 -6
  482. package/models/media.ts +0 -20
  483. package/models/message-direction-enum.ts +0 -2
  484. package/models/message-request.ts +0 -24
  485. package/models/message-status-enum.ts +0 -2
  486. package/models/message-type-enum.ts +0 -2
  487. package/models/message.ts +0 -37
  488. package/models/messages-list.ts +0 -17
  489. package/models/messaging-code-response.ts +0 -7
  490. package/models/messaging-request-error.ts +0 -15
  491. package/models/mfa-forbidden-request-error.ts +0 -7
  492. package/models/mfa-request-error.ts +0 -9
  493. package/models/mfa-unauthorized-request-error.ts +0 -7
  494. package/models/mms-message-content-file.ts +0 -7
  495. package/models/mms-message-content.ts +0 -12
  496. package/models/model-error.ts +0 -20
  497. package/models/multi-channel-action-calendar-event.ts +0 -1
  498. package/models/multi-channel-action.ts +48 -5
  499. package/models/{multi-channel-message-response-data-channel-list-inner.ts → multi-channel-channel-list-mmsobject.ts} +4 -5
  500. package/models/multi-channel-channel-list-mmsresponse-object.ts +34 -0
  501. package/models/multi-channel-channel-list-object-base.ts +33 -0
  502. package/models/multi-channel-channel-list-owner-object.ts +23 -0
  503. package/models/{multi-channel-channel-list-object-content.ts → multi-channel-channel-list-rbmobject-all-of-content.ts} +5 -12
  504. package/models/multi-channel-channel-list-rbmobject.ts +31 -0
  505. package/models/multi-channel-channel-list-rbmresponse-object.ts +34 -0
  506. package/models/{multi-channel-channel-list-object.ts → multi-channel-channel-list-request-object.ts} +12 -22
  507. package/models/multi-channel-channel-list-response-object.ts +50 -0
  508. package/models/multi-channel-channel-list-smsobject.ts +31 -0
  509. package/models/multi-channel-channel-list-smsresponse-object.ts +34 -0
  510. package/models/multi-channel-error.ts +0 -20
  511. package/models/multi-channel-message-channel-enum.ts +0 -2
  512. package/models/multi-channel-message-content.ts +0 -12
  513. package/models/multi-channel-message-request.ts +2 -17
  514. package/models/multi-channel-message-response-data.ts +2 -26
  515. package/models/opt-in-workflow.ts +0 -20
  516. package/models/page-info.ts +0 -13
  517. package/models/priority-enum.ts +0 -2
  518. package/models/product-type-enum.ts +0 -2
  519. package/models/rbm-action-base.ts +0 -14
  520. package/models/rbm-action-dial.ts +0 -1
  521. package/models/rbm-action-open-url.ts +0 -1
  522. package/models/rbm-action-type-enum.ts +0 -5
  523. package/models/rbm-action-view-location.ts +0 -1
  524. package/models/rbm-card-content-media.ts +0 -1
  525. package/models/rbm-card-content.ts +0 -16
  526. package/models/rbm-location-response.ts +0 -9
  527. package/models/rbm-media-height-enum.ts +0 -2
  528. package/models/rbm-message-carousel-card.ts +0 -17
  529. package/models/rbm-message-content-file.ts +0 -9
  530. package/models/rbm-message-content-rich-card.ts +0 -1
  531. package/models/rbm-message-content-text.ts +0 -9
  532. package/models/rbm-message-media.ts +0 -12
  533. package/models/rbm-standalone-card.ts +0 -22
  534. package/models/rbm-suggestion-response.ts +0 -9
  535. package/models/recording-available-callback.ts +0 -52
  536. package/models/recording-complete-callback.ts +0 -52
  537. package/models/recording-state-enum.ts +0 -2
  538. package/models/recording-transcription-metadata.ts +0 -10
  539. package/models/recording-transcriptions.ts +0 -10
  540. package/models/redirect-callback.ts +0 -37
  541. package/models/redirect-method-enum.ts +0 -2
  542. package/models/sms-message-content.ts +0 -7
  543. package/models/standalone-card-orientation-enum.ts +0 -5
  544. package/models/status-callback-message.ts +0 -43
  545. package/models/status-callback-type-enum.ts +0 -2
  546. package/models/status-callback.ts +0 -27
  547. package/models/stir-shaken.ts +0 -11
  548. package/models/sync-lookup-request.ts +23 -0
  549. package/models/telephone-number.ts +0 -7
  550. package/models/tfv-basic-authentication.ts +0 -15
  551. package/models/tfv-callback-status-enum.ts +0 -5
  552. package/models/tfv-error.ts +0 -14
  553. package/models/tfv-status-enum.ts +0 -5
  554. package/models/tfv-status.ts +0 -31
  555. package/models/tfv-submission-info.ts +0 -50
  556. package/models/tfv-submission-wrapper.ts +0 -10
  557. package/models/thumbnail-alignment-enum.ts +0 -2
  558. package/models/transcribe-recording.ts +0 -22
  559. package/models/transcription-available-callback.ts +0 -53
  560. package/models/transcription.ts +0 -9
  561. package/models/transfer-answer-callback.ts +0 -35
  562. package/models/transfer-complete-callback.ts +0 -41
  563. package/models/transfer-disconnect-callback.ts +0 -45
  564. package/models/update-call-recording.ts +0 -10
  565. package/models/update-call.ts +0 -34
  566. package/models/update-conference-member.ts +0 -11
  567. package/models/update-conference.ts +0 -32
  568. package/models/verification-denial-webhook.ts +0 -28
  569. package/models/verification-request.ts +0 -59
  570. package/models/verification-update-request.ts +0 -54
  571. package/models/verification-webhook.ts +0 -16
  572. package/models/verify-code-request.ts +0 -13
  573. package/models/verify-code-response.ts +0 -7
  574. package/models/voice-api-error.ts +0 -20
  575. package/models/voice-code-response.ts +0 -7
  576. package/models/webhook-subscription-basic-authentication.ts +0 -12
  577. package/models/webhook-subscription-request-schema.ts +0 -14
  578. package/models/webhook-subscription-type-enum.ts +0 -5
  579. package/models/webhook-subscription.ts +0 -34
  580. package/models/webhook-subscriptions-list-body.ts +0 -17
  581. package/openapitools.json +1 -1
  582. package/package.json +2 -2
  583. package/tests/smoke/multi-channel-api.test.ts +117 -10
  584. package/tests/smoke/phone-number-lookup-api.test.ts +64 -61
  585. package/tests/unit/api/multi-channel-api.test.ts +27 -10
  586. package/tests/unit/api/phone-number-lookup-api.test.ts +64 -58
  587. package/tests/unit/models/completed-lookup-status-enum.test.ts +9 -0
  588. package/tests/unit/models/deactivation-event-enum.test.ts +7 -0
  589. package/tests/unit/models/in-progress-lookup-status-enum.test.ts +11 -0
  590. package/tests/unit/models/latest-message-delivery-status-enum.test.ts +10 -0
  591. package/tests/unit/models/line-type-enum.test.ts +11 -0
  592. package/dist/models/create-lookup-response.d.ts +0 -31
  593. package/dist/models/lookup-status.d.ts +0 -44
  594. package/docs/LookupStatus.md +0 -27
  595. package/models/lookup-status.ts +0 -56
  596. package/tests/unit/models/lookup-status-enum.test.ts +0 -10
  597. /package/dist/models/{create-lookup-response.js → async-lookup-request.js} +0 -0
  598. /package/dist/models/{lookup-request.js → create-async-bulk-lookup-response-data.js} +0 -0
  599. /package/dist/models/{lookup-status.js → create-async-bulk-lookup-response.js} +0 -0
  600. /package/dist/models/{multi-channel-channel-list-object-content.js → create-sync-lookup-response-data.js} +0 -0
  601. /package/dist/models/{multi-channel-channel-list-object.js → create-sync-lookup-response.js} +0 -0
  602. /package/dist/models/{multi-channel-message-response-data-channel-list-inner.js → get-async-bulk-lookup-response-data.js} +0 -0
  603. /package/dist/models/{tn-lookup-request-error.js → get-async-bulk-lookup-response.js} +0 -0
@@ -4,13 +4,14 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createLookup**](#createlookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup|
8
- |[**getLookupStatus**](#getlookupstatus) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status|
7
+ |[**createAsyncBulkLookup**](#createasyncbulklookup) | **POST** /accounts/{accountId}/phoneNumberLookup/bulk | Create Asynchronous Bulk Number Lookup|
8
+ |[**createSyncLookup**](#createsynclookup) | **POST** /accounts/{accountId}/phoneNumberLookup | Create Synchronous Number Lookup|
9
+ |[**getAsyncBulkLookup**](#getasyncbulklookup) | **GET** /accounts/{accountId}/phoneNumberLookup/bulk/{requestId} | Get Asynchronous Bulk Number Lookup|
9
10
 
10
- # **createLookup**
11
- > CreateLookupResponse createLookup(lookupRequest)
11
+ # **createAsyncBulkLookup**
12
+ > CreateAsyncBulkLookupResponse createAsyncBulkLookup(asyncLookupRequest)
12
13
 
13
- Create a Phone Number Lookup Request.
14
+ Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
14
15
 
15
16
  ### Example
16
17
 
@@ -18,18 +19,18 @@ Create a Phone Number Lookup Request.
18
19
  import {
19
20
  PhoneNumberLookupApi,
20
21
  Configuration,
21
- LookupRequest
22
+ AsyncLookupRequest
22
23
  } from 'bandwidth-sdk';
23
24
 
24
25
  const configuration = new Configuration();
25
26
  const apiInstance = new PhoneNumberLookupApi(configuration);
26
27
 
27
- let accountId: string; //Your Bandwidth Account ID. (default to undefined)
28
- let lookupRequest: LookupRequest; //Phone number lookup request.
28
+ let accountId: string; // (default to undefined)
29
+ let asyncLookupRequest: AsyncLookupRequest; //Asynchronous bulk phone number lookup request.
29
30
 
30
- const { status, data } = await apiInstance.createLookup(
31
+ const { status, data } = await apiInstance.createAsyncBulkLookup(
31
32
  accountId,
32
- lookupRequest
33
+ asyncLookupRequest
33
34
  );
34
35
  ```
35
36
 
@@ -37,13 +38,13 @@ const { status, data } = await apiInstance.createLookup(
37
38
 
38
39
  |Name | Type | Description | Notes|
39
40
  |------------- | ------------- | ------------- | -------------|
40
- | **lookupRequest** | **LookupRequest**| Phone number lookup request. | |
41
- | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
41
+ | **asyncLookupRequest** | **AsyncLookupRequest**| Asynchronous bulk phone number lookup request. | |
42
+ | **accountId** | [**string**] | | defaults to undefined|
42
43
 
43
44
 
44
45
  ### Return type
45
46
 
46
- **CreateLookupResponse**
47
+ **CreateAsyncBulkLookupResponse**
47
48
 
48
49
  ### Authorization
49
50
 
@@ -59,19 +60,70 @@ const { status, data } = await apiInstance.createLookup(
59
60
  | Status code | Description | Response headers |
60
61
  |-------------|-------------|------------------|
61
62
  |**202** | Accepted | - |
62
- |**400** | Bad Request | - |
63
- |**401** | Unauthorized | - |
64
- |**403** | Forbidden | - |
65
- |**415** | Unsupported Media Type | - |
66
- |**429** | Too Many Requests | - |
67
- |**500** | Internal Server Error | - |
63
+ |**0** | Bad Request | - |
68
64
 
69
65
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
70
66
 
71
- # **getLookupStatus**
72
- > LookupStatus getLookupStatus()
67
+ # **createSyncLookup**
68
+ > CreateSyncLookupResponse createSyncLookup(syncLookupRequest)
73
69
 
74
- Get an existing Phone Number Lookup Request.
70
+ Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
71
+
72
+ ### Example
73
+
74
+ ```typescript
75
+ import {
76
+ PhoneNumberLookupApi,
77
+ Configuration,
78
+ SyncLookupRequest
79
+ } from 'bandwidth-sdk';
80
+
81
+ const configuration = new Configuration();
82
+ const apiInstance = new PhoneNumberLookupApi(configuration);
83
+
84
+ let accountId: string; // (default to undefined)
85
+ let syncLookupRequest: SyncLookupRequest; //Synchronous phone number lookup request.
86
+
87
+ const { status, data } = await apiInstance.createSyncLookup(
88
+ accountId,
89
+ syncLookupRequest
90
+ );
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ |Name | Type | Description | Notes|
96
+ |------------- | ------------- | ------------- | -------------|
97
+ | **syncLookupRequest** | **SyncLookupRequest**| Synchronous phone number lookup request. | |
98
+ | **accountId** | [**string**] | | defaults to undefined|
99
+
100
+
101
+ ### Return type
102
+
103
+ **CreateSyncLookupResponse**
104
+
105
+ ### Authorization
106
+
107
+ [Basic](../README.md#Basic)
108
+
109
+ ### HTTP request headers
110
+
111
+ - **Content-Type**: application/json
112
+ - **Accept**: application/json
113
+
114
+
115
+ ### HTTP response details
116
+ | Status code | Description | Response headers |
117
+ |-------------|-------------|------------------|
118
+ |**200** | OK | - |
119
+ |**0** | Bad Request | - |
120
+
121
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
122
+
123
+ # **getAsyncBulkLookup**
124
+ > GetAsyncBulkLookupResponse getAsyncBulkLookup()
125
+
126
+ Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
75
127
 
76
128
  ### Example
77
129
 
@@ -84,10 +136,10 @@ import {
84
136
  const configuration = new Configuration();
85
137
  const apiInstance = new PhoneNumberLookupApi(configuration);
86
138
 
87
- let accountId: string; //Your Bandwidth Account ID. (default to undefined)
88
- let requestId: string; //The phone number lookup request ID from Bandwidth. (default to undefined)
139
+ let accountId: string; // (default to undefined)
140
+ let requestId: string; // (default to undefined)
89
141
 
90
- const { status, data } = await apiInstance.getLookupStatus(
142
+ const { status, data } = await apiInstance.getAsyncBulkLookup(
91
143
  accountId,
92
144
  requestId
93
145
  );
@@ -97,13 +149,13 @@ const { status, data } = await apiInstance.getLookupStatus(
97
149
 
98
150
  |Name | Type | Description | Notes|
99
151
  |------------- | ------------- | ------------- | -------------|
100
- | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
101
- | **requestId** | [**string**] | The phone number lookup request ID from Bandwidth. | defaults to undefined|
152
+ | **accountId** | [**string**] | | defaults to undefined|
153
+ | **requestId** | [**string**] | | defaults to undefined|
102
154
 
103
155
 
104
156
  ### Return type
105
157
 
106
- **LookupStatus**
158
+ **GetAsyncBulkLookupResponse**
107
159
 
108
160
  ### Authorization
109
161
 
@@ -119,12 +171,7 @@ const { status, data } = await apiInstance.getLookupStatus(
119
171
  | Status code | Description | Response headers |
120
172
  |-------------|-------------|------------------|
121
173
  |**200** | OK | - |
122
- |**400** | Bad Request | - |
123
- |**401** | Unauthorized | - |
124
- |**403** | Forbidden | - |
125
- |**404** | Not Found | - |
126
- |**429** | Too Many Requests | - |
127
- |**500** | Internal Server Error | - |
174
+ |**0** | Bad Request | - |
128
175
 
129
176
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
130
177
 
@@ -1,20 +1,19 @@
1
- # LookupRequest
1
+ # SyncLookupRequest
2
2
 
3
- Create phone number lookup request.
4
3
 
5
4
  ## Properties
6
5
 
7
6
  Name | Type | Description | Notes
8
7
  ------------ | ------------- | ------------- | -------------
9
- **tns** | **Array<string>** | | [default to undefined]
8
+ **phoneNumbers** | **Array<string>** | Telephone numbers in E.164 format. | [default to undefined]
10
9
 
11
10
  ## Example
12
11
 
13
12
  ```typescript
14
- import { LookupRequest } from 'bandwidth-sdk';
13
+ import { SyncLookupRequest } from 'bandwidth-sdk';
15
14
 
16
- const instance: LookupRequest = {
17
- tns,
15
+ const instance: SyncLookupRequest = {
16
+ phoneNumbers,
18
17
  };
19
18
  ```
20
19
 
@@ -14,22 +14,13 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface AccountStatistics
21
- */
22
17
  export interface AccountStatistics {
23
18
  /**
24
19
  * The number of calls currently enqueued.
25
- * @type {number}
26
- * @memberof AccountStatistics
27
20
  */
28
21
  'currentCallQueueSize'?: number;
29
22
  /**
30
23
  * The maximum size of the queue before outgoing calls start being rejected.
31
- * @type {number}
32
- * @memberof AccountStatistics
33
24
  */
34
25
  'maxCallQueueSize'?: number;
35
26
  }
@@ -14,28 +14,17 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface AdditionalDenialReason
21
- */
22
17
  export interface AdditionalDenialReason {
23
18
  /**
24
19
  * Reason code for denial.
25
- * @type {number}
26
- * @memberof AdditionalDenialReason
27
20
  */
28
21
  'statusCode': number;
29
22
  /**
30
23
  * Explanation for why a verification request was declined.
31
- * @type {string}
32
- * @memberof AdditionalDenialReason
33
24
  */
34
25
  'reason': string;
35
26
  /**
36
27
  * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
37
- * @type {boolean}
38
- * @memberof AdditionalDenialReason
39
28
  */
40
29
  'resubmitAllowed': boolean;
41
30
  }
package/models/address.ts CHANGED
@@ -14,52 +14,33 @@
14
14
 
15
15
 
16
16
 
17
- /**
18
- *
19
- * @export
20
- * @interface Address
21
- */
22
17
  export interface Address {
23
18
  /**
24
19
  * The name of the business using the toll-free number.
25
- * @type {string}
26
- * @memberof Address
27
20
  */
28
21
  'name': string;
29
22
  /**
30
23
  * The address of the business using the toll-free number.
31
- * @type {string}
32
- * @memberof Address
33
24
  */
34
25
  'addr1': string;
35
26
  /**
36
27
  * The address of the business using the toll-free number.
37
- * @type {string}
38
- * @memberof Address
39
28
  */
40
29
  'addr2'?: string | null;
41
30
  /**
42
31
  * The city of the business using the toll-free number.
43
- * @type {string}
44
- * @memberof Address
45
32
  */
46
33
  'city': string;
47
34
  /**
48
35
  * The state of the business using the toll-free number.
49
- * @type {string}
50
- * @memberof Address
51
36
  */
52
37
  'state': string;
53
38
  /**
54
39
  * The zip of the business using the toll-free number.
55
- * @type {string}
56
- * @memberof Address
57
40
  */
58
41
  'zip': string;
59
42
  /**
60
43
  * The website of the business using the toll-free number.
61
- * @type {string}
62
- * @memberof Address
63
44
  */
64
45
  'url': string;
65
46
  }
@@ -22,93 +22,57 @@ import type { MachineDetectionResult } from './machine-detection-result';
22
22
 
23
23
  /**
24
24
  * The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
25
- * @export
26
- * @interface AnswerCallback
27
25
  */
28
26
  export interface AnswerCallback {
29
27
  /**
30
28
  * The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
31
- * @type {string}
32
- * @memberof AnswerCallback
33
29
  */
34
30
  'eventType'?: string;
35
31
  /**
36
32
  * The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
37
- * @type {string}
38
- * @memberof AnswerCallback
39
33
  */
40
34
  'eventTime'?: string;
41
35
  /**
42
36
  * The user account associated with the call.
43
- * @type {string}
44
- * @memberof AnswerCallback
45
37
  */
46
38
  'accountId'?: string;
47
39
  /**
48
40
  * The id of the application associated with the call.
49
- * @type {string}
50
- * @memberof AnswerCallback
51
41
  */
52
42
  'applicationId'?: string;
53
43
  /**
54
44
  * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
55
- * @type {string}
56
- * @memberof AnswerCallback
57
45
  */
58
46
  'from'?: string;
59
47
  /**
60
48
  * The phone number that received the call, in E.164 format (e.g. +15555555555).
61
- * @type {string}
62
- * @memberof AnswerCallback
63
49
  */
64
50
  'to'?: string;
65
- /**
66
- *
67
- * @type {CallDirectionEnum}
68
- * @memberof AnswerCallback
69
- */
70
51
  'direction'?: CallDirectionEnum;
71
52
  /**
72
53
  * The call id associated with the event.
73
- * @type {string}
74
- * @memberof AnswerCallback
75
54
  */
76
55
  'callId'?: string;
77
56
  /**
78
57
  * The URL of the call associated with the event.
79
- * @type {string}
80
- * @memberof AnswerCallback
81
58
  */
82
59
  'callUrl'?: string;
83
60
  /**
84
61
  * (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
85
- * @type {string}
86
- * @memberof AnswerCallback
87
62
  */
88
63
  'enqueuedTime'?: string | null;
89
64
  /**
90
65
  * Time the call was started, in ISO 8601 format.
91
- * @type {string}
92
- * @memberof AnswerCallback
93
66
  */
94
67
  'startTime'?: string;
95
68
  /**
96
69
  * Time the call was answered, in ISO 8601 format.
97
- * @type {string}
98
- * @memberof AnswerCallback
99
70
  */
100
71
  'answerTime'?: string | null;
101
72
  /**
102
73
  * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
103
- * @type {string}
104
- * @memberof AnswerCallback
105
74
  */
106
75
  'tag'?: string | null;
107
- /**
108
- *
109
- * @type {MachineDetectionResult}
110
- * @memberof AnswerCallback
111
- */
112
76
  'machineDetectionResult'?: MachineDetectionResult | null;
113
77
  }
114
78
 
@@ -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 AsyncLookupRequest {
18
+ /**
19
+ * Telephone numbers in E.164 format.
20
+ */
21
+ 'phoneNumbers': Array<string>;
22
+ }
23
+
@@ -17,46 +17,26 @@
17
17
  // @ts-ignore
18
18
  import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum';
19
19
 
20
- /**
21
- *
22
- * @export
23
- * @interface BlockedWebhook
24
- */
25
20
  export interface BlockedWebhook {
26
21
  /**
27
22
  * User\'s account ID.
28
- * @type {string}
29
- * @memberof BlockedWebhook
30
23
  */
31
24
  'accountId'?: string;
32
25
  /**
33
26
  * Toll-free telephone number in E.164 format.
34
- * @type {string}
35
- * @memberof BlockedWebhook
36
27
  */
37
28
  'phoneNumber'?: string;
38
- /**
39
- *
40
- * @type {TfvCallbackStatusEnum}
41
- * @memberof BlockedWebhook
42
- */
43
29
  'status'?: TfvCallbackStatusEnum;
44
30
  /**
45
31
  * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
46
- * @type {string}
47
- * @memberof BlockedWebhook
48
32
  */
49
33
  'internalTicketNumber'?: string;
50
34
  /**
51
35
  * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
52
- * @type {boolean}
53
- * @memberof BlockedWebhook
54
36
  */
55
37
  'blocked'?: boolean;
56
38
  /**
57
39
  * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
58
- * @type {string}
59
- * @memberof BlockedWebhook
60
40
  */
61
41
  'blockedReason'?: string;
62
42
  }
@@ -19,104 +19,67 @@ import type { CallDirectionEnum } from './call-direction-enum';
19
19
 
20
20
  /**
21
21
  * If the target call leaves the <Bridge>, then this callback is sent to the bridgeCompleteUrl, and the BXML returned in it is executed on the call. If this webhook is sent, the Bridge Target Complete webhook is NOT sent. This callback is also sent if any problem occurs that prevents the calls to be bridged.
22
- * @export
23
- * @interface BridgeCompleteCallback
24
22
  */
25
23
  export interface BridgeCompleteCallback {
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 BridgeCompleteCallback
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 BridgeCompleteCallback
36
30
  */
37
31
  'eventTime'?: string;
38
32
  /**
39
33
  * The user account associated with the call.
40
- * @type {string}
41
- * @memberof BridgeCompleteCallback
42
34
  */
43
35
  'accountId'?: string;
44
36
  /**
45
37
  * The id of the application associated with the call.
46
- * @type {string}
47
- * @memberof BridgeCompleteCallback
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 BridgeCompleteCallback
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 BridgeCompleteCallback
60
46
  */
61
47
  'to'?: string;
62
- /**
63
- *
64
- * @type {CallDirectionEnum}
65
- * @memberof BridgeCompleteCallback
66
- */
67
48
  'direction'?: CallDirectionEnum;
68
49
  /**
69
50
  * The call id associated with the event.
70
- * @type {string}
71
- * @memberof BridgeCompleteCallback
72
51
  */
73
52
  'callId'?: string;
74
53
  /**
75
54
  * The URL of the call associated with the event.
76
- * @type {string}
77
- * @memberof BridgeCompleteCallback
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 BridgeCompleteCallback
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 BridgeCompleteCallback
90
63
  */
91
64
  'startTime'?: string;
92
65
  /**
93
66
  * Time the call was answered, in ISO 8601 format.
94
- * @type {string}
95
- * @memberof BridgeCompleteCallback
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 BridgeCompleteCallback
102
71
  */
103
72
  'tag'?: string | null;
104
73
  /**
105
74
  * Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
106
- * @type {string}
107
- * @memberof BridgeCompleteCallback
108
75
  */
109
76
  'cause'?: string;
110
77
  /**
111
78
  * Text explaining the reason that caused the call to fail in case of errors.
112
- * @type {string}
113
- * @memberof BridgeCompleteCallback
114
79
  */
115
80
  'errorMessage'?: string | null;
116
81
  /**
117
82
  * Bandwidth\'s internal id that references the error event.
118
- * @type {string}
119
- * @memberof BridgeCompleteCallback
120
83
  */
121
84
  'errorId'?: string | null;
122
85
  }
@@ -19,86 +19,55 @@ import type { CallDirectionEnum } from './call-direction-enum';
19
19
 
20
20
  /**
21
21
  * If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.
22
- * @export
23
- * @interface BridgeTargetCompleteCallback
24
22
  */
25
23
  export interface BridgeTargetCompleteCallback {
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 BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
36
30
  */
37
31
  'eventTime'?: string;
38
32
  /**
39
33
  * The user account associated with the call.
40
- * @type {string}
41
- * @memberof BridgeTargetCompleteCallback
42
34
  */
43
35
  'accountId'?: string;
44
36
  /**
45
37
  * The id of the application associated with the call.
46
- * @type {string}
47
- * @memberof BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
60
46
  */
61
47
  'to'?: string;
62
- /**
63
- *
64
- * @type {CallDirectionEnum}
65
- * @memberof BridgeTargetCompleteCallback
66
- */
67
48
  'direction'?: CallDirectionEnum;
68
49
  /**
69
50
  * The call id associated with the event.
70
- * @type {string}
71
- * @memberof BridgeTargetCompleteCallback
72
51
  */
73
52
  'callId'?: string;
74
53
  /**
75
54
  * The URL of the call associated with the event.
76
- * @type {string}
77
- * @memberof BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
90
63
  */
91
64
  'startTime'?: string;
92
65
  /**
93
66
  * Time the call was answered, in ISO 8601 format.
94
- * @type {string}
95
- * @memberof BridgeTargetCompleteCallback
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 BridgeTargetCompleteCallback
102
71
  */
103
72
  'tag'?: string | null;
104
73
  }
@@ -16,8 +16,6 @@
16
16
 
17
17
  /**
18
18
  * The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
19
- * @export
20
- * @enum {string}
21
19
  */
22
20
 
23
21
  export const BusinessEntityTypeEnum = {