bandwidth-sdk 4.0.0 → 4.1.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 +1 -1
- package/.github/workflows/deploy.yml +8 -2
- package/.github/workflows/test-pr.yml +2 -2
- package/.github/workflows/test-smoke.yml +39 -10
- package/.openapi-generator/FILES +25 -0
- package/README.md +3 -4
- package/api/toll-free-verification-api.ts +715 -0
- package/api.ts +1 -0
- package/bandwidth.yml +1113 -0
- package/base.ts +48 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +674 -438
- package/coverage/coverage-final.json +70 -66
- package/coverage/lcov-report/index.html +26 -26
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/index.html +24 -9
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2230 -0
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api.ts.html +16 -13
- package/coverage/lcov-report/node-sdk/base.ts.html +158 -14
- package/coverage/lcov-report/node-sdk/common.ts.html +32 -32
- package/coverage/lcov-report/node-sdk/configuration.ts.html +16 -16
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/index.html +50 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +164 -92
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +178 -0
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +187 -0
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +178 -0
- package/coverage/lcov.info +1106 -526
- package/custom_templates/README.mustache +3 -4
- package/dist/api/toll-free-verification-api.d.ts +338 -0
- package/dist/api/toll-free-verification-api.js +870 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +48 -0
- package/dist/common.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/additional-denial-reason.d.ts +36 -0
- package/dist/models/additional-denial-reason.js +15 -0
- package/dist/models/address.d.ts +60 -0
- package/dist/models/address.js +15 -0
- package/dist/models/contact.d.ts +42 -0
- package/dist/models/contact.js +15 -0
- package/dist/models/failure-webhook.d.ts +54 -0
- package/dist/models/failure-webhook.js +15 -0
- package/dist/models/index.d.ts +24 -0
- package/dist/models/index.js +24 -0
- package/dist/models/initiate-callback.d.ts +6 -0
- package/dist/models/links-object.d.ts +42 -0
- package/dist/models/links-object.js +15 -0
- package/dist/models/model-error.d.ts +37 -0
- package/dist/models/model-error.js +15 -0
- package/dist/models/opt-in-workflow.d.ts +30 -0
- package/dist/models/opt-in-workflow.js +15 -0
- package/dist/models/telephone-number.d.ts +24 -0
- package/dist/models/telephone-number.js +15 -0
- package/dist/models/tfv-basic-authentication.d.ts +30 -0
- package/dist/models/tfv-basic-authentication.js +15 -0
- package/dist/models/tfv-callback-status-enum.d.ts +21 -0
- package/dist/models/tfv-callback-status-enum.js +25 -0
- package/dist/models/tfv-error.d.ts +36 -0
- package/dist/models/tfv-error.js +15 -0
- package/dist/models/tfv-status-enum.d.ts +24 -0
- package/dist/models/tfv-status-enum.js +28 -0
- package/dist/models/tfv-status.d.ts +68 -0
- package/dist/models/tfv-status.js +15 -0
- package/dist/models/tfv-submission-info.d.ts +75 -0
- package/dist/models/tfv-submission-info.js +15 -0
- package/dist/models/tfv-submission-wrapper.d.ts +25 -0
- package/dist/models/tfv-submission-wrapper.js +15 -0
- package/dist/models/verification-denial-webhook.d.ts +67 -0
- package/dist/models/verification-denial-webhook.js +15 -0
- package/dist/models/verification-request.d.ts +81 -0
- package/dist/models/verification-request.js +15 -0
- package/dist/models/verification-update-request.d.ts +75 -0
- package/dist/models/verification-update-request.js +15 -0
- package/dist/models/verification-webhook.d.ts +43 -0
- package/dist/models/verification-webhook.js +15 -0
- package/dist/models/webhook-subscription-basic-authentication.d.ts +30 -0
- package/dist/models/webhook-subscription-basic-authentication.js +15 -0
- package/dist/models/webhook-subscription-request-schema.d.ts +37 -0
- package/dist/models/webhook-subscription-request-schema.js +15 -0
- package/dist/models/webhook-subscription-type-enum.d.ts +21 -0
- package/dist/models/webhook-subscription-type-enum.js +25 -0
- package/dist/models/webhook-subscription.d.ts +62 -0
- package/dist/models/webhook-subscription.js +15 -0
- package/dist/models/webhook-subscriptions-list-body.d.ts +39 -0
- package/dist/models/webhook-subscriptions-list-body.js +15 -0
- package/models/additional-denial-reason.ts +42 -0
- package/models/address.ts +66 -0
- package/models/contact.ts +48 -0
- package/models/failure-webhook.ts +60 -0
- package/models/index.ts +24 -0
- package/models/initiate-callback.ts +6 -0
- package/models/links-object.ts +48 -0
- package/models/model-error.ts +45 -0
- package/models/opt-in-workflow.ts +36 -0
- package/models/telephone-number.ts +30 -0
- package/models/tfv-basic-authentication.ts +36 -0
- package/models/tfv-callback-status-enum.ts +31 -0
- package/models/tfv-error.ts +42 -0
- package/models/tfv-status-enum.ts +34 -0
- package/models/tfv-status.ts +80 -0
- package/models/tfv-submission-info.ts +87 -0
- package/models/tfv-submission-wrapper.ts +33 -0
- package/models/verification-denial-webhook.ts +75 -0
- package/models/verification-request.ts +93 -0
- package/models/verification-update-request.ts +87 -0
- package/models/verification-webhook.ts +53 -0
- package/models/webhook-subscription-basic-authentication.ts +36 -0
- package/models/webhook-subscription-request-schema.ts +45 -0
- package/models/webhook-subscription-type-enum.ts +31 -0
- package/models/webhook-subscription.ts +74 -0
- package/models/webhook-subscriptions-list-body.ts +51 -0
- package/openapi-config.yml +0 -1
- package/package.json +1 -1
- package/tests/callUtils.ts +0 -8
- package/tests/smoke/phone-number-lookup-api.test.ts +2 -12
- package/tests/smoke/toll-free-verification-api.test.ts +18 -0
- package/tests/unit/api/calls-api.test.ts +5 -5
- package/tests/unit/api/conferences-api.test.ts +4 -4
- package/tests/unit/api/messages-api.test.ts +5 -14
- package/tests/unit/api/phone-number-lookup-api.test.ts +2 -12
- package/tests/unit/api/recordings-api.test.ts +6 -6
- package/tests/unit/api/toll-free-verification-api.test.ts +159 -0
- package/tests/unit/models/tfv-callback-status-enum.test.ts +8 -0
- package/tests/unit/models/tfv-status-enum.test.ts +11 -0
- package/tests/unit/models/webhook-subscription-type-enum.test.ts +8 -0
|
@@ -2,13 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|:---:|:---:|
|
|
5
|
+
| **OS** | **Node** |
|
|
6
|
+
|:------------:|:----------:|
|
|
8
7
|
| Windows 2019 | 18, 20, 22 |
|
|
9
8
|
| Windows 2022 | 18, 20, 22 |
|
|
10
|
-
| Ubuntu 20.04 | 18, 20, 22 |
|
|
11
9
|
| Ubuntu 22.04 | 18, 20, 22 |
|
|
10
|
+
| Ubuntu 24.04 | 18, 20, 22 |
|
|
12
11
|
|
|
13
12
|
#### Available on NPM
|
|
14
13
|
```
|
|
@@ -0,0 +1,338 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { TfvStatus } from '../models';
|
|
16
|
+
import type { TfvSubmissionWrapper } from '../models';
|
|
17
|
+
import type { VerificationRequest } from '../models';
|
|
18
|
+
import type { WebhookSubscription } from '../models';
|
|
19
|
+
import type { WebhookSubscriptionRequestSchema } from '../models';
|
|
20
|
+
import type { WebhookSubscriptionsListBody } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* TollFreeVerificationApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const TollFreeVerificationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
* Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
|
|
28
|
+
* @summary Create Webhook Subscription
|
|
29
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
30
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
createWebhookSubscription: (accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Delete a webhook subscription by ID.
|
|
37
|
+
* @summary Delete Webhook Subscription
|
|
38
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
39
|
+
* @param {string} id Webhook subscription ID
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
deleteWebhookSubscription: (accountId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
|
|
46
|
+
* @summary Get Toll-Free Verification Status
|
|
47
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
48
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
49
|
+
* @param {*} [options] Override http request option.
|
|
50
|
+
* @throws {RequiredError}
|
|
51
|
+
*/
|
|
52
|
+
getTollFreeVerificationStatus: (accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
|
+
/**
|
|
54
|
+
* Lists valid toll-free use cases.
|
|
55
|
+
* @summary List Toll-Free Use Cases
|
|
56
|
+
* @param {*} [options] Override http request option.
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
listTollFreeUseCases: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
|
+
/**
|
|
61
|
+
* Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
|
|
62
|
+
* @summary List Webhook Subscriptions
|
|
63
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
listWebhookSubscriptions: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* Submit a request for verification of a toll-free phone number.
|
|
70
|
+
* @summary Request Toll-Free Verification
|
|
71
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
72
|
+
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
requestTollFreeVerification: (accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
/**
|
|
78
|
+
* 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).
|
|
79
|
+
* @summary Update Toll-Free Verification Request
|
|
80
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
81
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
82
|
+
* @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number.
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
updateTollFreeVerificationRequest: (accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
+
/**
|
|
88
|
+
* Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
|
|
89
|
+
* @summary Update Webhook Subscription
|
|
90
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
91
|
+
* @param {string} id Webhook subscription ID
|
|
92
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
updateWebhookSubscription: (accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* TollFreeVerificationApi - functional programming interface
|
|
100
|
+
* @export
|
|
101
|
+
*/
|
|
102
|
+
export declare const TollFreeVerificationApiFp: (configuration?: Configuration) => {
|
|
103
|
+
/**
|
|
104
|
+
* Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
|
|
105
|
+
* @summary Create Webhook Subscription
|
|
106
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
107
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookSubscription>>;
|
|
112
|
+
/**
|
|
113
|
+
* Delete a webhook subscription by ID.
|
|
114
|
+
* @summary Delete Webhook Subscription
|
|
115
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
116
|
+
* @param {string} id Webhook subscription ID
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
121
|
+
/**
|
|
122
|
+
* Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
|
|
123
|
+
* @summary Get Toll-Free Verification Status
|
|
124
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
125
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TfvStatus>>;
|
|
130
|
+
/**
|
|
131
|
+
* Lists valid toll-free use cases.
|
|
132
|
+
* @summary List Toll-Free Use Cases
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
listTollFreeUseCases(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
137
|
+
/**
|
|
138
|
+
* Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
|
|
139
|
+
* @summary List Webhook Subscriptions
|
|
140
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookSubscriptionsListBody>>;
|
|
145
|
+
/**
|
|
146
|
+
* Submit a request for verification of a toll-free phone number.
|
|
147
|
+
* @summary Request Toll-Free Verification
|
|
148
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
149
|
+
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
154
|
+
/**
|
|
155
|
+
* 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).
|
|
156
|
+
* @summary Update Toll-Free Verification Request
|
|
157
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
158
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
159
|
+
* @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number.
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
164
|
+
/**
|
|
165
|
+
* Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
|
|
166
|
+
* @summary Update Webhook Subscription
|
|
167
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
168
|
+
* @param {string} id Webhook subscription ID
|
|
169
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhookSubscription>>;
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* TollFreeVerificationApi - factory interface
|
|
177
|
+
* @export
|
|
178
|
+
*/
|
|
179
|
+
export declare const TollFreeVerificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
180
|
+
/**
|
|
181
|
+
* Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
|
|
182
|
+
* @summary Create Webhook Subscription
|
|
183
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
184
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise<WebhookSubscription>;
|
|
189
|
+
/**
|
|
190
|
+
* Delete a webhook subscription by ID.
|
|
191
|
+
* @summary Delete Webhook Subscription
|
|
192
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
193
|
+
* @param {string} id Webhook subscription ID
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
*/
|
|
197
|
+
deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
198
|
+
/**
|
|
199
|
+
* Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
|
|
200
|
+
* @summary Get Toll-Free Verification Status
|
|
201
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
202
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): AxiosPromise<TfvStatus>;
|
|
207
|
+
/**
|
|
208
|
+
* Lists valid toll-free use cases.
|
|
209
|
+
* @summary List Toll-Free Use Cases
|
|
210
|
+
* @param {*} [options] Override http request option.
|
|
211
|
+
* @throws {RequiredError}
|
|
212
|
+
*/
|
|
213
|
+
listTollFreeUseCases(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
214
|
+
/**
|
|
215
|
+
* Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
|
|
216
|
+
* @summary List Webhook Subscriptions
|
|
217
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): AxiosPromise<WebhookSubscriptionsListBody>;
|
|
222
|
+
/**
|
|
223
|
+
* Submit a request for verification of a toll-free phone number.
|
|
224
|
+
* @summary Request Toll-Free Verification
|
|
225
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
226
|
+
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
231
|
+
/**
|
|
232
|
+
* 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).
|
|
233
|
+
* @summary Update Toll-Free Verification Request
|
|
234
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
235
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
236
|
+
* @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number.
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
*/
|
|
240
|
+
updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
241
|
+
/**
|
|
242
|
+
* Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
|
|
243
|
+
* @summary Update Webhook Subscription
|
|
244
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
245
|
+
* @param {string} id Webhook subscription ID
|
|
246
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise<WebhookSubscription>;
|
|
251
|
+
};
|
|
252
|
+
/**
|
|
253
|
+
* TollFreeVerificationApi - object-oriented interface
|
|
254
|
+
* @export
|
|
255
|
+
* @class TollFreeVerificationApi
|
|
256
|
+
* @extends {BaseAPI}
|
|
257
|
+
*/
|
|
258
|
+
export declare class TollFreeVerificationApi extends BaseAPI {
|
|
259
|
+
/**
|
|
260
|
+
* Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
|
|
261
|
+
* @summary Create Webhook Subscription
|
|
262
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
263
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
* @memberof TollFreeVerificationApi
|
|
267
|
+
*/
|
|
268
|
+
createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookSubscription, any>>;
|
|
269
|
+
/**
|
|
270
|
+
* Delete a webhook subscription by ID.
|
|
271
|
+
* @summary Delete Webhook Subscription
|
|
272
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
273
|
+
* @param {string} id Webhook subscription ID
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
* @memberof TollFreeVerificationApi
|
|
277
|
+
*/
|
|
278
|
+
deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
279
|
+
/**
|
|
280
|
+
* Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
|
|
281
|
+
* @summary Get Toll-Free Verification Status
|
|
282
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
283
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
* @memberof TollFreeVerificationApi
|
|
287
|
+
*/
|
|
288
|
+
getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TfvStatus, any>>;
|
|
289
|
+
/**
|
|
290
|
+
* Lists valid toll-free use cases.
|
|
291
|
+
* @summary List Toll-Free Use Cases
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
* @memberof TollFreeVerificationApi
|
|
295
|
+
*/
|
|
296
|
+
listTollFreeUseCases(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
297
|
+
/**
|
|
298
|
+
* Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
|
|
299
|
+
* @summary List Webhook Subscriptions
|
|
300
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
* @memberof TollFreeVerificationApi
|
|
304
|
+
*/
|
|
305
|
+
listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookSubscriptionsListBody, any>>;
|
|
306
|
+
/**
|
|
307
|
+
* Submit a request for verification of a toll-free phone number.
|
|
308
|
+
* @summary Request Toll-Free Verification
|
|
309
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
310
|
+
* @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number.
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
* @memberof TollFreeVerificationApi
|
|
314
|
+
*/
|
|
315
|
+
requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
316
|
+
/**
|
|
317
|
+
* 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).
|
|
318
|
+
* @summary Update Toll-Free Verification Request
|
|
319
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
320
|
+
* @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format.
|
|
321
|
+
* @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number.
|
|
322
|
+
* @param {*} [options] Override http request option.
|
|
323
|
+
* @throws {RequiredError}
|
|
324
|
+
* @memberof TollFreeVerificationApi
|
|
325
|
+
*/
|
|
326
|
+
updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
327
|
+
/**
|
|
328
|
+
* Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
|
|
329
|
+
* @summary Update Webhook Subscription
|
|
330
|
+
* @param {string} accountId Your Bandwidth Account ID.
|
|
331
|
+
* @param {string} id Webhook subscription ID
|
|
332
|
+
* @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
|
|
333
|
+
* @param {*} [options] Override http request option.
|
|
334
|
+
* @throws {RequiredError}
|
|
335
|
+
* @memberof TollFreeVerificationApi
|
|
336
|
+
*/
|
|
337
|
+
updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhookSubscription, any>>;
|
|
338
|
+
}
|