bandwidth-sdk 8.1.4 → 8.1.5
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/.bandwidth/component.yaml +1 -0
- package/.github/workflows/deploy.yml +15 -11
- package/.github/workflows/test-pr.yml +3 -3
- package/.github/workflows/test-smoke.yml +13 -13
- package/.openapi-generator/VERSION +1 -1
- package/api/calls-api.ts +14 -17
- package/api/conferences-api.ts +31 -34
- package/api/endpoints-api.ts +14 -16
- package/api/media-api.ts +28 -29
- package/api/messages-api.ts +13 -14
- package/api/mfaapi.ts +7 -10
- package/api/multi-channel-api.ts +7 -8
- package/api/phone-number-lookup-api.ts +8 -10
- package/api/recordings-api.ts +37 -39
- package/api/statistics-api.ts +3 -3
- package/api/toll-free-verification-api.ts +23 -27
- package/api/transcriptions-api.ts +12 -12
- package/bandwidth.yml +127 -49
- package/common.ts +18 -4
- package/configuration.ts +1 -1
- package/coverage/clover.xml +948 -890
- package/coverage/coverage-final.json +13 -13
- package/coverage/lcov-report/index.html +19 -19
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +25 -34
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +46 -55
- package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +25 -31
- package/coverage/lcov-report/node-sdk/api/index.html +69 -69
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +38 -41
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +21 -24
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +16 -25
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +14 -17
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +17 -23
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +53 -59
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +9 -9
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +38 -50
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +20 -20
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/common.ts.html +55 -13
- package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/index.html +15 -15
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- 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 +2 -2
- package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +2 -2
- 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 +2 -2
- package/coverage/lcov-report/node-sdk/models/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/index.ts.html +1 -1
- 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 +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +2 -2
- 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 +2413 -2353
- package/custom_templates/common.mustache +18 -4
- package/custom_templates/package.mustache +1 -1
- package/dist/api/calls-api.d.ts +5 -5
- package/dist/api/calls-api.js +13 -8
- package/dist/api/conferences-api.d.ts +9 -9
- package/dist/api/conferences-api.js +30 -21
- package/dist/api/endpoints-api.d.ts +5 -5
- package/dist/api/endpoints-api.js +13 -8
- package/dist/api/media-api.d.ts +20 -20
- package/dist/api/media-api.js +27 -23
- package/dist/api/messages-api.d.ts +10 -10
- package/dist/api/messages-api.js +12 -10
- package/dist/api/mfaapi.d.ts +3 -3
- package/dist/api/mfaapi.js +6 -3
- package/dist/api/multi-channel-api.d.ts +5 -5
- package/dist/api/multi-channel-api.js +6 -5
- package/dist/api/phone-number-lookup-api.d.ts +3 -3
- package/dist/api/phone-number-lookup-api.js +7 -4
- package/dist/api/recordings-api.d.ts +10 -10
- package/dist/api/recordings-api.js +36 -26
- package/dist/api/statistics-api.d.ts +1 -1
- package/dist/api/statistics-api.js +2 -1
- package/dist/api/toll-free-verification-api.d.ts +9 -9
- package/dist/api/toll-free-verification-api.js +22 -13
- package/dist/api/transcriptions-api.d.ts +3 -3
- package/dist/api/transcriptions-api.js +11 -8
- package/dist/common.d.ts +6 -0
- package/dist/common.js +18 -3
- package/dist/configuration.js +1 -1
- package/dist/models/answer-callback.d.ts +4 -0
- package/dist/models/business-entity-type-enum.js +1 -1
- package/dist/models/business-registration-type-enum.js +1 -1
- package/dist/models/call-direction-enum.js +1 -1
- package/dist/models/call-state-enum.js +1 -1
- package/dist/models/call-transcription-detected-language-enum.js +1 -1
- package/dist/models/call-transcription-track-enum.js +1 -1
- package/dist/models/callback-method-enum.js +1 -1
- package/dist/models/card-width-enum.js +1 -1
- package/dist/models/completed-lookup-status-enum.js +1 -1
- package/dist/models/conference-state-enum.js +1 -1
- package/dist/models/deactivation-event-enum.js +1 -1
- package/dist/models/device-status-enum.js +1 -1
- package/dist/models/disconnect-callback.d.ts +8 -0
- package/dist/models/endpoint-direction-enum.js +1 -1
- package/dist/models/endpoint-event-type-enum.js +1 -1
- package/dist/models/endpoint-status-enum.js +1 -1
- package/dist/models/endpoint-type-enum.js +1 -1
- package/dist/models/file-format-enum.js +1 -1
- package/dist/models/in-progress-lookup-status-enum.js +1 -1
- package/dist/models/inbound-callback-type-enum.js +1 -1
- package/dist/models/initiate-callback.d.ts +10 -0
- package/dist/models/latest-message-delivery-status-enum.js +1 -1
- package/dist/models/line-type-enum.js +1 -1
- package/dist/models/list-message-direction-enum.js +1 -1
- package/dist/models/machine-detection-mode-enum.js +1 -1
- package/dist/models/message-direction-enum.js +1 -1
- package/dist/models/message-status-enum.js +1 -1
- package/dist/models/message-type-enum.js +1 -1
- package/dist/models/multi-channel-message-channel-enum.js +1 -1
- package/dist/models/priority-enum.js +1 -1
- package/dist/models/product-type-enum.js +1 -1
- package/dist/models/rbm-action-type-enum.js +1 -1
- package/dist/models/rbm-media-height-enum.js +1 -1
- package/dist/models/rbm-open-url-enum.js +1 -1
- package/dist/models/rbm-web-view-enum.js +1 -1
- package/dist/models/recording-state-enum.js +1 -1
- package/dist/models/redirect-method-enum.js +1 -1
- package/dist/models/standalone-card-orientation-enum.js +1 -1
- package/dist/models/status-callback-type-enum.js +1 -1
- package/dist/models/tfv-callback-status-enum.js +1 -1
- package/dist/models/tfv-status-enum.js +1 -1
- package/dist/models/thumbnail-alignment-enum.js +1 -1
- package/dist/models/webhook-subscription-type-enum.js +1 -1
- package/docs/AnswerCallback.md +2 -0
- package/docs/DisconnectCallback.md +4 -0
- package/docs/InitiateCallback.md +4 -0
- package/docs/MediaApi.md +8 -8
- package/docs/MessagesApi.md +4 -4
- package/docs/MultiChannelApi.md +2 -2
- package/models/answer-callback.ts +4 -0
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-type-enum.ts +1 -1
- package/models/call-direction-enum.ts +1 -1
- package/models/call-state-enum.ts +1 -1
- package/models/call-transcription-detected-language-enum.ts +1 -1
- package/models/call-transcription-track-enum.ts +1 -1
- package/models/callback-method-enum.ts +1 -1
- package/models/card-width-enum.ts +1 -1
- package/models/completed-lookup-status-enum.ts +1 -1
- package/models/conference-state-enum.ts +1 -1
- package/models/deactivation-event-enum.ts +1 -1
- package/models/device-status-enum.ts +1 -1
- package/models/disconnect-callback.ts +8 -0
- package/models/endpoint-direction-enum.ts +1 -1
- package/models/endpoint-event-type-enum.ts +1 -1
- package/models/endpoint-status-enum.ts +1 -1
- package/models/endpoint-type-enum.ts +1 -1
- package/models/file-format-enum.ts +1 -1
- package/models/in-progress-lookup-status-enum.ts +1 -1
- package/models/inbound-callback-type-enum.ts +1 -1
- package/models/initiate-callback.ts +8 -0
- package/models/latest-message-delivery-status-enum.ts +1 -1
- package/models/line-type-enum.ts +1 -1
- package/models/list-message-direction-enum.ts +1 -1
- package/models/machine-detection-mode-enum.ts +1 -1
- package/models/message-direction-enum.ts +1 -1
- package/models/message-status-enum.ts +1 -1
- package/models/message-type-enum.ts +1 -1
- package/models/multi-channel-message-channel-enum.ts +1 -1
- package/models/priority-enum.ts +1 -1
- package/models/product-type-enum.ts +1 -1
- package/models/rbm-action-type-enum.ts +1 -1
- package/models/rbm-media-height-enum.ts +1 -1
- package/models/rbm-open-url-enum.ts +1 -1
- package/models/rbm-web-view-enum.ts +1 -1
- package/models/recording-state-enum.ts +1 -1
- package/models/redirect-method-enum.ts +1 -1
- package/models/standalone-card-orientation-enum.ts +1 -1
- package/models/status-callback-type-enum.ts +1 -1
- package/models/tfv-callback-status-enum.ts +1 -1
- package/models/tfv-status-enum.ts +1 -1
- package/models/thumbnail-alignment-enum.ts +1 -1
- package/models/webhook-subscription-type-enum.ts +1 -1
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tests/unit/models/answer-callback.test.ts +2 -0
- package/tests/unit/models/disconnect-callback.test.ts +4 -0
- package/tests/unit/models/initiate-callback.test.ts +4 -0
|
@@ -16,5 +16,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
16
16
|
exports.WebhookSubscriptionTypeEnum = void 0;
|
|
17
17
|
exports.WebhookSubscriptionTypeEnum = {
|
|
18
18
|
TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS',
|
|
19
|
-
MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS'
|
|
19
|
+
MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS',
|
|
20
20
|
};
|
package/docs/AnswerCallback.md
CHANGED
|
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**answerTime** | **string** | Time the call was answered, in ISO 8601 format. | [optional] [default to undefined]
|
|
21
21
|
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
|
|
22
22
|
**machineDetectionResult** | [**MachineDetectionResult**](MachineDetectionResult.md) | | [optional] [default to undefined]
|
|
23
|
+
**sipCallId** | **string** | (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -41,6 +42,7 @@ const instance: AnswerCallback = {
|
|
|
41
42
|
answerTime,
|
|
42
43
|
tag,
|
|
43
44
|
machineDetectionResult,
|
|
45
|
+
sipCallId,
|
|
44
46
|
};
|
|
45
47
|
```
|
|
46
48
|
|
|
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
|
|
24
24
|
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
25
25
|
**tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] [default to undefined]
|
|
26
|
+
**sipCallId** | **string** | (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
|
|
27
|
+
**sipResponseCode** | **number** | (optional) The SIP status code returned by Bandwidth\'s SBC when it rejected an outbound call\'s INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC. | [optional] [default to undefined]
|
|
26
28
|
|
|
27
29
|
## Example
|
|
28
30
|
|
|
@@ -47,6 +49,8 @@ const instance: DisconnectCallback = {
|
|
|
47
49
|
errorMessage,
|
|
48
50
|
errorId,
|
|
49
51
|
tag,
|
|
52
|
+
sipCallId,
|
|
53
|
+
sipResponseCode,
|
|
50
54
|
};
|
|
51
55
|
```
|
|
52
56
|
|
package/docs/InitiateCallback.md
CHANGED
|
@@ -19,6 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**diversion** | [**Diversion**](Diversion.md) | | [optional] [default to undefined]
|
|
20
20
|
**stirShaken** | [**StirShaken**](StirShaken.md) | | [optional] [default to undefined]
|
|
21
21
|
**uui** | **string** | The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] [default to undefined]
|
|
22
|
+
**sipCallId** | **string** | (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
|
|
23
|
+
**sipHeaders** | **{ [key: string]: string; }** | (optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. | [optional] [default to undefined]
|
|
22
24
|
|
|
23
25
|
## Example
|
|
24
26
|
|
|
@@ -39,6 +41,8 @@ const instance: InitiateCallback = {
|
|
|
39
41
|
diversion,
|
|
40
42
|
stirShaken,
|
|
41
43
|
uui,
|
|
44
|
+
sipCallId,
|
|
45
|
+
sipHeaders,
|
|
42
46
|
};
|
|
43
47
|
```
|
|
44
48
|
|
package/docs/MediaApi.md
CHANGED
|
@@ -25,7 +25,7 @@ import {
|
|
|
25
25
|
const configuration = new Configuration();
|
|
26
26
|
const apiInstance = new MediaApi(configuration);
|
|
27
27
|
|
|
28
|
-
let accountId: string; //
|
|
28
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
29
29
|
let mediaId: string; //Media ID to retrieve. (default to undefined)
|
|
30
30
|
|
|
31
31
|
const { status, data } = await apiInstance.deleteMedia(
|
|
@@ -38,7 +38,7 @@ const { status, data } = await apiInstance.deleteMedia(
|
|
|
38
38
|
|
|
39
39
|
|Name | Type | Description | Notes|
|
|
40
40
|
|------------- | ------------- | ------------- | -------------|
|
|
41
|
-
| **accountId** | [**string**] |
|
|
41
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
42
42
|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
|
|
43
43
|
|
|
44
44
|
|
|
@@ -87,7 +87,7 @@ import {
|
|
|
87
87
|
const configuration = new Configuration();
|
|
88
88
|
const apiInstance = new MediaApi(configuration);
|
|
89
89
|
|
|
90
|
-
let accountId: string; //
|
|
90
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
91
91
|
let mediaId: string; //Media ID to retrieve. (default to undefined)
|
|
92
92
|
|
|
93
93
|
const { status, data } = await apiInstance.getMedia(
|
|
@@ -100,7 +100,7 @@ const { status, data } = await apiInstance.getMedia(
|
|
|
100
100
|
|
|
101
101
|
|Name | Type | Description | Notes|
|
|
102
102
|
|------------- | ------------- | ------------- | -------------|
|
|
103
|
-
| **accountId** | [**string**] |
|
|
103
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
104
104
|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
|
|
105
105
|
|
|
106
106
|
|
|
@@ -149,7 +149,7 @@ import {
|
|
|
149
149
|
const configuration = new Configuration();
|
|
150
150
|
const apiInstance = new MediaApi(configuration);
|
|
151
151
|
|
|
152
|
-
let accountId: string; //
|
|
152
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
153
153
|
let continuationToken: string; //Continuation token used to retrieve subsequent media. (optional) (default to undefined)
|
|
154
154
|
|
|
155
155
|
const { status, data } = await apiInstance.listMedia(
|
|
@@ -162,7 +162,7 @@ const { status, data } = await apiInstance.listMedia(
|
|
|
162
162
|
|
|
163
163
|
|Name | Type | Description | Notes|
|
|
164
164
|
|------------- | ------------- | ------------- | -------------|
|
|
165
|
-
| **accountId** | [**string**] |
|
|
165
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
166
166
|
| **continuationToken** | [**string**] | Continuation token used to retrieve subsequent media. | (optional) defaults to undefined|
|
|
167
167
|
|
|
168
168
|
|
|
@@ -211,7 +211,7 @@ import {
|
|
|
211
211
|
const configuration = new Configuration();
|
|
212
212
|
const apiInstance = new MediaApi(configuration);
|
|
213
213
|
|
|
214
|
-
let accountId: string; //
|
|
214
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
215
215
|
let mediaId: string; //Media ID to retrieve. (default to undefined)
|
|
216
216
|
let body: File; //
|
|
217
217
|
let contentType: string; //The media type of the entity-body. (optional) (default to undefined)
|
|
@@ -231,7 +231,7 @@ const { status, data } = await apiInstance.uploadMedia(
|
|
|
231
231
|
|Name | Type | Description | Notes|
|
|
232
232
|
|------------- | ------------- | ------------- | -------------|
|
|
233
233
|
| **body** | **File**| | |
|
|
234
|
-
| **accountId** | [**string**] |
|
|
234
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
235
235
|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
|
|
236
236
|
| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined|
|
|
237
237
|
| **cacheControl** | [**string**] | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | (optional) defaults to undefined|
|
package/docs/MessagesApi.md
CHANGED
|
@@ -24,7 +24,7 @@ import {
|
|
|
24
24
|
const configuration = new Configuration();
|
|
25
25
|
const apiInstance = new MessagesApi(configuration);
|
|
26
26
|
|
|
27
|
-
let accountId: string; //
|
|
27
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
28
28
|
let messageRequest: MessageRequest; //
|
|
29
29
|
|
|
30
30
|
const { status, data } = await apiInstance.createMessage(
|
|
@@ -38,7 +38,7 @@ const { status, data } = await apiInstance.createMessage(
|
|
|
38
38
|
|Name | Type | Description | Notes|
|
|
39
39
|
|------------- | ------------- | ------------- | -------------|
|
|
40
40
|
| **messageRequest** | **MessageRequest**| | |
|
|
41
|
-
| **accountId** | [**string**] |
|
|
41
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### Return type
|
|
@@ -87,7 +87,7 @@ import {
|
|
|
87
87
|
const configuration = new Configuration();
|
|
88
88
|
const apiInstance = new MessagesApi(configuration);
|
|
89
89
|
|
|
90
|
-
let accountId: string; //
|
|
90
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
91
91
|
let messageId: string; //The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. (optional) (default to undefined)
|
|
92
92
|
let sourceTn: string; //The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). (optional) (default to undefined)
|
|
93
93
|
let destinationTn: string; //The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). (optional) (default to undefined)
|
|
@@ -152,7 +152,7 @@ const { status, data } = await apiInstance.listMessages(
|
|
|
152
152
|
|
|
153
153
|
|Name | Type | Description | Notes|
|
|
154
154
|
|------------- | ------------- | ------------- | -------------|
|
|
155
|
-
| **accountId** | [**string**] |
|
|
155
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
156
156
|
| **messageId** | [**string**] | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | (optional) defaults to undefined|
|
|
157
157
|
| **sourceTn** | [**string**] | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). | (optional) defaults to undefined|
|
|
158
158
|
| **destinationTn** | [**string**] | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. \'%2B1919\'). | (optional) defaults to undefined|
|
package/docs/MultiChannelApi.md
CHANGED
|
@@ -23,7 +23,7 @@ import {
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
24
|
const apiInstance = new MultiChannelApi(configuration);
|
|
25
25
|
|
|
26
|
-
let accountId: string; //
|
|
26
|
+
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
27
27
|
let multiChannelMessageRequest: MultiChannelMessageRequest; //
|
|
28
28
|
|
|
29
29
|
const { status, data } = await apiInstance.createMultiChannelMessage(
|
|
@@ -37,7 +37,7 @@ const { status, data } = await apiInstance.createMultiChannelMessage(
|
|
|
37
37
|
|Name | Type | Description | Notes|
|
|
38
38
|
|------------- | ------------- | ------------- | -------------|
|
|
39
39
|
| **multiChannelMessageRequest** | **MultiChannelMessageRequest**| | |
|
|
40
|
-
| **accountId** | [**string**] |
|
|
40
|
+
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### Return type
|
|
@@ -74,6 +74,10 @@ export interface AnswerCallback {
|
|
|
74
74
|
*/
|
|
75
75
|
'tag'?: string | null;
|
|
76
76
|
'machineDetectionResult'?: MachineDetectionResult | null;
|
|
77
|
+
/**
|
|
78
|
+
* (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists.
|
|
79
|
+
*/
|
|
80
|
+
'sipCallId'?: string;
|
|
77
81
|
}
|
|
78
82
|
|
|
79
83
|
|
|
@@ -23,7 +23,7 @@ export const BusinessEntityTypeEnum = {
|
|
|
23
23
|
PrivateProfit: 'PRIVATE_PROFIT',
|
|
24
24
|
PublicProfit: 'PUBLIC_PROFIT',
|
|
25
25
|
NonProfit: 'NON_PROFIT',
|
|
26
|
-
Government: 'GOVERNMENT'
|
|
26
|
+
Government: 'GOVERNMENT',
|
|
27
27
|
} as const;
|
|
28
28
|
|
|
29
29
|
export type BusinessEntityTypeEnum = typeof BusinessEntityTypeEnum[keyof typeof BusinessEntityTypeEnum];
|
|
@@ -36,7 +36,7 @@ export const BusinessRegistrationTypeEnum = {
|
|
|
36
36
|
Nif: 'NIF',
|
|
37
37
|
Cnpj: 'CNPJ',
|
|
38
38
|
Uid: 'UID',
|
|
39
|
-
Other: 'OTHER'
|
|
39
|
+
Other: 'OTHER',
|
|
40
40
|
} as const;
|
|
41
41
|
|
|
42
42
|
export type BusinessRegistrationTypeEnum = typeof BusinessRegistrationTypeEnum[keyof typeof BusinessRegistrationTypeEnum];
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
export const CallTranscriptionDetectedLanguageEnum = {
|
|
22
22
|
EnUs: 'en-US',
|
|
23
23
|
EsUs: 'es-US',
|
|
24
|
-
FrFr: 'fr-FR'
|
|
24
|
+
FrFr: 'fr-FR',
|
|
25
25
|
} as const;
|
|
26
26
|
|
|
27
27
|
export type CallTranscriptionDetectedLanguageEnum = typeof CallTranscriptionDetectedLanguageEnum[keyof typeof CallTranscriptionDetectedLanguageEnum];
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
export const CompletedLookupStatusEnum = {
|
|
19
19
|
Complete: 'COMPLETE',
|
|
20
20
|
PartialComplete: 'PARTIAL_COMPLETE',
|
|
21
|
-
Failed: 'FAILED'
|
|
21
|
+
Failed: 'FAILED',
|
|
22
22
|
} as const;
|
|
23
23
|
|
|
24
24
|
export type CompletedLookupStatusEnum = typeof CompletedLookupStatusEnum[keyof typeof CompletedLookupStatusEnum];
|
|
@@ -86,6 +86,14 @@ export interface DisconnectCallback {
|
|
|
86
86
|
* (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
|
|
87
87
|
*/
|
|
88
88
|
'tag'?: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists.
|
|
91
|
+
*/
|
|
92
|
+
'sipCallId'?: string;
|
|
93
|
+
/**
|
|
94
|
+
* (optional) The SIP status code returned by Bandwidth\'s SBC when it rejected an outbound call\'s INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC.
|
|
95
|
+
*/
|
|
96
|
+
'sipResponseCode'?: number;
|
|
89
97
|
}
|
|
90
98
|
|
|
91
99
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
export const EndpointDirectionEnum = {
|
|
19
19
|
Inbound: 'INBOUND',
|
|
20
20
|
Outbound: 'OUTBOUND',
|
|
21
|
-
Bidirectional: 'BIDIRECTIONAL'
|
|
21
|
+
Bidirectional: 'BIDIRECTIONAL',
|
|
22
22
|
} as const;
|
|
23
23
|
|
|
24
24
|
export type EndpointDirectionEnum = typeof EndpointDirectionEnum[keyof typeof EndpointDirectionEnum];
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
export const EndpointEventTypeEnum = {
|
|
19
19
|
DeviceConnected: 'DEVICE_CONNECTED',
|
|
20
|
-
DeviceDisconnected: 'DEVICE_DISCONNECTED'
|
|
20
|
+
DeviceDisconnected: 'DEVICE_DISCONNECTED',
|
|
21
21
|
} as const;
|
|
22
22
|
|
|
23
23
|
export type EndpointEventTypeEnum = typeof EndpointEventTypeEnum[keyof typeof EndpointEventTypeEnum];
|
|
@@ -19,7 +19,7 @@ export const InProgressLookupStatusEnum = {
|
|
|
19
19
|
InProgress: 'IN_PROGRESS',
|
|
20
20
|
Complete: 'COMPLETE',
|
|
21
21
|
PartialComplete: 'PARTIAL_COMPLETE',
|
|
22
|
-
Failed: 'FAILED'
|
|
22
|
+
Failed: 'FAILED',
|
|
23
23
|
} as const;
|
|
24
24
|
|
|
25
25
|
export type InProgressLookupStatusEnum = typeof InProgressLookupStatusEnum[keyof typeof InProgressLookupStatusEnum];
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
export const InboundCallbackTypeEnum = {
|
|
22
22
|
MessageReceived: 'message-received',
|
|
23
23
|
RequestedLocationResponse: 'requested-location-response',
|
|
24
|
-
SuggestionResponse: 'suggestion-response'
|
|
24
|
+
SuggestionResponse: 'suggestion-response',
|
|
25
25
|
} as const;
|
|
26
26
|
|
|
27
27
|
export type InboundCallbackTypeEnum = typeof InboundCallbackTypeEnum[keyof typeof InboundCallbackTypeEnum];
|
|
@@ -70,6 +70,14 @@ export interface InitiateCallback {
|
|
|
70
70
|
* The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.
|
|
71
71
|
*/
|
|
72
72
|
'uui'?: string;
|
|
73
|
+
/**
|
|
74
|
+
* (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists.
|
|
75
|
+
*/
|
|
76
|
+
'sipCallId'?: string;
|
|
77
|
+
/**
|
|
78
|
+
* (optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept.
|
|
79
|
+
*/
|
|
80
|
+
'sipHeaders'?: { [key: string]: string; };
|
|
73
81
|
}
|
|
74
82
|
|
|
75
83
|
|
|
@@ -22,7 +22,7 @@ export const LatestMessageDeliveryStatusEnum = {
|
|
|
22
22
|
Active: 'ACTIVE',
|
|
23
23
|
Deactivated: 'DEACTIVATED',
|
|
24
24
|
Unknown: 'UNKNOWN',
|
|
25
|
-
NotEnabled: 'NOT_ENABLED'
|
|
25
|
+
NotEnabled: 'NOT_ENABLED',
|
|
26
26
|
} as const;
|
|
27
27
|
|
|
28
28
|
export type LatestMessageDeliveryStatusEnum = typeof LatestMessageDeliveryStatusEnum[keyof typeof LatestMessageDeliveryStatusEnum];
|
package/models/line-type-enum.ts
CHANGED