bandwidth-sdk 8.2.0 → 8.3.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/.github/CODEOWNERS +0 -3
- package/.github/workflows/deploy.yml +1 -11
- package/api/media-api.ts +20 -20
- package/api/toll-free-verification-api.ts +12 -12
- package/bandwidth.yml +58 -15
- package/configuration.ts +1 -1
- package/coverage/clover.xml +32 -32
- package/coverage/coverage-final.json +7 -7
- package/coverage/lcov-report/index.html +1 -1
- 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/endpoints-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 +21 -21
- 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 +13 -13
- 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/Connect.ts.html +5 -2
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +8 -2
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +26 -2
- 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 +8 -2
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Refer.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 +8 -2
- 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 +8 -2
- 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 +5 -2
- 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/device-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-type-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 +1 -1
- package/coverage/lcov-report/node-sdk/models/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +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/refer-call-status-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 +63 -63
- package/dist/api/media-api.d.ts +20 -20
- package/dist/api/media-api.js +20 -20
- package/dist/api/toll-free-verification-api.d.ts +12 -12
- package/dist/api/toll-free-verification-api.js +12 -12
- 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/bxml/verbs/Connect.d.ts +1 -0
- package/dist/models/bxml/verbs/Forward.d.ts +2 -0
- package/dist/models/bxml/verbs/Gather.d.ts +8 -0
- package/dist/models/bxml/verbs/Record.d.ts +2 -0
- package/dist/models/bxml/verbs/StartRecording.d.ts +2 -0
- package/dist/models/bxml/verbs/StartTranscription.d.ts +2 -0
- package/dist/models/bxml/verbs/Transfer.d.ts +1 -0
- package/dist/models/tfv-submission-info.d.ts +2 -2
- package/dist/models/verification-request.d.ts +2 -2
- package/dist/models/verification-update-request.d.ts +3 -3
- package/docs/BusinessEntityTypeEnum.md +1 -1
- package/docs/BusinessRegistrationTypeEnum.md +1 -1
- package/docs/MediaApi.md +9 -9
- package/docs/TfvSubmissionInfo.md +2 -2
- package/docs/TollFreeVerificationApi.md +6 -3
- package/docs/VerificationRequest.md +2 -2
- package/docs/VerificationUpdateRequest.md +3 -3
- package/generate.sh +6 -0
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-type-enum.ts +1 -1
- package/models/bxml/verbs/Connect.ts +1 -0
- package/models/bxml/verbs/Forward.ts +2 -0
- package/models/bxml/verbs/Gather.ts +8 -0
- package/models/bxml/verbs/Record.ts +2 -0
- package/models/bxml/verbs/StartRecording.ts +2 -0
- package/models/bxml/verbs/StartTranscription.ts +2 -0
- package/models/bxml/verbs/Transfer.ts +1 -0
- package/models/tfv-submission-info.ts +2 -2
- package/models/verification-request.ts +2 -2
- package/models/verification-update-request.ts +3 -3
- package/package.json +1 -1
- package/tests/smoke/bxml.test.ts +24 -7
- package/tests/unit/models/bxml/verbs/Connect.test.ts +6 -5
- package/tests/unit/models/bxml/verbs/Forward.test.ts +4 -2
- package/tests/unit/models/bxml/verbs/Gather.test.ts +14 -6
- package/tests/unit/models/bxml/verbs/Record.test.ts +4 -2
- package/tests/unit/models/bxml/verbs/StartRecording.test.ts +4 -2
- package/tests/unit/models/bxml/verbs/StartTranscription.test.ts +8 -6
- package/tests/unit/models/bxml/verbs/Transfer.test.ts +7 -6
|
@@ -32,7 +32,7 @@ export declare const TollFreeVerificationApiAxiosParamCreator: (configuration?:
|
|
|
32
32
|
*/
|
|
33
33
|
createWebhookSubscription: (accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
34
|
/**
|
|
35
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
35
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
36
36
|
* @summary Delete a Toll-Free Verification Submission
|
|
37
37
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
38
38
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -74,7 +74,7 @@ export declare const TollFreeVerificationApiAxiosParamCreator: (configuration?:
|
|
|
74
74
|
*/
|
|
75
75
|
listWebhookSubscriptions: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
76
|
/**
|
|
77
|
-
* Submit a request for verification of a toll-free phone number.
|
|
77
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
78
78
|
* @summary Request Toll-Free Verification
|
|
79
79
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
80
80
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -83,7 +83,7 @@ export declare const TollFreeVerificationApiAxiosParamCreator: (configuration?:
|
|
|
83
83
|
*/
|
|
84
84
|
requestTollFreeVerification: (accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
85
|
/**
|
|
86
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
86
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
87
87
|
* @summary Update Toll-Free Verification Request
|
|
88
88
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
89
89
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -117,7 +117,7 @@ export declare const TollFreeVerificationApiFp: (configuration?: Configuration)
|
|
|
117
117
|
*/
|
|
118
118
|
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookSubscription>>;
|
|
119
119
|
/**
|
|
120
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
120
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
121
121
|
* @summary Delete a Toll-Free Verification Submission
|
|
122
122
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
123
123
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -159,7 +159,7 @@ export declare const TollFreeVerificationApiFp: (configuration?: Configuration)
|
|
|
159
159
|
*/
|
|
160
160
|
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookSubscriptionsListBody>>;
|
|
161
161
|
/**
|
|
162
|
-
* Submit a request for verification of a toll-free phone number.
|
|
162
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
163
163
|
* @summary Request Toll-Free Verification
|
|
164
164
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
165
165
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -168,7 +168,7 @@ export declare const TollFreeVerificationApiFp: (configuration?: Configuration)
|
|
|
168
168
|
*/
|
|
169
169
|
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
170
170
|
/**
|
|
171
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
171
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
172
172
|
* @summary Update Toll-Free Verification Request
|
|
173
173
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
174
174
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -202,7 +202,7 @@ export declare const TollFreeVerificationApiFactory: (configuration?: Configurat
|
|
|
202
202
|
*/
|
|
203
203
|
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise<WebhookSubscription>;
|
|
204
204
|
/**
|
|
205
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
205
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
206
206
|
* @summary Delete a Toll-Free Verification Submission
|
|
207
207
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
208
208
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -244,7 +244,7 @@ export declare const TollFreeVerificationApiFactory: (configuration?: Configurat
|
|
|
244
244
|
*/
|
|
245
245
|
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): AxiosPromise<WebhookSubscriptionsListBody>;
|
|
246
246
|
/**
|
|
247
|
-
* Submit a request for verification of a toll-free phone number.
|
|
247
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
248
248
|
* @summary Request Toll-Free Verification
|
|
249
249
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
250
250
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -253,7 +253,7 @@ export declare const TollFreeVerificationApiFactory: (configuration?: Configurat
|
|
|
253
253
|
*/
|
|
254
254
|
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
255
255
|
/**
|
|
256
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
256
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
257
257
|
* @summary Update Toll-Free Verification Request
|
|
258
258
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
259
259
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -287,7 +287,7 @@ export declare class TollFreeVerificationApi extends BaseAPI {
|
|
|
287
287
|
*/
|
|
288
288
|
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookSubscription, any, {}, any>>;
|
|
289
289
|
/**
|
|
290
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
290
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
291
291
|
* @summary Delete a Toll-Free Verification Submission
|
|
292
292
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
293
293
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -329,7 +329,7 @@ export declare class TollFreeVerificationApi extends BaseAPI {
|
|
|
329
329
|
*/
|
|
330
330
|
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookSubscriptionsListBody, any, {}, any>>;
|
|
331
331
|
/**
|
|
332
|
-
* Submit a request for verification of a toll-free phone number.
|
|
332
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
333
333
|
* @summary Request Toll-Free Verification
|
|
334
334
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
335
335
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -338,7 +338,7 @@ export declare class TollFreeVerificationApi extends BaseAPI {
|
|
|
338
338
|
*/
|
|
339
339
|
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
340
340
|
/**
|
|
341
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
341
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
342
342
|
* @summary Update Toll-Free Verification Request
|
|
343
343
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
344
344
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -154,7 +154,7 @@ var TollFreeVerificationApiAxiosParamCreator = function (configuration) {
|
|
|
154
154
|
});
|
|
155
155
|
},
|
|
156
156
|
/**
|
|
157
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
157
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
158
158
|
* @summary Delete a Toll-Free Verification Submission
|
|
159
159
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
160
160
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -417,7 +417,7 @@ var TollFreeVerificationApiAxiosParamCreator = function (configuration) {
|
|
|
417
417
|
});
|
|
418
418
|
},
|
|
419
419
|
/**
|
|
420
|
-
* Submit a request for verification of a toll-free phone number.
|
|
420
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
421
421
|
* @summary Request Toll-Free Verification
|
|
422
422
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
423
423
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -473,7 +473,7 @@ var TollFreeVerificationApiAxiosParamCreator = function (configuration) {
|
|
|
473
473
|
});
|
|
474
474
|
},
|
|
475
475
|
/**
|
|
476
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
476
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
477
477
|
* @summary Update Toll-Free Verification Request
|
|
478
478
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
479
479
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -626,7 +626,7 @@ var TollFreeVerificationApiFp = function (configuration) {
|
|
|
626
626
|
});
|
|
627
627
|
},
|
|
628
628
|
/**
|
|
629
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
629
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
630
630
|
* @summary Delete a Toll-Free Verification Submission
|
|
631
631
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
632
632
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -743,7 +743,7 @@ var TollFreeVerificationApiFp = function (configuration) {
|
|
|
743
743
|
});
|
|
744
744
|
},
|
|
745
745
|
/**
|
|
746
|
-
* Submit a request for verification of a toll-free phone number.
|
|
746
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
747
747
|
* @summary Request Toll-Free Verification
|
|
748
748
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
749
749
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -767,7 +767,7 @@ var TollFreeVerificationApiFp = function (configuration) {
|
|
|
767
767
|
});
|
|
768
768
|
},
|
|
769
769
|
/**
|
|
770
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
770
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
771
771
|
* @summary Update Toll-Free Verification Request
|
|
772
772
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
773
773
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -837,7 +837,7 @@ var TollFreeVerificationApiFactory = function (configuration, basePath, axios) {
|
|
|
837
837
|
return localVarFp.createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then(function (request) { return request(axios, basePath); });
|
|
838
838
|
},
|
|
839
839
|
/**
|
|
840
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
840
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
841
841
|
* @summary Delete a Toll-Free Verification Submission
|
|
842
842
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
843
843
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -889,7 +889,7 @@ var TollFreeVerificationApiFactory = function (configuration, basePath, axios) {
|
|
|
889
889
|
return localVarFp.listWebhookSubscriptions(accountId, options).then(function (request) { return request(axios, basePath); });
|
|
890
890
|
},
|
|
891
891
|
/**
|
|
892
|
-
* Submit a request for verification of a toll-free phone number.
|
|
892
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
893
893
|
* @summary Request Toll-Free Verification
|
|
894
894
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
895
895
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -900,7 +900,7 @@ var TollFreeVerificationApiFactory = function (configuration, basePath, axios) {
|
|
|
900
900
|
return localVarFp.requestTollFreeVerification(accountId, verificationRequest, options).then(function (request) { return request(axios, basePath); });
|
|
901
901
|
},
|
|
902
902
|
/**
|
|
903
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
903
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
904
904
|
* @summary Update Toll-Free Verification Request
|
|
905
905
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
906
906
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -947,7 +947,7 @@ var TollFreeVerificationApi = /** @class */ (function (_super) {
|
|
|
947
947
|
return (0, exports.TollFreeVerificationApiFp)(this.configuration).createWebhookSubscription(accountId, webhookSubscriptionRequestSchema, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
948
948
|
};
|
|
949
949
|
/**
|
|
950
|
-
* Delete a toll-free verification submission for a toll-free number.
|
|
950
|
+
* Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
951
951
|
* @summary Delete a Toll-Free Verification Submission
|
|
952
952
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
953
953
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
@@ -1004,7 +1004,7 @@ var TollFreeVerificationApi = /** @class */ (function (_super) {
|
|
|
1004
1004
|
return (0, exports.TollFreeVerificationApiFp)(this.configuration).listWebhookSubscriptions(accountId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1005
1005
|
};
|
|
1006
1006
|
/**
|
|
1007
|
-
* Submit a request for verification of a toll-free phone number.
|
|
1007
|
+
* Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
1008
1008
|
* @summary Request Toll-Free Verification
|
|
1009
1009
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
1010
1010
|
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
@@ -1016,7 +1016,7 @@ var TollFreeVerificationApi = /** @class */ (function (_super) {
|
|
|
1016
1016
|
return (0, exports.TollFreeVerificationApiFp)(this.configuration).requestTollFreeVerification(accountId, verificationRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1017
1017
|
};
|
|
1018
1018
|
/**
|
|
1019
|
-
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
1019
|
+
* Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
1020
1020
|
* @summary Update Toll-Free Verification Request
|
|
1021
1021
|
* @param {string} accountId Your Bandwidth Account ID.
|
|
1022
1022
|
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
package/dist/configuration.js
CHANGED
|
@@ -104,7 +104,7 @@ var Configuration = /** @class */ (function () {
|
|
|
104
104
|
this.awsv4 = param.awsv4;
|
|
105
105
|
this.basePath = param.basePath;
|
|
106
106
|
this.serverIndex = param.serverIndex;
|
|
107
|
-
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_c = param.baseOptions) === null || _c === void 0 ? void 0 : _c.headers), { 'User-Agent': "OpenAPI-Generator/8.
|
|
107
|
+
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_c = param.baseOptions) === null || _c === void 0 ? void 0 : _c.headers), { 'User-Agent': "OpenAPI-Generator/8.3.1/typescript-axios" }) });
|
|
108
108
|
this.formDataCtor = param.formDataCtor;
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
@@ -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. **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. **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. **As of October 19th, 2026 this field is 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. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.**
|
|
19
19
|
*/
|
|
20
20
|
exports.BusinessRegistrationTypeEnum = {
|
|
21
21
|
Ein: 'EIN',
|
|
@@ -18,6 +18,14 @@ export interface GatherAttributes {
|
|
|
18
18
|
interDigitTimeout?: number;
|
|
19
19
|
firstDigitTimeout?: number;
|
|
20
20
|
repeatCount?: number;
|
|
21
|
+
input?: string;
|
|
22
|
+
hints?: string;
|
|
23
|
+
language?: string;
|
|
24
|
+
partialResultCallback?: string;
|
|
25
|
+
partialResultCallbackMethod?: string;
|
|
26
|
+
profanityFilter?: boolean;
|
|
27
|
+
speechModel?: string;
|
|
28
|
+
speechTimeout?: number;
|
|
21
29
|
}
|
|
22
30
|
/**
|
|
23
31
|
* @export
|
|
@@ -55,12 +55,12 @@ export interface TfvSubmissionInfo {
|
|
|
55
55
|
*/
|
|
56
56
|
'businessDba'?: string;
|
|
57
57
|
/**
|
|
58
|
-
* Government-issued business identifying number. **
|
|
58
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
59
59
|
*/
|
|
60
60
|
'businessRegistrationNumber'?: string | null;
|
|
61
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
62
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. **
|
|
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. **As of October 19th, 2026 this field is 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
64
|
*/
|
|
65
65
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
66
66
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
@@ -56,12 +56,12 @@ export interface VerificationRequest {
|
|
|
56
56
|
*/
|
|
57
57
|
'businessDba'?: string;
|
|
58
58
|
/**
|
|
59
|
-
* Government-issued business identifying number. **
|
|
59
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
60
60
|
*/
|
|
61
61
|
'businessRegistrationNumber'?: string | null;
|
|
62
62
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
63
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. **
|
|
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. **As of October 19th, 2026 this field is 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
65
|
*/
|
|
66
66
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
67
67
|
'businessEntityType': BusinessEntityTypeEnum;
|
|
@@ -55,13 +55,13 @@ export interface VerificationUpdateRequest {
|
|
|
55
55
|
*/
|
|
56
56
|
'businessDba'?: string;
|
|
57
57
|
/**
|
|
58
|
-
* Government-issued business identifying number. **
|
|
58
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
59
59
|
*/
|
|
60
60
|
'businessRegistrationNumber'?: string | null;
|
|
61
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
62
|
-
'businessEntityType'
|
|
62
|
+
'businessEntityType': BusinessEntityTypeEnum;
|
|
63
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. **
|
|
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. **As of October 19th, 2026 this field is 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
65
|
*/
|
|
66
66
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
67
67
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessEntityTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of registered business. **
|
|
3
|
+
The type of registered business. **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
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessRegistrationTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of business registration number. **
|
|
3
|
+
The type of business registration number. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.**
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
package/docs/MediaApi.md
CHANGED
|
@@ -26,7 +26,7 @@ const configuration = new Configuration();
|
|
|
26
26
|
const apiInstance = new MediaApi(configuration);
|
|
27
27
|
|
|
28
28
|
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
29
|
-
let mediaId: string; //
|
|
29
|
+
let mediaId: string; //The ID of the media file. (default to undefined)
|
|
30
30
|
|
|
31
31
|
const { status, data } = await apiInstance.deleteMedia(
|
|
32
32
|
accountId,
|
|
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.deleteMedia(
|
|
|
39
39
|
|Name | Type | Description | Notes|
|
|
40
40
|
|------------- | ------------- | ------------- | -------------|
|
|
41
41
|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
42
|
-
| **mediaId** | [**string**] |
|
|
42
|
+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### Return type
|
|
@@ -88,7 +88,7 @@ const configuration = new Configuration();
|
|
|
88
88
|
const apiInstance = new MediaApi(configuration);
|
|
89
89
|
|
|
90
90
|
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
91
|
-
let mediaId: string; //
|
|
91
|
+
let mediaId: string; //The ID of the media file. (default to undefined)
|
|
92
92
|
|
|
93
93
|
const { status, data } = await apiInstance.getMedia(
|
|
94
94
|
accountId,
|
|
@@ -101,7 +101,7 @@ const { status, data } = await apiInstance.getMedia(
|
|
|
101
101
|
|Name | Type | Description | Notes|
|
|
102
102
|
|------------- | ------------- | ------------- | -------------|
|
|
103
103
|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
104
|
-
| **mediaId** | [**string**] |
|
|
104
|
+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.listMedia(
|
|
|
198
198
|
# **uploadMedia**
|
|
199
199
|
> uploadMedia(body)
|
|
200
200
|
|
|
201
|
-
Upload a file.
|
|
201
|
+
Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. 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
|
|
|
@@ -212,10 +212,10 @@ const configuration = new Configuration();
|
|
|
212
212
|
const apiInstance = new MediaApi(configuration);
|
|
213
213
|
|
|
214
214
|
let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
|
|
215
|
-
let mediaId: string; //
|
|
215
|
+
let mediaId: string; //The ID of the media file. (default to undefined)
|
|
216
216
|
let body: File; //
|
|
217
217
|
let contentType: string; //The media type of the entity-body. (optional) (default to undefined)
|
|
218
|
-
let cacheControl: string; //
|
|
218
|
+
let cacheControl: string; //Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) (default to undefined)
|
|
219
219
|
|
|
220
220
|
const { status, data } = await apiInstance.uploadMedia(
|
|
221
221
|
accountId,
|
|
@@ -232,9 +232,9 @@ const { status, data } = await apiInstance.uploadMedia(
|
|
|
232
232
|
|------------- | ------------- | ------------- | -------------|
|
|
233
233
|
| **body** | **File**| | |
|
|
234
234
|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
235
|
-
| **mediaId** | [**string**] |
|
|
235
|
+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
|
|
236
236
|
| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined|
|
|
237
|
-
| **cacheControl** | [**string**] |
|
|
237
|
+
| **cacheControl** | [**string**] | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | (optional) defaults to undefined|
|
|
238
238
|
|
|
239
239
|
|
|
240
240
|
### Return type
|
|
@@ -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. **
|
|
20
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **As of October 19th, 2026 this field is 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** | **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. **
|
|
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. **As of October 19th, 2026 this field is 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
|
|
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.createWebhookSubscription(
|
|
|
80
80
|
# **deleteVerificationRequest**
|
|
81
81
|
> deleteVerificationRequest()
|
|
82
82
|
|
|
83
|
-
Delete a toll-free verification submission for a toll-free number.
|
|
83
|
+
Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
|
|
84
84
|
|
|
85
85
|
### Example
|
|
86
86
|
|
|
@@ -376,7 +376,7 @@ const { status, data } = await apiInstance.listWebhookSubscriptions(
|
|
|
376
376
|
# **requestTollFreeVerification**
|
|
377
377
|
> requestTollFreeVerification(verificationRequest)
|
|
378
378
|
|
|
379
|
-
Submit a request for verification of a toll-free phone number.
|
|
379
|
+
Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
|
|
380
380
|
|
|
381
381
|
### Example
|
|
382
382
|
|
|
@@ -429,6 +429,7 @@ void (empty response body)
|
|
|
429
429
|
|**401** | Unauthorized | - |
|
|
430
430
|
|**403** | Forbidden | - |
|
|
431
431
|
|**405** | Method Not Allowed | - |
|
|
432
|
+
|**409** | Conflict. A toll-free verification for the phone number is already in progress. | - |
|
|
432
433
|
|**429** | Too Many Requests | - |
|
|
433
434
|
|**500** | Internal Server Error | - |
|
|
434
435
|
|**503** | Service Unavailable | - |
|
|
@@ -438,7 +439,7 @@ void (empty response body)
|
|
|
438
439
|
# **updateTollFreeVerificationRequest**
|
|
439
440
|
> updateTollFreeVerificationRequest(tfvSubmissionWrapper)
|
|
440
441
|
|
|
441
|
-
Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
|
|
442
|
+
Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
|
|
442
443
|
|
|
443
444
|
### Example
|
|
444
445
|
|
|
@@ -493,7 +494,9 @@ void (empty response body)
|
|
|
493
494
|
|**400** | Bad Request | - |
|
|
494
495
|
|**401** | Unauthorized | - |
|
|
495
496
|
|**403** | Forbidden | - |
|
|
497
|
+
|**404** | Cannot find the requested resource. | - |
|
|
496
498
|
|**405** | Method Not Allowed | - |
|
|
499
|
+
|**409** | Conflict. A toll-free verification for the phone number is already in progress. | - |
|
|
497
500
|
|**429** | Too Many Requests | - |
|
|
498
501
|
|**500** | Internal Server Error | - |
|
|
499
502
|
|**503** | Service Unavailable | - |
|
|
@@ -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. **
|
|
21
|
+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **As of October 19th, 2026 this field is 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** | **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. **
|
|
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. **As of October 19th, 2026 this field is 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]
|