bandwidth-sdk 7.4.2 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (345) hide show
  1. package/.github/workflows/deploy.yml +1 -1
  2. package/.github/workflows/test-pr.yml +1 -1
  3. package/.github/workflows/test-smoke.yml +1 -1
  4. package/.openapi-generator/FILES +48 -4
  5. package/README.md +28 -2
  6. package/api/endpoints-api.ts +519 -0
  7. package/api/media-api.ts +4 -4
  8. package/api.ts +1 -0
  9. package/bandwidth.yml +972 -60
  10. package/base.ts +30 -0
  11. package/configuration.ts +1 -1
  12. package/coverage/clover.xml +815 -616
  13. package/coverage/coverage-final.json +95 -88
  14. package/coverage/lcov-report/index.html +38 -38
  15. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
  16. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
  17. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1642 -0
  18. package/coverage/lcov-report/node-sdk/api/index.html +24 -9
  19. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +17 -17
  20. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
  21. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
  22. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +10 -10
  23. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +12 -12
  24. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
  25. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
  26. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +18 -18
  27. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
  28. package/coverage/lcov-report/node-sdk/api.ts.html +18 -15
  29. package/coverage/lcov-report/node-sdk/base.ts.html +104 -14
  30. package/coverage/lcov-report/node-sdk/common.ts.html +39 -39
  31. package/coverage/lcov-report/node-sdk/configuration.ts.html +26 -26
  32. package/coverage/lcov-report/node-sdk/index.html +7 -7
  33. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +3 -3
  34. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +3 -3
  35. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
  36. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +23 -23
  37. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
  38. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
  39. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +13 -13
  40. package/coverage/lcov-report/node-sdk/models/bxml/index.html +15 -15
  41. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +184 -0
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +142 -0
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +38 -8
  73. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +39 -33
  74. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  75. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
  76. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
  77. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
  78. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
  79. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -2
  80. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +2 -2
  81. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
  82. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +2 -2
  83. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +163 -0
  84. package/coverage/lcov-report/node-sdk/models/{business-registration-issuing-country-enum.ts.html → endpoint-direction-enum.ts.html} +10 -61
  85. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +163 -0
  86. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +163 -0
  87. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +160 -0
  88. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
  89. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +2 -2
  90. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +3 -3
  91. package/coverage/lcov-report/node-sdk/models/index.html +76 -16
  92. package/coverage/lcov-report/node-sdk/models/index.ts.html +246 -183
  93. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +2 -2
  94. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +2 -2
  95. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
  96. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
  97. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
  98. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
  99. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
  100. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -2
  101. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  102. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -2
  103. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -2
  104. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -2
  105. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +3 -3
  106. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +3 -3
  107. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
  108. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
  109. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -2
  110. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -2
  111. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
  112. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -2
  113. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -2
  114. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
  115. package/coverage/lcov.info +1226 -764
  116. package/custom_templates/modelAllOf.mustache +14 -0
  117. package/dist/api/endpoints-api.d.ts +236 -0
  118. package/dist/api/endpoints-api.js +666 -0
  119. package/dist/api/media-api.d.ts +4 -4
  120. package/dist/api/media-api.js +4 -4
  121. package/dist/api.d.ts +1 -0
  122. package/dist/api.js +1 -0
  123. package/dist/base.js +30 -0
  124. package/dist/configuration.js +1 -1
  125. package/dist/models/brtc-error-response.d.ts +18 -0
  126. package/dist/models/brtc-error-source.d.ts +29 -0
  127. package/dist/models/brtc-error-source.js +15 -0
  128. package/dist/models/brtc-error.d.ts +31 -0
  129. package/dist/models/brtc-error.js +15 -0
  130. package/dist/models/brtc-link.d.ts +25 -0
  131. package/dist/models/brtc-link.js +15 -0
  132. package/dist/models/business-entity-type-enum.d.ts +1 -1
  133. package/dist/models/business-entity-type-enum.js +1 -1
  134. package/dist/models/business-registration-type-enum.d.ts +1 -1
  135. package/dist/models/business-registration-type-enum.js +1 -1
  136. package/dist/models/bxml/verbs/Connect.d.ts +25 -0
  137. package/dist/models/bxml/verbs/Connect.js +45 -0
  138. package/dist/models/bxml/verbs/Endpoint.d.ts +15 -0
  139. package/dist/models/bxml/verbs/Endpoint.js +37 -0
  140. package/dist/models/bxml/verbs/index.d.ts +2 -0
  141. package/dist/models/bxml/verbs/index.js +2 -0
  142. package/dist/models/create-call.d.ts +2 -2
  143. package/dist/models/create-endpoint-request-base.d.ts +29 -0
  144. package/dist/models/create-endpoint-request-base.js +15 -0
  145. package/dist/models/create-endpoint-response-data.d.ts +42 -0
  146. package/dist/models/create-endpoint-response-data.js +15 -0
  147. package/dist/models/create-endpoint-response.d.ts +19 -0
  148. package/dist/models/create-endpoint-response.js +15 -0
  149. package/dist/models/create-web-rtc-connection-request.d.ts +33 -0
  150. package/dist/models/create-web-rtc-connection-request.js +15 -0
  151. package/dist/models/device-status-enum.d.ts +16 -0
  152. package/dist/models/device-status-enum.js +20 -0
  153. package/dist/models/device.d.ts +27 -0
  154. package/dist/models/device.js +15 -0
  155. package/dist/models/endpoint-direction-enum.d.ts +17 -0
  156. package/dist/models/endpoint-direction-enum.js +21 -0
  157. package/dist/models/endpoint-event-type-enum.d.ts +16 -0
  158. package/dist/models/endpoint-event-type-enum.js +20 -0
  159. package/dist/models/endpoint-event.d.ts +45 -0
  160. package/dist/models/endpoint-event.js +15 -0
  161. package/dist/models/endpoint-response.d.ts +19 -0
  162. package/dist/models/endpoint-response.js +15 -0
  163. package/dist/models/endpoint-status-enum.d.ts +16 -0
  164. package/dist/models/endpoint-status-enum.js +20 -0
  165. package/dist/models/endpoint-type-enum.d.ts +15 -0
  166. package/dist/models/endpoint-type-enum.js +19 -0
  167. package/dist/models/endpoint.d.ts +38 -0
  168. package/dist/models/endpoint.js +15 -0
  169. package/dist/models/endpoints.d.ts +33 -0
  170. package/dist/models/endpoints.js +15 -0
  171. package/dist/models/inbound-callback-message.d.ts +48 -2
  172. package/dist/models/inbound-callback-type-enum.d.ts +1 -1
  173. package/dist/models/inbound-callback-type-enum.js +1 -1
  174. package/dist/models/inbound-callback.d.ts +2 -2
  175. package/dist/models/index.d.ts +23 -2
  176. package/dist/models/index.js +23 -2
  177. package/dist/models/list-endpoints-response.d.ts +21 -0
  178. package/dist/models/list-endpoints-response.js +15 -0
  179. package/dist/models/lookup-result.d.ts +1 -1
  180. package/dist/models/machine-detection-configuration.d.ts +1 -1
  181. package/dist/models/message-request.d.ts +1 -1
  182. package/dist/models/mms-message-content-file.d.ts +1 -1
  183. package/dist/models/multi-channel-action-calendar-event.d.ts +28 -2
  184. package/dist/models/multi-channel-channel-list-mmsobject.d.ts +14 -2
  185. package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +18 -3
  186. package/dist/models/multi-channel-channel-list-rbmobject.d.ts +14 -2
  187. package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +18 -3
  188. package/dist/models/multi-channel-channel-list-smsobject.d.ts +14 -2
  189. package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +18 -3
  190. package/dist/models/page.d.ts +29 -0
  191. package/dist/models/page.js +15 -0
  192. package/dist/models/rbm-action-dial.d.ts +16 -2
  193. package/dist/models/rbm-action-open-url.d.ts +20 -2
  194. package/dist/models/rbm-action-view-location.d.ts +24 -2
  195. package/dist/models/rbm-card-content-media.d.ts +12 -2
  196. package/dist/models/rbm-open-url-enum.d.ts +1 -1
  197. package/dist/models/rbm-open-url-enum.js +1 -1
  198. package/dist/models/rbm-web-view-enum.d.ts +1 -1
  199. package/dist/models/rbm-web-view-enum.js +1 -1
  200. package/dist/models/sip-connection-metadata.d.ts +27 -0
  201. package/dist/models/sip-connection-metadata.js +15 -0
  202. package/dist/models/sip-credentials.d.ts +21 -0
  203. package/dist/models/sip-credentials.js +15 -0
  204. package/dist/models/status-callback.d.ts +1 -1
  205. package/dist/models/tfv-submission-info.d.ts +5 -3
  206. package/dist/models/update-call.d.ts +1 -1
  207. package/dist/models/verification-request.d.ts +5 -3
  208. package/dist/models/verification-update-request.d.ts +5 -3
  209. package/dist/models/{model-error.d.ts → webhook-subscription-error.d.ts} +1 -1
  210. package/dist/models/webhook-subscription-error.js +15 -0
  211. package/dist/models/webhook-subscriptions-list-body.d.ts +2 -2
  212. package/docs/BrtcError.md +28 -0
  213. package/docs/BrtcErrorResponse.md +24 -0
  214. package/docs/BrtcErrorSource.md +26 -0
  215. package/docs/BrtcLink.md +24 -0
  216. package/docs/BusinessEntityTypeEnum.md +1 -1
  217. package/docs/BusinessRegistrationTypeEnum.md +1 -1
  218. package/docs/Callback.md +2 -2
  219. package/docs/CreateCall.md +2 -2
  220. package/docs/CreateEndpointRequestBase.md +28 -0
  221. package/docs/CreateEndpointResponse.md +24 -0
  222. package/docs/CreateEndpointResponseData.md +34 -0
  223. package/docs/CreateWebRtcConnectionRequest.md +30 -0
  224. package/docs/Device.md +26 -0
  225. package/docs/DeviceStatusEnum.md +10 -0
  226. package/docs/Endpoint.md +32 -0
  227. package/docs/EndpointDirectionEnum.md +12 -0
  228. package/docs/EndpointEvent.md +37 -0
  229. package/docs/EndpointEventTypeEnum.md +10 -0
  230. package/docs/EndpointResponse.md +24 -0
  231. package/docs/EndpointStatusEnum.md +10 -0
  232. package/docs/EndpointTypeEnum.md +8 -0
  233. package/docs/Endpoints.md +30 -0
  234. package/docs/EndpointsApi.md +334 -0
  235. package/docs/InboundCallback.md +2 -2
  236. package/docs/InboundCallbackTypeEnum.md +1 -1
  237. package/docs/ListEndpointsResponse.md +26 -0
  238. package/docs/LookupResult.md +1 -1
  239. package/docs/MachineDetectionConfiguration.md +1 -1
  240. package/docs/MediaApi.md +1 -1
  241. package/docs/MessageRequest.md +1 -1
  242. package/docs/MmsMessageContentFile.md +1 -1
  243. package/docs/Page.md +26 -0
  244. package/docs/RbmOpenUrlEnum.md +1 -1
  245. package/docs/RbmWebViewEnum.md +1 -1
  246. package/docs/SipConnectionMetadata.md +26 -0
  247. package/docs/SipCredentials.md +22 -0
  248. package/docs/StatusCallback.md +1 -1
  249. package/docs/TfvSubmissionInfo.md +2 -2
  250. package/docs/UpdateCall.md +1 -1
  251. package/docs/VerificationRequest.md +2 -2
  252. package/docs/VerificationUpdateRequest.md +2 -2
  253. package/docs/{Error.md → WebhookSubscriptionError.md} +3 -3
  254. package/docs/WebhookSubscriptionsListBody.md +1 -1
  255. package/models/brtc-error-response.ts +28 -0
  256. package/models/brtc-error-source.ts +35 -0
  257. package/models/brtc-error.ts +39 -0
  258. package/models/brtc-link.ts +31 -0
  259. package/models/business-entity-type-enum.ts +1 -1
  260. package/models/business-registration-type-enum.ts +1 -1
  261. package/models/bxml/verbs/Connect.ts +33 -0
  262. package/models/bxml/verbs/Endpoint.ts +19 -0
  263. package/models/bxml/verbs/index.ts +2 -0
  264. package/models/create-call.ts +2 -2
  265. package/models/create-endpoint-request-base.ts +41 -0
  266. package/models/create-endpoint-response-data.ts +58 -0
  267. package/models/create-endpoint-response.ts +31 -0
  268. package/models/create-web-rtc-connection-request.ts +47 -0
  269. package/models/device-status-enum.ts +26 -0
  270. package/models/device.ts +37 -0
  271. package/models/endpoint-direction-enum.ts +27 -0
  272. package/models/endpoint-event-type-enum.ts +26 -0
  273. package/models/endpoint-event.ts +63 -0
  274. package/models/endpoint-response.ts +31 -0
  275. package/models/endpoint-status-enum.ts +26 -0
  276. package/models/endpoint-type-enum.ts +25 -0
  277. package/models/endpoint.ts +54 -0
  278. package/models/endpoints.ts +45 -0
  279. package/models/inbound-callback-message.ts +42 -1
  280. package/models/inbound-callback-type-enum.ts +1 -1
  281. package/models/inbound-callback.ts +2 -2
  282. package/models/index.ts +23 -2
  283. package/models/list-endpoints-response.ts +35 -0
  284. package/models/lookup-result.ts +1 -1
  285. package/models/machine-detection-configuration.ts +1 -1
  286. package/models/message-request.ts +1 -1
  287. package/models/mms-message-content-file.ts +1 -1
  288. package/models/multi-channel-action-calendar-event.ts +27 -1
  289. package/models/multi-channel-channel-list-mmsobject.ts +12 -1
  290. package/models/multi-channel-channel-list-mmsresponse-object.ts +16 -1
  291. package/models/multi-channel-channel-list-rbmobject.ts +12 -1
  292. package/models/multi-channel-channel-list-rbmresponse-object.ts +16 -1
  293. package/models/multi-channel-channel-list-smsobject.ts +12 -1
  294. package/models/multi-channel-channel-list-smsresponse-object.ts +16 -1
  295. package/models/page.ts +35 -0
  296. package/models/rbm-action-dial.ts +15 -1
  297. package/models/rbm-action-open-url.ts +17 -1
  298. package/models/rbm-action-view-location.ts +23 -1
  299. package/models/rbm-card-content-media.ts +11 -1
  300. package/models/rbm-open-url-enum.ts +1 -1
  301. package/models/rbm-web-view-enum.ts +1 -1
  302. package/models/sip-connection-metadata.ts +35 -0
  303. package/models/sip-credentials.ts +27 -0
  304. package/models/status-callback.ts +1 -1
  305. package/models/tfv-submission-info.ts +5 -5
  306. package/models/update-call.ts +1 -1
  307. package/models/verification-request.ts +5 -5
  308. package/models/verification-update-request.ts +5 -5
  309. package/models/{model-error.ts → webhook-subscription-error.ts} +1 -1
  310. package/models/webhook-subscriptions-list-body.ts +3 -3
  311. package/package.json +1 -1
  312. package/tests/smoke/endpoints-api.test.ts +141 -0
  313. package/tests/smoke/phone-number-lookup-api.test.ts +2 -10
  314. package/tests/unit/api/endpoints-api.test.ts +106 -0
  315. package/tests/unit/api/toll-free-verification-api.test.ts +1 -1
  316. package/tests/unit/models/brtc-error-response.test.ts +50 -0
  317. package/tests/unit/models/brtc-error-source.test.ts +17 -0
  318. package/tests/unit/models/brtc-error.test.ts +30 -0
  319. package/tests/unit/models/brtc-link.test.ts +15 -0
  320. package/tests/unit/models/bxml/verbs/Connect.test.ts +47 -0
  321. package/tests/unit/models/bxml/verbs/Endpoint.test.ts +12 -0
  322. package/tests/unit/models/create-endpoint-request-base.test.ts +21 -0
  323. package/tests/unit/models/create-endpoint-response-data.test.ts +44 -0
  324. package/tests/unit/models/create-endpoint-response.test.ts +86 -0
  325. package/tests/unit/models/create-web-rtc-connection-request.test.ts +21 -0
  326. package/tests/unit/models/device-status-enum.test.ts +12 -0
  327. package/tests/unit/models/device.test.ts +19 -0
  328. package/tests/unit/models/endpoint-direction-enum.test.ts +14 -0
  329. package/tests/unit/models/endpoint-event-type-enum.test.ts +12 -0
  330. package/tests/unit/models/endpoint-event.test.ts +44 -0
  331. package/tests/unit/models/endpoint-response.test.ts +84 -0
  332. package/tests/unit/models/endpoint-status-enum.test.ts +12 -0
  333. package/tests/unit/models/endpoint-type-enum.test.ts +10 -0
  334. package/tests/unit/models/endpoint.test.ts +50 -0
  335. package/tests/unit/models/endpoints.test.ts +25 -0
  336. package/tests/unit/models/list-endpoints-response.test.ts +94 -0
  337. package/tests/unit/models/page.test.ts +17 -0
  338. package/tests/unit/models/sip-connection-metadata.test.ts +25 -0
  339. package/tests/unit/models/sip-credentials.test.ts +13 -0
  340. package/dist/models/business-registration-issuing-country-enum.d.ts +0 -34
  341. package/dist/models/business-registration-issuing-country-enum.js +0 -38
  342. package/docs/BusinessRegistrationIssuingCountryEnum.md +0 -41
  343. package/models/business-registration-issuing-country-enum.ts +0 -44
  344. package/tests/unit/models/business-registration-issuing-country-enum.test.ts +0 -23
  345. /package/dist/models/{model-error.js → brtc-error-response.js} +0 -0
