bandwidth-sdk 8.0.0 → 8.1.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 (318) 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 -2
  5. package/README.md +28 -1
  6. package/api/endpoints-api.ts +519 -0
  7. package/api.ts +1 -0
  8. package/bandwidth.yml +944 -19
  9. package/base.ts +30 -0
  10. package/configuration.ts +1 -1
  11. package/coverage/clover.xml +815 -611
  12. package/coverage/coverage-final.json +95 -87
  13. package/coverage/lcov-report/index.html +38 -38
  14. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
  15. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
  16. package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1642 -0
  17. package/coverage/lcov-report/node-sdk/api/index.html +24 -9
  18. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
  19. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
  20. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
  21. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +10 -10
  22. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +12 -12
  23. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
  24. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
  25. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +18 -18
  26. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
  27. package/coverage/lcov-report/node-sdk/api.ts.html +18 -15
  28. package/coverage/lcov-report/node-sdk/base.ts.html +104 -14
  29. package/coverage/lcov-report/node-sdk/common.ts.html +39 -39
  30. package/coverage/lcov-report/node-sdk/configuration.ts.html +26 -26
  31. package/coverage/lcov-report/node-sdk/index.html +7 -7
  32. package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -2
  33. package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
  34. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
  35. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +23 -23
  36. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
  37. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
  38. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +13 -13
  39. package/coverage/lcov-report/node-sdk/models/bxml/index.html +15 -15
  40. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +184 -0
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +142 -0
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
  68. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
  69. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
  70. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
  71. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +38 -8
  72. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +39 -33
  73. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  74. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
  75. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
  76. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
  77. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
  78. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -2
  79. package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +2 -2
  80. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
  81. package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +2 -2
  82. package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +163 -0
  83. package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +166 -0
  84. package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +163 -0
  85. package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +163 -0
  86. package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +160 -0
  87. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
  88. package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +2 -2
  89. package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +3 -3
  90. package/coverage/lcov-report/node-sdk/models/index.html +80 -5
  91. package/coverage/lcov-report/node-sdk/models/index.ts.html +247 -181
  92. package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +2 -2
  93. package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +2 -2
  94. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
  95. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
  96. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
  97. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
  98. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
  99. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -2
  100. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  101. package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -2
  102. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -2
  103. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -2
  104. package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +3 -3
  105. package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +3 -3
  106. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
  107. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
  108. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -2
  109. package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -2
  110. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
  111. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -2
  112. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -2
  113. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
  114. package/coverage/lcov.info +1234 -761
  115. package/custom_templates/modelAllOf.mustache +14 -0
  116. package/dist/api/endpoints-api.d.ts +236 -0
  117. package/dist/api/endpoints-api.js +666 -0
  118. package/dist/api.d.ts +1 -0
  119. package/dist/api.js +1 -0
  120. package/dist/base.js +30 -0
  121. package/dist/configuration.js +1 -1
  122. package/dist/models/brtc-error-response.d.ts +18 -0
  123. package/dist/models/brtc-error-source.d.ts +29 -0
  124. package/dist/models/brtc-error-source.js +15 -0
  125. package/dist/models/brtc-error.d.ts +31 -0
  126. package/dist/models/brtc-error.js +15 -0
  127. package/dist/models/brtc-link.d.ts +25 -0
  128. package/dist/models/brtc-link.js +15 -0
  129. package/dist/models/bxml/verbs/Connect.d.ts +25 -0
  130. package/dist/models/bxml/verbs/Connect.js +45 -0
  131. package/dist/models/bxml/verbs/Endpoint.d.ts +15 -0
  132. package/dist/models/bxml/verbs/Endpoint.js +37 -0
  133. package/dist/models/bxml/verbs/index.d.ts +2 -0
  134. package/dist/models/bxml/verbs/index.js +2 -0
  135. package/dist/models/create-call.d.ts +2 -2
  136. package/dist/models/create-endpoint-request-base.d.ts +29 -0
  137. package/dist/models/create-endpoint-request-base.js +15 -0
  138. package/dist/models/create-endpoint-response-data.d.ts +42 -0
  139. package/dist/models/create-endpoint-response-data.js +15 -0
  140. package/dist/models/create-endpoint-response.d.ts +19 -0
  141. package/dist/models/create-endpoint-response.js +15 -0
  142. package/dist/models/create-web-rtc-connection-request.d.ts +33 -0
  143. package/dist/models/create-web-rtc-connection-request.js +15 -0
  144. package/dist/models/device-status-enum.d.ts +16 -0
  145. package/dist/models/device-status-enum.js +20 -0
  146. package/dist/models/device.d.ts +27 -0
  147. package/dist/models/device.js +15 -0
  148. package/dist/models/endpoint-direction-enum.d.ts +17 -0
  149. package/dist/models/endpoint-direction-enum.js +21 -0
  150. package/dist/models/endpoint-event-type-enum.d.ts +16 -0
  151. package/dist/models/endpoint-event-type-enum.js +20 -0
  152. package/dist/models/endpoint-event.d.ts +45 -0
  153. package/dist/models/endpoint-event.js +15 -0
  154. package/dist/models/endpoint-response.d.ts +19 -0
  155. package/dist/models/endpoint-response.js +15 -0
  156. package/dist/models/endpoint-status-enum.d.ts +16 -0
  157. package/dist/models/endpoint-status-enum.js +20 -0
  158. package/dist/models/endpoint-type-enum.d.ts +15 -0
  159. package/dist/models/endpoint-type-enum.js +19 -0
  160. package/dist/models/endpoint.d.ts +38 -0
  161. package/dist/models/endpoint.js +15 -0
  162. package/dist/models/endpoints.d.ts +33 -0
  163. package/dist/models/endpoints.js +15 -0
  164. package/dist/models/inbound-callback-message.d.ts +48 -2
  165. package/dist/models/inbound-callback-type-enum.d.ts +1 -1
  166. package/dist/models/inbound-callback-type-enum.js +1 -1
  167. package/dist/models/inbound-callback.d.ts +2 -2
  168. package/dist/models/index.d.ts +23 -1
  169. package/dist/models/index.js +23 -1
  170. package/dist/models/list-endpoints-response.d.ts +21 -0
  171. package/dist/models/list-endpoints-response.js +15 -0
  172. package/dist/models/lookup-result.d.ts +1 -1
  173. package/dist/models/machine-detection-configuration.d.ts +1 -1
  174. package/dist/models/message-request.d.ts +1 -1
  175. package/dist/models/multi-channel-action-calendar-event.d.ts +28 -2
  176. package/dist/models/multi-channel-channel-list-mmsobject.d.ts +14 -2
  177. package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +18 -3
  178. package/dist/models/multi-channel-channel-list-rbmobject.d.ts +14 -2
  179. package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +18 -3
  180. package/dist/models/multi-channel-channel-list-smsobject.d.ts +14 -2
  181. package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +18 -3
  182. package/dist/models/page.d.ts +29 -0
  183. package/dist/models/page.js +15 -0
  184. package/dist/models/rbm-action-dial.d.ts +16 -2
  185. package/dist/models/rbm-action-open-url.d.ts +20 -2
  186. package/dist/models/rbm-action-view-location.d.ts +24 -2
  187. package/dist/models/rbm-card-content-media.d.ts +12 -2
  188. package/dist/models/rbm-open-url-enum.d.ts +1 -1
  189. package/dist/models/rbm-open-url-enum.js +1 -1
  190. package/dist/models/rbm-web-view-enum.d.ts +1 -1
  191. package/dist/models/rbm-web-view-enum.js +1 -1
  192. package/dist/models/sip-connection-metadata.d.ts +27 -0
  193. package/dist/models/sip-connection-metadata.js +15 -0
  194. package/dist/models/sip-credentials.d.ts +21 -0
  195. package/dist/models/sip-credentials.js +15 -0
  196. package/dist/models/status-callback.d.ts +1 -1
  197. package/dist/models/sync-lookup-request.d.ts +4 -0
  198. package/dist/models/update-call.d.ts +1 -1
  199. package/dist/models/{model-error.d.ts → webhook-subscription-error.d.ts} +1 -1
  200. package/dist/models/webhook-subscription-error.js +15 -0
  201. package/dist/models/webhook-subscriptions-list-body.d.ts +2 -2
  202. package/docs/BrtcError.md +28 -0
  203. package/docs/BrtcErrorResponse.md +24 -0
  204. package/docs/BrtcErrorSource.md +26 -0
  205. package/docs/BrtcLink.md +24 -0
  206. package/docs/Callback.md +2 -2
  207. package/docs/CreateCall.md +2 -2
  208. package/docs/CreateEndpointRequestBase.md +28 -0
  209. package/docs/CreateEndpointResponse.md +24 -0
  210. package/docs/CreateEndpointResponseData.md +34 -0
  211. package/docs/CreateWebRtcConnectionRequest.md +30 -0
  212. package/docs/Device.md +26 -0
  213. package/docs/DeviceStatusEnum.md +10 -0
  214. package/docs/Endpoint.md +32 -0
  215. package/docs/EndpointDirectionEnum.md +12 -0
  216. package/docs/EndpointEvent.md +37 -0
  217. package/docs/EndpointEventTypeEnum.md +10 -0
  218. package/docs/EndpointResponse.md +24 -0
  219. package/docs/EndpointStatusEnum.md +10 -0
  220. package/docs/EndpointTypeEnum.md +8 -0
  221. package/docs/Endpoints.md +30 -0
  222. package/docs/EndpointsApi.md +334 -0
  223. package/docs/InboundCallback.md +2 -2
  224. package/docs/InboundCallbackTypeEnum.md +1 -1
  225. package/docs/ListEndpointsResponse.md +26 -0
  226. package/docs/LookupResult.md +1 -1
  227. package/docs/MachineDetectionConfiguration.md +1 -1
  228. package/docs/MessageRequest.md +1 -1
  229. package/docs/Page.md +26 -0
  230. package/docs/RbmOpenUrlEnum.md +1 -1
  231. package/docs/RbmWebViewEnum.md +1 -1
  232. package/docs/SipConnectionMetadata.md +26 -0
  233. package/docs/SipCredentials.md +22 -0
  234. package/docs/StatusCallback.md +1 -1
  235. package/docs/SyncLookupRequest.md +2 -0
  236. package/docs/UpdateCall.md +1 -1
  237. package/docs/{Error.md → WebhookSubscriptionError.md} +3 -3
  238. package/docs/WebhookSubscriptionsListBody.md +1 -1
  239. package/models/brtc-error-response.ts +28 -0
  240. package/models/brtc-error-source.ts +35 -0
  241. package/models/brtc-error.ts +39 -0
  242. package/models/brtc-link.ts +31 -0
  243. package/models/bxml/verbs/Connect.ts +33 -0
  244. package/models/bxml/verbs/Endpoint.ts +19 -0
  245. package/models/bxml/verbs/index.ts +2 -0
  246. package/models/create-call.ts +2 -2
  247. package/models/create-endpoint-request-base.ts +41 -0
  248. package/models/create-endpoint-response-data.ts +58 -0
  249. package/models/create-endpoint-response.ts +31 -0
  250. package/models/create-web-rtc-connection-request.ts +47 -0
  251. package/models/device-status-enum.ts +26 -0
  252. package/models/device.ts +37 -0
  253. package/models/endpoint-direction-enum.ts +27 -0
  254. package/models/endpoint-event-type-enum.ts +26 -0
  255. package/models/endpoint-event.ts +63 -0
  256. package/models/endpoint-response.ts +31 -0
  257. package/models/endpoint-status-enum.ts +26 -0
  258. package/models/endpoint-type-enum.ts +25 -0
  259. package/models/endpoint.ts +54 -0
  260. package/models/endpoints.ts +45 -0
  261. package/models/inbound-callback-message.ts +42 -1
  262. package/models/inbound-callback-type-enum.ts +1 -1
  263. package/models/inbound-callback.ts +2 -2
  264. package/models/index.ts +23 -1
  265. package/models/list-endpoints-response.ts +35 -0
  266. package/models/lookup-result.ts +1 -1
  267. package/models/machine-detection-configuration.ts +1 -1
  268. package/models/message-request.ts +1 -1
  269. package/models/multi-channel-action-calendar-event.ts +27 -1
  270. package/models/multi-channel-channel-list-mmsobject.ts +12 -1
  271. package/models/multi-channel-channel-list-mmsresponse-object.ts +16 -1
  272. package/models/multi-channel-channel-list-rbmobject.ts +12 -1
  273. package/models/multi-channel-channel-list-rbmresponse-object.ts +16 -1
  274. package/models/multi-channel-channel-list-smsobject.ts +12 -1
  275. package/models/multi-channel-channel-list-smsresponse-object.ts +16 -1
  276. package/models/page.ts +35 -0
  277. package/models/rbm-action-dial.ts +15 -1
  278. package/models/rbm-action-open-url.ts +17 -1
  279. package/models/rbm-action-view-location.ts +23 -1
  280. package/models/rbm-card-content-media.ts +11 -1
  281. package/models/rbm-open-url-enum.ts +1 -1
  282. package/models/rbm-web-view-enum.ts +1 -1
  283. package/models/sip-connection-metadata.ts +35 -0
  284. package/models/sip-credentials.ts +27 -0
  285. package/models/status-callback.ts +1 -1
  286. package/models/sync-lookup-request.ts +4 -0
  287. package/models/update-call.ts +1 -1
  288. package/models/{model-error.ts → webhook-subscription-error.ts} +1 -1
  289. package/models/webhook-subscriptions-list-body.ts +3 -3
  290. package/package.json +1 -1
  291. package/tests/smoke/endpoints-api.test.ts +141 -0
  292. package/tests/unit/api/endpoints-api.test.ts +106 -0
  293. package/tests/unit/api/phone-number-lookup-api.test.ts +4 -1
  294. package/tests/unit/models/brtc-error-response.test.ts +50 -0
  295. package/tests/unit/models/brtc-error-source.test.ts +17 -0
  296. package/tests/unit/models/brtc-error.test.ts +30 -0
  297. package/tests/unit/models/brtc-link.test.ts +15 -0
  298. package/tests/unit/models/bxml/verbs/Connect.test.ts +47 -0
  299. package/tests/unit/models/bxml/verbs/Endpoint.test.ts +12 -0
  300. package/tests/unit/models/create-endpoint-request-base.test.ts +21 -0
  301. package/tests/unit/models/create-endpoint-response-data.test.ts +44 -0
  302. package/tests/unit/models/create-endpoint-response.test.ts +86 -0
  303. package/tests/unit/models/create-web-rtc-connection-request.test.ts +21 -0
  304. package/tests/unit/models/device-status-enum.test.ts +12 -0
  305. package/tests/unit/models/device.test.ts +19 -0
  306. package/tests/unit/models/endpoint-direction-enum.test.ts +14 -0
  307. package/tests/unit/models/endpoint-event-type-enum.test.ts +12 -0
  308. package/tests/unit/models/endpoint-event.test.ts +44 -0
  309. package/tests/unit/models/endpoint-response.test.ts +84 -0
  310. package/tests/unit/models/endpoint-status-enum.test.ts +12 -0
  311. package/tests/unit/models/endpoint-type-enum.test.ts +10 -0
  312. package/tests/unit/models/endpoint.test.ts +50 -0
  313. package/tests/unit/models/endpoints.test.ts +25 -0
  314. package/tests/unit/models/list-endpoints-response.test.ts +94 -0
  315. package/tests/unit/models/page.test.ts +17 -0
  316. package/tests/unit/models/sip-connection-metadata.test.ts +25 -0
  317. package/tests/unit/models/sip-credentials.test.ts +13 -0
  318. /package/dist/models/{model-error.js → brtc-error-response.js} +0 -0
