bandwidth-sdk 6.1.0 → 6.2.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.
- package/.openapi-generator/FILES +6 -0
- package/api/messages-api.ts +105 -7
- package/api/phone-number-lookup-api.ts +8 -0
- package/api/transcriptions-api.ts +16 -16
- package/bandwidth.yml +272 -15
- package/configuration.ts +1 -1
- package/coverage/clover.xml +175 -136
- package/coverage/coverage-final.json +8 -5
- package/coverage/lcov-report/block-navigation.js +1 -1
- package/coverage/lcov-report/index.html +17 -17
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/index.html +15 -15
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +309 -15
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +26 -2
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +17 -17
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +187 -0
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +178 -0
- 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/CustomParam.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 +5 -2
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/index.html +50 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +13 -4
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +6 -3
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +199 -0
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
- package/coverage/lcov-report/sorter.js +21 -7
- package/coverage/lcov.info +343 -274
- package/dist/api/calls-api.d.ts +5 -5
- package/dist/api/conferences-api.d.ts +9 -9
- package/dist/api/media-api.d.ts +4 -4
- package/dist/api/messages-api.d.ts +54 -5
- package/dist/api/messages-api.js +94 -10
- package/dist/api/mfaapi.d.ts +3 -3
- package/dist/api/multi-channel-api.d.ts +1 -1
- package/dist/api/phone-number-lookup-api.d.ts +10 -2
- package/dist/api/phone-number-lookup-api.js +8 -0
- package/dist/api/recordings-api.d.ts +10 -10
- package/dist/api/statistics-api.d.ts +1 -1
- package/dist/api/toll-free-verification-api.d.ts +9 -9
- package/dist/api/transcriptions-api.d.ts +19 -19
- package/dist/api/transcriptions-api.js +16 -16
- package/dist/configuration.js +1 -1
- package/dist/models/business-entity-type-enum.d.ts +24 -0
- package/dist/models/business-entity-type-enum.js +28 -0
- package/dist/models/business-registration-type-enum.d.ts +21 -0
- package/dist/models/business-registration-type-enum.js +25 -0
- package/dist/models/bxml/verbs/StopStream.d.ts +1 -0
- package/dist/models/call-state.d.ts +1 -1
- package/dist/models/call-transcription-metadata.d.ts +1 -1
- package/dist/models/conference-member.d.ts +1 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-message-item.d.ts +36 -0
- package/dist/models/message-type-enum.d.ts +1 -0
- package/dist/models/message-type-enum.js +2 -1
- package/dist/models/multi-channel-message-response-data.d.ts +1 -1
- package/dist/models/opt-in-workflow.d.ts +6 -0
- package/dist/models/product-type-enum.d.ts +28 -0
- package/dist/models/product-type-enum.js +32 -0
- package/dist/models/stir-shaken.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +20 -0
- package/dist/models/verification-request.d.ts +32 -0
- package/dist/models/verification-update-request.d.ts +32 -0
- package/docs/BusinessEntityTypeEnum.md +17 -0
- package/docs/BusinessRegistrationTypeEnum.md +11 -0
- package/docs/CallState.md +1 -1
- package/docs/CallTranscriptionMetadata.md +1 -1
- package/docs/ConferenceMember.md +1 -1
- package/docs/ListMessageItem.md +12 -0
- package/docs/MessageTypeEnum.md +2 -0
- package/docs/MessagesApi.md +36 -0
- package/docs/MultiChannelMessageResponseData.md +2 -2
- package/docs/OptInWorkflow.md +2 -0
- package/docs/ProductTypeEnum.md +25 -0
- package/docs/StirShaken.md +1 -1
- package/docs/TfvSubmissionInfo.md +6 -0
- package/docs/TranscriptionsApi.md +4 -4
- package/docs/VerificationRequest.md +10 -0
- package/docs/VerificationUpdateRequest.md +10 -0
- package/models/business-entity-type-enum.ts +34 -0
- package/models/business-registration-type-enum.ts +31 -0
- package/models/bxml/verbs/StopStream.ts +1 -0
- package/models/call-state.ts +1 -1
- package/models/call-transcription-metadata.ts +1 -1
- package/models/conference-member.ts +1 -1
- package/models/index.ts +3 -0
- package/models/list-message-item.ts +36 -0
- package/models/message-type-enum.ts +2 -1
- package/models/multi-channel-message-response-data.ts +1 -1
- package/models/opt-in-workflow.ts +6 -0
- package/models/product-type-enum.ts +38 -0
- package/models/stir-shaken.ts +1 -1
- package/models/tfv-submission-info.ts +26 -0
- package/models/verification-request.ts +38 -0
- package/models/verification-update-request.ts +38 -0
- package/package.json +1 -1
- package/tests/smoke/bxml.test.ts +2 -1
- package/tests/smoke/messages-api.test.ts +6 -1
- package/tests/unit/api/messages-api.test.ts +6 -0
- package/tests/unit/models/business-entity-type-enum.test.ts +11 -0
- package/tests/unit/models/business-registration-type-enum.test.ts +8 -0
- package/tests/unit/models/bxml/verbs/StopStream.test.ts +3 -2
- package/tests/unit/models/message-type-enum.test.ts +1 -0
- package/tests/unit/models/product-type-enum.test.ts +15 -0
|
@@ -28,7 +28,7 @@ export interface ConferenceMember {
|
|
|
28
28
|
*/
|
|
29
29
|
'conferenceId'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
|
|
31
|
+
* A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ConferenceMember
|
|
34
34
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -5,6 +5,8 @@ export * from './answer-callback';
|
|
|
5
5
|
export * from './blocked-webhook';
|
|
6
6
|
export * from './bridge-complete-callback';
|
|
7
7
|
export * from './bridge-target-complete-callback';
|
|
8
|
+
export * from './business-entity-type-enum';
|
|
9
|
+
export * from './business-registration-type-enum';
|
|
8
10
|
export * from './call-direction-enum';
|
|
9
11
|
export * from './call-recording-metadata';
|
|
10
12
|
export * from './call-state';
|
|
@@ -87,6 +89,7 @@ export * from './multi-channel-message-response-data-channel-list-inner';
|
|
|
87
89
|
export * from './opt-in-workflow';
|
|
88
90
|
export * from './page-info';
|
|
89
91
|
export * from './priority-enum';
|
|
92
|
+
export * from './product-type-enum';
|
|
90
93
|
export * from './rbm-action-base';
|
|
91
94
|
export * from './rbm-action-dial';
|
|
92
95
|
export * from './rbm-action-open-url';
|
package/dist/models/index.js
CHANGED
|
@@ -21,6 +21,8 @@ __exportStar(require("./answer-callback"), exports);
|
|
|
21
21
|
__exportStar(require("./blocked-webhook"), exports);
|
|
22
22
|
__exportStar(require("./bridge-complete-callback"), exports);
|
|
23
23
|
__exportStar(require("./bridge-target-complete-callback"), exports);
|
|
24
|
+
__exportStar(require("./business-entity-type-enum"), exports);
|
|
25
|
+
__exportStar(require("./business-registration-type-enum"), exports);
|
|
24
26
|
__exportStar(require("./call-direction-enum"), exports);
|
|
25
27
|
__exportStar(require("./call-recording-metadata"), exports);
|
|
26
28
|
__exportStar(require("./call-state"), exports);
|
|
@@ -103,6 +105,7 @@ __exportStar(require("./multi-channel-message-response-data-channel-list-inner")
|
|
|
103
105
|
__exportStar(require("./opt-in-workflow"), exports);
|
|
104
106
|
__exportStar(require("./page-info"), exports);
|
|
105
107
|
__exportStar(require("./priority-enum"), exports);
|
|
108
|
+
__exportStar(require("./product-type-enum"), exports);
|
|
106
109
|
__exportStar(require("./rbm-action-base"), exports);
|
|
107
110
|
__exportStar(require("./rbm-action-dial"), exports);
|
|
108
111
|
__exportStar(require("./rbm-action-open-url"), exports);
|
|
@@ -120,4 +120,40 @@ export interface ListMessageItem {
|
|
|
120
120
|
* @memberof ListMessageItem
|
|
121
121
|
*/
|
|
122
122
|
'campaignId'?: string | null;
|
|
123
|
+
/**
|
|
124
|
+
* The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled.
|
|
125
|
+
* @type {number}
|
|
126
|
+
* @memberof ListMessageItem
|
|
127
|
+
*/
|
|
128
|
+
'bwLatency'?: number | null;
|
|
129
|
+
/**
|
|
130
|
+
* The carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled.
|
|
131
|
+
* @type {number}
|
|
132
|
+
* @memberof ListMessageItem
|
|
133
|
+
*/
|
|
134
|
+
'carrierLatency'?: number | null;
|
|
135
|
+
/**
|
|
136
|
+
* The A3 country code of the calling number.
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof ListMessageItem
|
|
139
|
+
*/
|
|
140
|
+
'callingNumberCountryA3'?: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* The A3 country code of the called number.
|
|
143
|
+
* @type {string}
|
|
144
|
+
* @memberof ListMessageItem
|
|
145
|
+
*/
|
|
146
|
+
'calledNumberCountryA3'?: string | null;
|
|
147
|
+
/**
|
|
148
|
+
* The messaging product associated with the message.
|
|
149
|
+
* @type {string}
|
|
150
|
+
* @memberof ListMessageItem
|
|
151
|
+
*/
|
|
152
|
+
'product'?: string | null;
|
|
153
|
+
/**
|
|
154
|
+
* The location ID associated with this message.
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof ListMessageItem
|
|
157
|
+
*/
|
|
158
|
+
'location'?: string | null;
|
|
123
159
|
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The type of product associated with the message.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const ProductTypeEnum: {
|
|
18
|
+
readonly LocalA2P: "LOCAL_A2P";
|
|
19
|
+
readonly P2P: "P2P";
|
|
20
|
+
readonly ShortCodeReach: "SHORT_CODE_REACH";
|
|
21
|
+
readonly TollFree: "TOLL_FREE";
|
|
22
|
+
readonly HostedShortCode: "HOSTED_SHORT_CODE";
|
|
23
|
+
readonly AlphaNumeric: "ALPHA_NUMERIC";
|
|
24
|
+
readonly RbmMedia: "RBM_MEDIA";
|
|
25
|
+
readonly RbmRich: "RBM_RICH";
|
|
26
|
+
readonly RbmConversational: "RBM_CONVERSATIONAL";
|
|
27
|
+
};
|
|
28
|
+
export type ProductTypeEnum = typeof ProductTypeEnum[keyof typeof ProductTypeEnum];
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ProductTypeEnum = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* The type of product associated with the message.
|
|
19
|
+
* @export
|
|
20
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
exports.ProductTypeEnum = {
|
|
23
|
+
LocalA2P: 'LOCAL_A2P',
|
|
24
|
+
P2P: 'P2P',
|
|
25
|
+
ShortCodeReach: 'SHORT_CODE_REACH',
|
|
26
|
+
TollFree: 'TOLL_FREE',
|
|
27
|
+
HostedShortCode: 'HOSTED_SHORT_CODE',
|
|
28
|
+
AlphaNumeric: 'ALPHA_NUMERIC',
|
|
29
|
+
RbmMedia: 'RBM_MEDIA',
|
|
30
|
+
RbmRich: 'RBM_RICH',
|
|
31
|
+
RbmConversational: 'RBM_CONVERSATIONAL'
|
|
32
|
+
};
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface StirShaken {
|
|
18
18
|
/**
|
|
19
|
-
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-
|
|
19
|
+
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof StirShaken
|
|
22
22
|
*/
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
|
+
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
+
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
13
15
|
import type { Contact } from './contact';
|
|
14
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
15
17
|
/**
|
|
@@ -90,4 +92,22 @@ export interface TfvSubmissionInfo {
|
|
|
90
92
|
* @memberof TfvSubmissionInfo
|
|
91
93
|
*/
|
|
92
94
|
'businessDba'?: string;
|
|
95
|
+
/**
|
|
96
|
+
* US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof TfvSubmissionInfo
|
|
99
|
+
*/
|
|
100
|
+
'businessRegistrationNumber'?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {BusinessRegistrationTypeEnum}
|
|
104
|
+
* @memberof TfvSubmissionInfo
|
|
105
|
+
*/
|
|
106
|
+
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {BusinessEntityTypeEnum}
|
|
110
|
+
* @memberof TfvSubmissionInfo
|
|
111
|
+
*/
|
|
112
|
+
'businessEntityType'?: BusinessEntityTypeEnum | null;
|
|
93
113
|
}
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
|
+
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
+
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
13
15
|
import type { Contact } from './contact';
|
|
14
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
15
17
|
/**
|
|
@@ -96,4 +98,34 @@ export interface VerificationRequest {
|
|
|
96
98
|
* @memberof VerificationRequest
|
|
97
99
|
*/
|
|
98
100
|
'businessDba'?: string;
|
|
101
|
+
/**
|
|
102
|
+
* US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof VerificationRequest
|
|
105
|
+
*/
|
|
106
|
+
'businessRegistrationNumber'?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {BusinessRegistrationTypeEnum}
|
|
110
|
+
* @memberof VerificationRequest
|
|
111
|
+
*/
|
|
112
|
+
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @type {BusinessEntityTypeEnum}
|
|
116
|
+
* @memberof VerificationRequest
|
|
117
|
+
*/
|
|
118
|
+
'businessEntityType'?: BusinessEntityTypeEnum | null;
|
|
119
|
+
/**
|
|
120
|
+
* A message that gets sent to users requesting help.
|
|
121
|
+
* @type {string}
|
|
122
|
+
* @memberof VerificationRequest
|
|
123
|
+
*/
|
|
124
|
+
'helpMessageResponse'?: string | null;
|
|
125
|
+
/**
|
|
126
|
+
* Indicates whether the content is age-gated.
|
|
127
|
+
* @type {boolean}
|
|
128
|
+
* @memberof VerificationRequest
|
|
129
|
+
*/
|
|
130
|
+
'ageGatedContent'?: boolean;
|
|
99
131
|
}
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
|
+
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
+
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
13
15
|
import type { Contact } from './contact';
|
|
14
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
15
17
|
/**
|
|
@@ -90,4 +92,34 @@ export interface VerificationUpdateRequest {
|
|
|
90
92
|
* @memberof VerificationUpdateRequest
|
|
91
93
|
*/
|
|
92
94
|
'businessDba'?: string;
|
|
95
|
+
/**
|
|
96
|
+
* US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof VerificationUpdateRequest
|
|
99
|
+
*/
|
|
100
|
+
'businessRegistrationNumber'?: string | null;
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {BusinessRegistrationTypeEnum}
|
|
104
|
+
* @memberof VerificationUpdateRequest
|
|
105
|
+
*/
|
|
106
|
+
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {BusinessEntityTypeEnum}
|
|
110
|
+
* @memberof VerificationUpdateRequest
|
|
111
|
+
*/
|
|
112
|
+
'businessEntityType'?: BusinessEntityTypeEnum | null;
|
|
113
|
+
/**
|
|
114
|
+
* A message that gets sent to users requesting help.
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof VerificationUpdateRequest
|
|
117
|
+
*/
|
|
118
|
+
'helpMessageResponse'?: string | null;
|
|
119
|
+
/**
|
|
120
|
+
* Indicates whether the content is age-gated.
|
|
121
|
+
* @type {boolean}
|
|
122
|
+
* @memberof VerificationUpdateRequest
|
|
123
|
+
*/
|
|
124
|
+
'ageGatedContent'?: boolean;
|
|
93
125
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# BusinessEntityTypeEnum
|
|
2
|
+
|
|
3
|
+
The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `SoleProprietor` (value: `'SOLE_PROPRIETOR'`)
|
|
8
|
+
|
|
9
|
+
* `PrivateProfit` (value: `'PRIVATE_PROFIT'`)
|
|
10
|
+
|
|
11
|
+
* `PublicProfit` (value: `'PUBLIC_PROFIT'`)
|
|
12
|
+
|
|
13
|
+
* `NonProfit` (value: `'NON_PROFIT'`)
|
|
14
|
+
|
|
15
|
+
* `Government` (value: `'GOVERNMENT'`)
|
|
16
|
+
|
|
17
|
+
[[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,11 @@
|
|
|
1
|
+
# BusinessRegistrationTypeEnum
|
|
2
|
+
|
|
3
|
+
The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Ein` (value: `'EIN'`)
|
|
8
|
+
|
|
9
|
+
* `Cbn` (value: `'CBN'`)
|
|
10
|
+
|
|
11
|
+
[[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/CallState.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
|
|
14
14
|
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
|
|
15
15
|
**state** | **string** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined]
|
|
16
|
-
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-
|
|
16
|
+
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] [default to undefined]
|
|
17
17
|
**identity** | **string** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] [default to undefined]
|
|
18
18
|
**enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined]
|
|
19
19
|
**startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined]
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**transcriptionId** | **string** | The programmable voice API transcription ID. | [optional] [default to undefined]
|
|
9
9
|
**transcriptionName** | **string** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] [default to undefined]
|
|
10
|
-
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/
|
|
10
|
+
**transcriptionUrl** | **string** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/ConferenceMember.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**callId** | **string** | The call id associated with the event. | [optional] [default to undefined]
|
|
9
9
|
**conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined]
|
|
10
|
-
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] [default to undefined]
|
|
10
|
+
**memberUrl** | **string** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member\'s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional] [default to undefined]
|
|
11
11
|
**mute** | **boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member\'s mute status. Has no effect if omitted. | [optional] [default to undefined]
|
|
12
12
|
**hold** | **boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member\'s hold status. Has no effect if omitted. | [optional] [default to undefined]
|
|
13
13
|
**callIdsToCoach** | **Array<string>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] [default to undefined]
|
package/docs/ListMessageItem.md
CHANGED
|
@@ -22,6 +22,12 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**recipientCount** | **number** | The number of recipients the message has. | [optional] [default to undefined]
|
|
23
23
|
**campaignClass** | **string** | The campaign class of the message if it has one. | [optional] [default to undefined]
|
|
24
24
|
**campaignId** | **string** | The campaign ID of the message if it has one. | [optional] [default to undefined]
|
|
25
|
+
**bwLatency** | **number** | The Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | [optional] [default to undefined]
|
|
26
|
+
**carrierLatency** | **number** | The carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | [optional] [default to undefined]
|
|
27
|
+
**callingNumberCountryA3** | **string** | The A3 country code of the calling number. | [optional] [default to undefined]
|
|
28
|
+
**calledNumberCountryA3** | **string** | The A3 country code of the called number. | [optional] [default to undefined]
|
|
29
|
+
**product** | **string** | The messaging product associated with the message. | [optional] [default to undefined]
|
|
30
|
+
**location** | **string** | The location ID associated with this message. | [optional] [default to undefined]
|
|
25
31
|
|
|
26
32
|
## Example
|
|
27
33
|
|
|
@@ -46,6 +52,12 @@ const instance: ListMessageItem = {
|
|
|
46
52
|
recipientCount,
|
|
47
53
|
campaignClass,
|
|
48
54
|
campaignId,
|
|
55
|
+
bwLatency,
|
|
56
|
+
carrierLatency,
|
|
57
|
+
callingNumberCountryA3,
|
|
58
|
+
calledNumberCountryA3,
|
|
59
|
+
product,
|
|
60
|
+
location,
|
|
49
61
|
};
|
|
50
62
|
```
|
|
51
63
|
|
package/docs/MessageTypeEnum.md
CHANGED
package/docs/MessagesApi.md
CHANGED
|
@@ -99,6 +99,18 @@ let errorCode: number; //The error code of the message. (optional) (default to u
|
|
|
99
99
|
let fromDateTime: string; //The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. (optional) (default to undefined)
|
|
100
100
|
let toDateTime: string; //The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. (optional) (default to undefined)
|
|
101
101
|
let campaignId: string; //The campaign ID of the message. (optional) (default to undefined)
|
|
102
|
+
let fromBwLatency: number; //The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. (optional) (default to undefined)
|
|
103
|
+
let bwQueued: boolean; //A boolean value indicating whether the message is queued in the Bandwidth network. (optional) (default to undefined)
|
|
104
|
+
let product: ProductTypeEnum; //Messaging product associated with the message. (optional) (default to undefined)
|
|
105
|
+
let location: string; //Location Id associated with the message. (optional) (default to undefined)
|
|
106
|
+
let carrierQueued: boolean; //A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. (optional) (default to undefined)
|
|
107
|
+
let fromCarrierLatency: number; //The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. (optional) (default to undefined)
|
|
108
|
+
let callingNumberCountryA3: string; //Calling number country in A3 format. (optional) (default to undefined)
|
|
109
|
+
let calledNumberCountryA3: string; //Called number country in A3 format. (optional) (default to undefined)
|
|
110
|
+
let fromSegmentCount: number; //Segment count (start range). (optional) (default to undefined)
|
|
111
|
+
let toSegmentCount: number; //Segment count (end range). (optional) (default to undefined)
|
|
112
|
+
let fromMessageSize: number; //Message size (start range). (optional) (default to undefined)
|
|
113
|
+
let toMessageSize: number; //Message size (end range). (optional) (default to undefined)
|
|
102
114
|
let sort: string; //The field and direction to sort by combined with a colon. Direction is either asc or desc. (optional) (default to undefined)
|
|
103
115
|
let pageToken: string; //A base64 encoded value used for pagination of results. (optional) (default to undefined)
|
|
104
116
|
let limit: number; //The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. (optional) (default to undefined)
|
|
@@ -117,6 +129,18 @@ const { status, data } = await apiInstance.listMessages(
|
|
|
117
129
|
fromDateTime,
|
|
118
130
|
toDateTime,
|
|
119
131
|
campaignId,
|
|
132
|
+
fromBwLatency,
|
|
133
|
+
bwQueued,
|
|
134
|
+
product,
|
|
135
|
+
location,
|
|
136
|
+
carrierQueued,
|
|
137
|
+
fromCarrierLatency,
|
|
138
|
+
callingNumberCountryA3,
|
|
139
|
+
calledNumberCountryA3,
|
|
140
|
+
fromSegmentCount,
|
|
141
|
+
toSegmentCount,
|
|
142
|
+
fromMessageSize,
|
|
143
|
+
toMessageSize,
|
|
120
144
|
sort,
|
|
121
145
|
pageToken,
|
|
122
146
|
limit,
|
|
@@ -140,6 +164,18 @@ const { status, data } = await apiInstance.listMessages(
|
|
|
140
164
|
| **fromDateTime** | [**string**] | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | (optional) defaults to undefined|
|
|
141
165
|
| **toDateTime** | [**string**] | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | (optional) defaults to undefined|
|
|
142
166
|
| **campaignId** | [**string**] | The campaign ID of the message. | (optional) defaults to undefined|
|
|
167
|
+
| **fromBwLatency** | [**number**] | The minimum Bandwidth latency of the message in seconds. Only available for accounts with the Advanced Quality Metrics feature enabled. | (optional) defaults to undefined|
|
|
168
|
+
| **bwQueued** | [**boolean**] | A boolean value indicating whether the message is queued in the Bandwidth network. | (optional) defaults to undefined|
|
|
169
|
+
| **product** | **ProductTypeEnum** | Messaging product associated with the message. | (optional) defaults to undefined|
|
|
170
|
+
| **location** | [**string**] | Location Id associated with the message. | (optional) defaults to undefined|
|
|
171
|
+
| **carrierQueued** | [**boolean**] | A boolean value indicating whether the message is queued in the carrier network. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | (optional) defaults to undefined|
|
|
172
|
+
| **fromCarrierLatency** | [**number**] | The minimum carrier latency of the message in seconds. Only available for OUTBOUND messages from accounts with the Advanced Quality Metrics feature enabled. | (optional) defaults to undefined|
|
|
173
|
+
| **callingNumberCountryA3** | [**string**] | Calling number country in A3 format. | (optional) defaults to undefined|
|
|
174
|
+
| **calledNumberCountryA3** | [**string**] | Called number country in A3 format. | (optional) defaults to undefined|
|
|
175
|
+
| **fromSegmentCount** | [**number**] | Segment count (start range). | (optional) defaults to undefined|
|
|
176
|
+
| **toSegmentCount** | [**number**] | Segment count (end range). | (optional) defaults to undefined|
|
|
177
|
+
| **fromMessageSize** | [**number**] | Message size (start range). | (optional) defaults to undefined|
|
|
178
|
+
| **toMessageSize** | [**number**] | Message size (end range). | (optional) defaults to undefined|
|
|
143
179
|
| **sort** | [**string**] | The field and direction to sort by combined with a colon. Direction is either asc or desc. | (optional) defaults to undefined|
|
|
144
180
|
| **pageToken** | [**string**] | A base64 encoded value used for pagination of results. | (optional) defaults to undefined|
|
|
145
181
|
| **limit** | [**number**] | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | (optional) defaults to undefined|
|
|
@@ -6,7 +6,7 @@ The data returned in a multichannel message response.
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
9
|
+
**id** | **string** | The ID of the message. | [default to undefined]
|
|
10
10
|
**time** | **string** | The time the message was received by the Bandwidth API. | [default to undefined]
|
|
11
11
|
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
|
|
12
12
|
**to** | **Set<string>** | The destination phone number(s) of the message, in E164 format. | [default to undefined]
|
|
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
|
|
|
21
21
|
import { MultiChannelMessageResponseData } from 'bandwidth-sdk';
|
|
22
22
|
|
|
23
23
|
const instance: MultiChannelMessageResponseData = {
|
|
24
|
-
|
|
24
|
+
id,
|
|
25
25
|
time,
|
|
26
26
|
direction,
|
|
27
27
|
to,
|
package/docs/OptInWorkflow.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**description** | **string** | | [default to undefined]
|
|
9
9
|
**imageUrls** | **Array<string>** | | [default to undefined]
|
|
10
|
+
**confirmationResponse** | **string** | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { OptInWorkflow } from 'bandwidth-sdk';
|
|
|
16
17
|
const instance: OptInWorkflow = {
|
|
17
18
|
description,
|
|
18
19
|
imageUrls,
|
|
20
|
+
confirmationResponse,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ProductTypeEnum
|
|
2
|
+
|
|
3
|
+
The type of product associated with the message.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `LocalA2P` (value: `'LOCAL_A2P'`)
|
|
8
|
+
|
|
9
|
+
* `P2P` (value: `'P2P'`)
|
|
10
|
+
|
|
11
|
+
* `ShortCodeReach` (value: `'SHORT_CODE_REACH'`)
|
|
12
|
+
|
|
13
|
+
* `TollFree` (value: `'TOLL_FREE'`)
|
|
14
|
+
|
|
15
|
+
* `HostedShortCode` (value: `'HOSTED_SHORT_CODE'`)
|
|
16
|
+
|
|
17
|
+
* `AlphaNumeric` (value: `'ALPHA_NUMERIC'`)
|
|
18
|
+
|
|
19
|
+
* `RbmMedia` (value: `'RBM_MEDIA'`)
|
|
20
|
+
|
|
21
|
+
* `RbmRich` (value: `'RBM_RICH'`)
|
|
22
|
+
|
|
23
|
+
* `RbmConversational` (value: `'RBM_CONVERSATIONAL'`)
|
|
24
|
+
|
|
25
|
+
[[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/StirShaken.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-
|
|
8
|
+
**verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. | [optional] [default to undefined]
|
|
9
9
|
**attestationIndicator** | **string** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] [default to undefined]
|
|
10
10
|
**originatingId** | **string** | (optional) A unique origination identifier. | [optional] [default to undefined]
|
|
11
11
|
|
|
@@ -17,6 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
|
|
18
18
|
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
|
|
19
19
|
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
|
|
20
|
+
**businessRegistrationNumber** | **string** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] [default to undefined]
|
|
21
|
+
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
|
+
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
20
23
|
|
|
21
24
|
## Example
|
|
22
25
|
|
|
@@ -36,6 +39,9 @@ const instance: TfvSubmissionInfo = {
|
|
|
36
39
|
privacyPolicyUrl,
|
|
37
40
|
termsAndConditionsUrl,
|
|
38
41
|
businessDba,
|
|
42
|
+
businessRegistrationNumber,
|
|
43
|
+
businessRegistrationType,
|
|
44
|
+
businessEntityType,
|
|
39
45
|
};
|
|
40
46
|
```
|
|
41
47
|
|
|
@@ -4,9 +4,9 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete
|
|
8
|
-
|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} |
|
|
9
|
-
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions |
|
|
7
|
+
|[**deleteRealTimeTranscription**](#deleterealtimetranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription|
|
|
8
|
+
|[**getRealTimeTranscription**](#getrealtimetranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription|
|
|
9
|
+
|[**listRealTimeTranscriptions**](#listrealtimetranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions|
|
|
10
10
|
|
|
11
11
|
# **deleteRealTimeTranscription**
|
|
12
12
|
> deleteRealTimeTranscription()
|
|
@@ -141,7 +141,7 @@ const { status, data } = await apiInstance.getRealTimeTranscription(
|
|
|
141
141
|
# **listRealTimeTranscriptions**
|
|
142
142
|
> Array<CallTranscriptionMetadata> listRealTimeTranscriptions()
|
|
143
143
|
|
|
144
|
-
|
|
144
|
+
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
|
|
145
145
|
|
|
146
146
|
### Example
|
|
147
147
|
|
|
@@ -18,6 +18,11 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
|
|
19
19
|
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
|
|
20
20
|
**businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
|
|
21
|
+
**businessRegistrationNumber** | **string** | US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025. | [optional] [default to undefined]
|
|
22
|
+
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
23
|
+
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
24
|
+
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
25
|
+
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
|
|
21
26
|
|
|
22
27
|
## Example
|
|
23
28
|
|
|
@@ -38,6 +43,11 @@ const instance: VerificationRequest = {
|
|
|
38
43
|
privacyPolicyUrl,
|
|
39
44
|
termsAndConditionsUrl,
|
|
40
45
|
businessDba,
|
|
46
|
+
businessRegistrationNumber,
|
|
47
|
+
businessRegistrationType,
|
|
48
|
+
businessEntityType,
|
|
49
|
+
helpMessageResponse,
|
|
50
|
+
ageGatedContent,
|
|
41
51
|
};
|
|
42
52
|
```
|
|
43
53
|
|