@@ -0,0 +1,25 @@
1
+ import { Endpoints } from '../../../models/endpoints';
2
+ import { EndpointStatusEnum } from '../../../models/endpoint-status-enum';
3
+ import { EndpointTypeEnum } from '../../../models/endpoint-type-enum';
4
+
5
+ describe('Endpoints', () => {
6
+ test('should create an endpoints object with all fields', () => {
7
+ const endpoint: Endpoints = {
8
+ endpointId: 'ep-123456',
9
+ type: EndpointTypeEnum.Webrtc,
10
+ status: EndpointStatusEnum.Connected,
11
+ creationTimestamp: '2024-02-18T10:30:00Z',
12
+ expirationTimestamp: '2024-02-19T10:30:00Z',
13
+ tag: 'test-endpoint'
14
+ };
15
+
16
+ expect(endpoint.endpointId).toBe('ep-123456');
17
+ expect(endpoint.type).toBe('WEBRTC');
18
+ expect(endpoint.status).toBe('CONNECTED');
19
+ expect(new Date(endpoint.creationTimestamp).getFullYear()).toBe(2024);
20
+ expect(new Date(endpoint.creationTimestamp).toISOString()).toBe('2024-02-18T10:30:00.000Z');
21
+ expect(new Date(endpoint.expirationTimestamp).getFullYear()).toBe(2024);
22
+ expect(new Date(endpoint.expirationTimestamp).toISOString()).toBe('2024-02-19T10:30:00.000Z');
23
+ expect(endpoint.tag).toBe('test-endpoint');
24
+ });
25
+ });
@@ -0,0 +1,94 @@
1
+ import { ListEndpointsResponse } from '../../../models/list-endpoints-response';
2
+ import { Endpoints } from '../../../models/endpoints';
3
+ import { EndpointStatusEnum } from '../../../models/endpoint-status-enum';
4
+ import { EndpointTypeEnum } from '../../../models/endpoint-type-enum';
5
+ import { BrtcLink } from '../../../models/brtc-link';
6
+ import { BrtcError } from '../../../models/brtc-error';
7
+ import { BrtcErrorSource } from '../../../models/brtc-error-source';
8
+ import { Page } from '../../../models/page';
9
+
10
+ describe('ListEndpointsResponse', () => {
11
+ test('should create a list endpoints response with all fields', () => {
12
+ const link: BrtcLink = {
13
+ href: 'http://api.example.com/endpoints?page=1',
14
+ rel: 'self',
15
+ method: 'GET'
16
+ };
17
+
18
+ const page: Page = {
19
+ pageSize: 10,
20
+ pageNumber: 1,
21
+ totalPages: 5,
22
+ totalElements: 47
23
+ };
24
+
25
+ const endpoints: Endpoints[] = [
26
+ {
27
+ endpointId: 'ep-001',
28
+ type: EndpointTypeEnum.Webrtc,
29
+ status: EndpointStatusEnum.Connected,
30
+ creationTimestamp: '2024-02-18T10:30:00Z',
31
+ expirationTimestamp: '2024-02-19T10:30:00Z',
32
+ tag: 'primary-endpoint'
33
+ },
34
+ {
35
+ endpointId: 'ep-002',
36
+ type: EndpointTypeEnum.Webrtc,
37
+ status: EndpointStatusEnum.Disconnected,
38
+ creationTimestamp: '2024-02-18T10:30:00Z',
39
+ expirationTimestamp: '2024-02-19T10:30:00Z'
40
+ }
41
+ ];
42
+
43
+ const source: BrtcErrorSource = {
44
+ parameter: 'page',
45
+ field: 'pageNumber',
46
+ header: 'Authorization',
47
+ reference: '/endpoints'
48
+ };
49
+
50
+ const error: BrtcError = {
51
+ id: 'err-500',
52
+ type: 'internal-error',
53
+ description: 'Internal server error',
54
+ code: '500',
55
+ source
56
+ };
57
+
58
+ const response: ListEndpointsResponse = {
59
+ links: [link],
60
+ page: page,
61
+ data: endpoints,
62
+ errors: [error]
63
+ };
64
+
65
+ expect(response.links).toHaveLength(1);
66
+ expect(response.links[0].href).toBe('http://api.example.com/endpoints?page=1');
67
+ expect(response.links[0].rel).toBe('self');
68
+ expect(response.links[0].method).toBe('GET');
69
+ expect(response.page).toBeDefined();
70
+ expect(response.page?.pageSize).toBe(10);
71
+ expect(response.page?.pageNumber).toBe(1);
72
+ expect(response.page?.totalPages).toBe(5);
73
+ expect(response.page?.totalElements).toBe(47);
74
+ expect(response.data).toHaveLength(2);
75
+ expect(response.data[0].endpointId).toBe('ep-001');
76
+ expect(response.data[0].tag).toBe('primary-endpoint');
77
+ expect(response.data[1].endpointId).toBe('ep-002');
78
+ expect(response.data[1].type).toBe(EndpointTypeEnum.Webrtc);
79
+ expect(response.data[1].status).toBe(EndpointStatusEnum.Disconnected);
80
+ expect(new Date(response.data[1].creationTimestamp).getFullYear()).toBe(2024);
81
+ expect(new Date(response.data[1].creationTimestamp).toISOString()).toBe('2024-02-18T10:30:00.000Z');
82
+ expect(new Date(response.data[1].expirationTimestamp).getFullYear()).toBe(2024);
83
+ expect(new Date(response.data[1].expirationTimestamp).toISOString()).toBe('2024-02-19T10:30:00.000Z');
84
+ expect(response.errors).toHaveLength(1);
85
+ expect(response.errors[0].id).toBe('err-500');
86
+ expect(response.errors[0].type).toBe('internal-error');
87
+ expect(response.errors[0].description).toBe('Internal server error');
88
+ expect(response.errors[0].code).toBe('500');
89
+ expect(response.errors[0].source?.parameter).toBe('page');
90
+ expect(response.errors[0].source?.field).toBe('pageNumber');
91
+ expect(response.errors[0].source?.header).toBe('Authorization');
92
+ expect(response.errors[0].source?.reference).toBe('/endpoints');
93
+ });
94
+ });
@@ -0,0 +1,17 @@
1
+ import { Page } from '../../../models/page';
2
+
3
+ describe('Page', () => {
4
+ test('should support full page shape', () => {
5
+ const page: Page = {
6
+ pageSize: 25,
7
+ totalElements: 100,
8
+ totalPages: 4,
9
+ pageNumber: 1
10
+ };
11
+
12
+ expect(page.pageSize).toBe(25);
13
+ expect(page.totalElements).toBe(100);
14
+ expect(page.totalPages).toBe(4);
15
+ expect(page.pageNumber).toBe(1);
16
+ });
17
+ });
@@ -0,0 +1,25 @@
1
+ import { SipConnectionMetadata } from '../../../models/sip-connection-metadata';
2
+ import { SipCredentials } from '../../../models/sip-credentials';
3
+
4
+ describe('SipConnectionMetadata', () => {
5
+ test('should support full SIP connection metadata shape', () => {
6
+ const credentials: SipCredentials = {
7
+ username: 'sip-user',
8
+ password: 'sip-pass'
9
+ };
10
+
11
+ const metadata: SipConnectionMetadata = {
12
+ ipAddress: '192.168.1.100',
13
+ port: 5060,
14
+ credentials,
15
+ uuiHeader: 'test-uui-header'
16
+ };
17
+
18
+ expect(metadata.ipAddress).toBe('192.168.1.100');
19
+ expect(metadata.port).toBe(5060);
20
+ expect(metadata.credentials).toBeDefined();
21
+ expect(metadata.credentials!.username).toBe('sip-user');
22
+ expect(metadata.credentials!.password).toBe('sip-pass');
23
+ expect(metadata.uuiHeader).toBe('test-uui-header');
24
+ });
25
+ });
@@ -0,0 +1,13 @@
1
+ import { SipCredentials } from '../../../models/sip-credentials';
2
+
3
+ describe('SipCredentials', () => {
4
+ test('should support full SIP credentials shape', () => {
5
+ const credentials: SipCredentials = {
6
+ username: 'sip-user',
7
+ password: 'sip-pass'
8
+ };
9
+
10
+ expect(credentials.username).toBe('sip-user');
11
+ expect(credentials.password).toBe('sip-pass');
12
+ });
13
+ });
@@ -1,34 +0,0 @@
1
- /**
2
- * Bandwidth
3
- * Bandwidth\'s Communication APIs
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- * Contact: letstalk@bandwidth.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
14
- */
15
- export declare const BusinessRegistrationIssuingCountryEnum: {
16
- readonly Usa: "USA";
17
- readonly Can: "CAN";
18
- readonly Hkg: "HKG";
19
- readonly Gbr: "GBR";
20
- readonly Irl: "IRL";
21
- readonly Bra: "BRA";
22
- readonly Nld: "NLD";
23
- readonly Aus: "AUS";
24
- readonly Fra: "FRA";
25
- readonly Nzl: "NZL";
26
- readonly Deu: "DEU";
27
- readonly Esp: "ESP";
28
- readonly Che: "CHE";
29
- readonly Cyp: "CYP";
30
- readonly Ind: "IND";
31
- readonly Chn: "CHN";
32
- readonly Bgr: "BGR";
33
- };
34
- export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum];
@@ -1,38 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Bandwidth
6
- * Bandwidth\'s Communication APIs
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- * Contact: letstalk@bandwidth.com
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.BusinessRegistrationIssuingCountryEnum = void 0;
17
- /**
18
- * The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
19
- */
20
- exports.BusinessRegistrationIssuingCountryEnum = {
21
- Usa: 'USA',
22
- Can: 'CAN',
23
- Hkg: 'HKG',
24
- Gbr: 'GBR',
25
- Irl: 'IRL',
26
- Bra: 'BRA',
27
- Nld: 'NLD',
28
- Aus: 'AUS',
29
- Fra: 'FRA',
30
- Nzl: 'NZL',
31
- Deu: 'DEU',
32
- Esp: 'ESP',
33
- Che: 'CHE',
34
- Cyp: 'CYP',
35
- Ind: 'IND',
36
- Chn: 'CHN',
37
- Bgr: 'BGR'
38
- };
@@ -1,41 +0,0 @@
1
- # BusinessRegistrationIssuingCountryEnum
2
-
3
- The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
4
-
5
- ## Enum
6
-
7
- * `Usa` (value: `'USA'`)
8
-
9
- * `Can` (value: `'CAN'`)
10
-
11
- * `Hkg` (value: `'HKG'`)
12
-
13
- * `Gbr` (value: `'GBR'`)
14
-
15
- * `Irl` (value: `'IRL'`)
16
-
17
- * `Bra` (value: `'BRA'`)
18
-
19
- * `Nld` (value: `'NLD'`)
20
-
21
- * `Aus` (value: `'AUS'`)
22
-
23
- * `Fra` (value: `'FRA'`)
24
-
25
- * `Nzl` (value: `'NZL'`)
26
-
27
- * `Deu` (value: `'DEU'`)
28
-
29
- * `Esp` (value: `'ESP'`)
30
-
31
- * `Che` (value: `'CHE'`)
32
-
33
- * `Cyp` (value: `'CYP'`)
34
-
35
- * `Ind` (value: `'IND'`)
36
-
37
- * `Chn` (value: `'CHN'`)
38
-
39
- * `Bgr` (value: `'BGR'`)
40
-
41
- [[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,44 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Bandwidth
5
- * Bandwidth\'s Communication APIs
6
- *
7
- * The version of the OpenAPI document: 1.0.0
8
- * Contact: letstalk@bandwidth.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
-
17
- /**
18
- * The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged. **Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`. | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
19
- */
20
-
21
- export const BusinessRegistrationIssuingCountryEnum = {
22
- Usa: 'USA',
23
- Can: 'CAN',
24
- Hkg: 'HKG',
25
- Gbr: 'GBR',
26
- Irl: 'IRL',
27
- Bra: 'BRA',
28
- Nld: 'NLD',
29
- Aus: 'AUS',
30
- Fra: 'FRA',
31
- Nzl: 'NZL',
32
- Deu: 'DEU',
33
- Esp: 'ESP',
34
- Che: 'CHE',
35
- Cyp: 'CYP',
36
- Ind: 'IND',
37
- Chn: 'CHN',
38
- Bgr: 'BGR'
39
- } as const;
40
-
41
- export type BusinessRegistrationIssuingCountryEnum = typeof BusinessRegistrationIssuingCountryEnum[keyof typeof BusinessRegistrationIssuingCountryEnum];
42
-
43
-
44
-
@@ -1,23 +0,0 @@
1
- import { BusinessRegistrationIssuingCountryEnum } from '../../../models/business-registration-issuing-country-enum';
2
-
3
- describe('BusinessRegistrationIssuingCountryEnum', () => {
4
- test('should define the expected values', () => {
5
- expect(BusinessRegistrationIssuingCountryEnum.Usa).toBe('USA');
6
- expect(BusinessRegistrationIssuingCountryEnum.Can).toBe('CAN');
7
- expect(BusinessRegistrationIssuingCountryEnum.Hkg).toBe('HKG');
8
- expect(BusinessRegistrationIssuingCountryEnum.Gbr).toBe('GBR');
9
- expect(BusinessRegistrationIssuingCountryEnum.Irl).toBe('IRL');
10
- expect(BusinessRegistrationIssuingCountryEnum.Bra).toBe('BRA');
11
- expect(BusinessRegistrationIssuingCountryEnum.Nld).toBe('NLD');
12
- expect(BusinessRegistrationIssuingCountryEnum.Aus).toBe('AUS');
13
- expect(BusinessRegistrationIssuingCountryEnum.Fra).toBe('FRA');
14
- expect(BusinessRegistrationIssuingCountryEnum.Nzl).toBe('NZL');
15
- expect(BusinessRegistrationIssuingCountryEnum.Deu).toBe('DEU');
16
- expect(BusinessRegistrationIssuingCountryEnum.Esp).toBe('ESP');
17
- expect(BusinessRegistrationIssuingCountryEnum.Che).toBe('CHE');
18
- expect(BusinessRegistrationIssuingCountryEnum.Cyp).toBe('CYP');
19
- expect(BusinessRegistrationIssuingCountryEnum.Ind).toBe('IND');
20
- expect(BusinessRegistrationIssuingCountryEnum.Chn).toBe('CHN');
21
- expect(BusinessRegistrationIssuingCountryEnum.Bgr).toBe('BGR');
22
- });
23
- });