@@ -0,0 +1,26 @@
1
+ # BrtcErrorSource
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **parameter** | **string** | The URI parameter that caused the error. | [optional] [default to undefined]
9
+ **field** | **string** | The request body field that caused the error. | [optional] [default to undefined]
10
+ **header** | **string** | The header that caused the error. | [optional] [default to undefined]
11
+ **reference** | **string** | The resource ID or path to the resource (or non-existent resource) causing the error. | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { BrtcErrorSource } from 'bandwidth-sdk';
17
+
18
+ const instance: BrtcErrorSource = {
19
+ parameter,
20
+ field,
21
+ header,
22
+ reference,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # BrtcLink
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **href** | **string** | The full URL of the link. | [optional] [default to undefined]
9
+ **rel** | **string** | The relationship of the link to the current resource. | [optional] [default to undefined]
10
+ **method** | **string** | The HTTP method to use when making the request. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { BrtcLink } from 'bandwidth-sdk';
16
+
17
+ const instance: BrtcLink = {
18
+ href,
19
+ rel,
20
+ method,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Callback.md CHANGED
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
9
9
  **time** | **string** | | [default to undefined]
10
10
  **eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined]
11
11
  **type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
12
- **to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
12
+ **to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
13
13
  **description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
14
14
  **message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
15
15
  **errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined]
