bandwidth-sdk 8.0.0 → 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.
- package/.github/workflows/deploy.yml +1 -1
- package/.github/workflows/test-pr.yml +1 -1
- package/.github/workflows/test-smoke.yml +1 -1
- package/.openapi-generator/FILES +48 -2
- package/README.md +28 -1
- package/api/endpoints-api.ts +519 -0
- package/api.ts +1 -0
- package/bandwidth.yml +937 -19
- package/base.ts +30 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +815 -611
- package/coverage/coverage-final.json +95 -87
- package/coverage/lcov-report/index.html +38 -38
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1642 -0
- package/coverage/lcov-report/node-sdk/api/index.html +24 -9
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api.ts.html +18 -15
- package/coverage/lcov-report/node-sdk/base.ts.html +104 -14
- package/coverage/lcov-report/node-sdk/common.ts.html +39 -39
- package/coverage/lcov-report/node-sdk/configuration.ts.html +26 -26
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +23 -23
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +15 -15
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +184 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +142 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +38 -8
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +39 -33
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +166 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +160 -0
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/index.html +80 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +247 -181
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
- package/coverage/lcov.info +1234 -761
- package/custom_templates/modelAllOf.mustache +14 -0
- package/dist/api/endpoints-api.d.ts +236 -0
- package/dist/api/endpoints-api.js +666 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +30 -0
- package/dist/configuration.js +1 -1
- package/dist/models/brtc-error-response.d.ts +18 -0
- package/dist/models/brtc-error-source.d.ts +29 -0
- package/dist/models/brtc-error-source.js +15 -0
- package/dist/models/brtc-error.d.ts +31 -0
- package/dist/models/brtc-error.js +15 -0
- package/dist/models/brtc-link.d.ts +25 -0
- package/dist/models/brtc-link.js +15 -0
- package/dist/models/bxml/verbs/Connect.d.ts +25 -0
- package/dist/models/bxml/verbs/Connect.js +45 -0
- package/dist/models/bxml/verbs/Endpoint.d.ts +15 -0
- package/dist/models/bxml/verbs/Endpoint.js +37 -0
- package/dist/models/bxml/verbs/index.d.ts +2 -0
- package/dist/models/bxml/verbs/index.js +2 -0
- package/dist/models/create-call.d.ts +2 -2
- package/dist/models/create-endpoint-request-base.d.ts +29 -0
- package/dist/models/create-endpoint-request-base.js +15 -0
- package/dist/models/create-endpoint-response-data.d.ts +42 -0
- package/dist/models/create-endpoint-response-data.js +15 -0
- package/dist/models/create-endpoint-response.d.ts +19 -0
- package/dist/models/create-endpoint-response.js +15 -0
- package/dist/models/create-web-rtc-connection-request.d.ts +33 -0
- package/dist/models/create-web-rtc-connection-request.js +15 -0
- package/dist/models/device-status-enum.d.ts +16 -0
- package/dist/models/device-status-enum.js +20 -0
- package/dist/models/device.d.ts +27 -0
- package/dist/models/device.js +15 -0
- package/dist/models/endpoint-direction-enum.d.ts +17 -0
- package/dist/models/endpoint-direction-enum.js +21 -0
- package/dist/models/endpoint-event-type-enum.d.ts +16 -0
- package/dist/models/endpoint-event-type-enum.js +20 -0
- package/dist/models/endpoint-event.d.ts +45 -0
- package/dist/models/endpoint-event.js +15 -0
- package/dist/models/endpoint-response.d.ts +19 -0
- package/dist/models/endpoint-response.js +15 -0
- package/dist/models/endpoint-status-enum.d.ts +16 -0
- package/dist/models/endpoint-status-enum.js +20 -0
- package/dist/models/endpoint-type-enum.d.ts +15 -0
- package/dist/models/endpoint-type-enum.js +19 -0
- package/dist/models/endpoint.d.ts +38 -0
- package/dist/models/endpoint.js +15 -0
- package/dist/models/endpoints.d.ts +33 -0
- package/dist/models/endpoints.js +15 -0
- package/dist/models/inbound-callback-message.d.ts +48 -2
- package/dist/models/inbound-callback-type-enum.d.ts +1 -1
- package/dist/models/inbound-callback-type-enum.js +1 -1
- package/dist/models/inbound-callback.d.ts +2 -2
- package/dist/models/index.d.ts +23 -1
- package/dist/models/index.js +23 -1
- package/dist/models/list-endpoints-response.d.ts +21 -0
- package/dist/models/list-endpoints-response.js +15 -0
- package/dist/models/lookup-result.d.ts +1 -1
- package/dist/models/machine-detection-configuration.d.ts +1 -1
- package/dist/models/message-request.d.ts +1 -1
- package/dist/models/multi-channel-action-calendar-event.d.ts +28 -2
- package/dist/models/multi-channel-channel-list-mmsobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +18 -3
- package/dist/models/multi-channel-channel-list-rbmobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +18 -3
- package/dist/models/multi-channel-channel-list-smsobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +18 -3
- package/dist/models/page.d.ts +29 -0
- package/dist/models/page.js +15 -0
- package/dist/models/rbm-action-dial.d.ts +16 -2
- package/dist/models/rbm-action-open-url.d.ts +20 -2
- package/dist/models/rbm-action-view-location.d.ts +24 -2
- package/dist/models/rbm-card-content-media.d.ts +12 -2
- package/dist/models/rbm-open-url-enum.d.ts +1 -1
- package/dist/models/rbm-open-url-enum.js +1 -1
- package/dist/models/rbm-web-view-enum.d.ts +1 -1
- package/dist/models/rbm-web-view-enum.js +1 -1
- package/dist/models/sip-connection-metadata.d.ts +27 -0
- package/dist/models/sip-connection-metadata.js +15 -0
- package/dist/models/sip-credentials.d.ts +21 -0
- package/dist/models/sip-credentials.js +15 -0
- package/dist/models/status-callback.d.ts +1 -1
- package/dist/models/update-call.d.ts +1 -1
- package/dist/models/{model-error.d.ts → webhook-subscription-error.d.ts} +1 -1
- package/dist/models/webhook-subscription-error.js +15 -0
- package/dist/models/webhook-subscriptions-list-body.d.ts +2 -2
- package/docs/BrtcError.md +28 -0
- package/docs/BrtcErrorResponse.md +24 -0
- package/docs/BrtcErrorSource.md +26 -0
- package/docs/BrtcLink.md +24 -0
- package/docs/Callback.md +2 -2
- package/docs/CreateCall.md +2 -2
- package/docs/CreateEndpointRequestBase.md +28 -0
- package/docs/CreateEndpointResponse.md +24 -0
- package/docs/CreateEndpointResponseData.md +34 -0
- package/docs/CreateWebRtcConnectionRequest.md +30 -0
- package/docs/Device.md +26 -0
- package/docs/DeviceStatusEnum.md +10 -0
- package/docs/Endpoint.md +32 -0
- package/docs/EndpointDirectionEnum.md +12 -0
- package/docs/EndpointEvent.md +37 -0
- package/docs/EndpointEventTypeEnum.md +10 -0
- package/docs/EndpointResponse.md +24 -0
- package/docs/EndpointStatusEnum.md +10 -0
- package/docs/EndpointTypeEnum.md +8 -0
- package/docs/Endpoints.md +30 -0
- package/docs/EndpointsApi.md +334 -0
- package/docs/InboundCallback.md +2 -2
- package/docs/InboundCallbackTypeEnum.md +1 -1
- package/docs/ListEndpointsResponse.md +26 -0
- package/docs/LookupResult.md +1 -1
- package/docs/MachineDetectionConfiguration.md +1 -1
- package/docs/MessageRequest.md +1 -1
- package/docs/Page.md +26 -0
- package/docs/RbmOpenUrlEnum.md +1 -1
- package/docs/RbmWebViewEnum.md +1 -1
- package/docs/SipConnectionMetadata.md +26 -0
- package/docs/SipCredentials.md +22 -0
- package/docs/StatusCallback.md +1 -1
- package/docs/UpdateCall.md +1 -1
- package/docs/{Error.md → WebhookSubscriptionError.md} +3 -3
- package/docs/WebhookSubscriptionsListBody.md +1 -1
- package/models/brtc-error-response.ts +28 -0
- package/models/brtc-error-source.ts +35 -0
- package/models/brtc-error.ts +39 -0
- package/models/brtc-link.ts +31 -0
- package/models/bxml/verbs/Connect.ts +33 -0
- package/models/bxml/verbs/Endpoint.ts +19 -0
- package/models/bxml/verbs/index.ts +2 -0
- package/models/create-call.ts +2 -2
- package/models/create-endpoint-request-base.ts +41 -0
- package/models/create-endpoint-response-data.ts +58 -0
- package/models/create-endpoint-response.ts +31 -0
- package/models/create-web-rtc-connection-request.ts +47 -0
- package/models/device-status-enum.ts +26 -0
- package/models/device.ts +37 -0
- package/models/endpoint-direction-enum.ts +27 -0
- package/models/endpoint-event-type-enum.ts +26 -0
- package/models/endpoint-event.ts +63 -0
- package/models/endpoint-response.ts +31 -0
- package/models/endpoint-status-enum.ts +26 -0
- package/models/endpoint-type-enum.ts +25 -0
- package/models/endpoint.ts +54 -0
- package/models/endpoints.ts +45 -0
- package/models/inbound-callback-message.ts +42 -1
- package/models/inbound-callback-type-enum.ts +1 -1
- package/models/inbound-callback.ts +2 -2
- package/models/index.ts +23 -1
- package/models/list-endpoints-response.ts +35 -0
- package/models/lookup-result.ts +1 -1
- package/models/machine-detection-configuration.ts +1 -1
- package/models/message-request.ts +1 -1
- package/models/multi-channel-action-calendar-event.ts +27 -1
- package/models/multi-channel-channel-list-mmsobject.ts +12 -1
- package/models/multi-channel-channel-list-mmsresponse-object.ts +16 -1
- package/models/multi-channel-channel-list-rbmobject.ts +12 -1
- package/models/multi-channel-channel-list-rbmresponse-object.ts +16 -1
- package/models/multi-channel-channel-list-smsobject.ts +12 -1
- package/models/multi-channel-channel-list-smsresponse-object.ts +16 -1
- package/models/page.ts +35 -0
- package/models/rbm-action-dial.ts +15 -1
- package/models/rbm-action-open-url.ts +17 -1
- package/models/rbm-action-view-location.ts +23 -1
- package/models/rbm-card-content-media.ts +11 -1
- package/models/rbm-open-url-enum.ts +1 -1
- package/models/rbm-web-view-enum.ts +1 -1
- package/models/sip-connection-metadata.ts +35 -0
- package/models/sip-credentials.ts +27 -0
- package/models/status-callback.ts +1 -1
- package/models/update-call.ts +1 -1
- package/models/{model-error.ts → webhook-subscription-error.ts} +1 -1
- package/models/webhook-subscriptions-list-body.ts +3 -3
- package/package.json +1 -1
- package/tests/smoke/endpoints-api.test.ts +141 -0
- package/tests/unit/api/endpoints-api.test.ts +106 -0
- package/tests/unit/models/brtc-error-response.test.ts +50 -0
- package/tests/unit/models/brtc-error-source.test.ts +17 -0
- package/tests/unit/models/brtc-error.test.ts +30 -0
- package/tests/unit/models/brtc-link.test.ts +15 -0
- package/tests/unit/models/bxml/verbs/Connect.test.ts +47 -0
- package/tests/unit/models/bxml/verbs/Endpoint.test.ts +12 -0
- package/tests/unit/models/create-endpoint-request-base.test.ts +21 -0
- package/tests/unit/models/create-endpoint-response-data.test.ts +44 -0
- package/tests/unit/models/create-endpoint-response.test.ts +86 -0
- package/tests/unit/models/create-web-rtc-connection-request.test.ts +21 -0
- package/tests/unit/models/device-status-enum.test.ts +12 -0
- package/tests/unit/models/device.test.ts +19 -0
- package/tests/unit/models/endpoint-direction-enum.test.ts +14 -0
- package/tests/unit/models/endpoint-event-type-enum.test.ts +12 -0
- package/tests/unit/models/endpoint-event.test.ts +44 -0
- package/tests/unit/models/endpoint-response.test.ts +84 -0
- package/tests/unit/models/endpoint-status-enum.test.ts +12 -0
- package/tests/unit/models/endpoint-type-enum.test.ts +10 -0
- package/tests/unit/models/endpoint.test.ts +50 -0
- package/tests/unit/models/endpoints.test.ts +25 -0
- package/tests/unit/models/list-endpoints-response.test.ts +94 -0
- package/tests/unit/models/page.test.ts +17 -0
- package/tests/unit/models/sip-connection-metadata.test.ts +25 -0
- package/tests/unit/models/sip-credentials.test.ts +13 -0
- /package/dist/models/{model-error.js → brtc-error-response.js} +0 -0
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
# EndpointsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createEndpoint**](#createendpoint) | **POST** /accounts/{accountId}/endpoints | Create Endpoint|
|
|
8
|
+
|[**deleteEndpoint**](#deleteendpoint) | **DELETE** /accounts/{accountId}/endpoints/{endpointId} | Delete Endpoint|
|
|
9
|
+
|[**getEndpoint**](#getendpoint) | **GET** /accounts/{accountId}/endpoints/{endpointId} | Get Endpoint|
|
|
10
|
+
|[**listEndpoints**](#listendpoints) | **GET** /accounts/{accountId}/endpoints | List Endpoints|
|
|
11
|
+
|[**updateEndpointBxml**](#updateendpointbxml) | **PUT** /accounts/{accountId}/endpoints/{endpointId}/bxml | Update Endpoint BXML|
|
|
12
|
+
|
|
13
|
+
# **createEndpoint**
|
|
14
|
+
> CreateEndpointResponse createEndpoint(body)
|
|
15
|
+
|
|
16
|
+
Creates a new Endpoint for the specified account.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
EndpointsApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from 'bandwidth-sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new EndpointsApi(configuration);
|
|
28
|
+
|
|
29
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
30
|
+
let body: CreateWebRtcConnectionRequest; //
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.createEndpoint(
|
|
33
|
+
accountId,
|
|
34
|
+
body
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **body** | **CreateWebRtcConnectionRequest**| | |
|
|
43
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**CreateEndpointResponse**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**201** | Created | - |
|
|
64
|
+
|**400** | Bad Request | - |
|
|
65
|
+
|**401** | Unauthorized | - |
|
|
66
|
+
|**403** | Forbidden | - |
|
|
67
|
+
|**404** | Not Found | - |
|
|
68
|
+
|**405** | Method Not Allowed | - |
|
|
69
|
+
|**415** | Unsupported Media Type | - |
|
|
70
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds the client should wait before making another request. <br> |
|
|
71
|
+
|**500** | Service Unavailable | - |
|
|
72
|
+
|
|
73
|
+
[[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)
|
|
74
|
+
|
|
75
|
+
# **deleteEndpoint**
|
|
76
|
+
> deleteEndpoint()
|
|
77
|
+
|
|
78
|
+
Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated.
|
|
79
|
+
|
|
80
|
+
### Example
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import {
|
|
84
|
+
EndpointsApi,
|
|
85
|
+
Configuration
|
|
86
|
+
} from 'bandwidth-sdk';
|
|
87
|
+
|
|
88
|
+
const configuration = new Configuration();
|
|
89
|
+
const apiInstance = new EndpointsApi(configuration);
|
|
90
|
+
|
|
91
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
92
|
+
let endpointId: string; //BRTC Endpoint ID. (default to undefined)
|
|
93
|
+
|
|
94
|
+
const { status, data } = await apiInstance.deleteEndpoint(
|
|
95
|
+
accountId,
|
|
96
|
+
endpointId
|
|
97
|
+
);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
|Name | Type | Description | Notes|
|
|
103
|
+
|------------- | ------------- | ------------- | -------------|
|
|
104
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
105
|
+
| **endpointId** | [**string**] | BRTC Endpoint ID. | defaults to undefined|
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
void (empty response body)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**204** | No Content | - |
|
|
126
|
+
|**400** | Bad Request | - |
|
|
127
|
+
|**401** | Unauthorized | - |
|
|
128
|
+
|**403** | Forbidden | - |
|
|
129
|
+
|**404** | Not Found | - |
|
|
130
|
+
|**405** | Method Not Allowed | - |
|
|
131
|
+
|**415** | Unsupported Media Type | - |
|
|
132
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds the client should wait before making another request. <br> |
|
|
133
|
+
|**500** | Service Unavailable | - |
|
|
134
|
+
|
|
135
|
+
[[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)
|
|
136
|
+
|
|
137
|
+
# **getEndpoint**
|
|
138
|
+
> EndpointResponse getEndpoint()
|
|
139
|
+
|
|
140
|
+
Returns information about the specified endpoint.
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
import {
|
|
146
|
+
EndpointsApi,
|
|
147
|
+
Configuration
|
|
148
|
+
} from 'bandwidth-sdk';
|
|
149
|
+
|
|
150
|
+
const configuration = new Configuration();
|
|
151
|
+
const apiInstance = new EndpointsApi(configuration);
|
|
152
|
+
|
|
153
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
154
|
+
let endpointId: string; //BRTC Endpoint ID. (default to undefined)
|
|
155
|
+
|
|
156
|
+
const { status, data } = await apiInstance.getEndpoint(
|
|
157
|
+
accountId,
|
|
158
|
+
endpointId
|
|
159
|
+
);
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
|Name | Type | Description | Notes|
|
|
165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
166
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
167
|
+
| **endpointId** | [**string**] | BRTC Endpoint ID. | defaults to undefined|
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**EndpointResponse**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: Not defined
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | OK | - |
|
|
188
|
+
|**400** | Bad Request | - |
|
|
189
|
+
|**401** | Unauthorized | - |
|
|
190
|
+
|**403** | Forbidden | - |
|
|
191
|
+
|**404** | Not Found | - |
|
|
192
|
+
|**405** | Method Not Allowed | - |
|
|
193
|
+
|**415** | Unsupported Media Type | - |
|
|
194
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds the client should wait before making another request. <br> |
|
|
195
|
+
|**500** | Service Unavailable | - |
|
|
196
|
+
|
|
197
|
+
[[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)
|
|
198
|
+
|
|
199
|
+
# **listEndpoints**
|
|
200
|
+
> ListEndpointsResponse listEndpoints()
|
|
201
|
+
|
|
202
|
+
Returns a list of endpoints associated with the specified account.
|
|
203
|
+
|
|
204
|
+
### Example
|
|
205
|
+
|
|
206
|
+
```typescript
|
|
207
|
+
import {
|
|
208
|
+
EndpointsApi,
|
|
209
|
+
Configuration
|
|
210
|
+
} from 'bandwidth-sdk';
|
|
211
|
+
|
|
212
|
+
const configuration = new Configuration();
|
|
213
|
+
const apiInstance = new EndpointsApi(configuration);
|
|
214
|
+
|
|
215
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
216
|
+
let type: EndpointTypeEnum; //The type of endpoint. (optional) (default to undefined)
|
|
217
|
+
let status: EndpointStatusEnum; //The status of the endpoint. (optional) (default to undefined)
|
|
218
|
+
let afterCursor: string; //The cursor to use for pagination. This is the value of the `next` link in the previous response. (optional) (default to undefined)
|
|
219
|
+
let limit: number; //The maximum number of endpoints to return in the response. (optional) (default to 100)
|
|
220
|
+
|
|
221
|
+
const { status, data } = await apiInstance.listEndpoints(
|
|
222
|
+
accountId,
|
|
223
|
+
type,
|
|
224
|
+
status,
|
|
225
|
+
afterCursor,
|
|
226
|
+
limit
|
|
227
|
+
);
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Parameters
|
|
231
|
+
|
|
232
|
+
|Name | Type | Description | Notes|
|
|
233
|
+
|------------- | ------------- | ------------- | -------------|
|
|
234
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
235
|
+
| **type** | **EndpointTypeEnum** | The type of endpoint. | (optional) defaults to undefined|
|
|
236
|
+
| **status** | **EndpointStatusEnum** | The status of the endpoint. | (optional) defaults to undefined|
|
|
237
|
+
| **afterCursor** | [**string**] | The cursor to use for pagination. This is the value of the `next` link in the previous response. | (optional) defaults to undefined|
|
|
238
|
+
| **limit** | [**number**] | The maximum number of endpoints to return in the response. | (optional) defaults to 100|
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
### Return type
|
|
242
|
+
|
|
243
|
+
**ListEndpointsResponse**
|
|
244
|
+
|
|
245
|
+
### Authorization
|
|
246
|
+
|
|
247
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
248
|
+
|
|
249
|
+
### HTTP request headers
|
|
250
|
+
|
|
251
|
+
- **Content-Type**: Not defined
|
|
252
|
+
- **Accept**: application/json
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
### HTTP response details
|
|
256
|
+
| Status code | Description | Response headers |
|
|
257
|
+
|-------------|-------------|------------------|
|
|
258
|
+
|**200** | OK | - |
|
|
259
|
+
|**400** | Bad Request | - |
|
|
260
|
+
|**401** | Unauthorized | - |
|
|
261
|
+
|**403** | Forbidden | - |
|
|
262
|
+
|**404** | Not Found | - |
|
|
263
|
+
|**405** | Method Not Allowed | - |
|
|
264
|
+
|**415** | Unsupported Media Type | - |
|
|
265
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds the client should wait before making another request. <br> |
|
|
266
|
+
|**500** | Service Unavailable | - |
|
|
267
|
+
|
|
268
|
+
[[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)
|
|
269
|
+
|
|
270
|
+
# **updateEndpointBxml**
|
|
271
|
+
> updateEndpointBxml(body)
|
|
272
|
+
|
|
273
|
+
Updates the BXML for the specified endpoint.
|
|
274
|
+
|
|
275
|
+
### Example
|
|
276
|
+
|
|
277
|
+
```typescript
|
|
278
|
+
import {
|
|
279
|
+
EndpointsApi,
|
|
280
|
+
Configuration
|
|
281
|
+
} from 'bandwidth-sdk';
|
|
282
|
+
|
|
283
|
+
const configuration = new Configuration();
|
|
284
|
+
const apiInstance = new EndpointsApi(configuration);
|
|
285
|
+
|
|
286
|
+
let accountId: string; //Your Bandwidth Account ID. (default to undefined)
|
|
287
|
+
let endpointId: string; //BRTC Endpoint ID. (default to undefined)
|
|
288
|
+
let body: string; //
|
|
289
|
+
|
|
290
|
+
const { status, data } = await apiInstance.updateEndpointBxml(
|
|
291
|
+
accountId,
|
|
292
|
+
endpointId,
|
|
293
|
+
body
|
|
294
|
+
);
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
|Name | Type | Description | Notes|
|
|
300
|
+
|------------- | ------------- | ------------- | -------------|
|
|
301
|
+
| **body** | **string**| | |
|
|
302
|
+
| **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
|
|
303
|
+
| **endpointId** | [**string**] | BRTC Endpoint ID. | defaults to undefined|
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
void (empty response body)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: application/xml
|
|
317
|
+
- **Accept**: application/json
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### HTTP response details
|
|
321
|
+
| Status code | Description | Response headers |
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
|**204** | No Content | - |
|
|
324
|
+
|**400** | Bad Request | - |
|
|
325
|
+
|**401** | Unauthorized | - |
|
|
326
|
+
|**403** | Forbidden | - |
|
|
327
|
+
|**404** | Not Found | - |
|
|
328
|
+
|**405** | Method Not Allowed | - |
|
|
329
|
+
|**415** | Unsupported Media Type | - |
|
|
330
|
+
|**429** | Too Many Requests | * Retry-After - The number of seconds the client should wait before making another request. <br> |
|
|
331
|
+
|**500** | Service Unavailable | - |
|
|
332
|
+
|
|
333
|
+
[[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)
|
|
334
|
+
|
package/docs/InboundCallback.md
CHANGED
|
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**time** | **string** | | [default to undefined]
|
|
10
10
|
**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
|
|
11
|
-
**to** | **string** | The destination phone number the message was sent to.
|
|
11
|
+
**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
12
|
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
|
|
13
13
|
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
|
|
14
|
-
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message.
|
|
14
|
+
**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]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# InboundCallbackTypeEnum
|
|
2
2
|
|
|
3
|
-
The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message.
|
|
3
|
+
The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ListEndpointsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<BrtcLink>**](BrtcLink.md) | | [default to undefined]
|
|
9
|
+
**page** | [**Page**](Page.md) | | [optional] [default to undefined]
|
|
10
|
+
**data** | [**Array<Endpoints>**](Endpoints.md) | | [default to undefined]
|
|
11
|
+
**errors** | [**Array<BrtcError>**](BrtcError.md) | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ListEndpointsResponse } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ListEndpointsResponse = {
|
|
19
|
+
links,
|
|
20
|
+
page,
|
|
21
|
+
data,
|
|
22
|
+
errors,
|
|
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)
|
package/docs/LookupResult.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**deactivationDate** | **string** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] [default to undefined]
|
|
16
16
|
**deactivationEvent** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] [default to undefined]
|
|
17
17
|
**latestMessageDeliveryStatus** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] [default to undefined]
|
|
18
|
-
**initialMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`.
|
|
18
|
+
**initialMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] [default to undefined]
|
|
19
19
|
**latestMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] [default to undefined]
|
|
20
20
|
**rcsEnabled** | **boolean** | [RCS-Only](#section/RCS-Only). Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS. | [optional] [default to undefined]
|
|
21
21
|
|
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**silenceTimeout** | **number** | If no speech is detected in this period, a callback with a \'silence\' result is sent. | [optional] [default to 10]
|
|
12
12
|
**speechThreshold** | **number** | When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'. | [optional] [default to 10]
|
|
13
13
|
**speechEndThreshold** | **number** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional] [default to 5]
|
|
14
|
-
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing.
|
|
14
|
+
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional] [default to undefined]
|
|
15
15
|
**delayResult** | **boolean** | If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately. | [optional] [default to false]
|
|
16
16
|
**callbackUrl** | **string** | The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode. | [optional] [default to undefined]
|
|
17
17
|
**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]
|
package/docs/MessageRequest.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
|
|
9
9
|
**to** | **Set<string>** | The phone number(s) the message should be sent to in E164 format. | [default to undefined]
|
|
10
|
-
**from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message.
|
|
10
|
+
**from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined]
|
|
11
11
|
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined]
|
|
12
12
|
**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] [default to undefined]
|
|
13
13
|
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
|
package/docs/Page.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Page
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pageSize** | **number** | The number of items per page. | [default to undefined]
|
|
9
|
+
**totalElements** | **number** | The total number of items. | [optional] [default to undefined]
|
|
10
|
+
**totalPages** | **number** | The total number of pages. | [optional] [default to undefined]
|
|
11
|
+
**pageNumber** | **number** | The current page number. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Page } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: Page = {
|
|
19
|
+
pageSize,
|
|
20
|
+
totalElements,
|
|
21
|
+
totalPages,
|
|
22
|
+
pageNumber,
|
|
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)
|
package/docs/RbmOpenUrlEnum.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# RbmOpenUrlEnum
|
|
2
2
|
|
|
3
|
-
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn
|
|
3
|
+
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn\'t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
package/docs/RbmWebViewEnum.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# RbmWebViewEnum
|
|
2
2
|
|
|
3
|
-
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen.
|
|
3
|
+
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# SipConnectionMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ipAddress** | **string** | The IP address of the SIP connection. | [optional] [default to undefined]
|
|
9
|
+
**port** | **number** | The port of the SIP connection. | [optional] [default to undefined]
|
|
10
|
+
**credentials** | [**SipCredentials**](SipCredentials.md) | | [optional] [default to undefined]
|
|
11
|
+
**uuiHeader** | **string** | The User-to-User Information header for the SIP connection. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { SipConnectionMetadata } from 'bandwidth-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: SipConnectionMetadata = {
|
|
19
|
+
ipAddress,
|
|
20
|
+
port,
|
|
21
|
+
credentials,
|
|
22
|
+
uuiHeader,
|
|
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,22 @@
|
|
|
1
|
+
# SipCredentials
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**username** | **string** | The username for the SIP connection. | [optional] [default to undefined]
|
|
9
|
+
**password** | **string** | The password for the SIP connection. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SipCredentials } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: SipCredentials = {
|
|
17
|
+
username,
|
|
18
|
+
password,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/StatusCallback.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
|
|
14
14
|
**message** | [**StatusCallbackMessage**](StatusCallbackMessage.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.
|
|
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
|
|
package/docs/UpdateCall.md
CHANGED
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**redirectFallbackMethod** | [**RedirectMethodEnum**](RedirectMethodEnum.md) | | [optional] [default to undefined]
|
|
15
15
|
**fallbackUsername** | **string** | Basic auth username. | [optional] [default to undefined]
|
|
16
16
|
**fallbackPassword** | **string** | Basic auth password. | [optional] [default to undefined]
|
|
17
|
-
**tag** | **string** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length
|
|
17
|
+
**tag** | **string** | A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or [`<Tag>`](/docs/voice/bxml/tag) verb, or cleared. May be cleared by setting `tag=\"\"`. Max length 4096 characters. Not allowed if `state` is `completed`. | [optional] [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# WebhookSubscriptionError
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { WebhookSubscriptionError } from 'bandwidth-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: WebhookSubscriptionError = {
|
|
18
18
|
code,
|
|
19
19
|
description,
|
|
20
20
|
telephoneNumbers,
|
|
@@ -7,7 +7,7 @@ A list of all webhook subscriptions registered for this account ID for this part
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**links** | [**LinksObject**](LinksObject.md) | | [optional] [default to undefined]
|
|
10
|
-
**errors** | [**Array<
|
|
10
|
+
**errors** | [**Array<WebhookSubscriptionError>**](WebhookSubscriptionError.md) | | [optional] [default to undefined]
|
|
11
11
|
**data** | [**Array<WebhookSubscription>**](WebhookSubscription.md) | | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -0,0 +1,28 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { BrtcError } from './brtc-error';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { BrtcLink } from './brtc-link';
|
|
22
|
+
|
|
23
|
+
export interface BrtcErrorResponse {
|
|
24
|
+
'links': Array<BrtcLink>;
|
|
25
|
+
'data': object | null;
|
|
26
|
+
'errors': Array<BrtcError>;
|
|
27
|
+
}
|
|
28
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
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 BrtcErrorSource {
|
|
18
|
+
/**
|
|
19
|
+
* The URI parameter that caused the error.
|
|
20
|
+
*/
|
|
21
|
+
'parameter'?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The request body field that caused the error.
|
|
24
|
+
*/
|
|
25
|
+
'field'?: string;
|
|
26
|
+
/**
|
|
27
|
+
* The header that caused the error.
|
|
28
|
+
*/
|
|
29
|
+
'header'?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The resource ID or path to the resource (or non-existent resource) causing the error.
|
|
32
|
+
*/
|
|
33
|
+
'reference'?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { BrtcErrorSource } from './brtc-error-source';
|
|
19
|
+
|
|
20
|
+
export interface BrtcError {
|
|
21
|
+
/**
|
|
22
|
+
* A unique identifier for the error.
|
|
23
|
+
*/
|
|
24
|
+
'id'?: string;
|
|
25
|
+
/**
|
|
26
|
+
* The type of error.
|
|
27
|
+
*/
|
|
28
|
+
'type': string;
|
|
29
|
+
/**
|
|
30
|
+
* A description of the error.
|
|
31
|
+
*/
|
|
32
|
+
'description': string;
|
|
33
|
+
/**
|
|
34
|
+
* A code that uniquely identifies the error.
|
|
35
|
+
*/
|
|
36
|
+
'code'?: string;
|
|
37
|
+
'source'?: BrtcErrorSource;
|
|
38
|
+
}
|
|
39
|
+
|