bandwidth-sdk 7.4.1 → 8.0.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/.openapi-generator/FILES +0 -2
- package/README.md +0 -1
- package/api/media-api.ts +4 -4
- package/bandwidth.yml +157 -64
- package/configuration.ts +1 -1
- package/coverage/clover.xml +5 -10
- package/coverage/coverage-final.json +1 -2
- package/coverage/lcov-report/index.html +7 -7
- 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 +1 -1
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +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/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 +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 +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/completed-lookup-status-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/deactivation-event-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/in-progress-lookup-status-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 +5 -20
- package/coverage/lcov-report/node-sdk/models/index.ts.html +4 -7
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/list-message-direction-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 +1 -1
- 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 +1 -1
- 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/rbm-open-url-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-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.info +2 -13
- package/dist/api/media-api.d.ts +4 -4
- package/dist/api/media-api.js +4 -4
- package/dist/configuration.js +1 -1
- package/dist/models/business-entity-type-enum.d.ts +1 -1
- package/dist/models/business-entity-type-enum.js +1 -1
- package/dist/models/business-registration-type-enum.d.ts +1 -1
- package/dist/models/business-registration-type-enum.js +1 -1
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/lookup-error-schema.d.ts +3 -3
- package/dist/models/lookup-result.d.ts +5 -1
- package/dist/models/mms-message-content-file.d.ts +1 -1
- package/dist/models/tfv-submission-info.d.ts +5 -3
- package/dist/models/verification-request.d.ts +5 -3
- package/dist/models/verification-update-request.d.ts +5 -3
- package/docs/BusinessEntityTypeEnum.md +1 -1
- package/docs/BusinessRegistrationTypeEnum.md +1 -1
- package/docs/LookupErrorSchema.md +3 -3
- package/docs/LookupResult.md +3 -1
- package/docs/MediaApi.md +1 -1
- package/docs/MmsMessageContentFile.md +1 -1
- package/docs/TfvSubmissionInfo.md +2 -2
- package/docs/VerificationRequest.md +2 -2
- package/docs/VerificationUpdateRequest.md +2 -2
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-type-enum.ts +1 -1
- package/models/index.ts +0 -1
- package/models/lookup-error-schema.ts +3 -3
- package/models/lookup-result.ts +5 -1
- package/models/mms-message-content-file.ts +1 -1
- package/models/tfv-submission-info.ts +5 -5
- package/models/verification-request.ts +5 -5
- package/models/verification-update-request.ts +5 -5
- package/package.json +1 -1
- package/tests/smoke/phone-number-lookup-api.test.ts +2 -10
- package/tests/unit/api/phone-number-lookup-api.test.ts +0 -8
- package/tests/unit/api/toll-free-verification-api.test.ts +1 -1
- package/coverage/lcov-report/node-sdk/models/business-registration-issuing-country-enum.ts.html +0 -217
- package/dist/models/business-registration-issuing-country-enum.d.ts +0 -34
- package/dist/models/business-registration-issuing-country-enum.js +0 -38
- package/docs/BusinessRegistrationIssuingCountryEnum.md +0 -41
- package/models/business-registration-issuing-country-enum.ts +0 -44
- package/tests/unit/models/business-registration-issuing-country-enum.test.ts +0 -23
package/dist/api/media-api.d.ts
CHANGED
|
@@ -45,7 +45,7 @@ export declare const MediaApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
45
45
|
*/
|
|
46
46
|
listMedia: (accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
48
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
49
49
|
* @summary Upload Media
|
|
50
50
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
51
51
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -89,7 +89,7 @@ export declare const MediaApiFp: (configuration?: Configuration) => {
|
|
|
89
89
|
*/
|
|
90
90
|
listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Media>>>;
|
|
91
91
|
/**
|
|
92
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
92
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
93
93
|
* @summary Upload Media
|
|
94
94
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
95
95
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -133,7 +133,7 @@ export declare const MediaApiFactory: (configuration?: Configuration, basePath?:
|
|
|
133
133
|
*/
|
|
134
134
|
listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Media>>;
|
|
135
135
|
/**
|
|
136
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
136
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
137
137
|
* @summary Upload Media
|
|
138
138
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
139
139
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -177,7 +177,7 @@ export declare class MediaApi extends BaseAPI {
|
|
|
177
177
|
*/
|
|
178
178
|
listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Media[], any, {}>>;
|
|
179
179
|
/**
|
|
180
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
180
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
181
181
|
* @summary Upload Media
|
|
182
182
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
183
183
|
* @param {string} mediaId Media ID to retrieve.
|
package/dist/api/media-api.js
CHANGED
|
@@ -260,7 +260,7 @@ var MediaApiAxiosParamCreator = function (configuration) {
|
|
|
260
260
|
});
|
|
261
261
|
},
|
|
262
262
|
/**
|
|
263
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
263
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
264
264
|
* @summary Upload Media
|
|
265
265
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
266
266
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -408,7 +408,7 @@ var MediaApiFp = function (configuration) {
|
|
|
408
408
|
});
|
|
409
409
|
},
|
|
410
410
|
/**
|
|
411
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
411
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
412
412
|
* @summary Upload Media
|
|
413
413
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
414
414
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -477,7 +477,7 @@ var MediaApiFactory = function (configuration, basePath, axios) {
|
|
|
477
477
|
return localVarFp.listMedia(accountId, continuationToken, options).then(function (request) { return request(axios, basePath); });
|
|
478
478
|
},
|
|
479
479
|
/**
|
|
480
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
480
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
481
481
|
* @summary Upload Media
|
|
482
482
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
483
483
|
* @param {string} mediaId Media ID to retrieve.
|
|
@@ -538,7 +538,7 @@ var MediaApi = /** @class */ (function (_super) {
|
|
|
538
538
|
return (0, exports.MediaApiFp)(this.configuration).listMedia(accountId, continuationToken, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
539
539
|
};
|
|
540
540
|
/**
|
|
541
|
-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
541
|
+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
542
542
|
* @summary Upload Media
|
|
543
543
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
544
544
|
* @param {string} mediaId Media ID to retrieve.
|
package/dist/configuration.js
CHANGED
|
@@ -103,7 +103,7 @@ var Configuration = /** @class */ (function () {
|
|
|
103
103
|
this.awsv4 = param.awsv4;
|
|
104
104
|
this.basePath = param.basePath;
|
|
105
105
|
this.serverIndex = param.serverIndex;
|
|
106
|
-
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_b = param.baseOptions) === null || _b === void 0 ? void 0 : _b.headers), { 'User-Agent': "OpenAPI-Generator/
|
|
106
|
+
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_b = param.baseOptions) === null || _b === void 0 ? void 0 : _b.headers), { 'User-Agent': "OpenAPI-Generator/8.0.0/typescript-axios" }) });
|
|
107
107
|
this.formDataCtor = param.formDataCtor;
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The type of registered business.
|
|
13
|
+
* The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
|
|
14
14
|
*/
|
|
15
15
|
export declare const BusinessEntityTypeEnum: {
|
|
16
16
|
readonly SoleProprietor: "SOLE_PROPRIETOR";
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.BusinessEntityTypeEnum = void 0;
|
|
17
17
|
/**
|
|
18
|
-
* The type of registered business.
|
|
18
|
+
* The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
|
|
19
19
|
*/
|
|
20
20
|
exports.BusinessEntityTypeEnum = {
|
|
21
21
|
SoleProprietor: 'SOLE_PROPRIETOR',
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The type of business registration number.
|
|
13
|
+
* The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.**
|
|
14
14
|
*/
|
|
15
15
|
export declare const BusinessRegistrationTypeEnum: {
|
|
16
16
|
readonly Ein: "EIN";
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.BusinessRegistrationTypeEnum = void 0;
|
|
17
17
|
/**
|
|
18
|
-
* The type of business registration number.
|
|
18
|
+
* The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.**
|
|
19
19
|
*/
|
|
20
20
|
exports.BusinessRegistrationTypeEnum = {
|
|
21
21
|
Ein: 'EIN',
|
package/dist/models/index.d.ts
CHANGED
|
@@ -7,7 +7,6 @@ export * from './blocked-webhook';
|
|
|
7
7
|
export * from './bridge-complete-callback';
|
|
8
8
|
export * from './bridge-target-complete-callback';
|
|
9
9
|
export * from './business-entity-type-enum';
|
|
10
|
-
export * from './business-registration-issuing-country-enum';
|
|
11
10
|
export * from './business-registration-type-enum';
|
|
12
11
|
export * from './call-direction-enum';
|
|
13
12
|
export * from './call-recording-metadata';
|
package/dist/models/index.js
CHANGED
|
@@ -23,7 +23,6 @@ __exportStar(require("./blocked-webhook"), exports);
|
|
|
23
23
|
__exportStar(require("./bridge-complete-callback"), exports);
|
|
24
24
|
__exportStar(require("./bridge-target-complete-callback"), exports);
|
|
25
25
|
__exportStar(require("./business-entity-type-enum"), exports);
|
|
26
|
-
__exportStar(require("./business-registration-issuing-country-enum"), exports);
|
|
27
26
|
__exportStar(require("./business-registration-type-enum"), exports);
|
|
28
27
|
__exportStar(require("./call-direction-enum"), exports);
|
|
29
28
|
__exportStar(require("./call-recording-metadata"), exports);
|
|
@@ -14,14 +14,14 @@ export interface LookupErrorSchema {
|
|
|
14
14
|
/**
|
|
15
15
|
* Validation error code
|
|
16
16
|
*/
|
|
17
|
-
'code'
|
|
17
|
+
'code': string;
|
|
18
18
|
/**
|
|
19
19
|
* Description of validation error
|
|
20
20
|
*/
|
|
21
|
-
'description'
|
|
21
|
+
'description': string;
|
|
22
22
|
/**
|
|
23
23
|
* Type of validation error
|
|
24
24
|
*/
|
|
25
|
-
'type'
|
|
25
|
+
'type': string;
|
|
26
26
|
'meta'?: LookupErrorSchemaMeta;
|
|
27
27
|
}
|
|
@@ -48,7 +48,11 @@ export interface LookupResult {
|
|
|
48
48
|
*/
|
|
49
49
|
'initialMessageDeliveryStatusDate'?: string;
|
|
50
50
|
/**
|
|
51
|
-
* [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
|
|
51
|
+
* [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.
|
|
52
52
|
*/
|
|
53
53
|
'latestMessageDeliveryStatusDate'?: string;
|
|
54
|
+
/**
|
|
55
|
+
* [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.
|
|
56
|
+
*/
|
|
57
|
+
'rcsEnabled'?: boolean;
|
|
54
58
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
export interface MmsMessageContentFile {
|
|
13
13
|
/**
|
|
14
|
-
* The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [
|
|
14
|
+
* The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details.
|
|
15
15
|
*/
|
|
16
16
|
'fileUrl': string;
|
|
17
17
|
}
|
|
@@ -11,7 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
13
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
15
14
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
16
15
|
import type { Contact } from './contact';
|
|
17
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
@@ -56,10 +55,13 @@ export interface TfvSubmissionInfo {
|
|
|
56
55
|
*/
|
|
57
56
|
'businessDba'?: string;
|
|
58
57
|
/**
|
|
59
|
-
* Government-issued business identifying number. **Note
|
|
58
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
60
59
|
*/
|
|
61
60
|
'businessRegistrationNumber'?: string | null;
|
|
62
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
63
|
-
|
|
62
|
+
/**
|
|
63
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
64
|
+
*/
|
|
65
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
64
66
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
65
67
|
}
|
|
@@ -11,7 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
13
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
15
14
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
16
15
|
import type { Contact } from './contact';
|
|
17
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
@@ -57,11 +56,14 @@ export interface VerificationRequest {
|
|
|
57
56
|
*/
|
|
58
57
|
'businessDba'?: string;
|
|
59
58
|
/**
|
|
60
|
-
* Government-issued business identifying number. **Note
|
|
59
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
61
60
|
*/
|
|
62
61
|
'businessRegistrationNumber'?: string | null;
|
|
63
62
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
64
|
-
|
|
63
|
+
/**
|
|
64
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
65
|
+
*/
|
|
66
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
65
67
|
'businessEntityType': BusinessEntityTypeEnum;
|
|
66
68
|
/**
|
|
67
69
|
* A message that gets sent to users requesting help.
|
|
@@ -11,7 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Address } from './address';
|
|
13
13
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
14
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
15
14
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
16
15
|
import type { Contact } from './contact';
|
|
17
16
|
import type { OptInWorkflow } from './opt-in-workflow';
|
|
@@ -56,12 +55,15 @@ export interface VerificationUpdateRequest {
|
|
|
56
55
|
*/
|
|
57
56
|
'businessDba'?: string;
|
|
58
57
|
/**
|
|
59
|
-
* Government-issued business identifying number. **Note
|
|
58
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
60
59
|
*/
|
|
61
60
|
'businessRegistrationNumber'?: string | null;
|
|
62
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
63
62
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
64
|
-
|
|
63
|
+
/**
|
|
64
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
65
|
+
*/
|
|
66
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
65
67
|
/**
|
|
66
68
|
* A message that gets sent to users requesting help.
|
|
67
69
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessEntityTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of registered business.
|
|
3
|
+
The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**code** | **string** | Validation error code | [
|
|
9
|
-
**description** | **string** | Description of validation error | [
|
|
10
|
-
**type** | **string** | Type of validation error | [
|
|
8
|
+
**code** | **string** | Validation error code | [default to undefined]
|
|
9
|
+
**description** | **string** | Description of validation error | [default to undefined]
|
|
10
|
+
**type** | **string** | Type of validation error | [default to undefined]
|
|
11
11
|
**meta** | [**LookupErrorSchemaMeta**](LookupErrorSchemaMeta.md) | | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
package/docs/LookupResult.md
CHANGED
|
@@ -16,7 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**deactivationEvent** | [**DeactivationEventEnum**](DeactivationEventEnum.md) | | [optional] [default to undefined]
|
|
17
17
|
**latestMessageDeliveryStatus** | [**LatestMessageDeliveryStatusEnum**](LatestMessageDeliveryStatusEnum.md) | | [optional] [default to undefined]
|
|
18
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
|
-
**latestMessageDeliveryStatusDate** | **string** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
|
|
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
|
+
**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]
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -35,6 +36,7 @@ const instance: LookupResult = {
|
|
|
35
36
|
latestMessageDeliveryStatus,
|
|
36
37
|
initialMessageDeliveryStatusDate,
|
|
37
38
|
latestMessageDeliveryStatusDate,
|
|
39
|
+
rcsEnabled,
|
|
38
40
|
};
|
|
39
41
|
```
|
|
40
42
|
|
package/docs/MediaApi.md
CHANGED
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.listMedia(
|
|
|
198
198
|
# **uploadMedia**
|
|
199
199
|
> uploadMedia(body)
|
|
200
200
|
|
|
201
|
-
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [
|
|
201
|
+
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
202
202
|
|
|
203
203
|
### Example
|
|
204
204
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [
|
|
8
|
+
**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -17,9 +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** | Government-issued business identifying number. **Note
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
|
|
21
21
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
|
-
**businessRegistrationIssuingCountry** |
|
|
22
|
+
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
|
|
23
23
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
24
24
|
|
|
25
25
|
## Example
|
|
@@ -18,9 +18,9 @@ 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** | Government-issued business identifying number. **Note
|
|
21
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
|
|
22
22
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
23
|
-
**businessRegistrationIssuingCountry** |
|
|
23
|
+
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
|
|
24
24
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [default to undefined]
|
|
25
25
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
26
26
|
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
|
|
@@ -17,10 +17,10 @@ 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** | Government-issued business identifying number. **Note
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] [default to undefined]
|
|
21
21
|
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
|
|
22
22
|
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
|
|
23
|
-
**businessRegistrationIssuingCountry** |
|
|
23
|
+
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
|
|
24
24
|
**helpMessageResponse** | **string** | A message that gets sent to users requesting help. | [optional] [default to undefined]
|
|
25
25
|
**ageGatedContent** | **boolean** | Indicates whether the content is age-gated. | [optional] [default to undefined]
|
|
26
26
|
**cvToken** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] [default to undefined]
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The type of registered business.
|
|
18
|
+
* The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const BusinessEntityTypeEnum = {
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* The type of business registration number.
|
|
18
|
+
* The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.**
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const BusinessRegistrationTypeEnum = {
|
package/models/index.ts
CHANGED
|
@@ -7,7 +7,6 @@ export * from './blocked-webhook';
|
|
|
7
7
|
export * from './bridge-complete-callback';
|
|
8
8
|
export * from './bridge-target-complete-callback';
|
|
9
9
|
export * from './business-entity-type-enum';
|
|
10
|
-
export * from './business-registration-issuing-country-enum';
|
|
11
10
|
export * from './business-registration-type-enum';
|
|
12
11
|
export * from './call-direction-enum';
|
|
13
12
|
export * from './call-recording-metadata';
|
|
@@ -21,15 +21,15 @@ export interface LookupErrorSchema {
|
|
|
21
21
|
/**
|
|
22
22
|
* Validation error code
|
|
23
23
|
*/
|
|
24
|
-
'code'
|
|
24
|
+
'code': string;
|
|
25
25
|
/**
|
|
26
26
|
* Description of validation error
|
|
27
27
|
*/
|
|
28
|
-
'description'
|
|
28
|
+
'description': string;
|
|
29
29
|
/**
|
|
30
30
|
* Type of validation error
|
|
31
31
|
*/
|
|
32
|
-
'type'
|
|
32
|
+
'type': string;
|
|
33
33
|
'meta'?: LookupErrorSchemaMeta;
|
|
34
34
|
}
|
|
35
35
|
|
package/models/lookup-result.ts
CHANGED
|
@@ -59,9 +59,13 @@ export interface LookupResult {
|
|
|
59
59
|
*/
|
|
60
60
|
'initialMessageDeliveryStatusDate'?: string;
|
|
61
61
|
/**
|
|
62
|
-
* [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
|
|
62
|
+
* [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.
|
|
63
63
|
*/
|
|
64
64
|
'latestMessageDeliveryStatusDate'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* [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.
|
|
67
|
+
*/
|
|
68
|
+
'rcsEnabled'?: boolean;
|
|
65
69
|
}
|
|
66
70
|
|
|
67
71
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
export interface MmsMessageContentFile {
|
|
18
18
|
/**
|
|
19
|
-
* The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [
|
|
19
|
+
* The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details.
|
|
20
20
|
*/
|
|
21
21
|
'fileUrl': string;
|
|
22
22
|
}
|
|
@@ -21,9 +21,6 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
-
// May contain unused imports in some cases
|
|
26
|
-
// @ts-ignore
|
|
27
24
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
28
25
|
// May contain unused imports in some cases
|
|
29
26
|
// @ts-ignore
|
|
@@ -73,11 +70,14 @@ export interface TfvSubmissionInfo {
|
|
|
73
70
|
*/
|
|
74
71
|
'businessDba'?: string;
|
|
75
72
|
/**
|
|
76
|
-
* Government-issued business identifying number. **Note
|
|
73
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
77
74
|
*/
|
|
78
75
|
'businessRegistrationNumber'?: string | null;
|
|
79
76
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
80
|
-
|
|
77
|
+
/**
|
|
78
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
79
|
+
*/
|
|
80
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
81
81
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
82
82
|
}
|
|
83
83
|
|
|
@@ -21,9 +21,6 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
-
// May contain unused imports in some cases
|
|
26
|
-
// @ts-ignore
|
|
27
24
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
28
25
|
// May contain unused imports in some cases
|
|
29
26
|
// @ts-ignore
|
|
@@ -74,11 +71,14 @@ export interface VerificationRequest {
|
|
|
74
71
|
*/
|
|
75
72
|
'businessDba'?: string;
|
|
76
73
|
/**
|
|
77
|
-
* Government-issued business identifying number. **Note
|
|
74
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
78
75
|
*/
|
|
79
76
|
'businessRegistrationNumber'?: string | null;
|
|
80
77
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
81
|
-
|
|
78
|
+
/**
|
|
79
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
80
|
+
*/
|
|
81
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
82
82
|
'businessEntityType': BusinessEntityTypeEnum;
|
|
83
83
|
/**
|
|
84
84
|
* A message that gets sent to users requesting help.
|
|
@@ -21,9 +21,6 @@ import type { Address } from './address';
|
|
|
21
21
|
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
|
-
import type { BusinessRegistrationIssuingCountryEnum } from './business-registration-issuing-country-enum';
|
|
25
|
-
// May contain unused imports in some cases
|
|
26
|
-
// @ts-ignore
|
|
27
24
|
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
|
|
28
25
|
// May contain unused imports in some cases
|
|
29
26
|
// @ts-ignore
|
|
@@ -73,12 +70,15 @@ export interface VerificationUpdateRequest {
|
|
|
73
70
|
*/
|
|
74
71
|
'businessDba'?: string;
|
|
75
72
|
/**
|
|
76
|
-
* Government-issued business identifying number. **Note
|
|
73
|
+
* Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
77
74
|
*/
|
|
78
75
|
'businessRegistrationNumber'?: string | null;
|
|
79
76
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
80
77
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
81
|
-
|
|
78
|
+
/**
|
|
79
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
80
|
+
*/
|
|
81
|
+
'businessRegistrationIssuingCountry'?: string | null;
|
|
82
82
|
/**
|
|
83
83
|
* A message that gets sent to users requesting help.
|
|
84
84
|
*/
|