16
- **carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
16
+ **carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
17
17
 
18
18
  ## Example
19
19
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **to** | **string** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | [default to undefined]
9
9
  **from** | **string** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | [default to undefined]
10
10
  **privacy** | **boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] [default to undefined]
11
- **displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] [default to undefined]
11
+ **displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] [default to undefined]
12
12
  **uui** | **string** | A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] [default to undefined]
13
13
  **applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined]
14
14
  **answerUrl** | **string** | The full URL to send the <a href=\'/docs/voice/webhooks/answer\'>Answer</a> event to when the called party answers. This endpoint should return the first <a href=\'/docs/voice/bxml\'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | [default to undefined]
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
25
25
  **callbackTimeout** | **number** | This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. | [optional] [default to 15]
26
26
  **machineDetection** | [**MachineDetectionConfiguration**](MachineDetectionConfiguration.md) | | [optional] [default to undefined]
27
27
  **priority** | **number** | The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. | [optional] [default to 5]
28
- **tag** | **string** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href=\'/docs/voice/bxml/tag\'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=\"\"` Max length 256 characters. | [optional] [default to undefined]
28
+ **tag** | **string** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href=\'/docs/voice/bxml/tag\'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=\"\"` Max length 4096 characters. | [optional] [default to undefined]
29
29
 
30
30
  ## Example
31
31
 
@@ -0,0 +1,28 @@
1
+ # CreateEndpointRequestBase
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
9
+ **direction** | [**EndpointDirectionEnum**](EndpointDirectionEnum.md) | | [default to undefined]
10
+ **eventCallbackUrl** | **string** | The URL to send event callbacks to. | [optional] [default to undefined]
11
+ **eventFallbackUrl** | **string** | The URL to send event fallbacks to. | [optional] [default to undefined]
12
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { CreateEndpointRequestBase } from 'bandwidth-sdk';
18
+
19
+ const instance: CreateEndpointRequestBase = {
20
+ type,
21
+ direction,
22
+ eventCallbackUrl,
23
+ eventFallbackUrl,
24
+ tag,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # CreateEndpointResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **links** | [**Array<BrtcLink>**](BrtcLink.md) | | [default to undefined]
9
+ **data** | [**CreateEndpointResponseData**](CreateEndpointResponseData.md) | | [default to undefined]
10
+ **errors** | [**Array<BrtcError>**](BrtcError.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateEndpointResponse } from 'bandwidth-sdk';
16
+
17
+ const instance: CreateEndpointResponse = {
18
+ links,
19
+ data,
20
+ errors,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # CreateEndpointResponseData
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **endpointId** | **string** | The unique ID of the endpoint. | [default to undefined]
9
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
10
+ **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) | | [default to undefined]
11
+ **creationTimestamp** | **string** | The time the endpoint was created. In ISO-8601 format. | [default to undefined]
12
+ **expirationTimestamp** | **string** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | [default to undefined]
13
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
14
+ **devices** | [**Array<Device>**](Device.md) | | [optional] [default to undefined]
15
+ **token** | **string** | The json web token specific to the endpoint. Used to authenticate the client with the media gateway. | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CreateEndpointResponseData } from 'bandwidth-sdk';
21
+
22
+ const instance: CreateEndpointResponseData = {
23
+ endpointId,
24
+ type,
25
+ status,
26
+ creationTimestamp,
27
+ expirationTimestamp,
28
+ tag,
29
+ devices,
30
+ token,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,30 @@
1
+ # CreateWebRtcConnectionRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
9
+ **direction** | [**EndpointDirectionEnum**](EndpointDirectionEnum.md) | | [default to undefined]
10
+ **eventCallbackUrl** | **string** | The URL to send event callbacks to. | [optional] [default to undefined]
11
+ **eventFallbackUrl** | **string** | The URL to send event fallbacks to. | [optional] [default to undefined]
12
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
13
+ **connectionMetadata** | **object** | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { CreateWebRtcConnectionRequest } from 'bandwidth-sdk';
19
+
20
+ const instance: CreateWebRtcConnectionRequest = {
21
+ type,
22
+ direction,
23
+ eventCallbackUrl,
24
+ eventFallbackUrl,
25
+ tag,
26
+ connectionMetadata,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Device.md ADDED
@@ -0,0 +1,26 @@
1
+ # Device
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **deviceId** | **string** | The unique ID of the device. | [default to undefined]
9
+ **deviceName** | **string** | The name of the device. | [optional] [default to undefined]
10
+ **status** | [**DeviceStatusEnum**](DeviceStatusEnum.md) | | [default to undefined]
11
+ **creationTimestamp** | **string** | The time the device was created. In ISO-8601 format. | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { Device } from 'bandwidth-sdk';
17
+
18
+ const instance: Device = {
19
+ deviceId,
20
+ deviceName,
21
+ status,
22
+ creationTimestamp,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,10 @@
1
+ # DeviceStatusEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Connected` (value: `'CONNECTED'`)
7
+
8
+ * `Disconnected` (value: `'DISCONNECTED'`)
9
+
10
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # Endpoint
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **endpointId** | **string** | The unique ID of the endpoint. | [default to undefined]
9
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
10
+ **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) | | [default to undefined]
11
+ **creationTimestamp** | **string** | The time the endpoint was created. In ISO-8601 format. | [default to undefined]
12
+ **expirationTimestamp** | **string** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | [default to undefined]
13
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
14
+ **devices** | [**Array<Device>**](Device.md) | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { Endpoint } from 'bandwidth-sdk';
20
+
21
+ const instance: Endpoint = {
22
+ endpointId,
23
+ type,
24
+ status,
25
+ creationTimestamp,
26
+ expirationTimestamp,
27
+ tag,
28
+ devices,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # EndpointDirectionEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Inbound` (value: `'INBOUND'`)
7
+
8
+ * `Outbound` (value: `'OUTBOUND'`)
9
+
10
+ * `Bidirectional` (value: `'BIDIRECTIONAL'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,37 @@
1
+ # EndpointEvent
2
+
3
+ An event that occurred on an endpoint.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **endpointId** | **string** | The unique ID of the endpoint. | [default to undefined]
10
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
11
+ **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) | | [default to undefined]
12
+ **creationTimestamp** | **string** | The time the endpoint was created. In ISO-8601 format. | [default to undefined]
13
+ **expirationTimestamp** | **string** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | [default to undefined]
14
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
15
+ **eventTime** | **string** | The time the event occurred. In ISO-8601 format. | [default to undefined]
16
+ **eventType** | [**EndpointEventTypeEnum**](EndpointEventTypeEnum.md) | | [default to undefined]
17
+ **device** | [**Device**](Device.md) | | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { EndpointEvent } from 'bandwidth-sdk';
23
+
24
+ const instance: EndpointEvent = {
25
+ endpointId,
26
+ type,
27
+ status,
28
+ creationTimestamp,
29
+ expirationTimestamp,
30
+ tag,
31
+ eventTime,
32
+ eventType,
33
+ device,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,10 @@
1
+ # EndpointEventTypeEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `DeviceConnected` (value: `'DEVICE_CONNECTED'`)
7
+
8
+ * `DeviceDisconnected` (value: `'DEVICE_DISCONNECTED'`)
9
+
10
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # EndpointResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **links** | [**Array<BrtcLink>**](BrtcLink.md) | | [default to undefined]
9
+ **data** | [**Endpoint**](Endpoint.md) | | [default to undefined]
10
+ **errors** | [**Array<BrtcError>**](BrtcError.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { EndpointResponse } from 'bandwidth-sdk';
16
+
17
+ const instance: EndpointResponse = {
18
+ links,
19
+ data,
20
+ errors,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,10 @@
1
+ # EndpointStatusEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Connected` (value: `'CONNECTED'`)
7
+
8
+ * `Disconnected` (value: `'DISCONNECTED'`)
9
+
10
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,8 @@
1
+ # EndpointTypeEnum
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Webrtc` (value: `'WEBRTC'`)
7
+
8
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,30 @@
1
+ # Endpoints
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **endpointId** | **string** | The unique ID of the endpoint. | [default to undefined]
9
+ **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) | | [default to undefined]
10
+ **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) | | [default to undefined]
11
+ **creationTimestamp** | **string** | The time the endpoint was created. In ISO-8601 format. | [default to undefined]
12
+ **expirationTimestamp** | **string** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | [default to undefined]
13
+ **tag** | **string** | A tag for the endpoint. | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { Endpoints } from 'bandwidth-sdk';
19
+
20
+ const instance: Endpoints = {
21
+ endpointId,
22
+ type,
23
+ status,
24
+ creationTimestamp,
25
+ expirationTimestamp,
26
+ tag,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)