bandwidth-sdk 4.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.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 +1102 -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/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/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/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
|
@@ -0,0 +1,75 @@
|
|
|
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 { Address } from './address';
|
|
13
|
+
import type { Contact } from './contact';
|
|
14
|
+
import type { OptInWorkflow } from './opt-in-workflow';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface VerificationUpdateRequest
|
|
19
|
+
*/
|
|
20
|
+
export interface VerificationUpdateRequest {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {Address}
|
|
24
|
+
* @memberof VerificationUpdateRequest
|
|
25
|
+
*/
|
|
26
|
+
'businessAddress': Address;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {Contact}
|
|
30
|
+
* @memberof VerificationUpdateRequest
|
|
31
|
+
*/
|
|
32
|
+
'businessContact': Contact;
|
|
33
|
+
/**
|
|
34
|
+
* Estimated monthly volume of messages from the toll-free number.
|
|
35
|
+
* @type {number}
|
|
36
|
+
* @memberof VerificationUpdateRequest
|
|
37
|
+
*/
|
|
38
|
+
'messageVolume': number;
|
|
39
|
+
/**
|
|
40
|
+
* The category of the use case.
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof VerificationUpdateRequest
|
|
43
|
+
*/
|
|
44
|
+
'useCase': string;
|
|
45
|
+
/**
|
|
46
|
+
* A general idea of the use case and customer.
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof VerificationUpdateRequest
|
|
49
|
+
*/
|
|
50
|
+
'useCaseSummary': string;
|
|
51
|
+
/**
|
|
52
|
+
* Example of message content.
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof VerificationUpdateRequest
|
|
55
|
+
*/
|
|
56
|
+
'productionMessageContent': string;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {OptInWorkflow}
|
|
60
|
+
* @memberof VerificationUpdateRequest
|
|
61
|
+
*/
|
|
62
|
+
'optInWorkflow': OptInWorkflow;
|
|
63
|
+
/**
|
|
64
|
+
* Any additional information.
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof VerificationUpdateRequest
|
|
67
|
+
*/
|
|
68
|
+
'additionalInformation'?: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* ISV name.
|
|
71
|
+
* @type {string}
|
|
72
|
+
* @memberof VerificationUpdateRequest
|
|
73
|
+
*/
|
|
74
|
+
'isvReseller'?: string | null;
|
|
75
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,43 @@
|
|
|
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 { TfvCallbackStatusEnum } from './tfv-callback-status-enum';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface VerificationWebhook
|
|
17
|
+
*/
|
|
18
|
+
export interface VerificationWebhook {
|
|
19
|
+
/**
|
|
20
|
+
* User\'s account ID.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof VerificationWebhook
|
|
23
|
+
*/
|
|
24
|
+
'accountId'?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Toll-free telephone number in E.164 format.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof VerificationWebhook
|
|
29
|
+
*/
|
|
30
|
+
'phoneNumber'?: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {TfvCallbackStatusEnum}
|
|
34
|
+
* @memberof VerificationWebhook
|
|
35
|
+
*/
|
|
36
|
+
'status'?: TfvCallbackStatusEnum;
|
|
37
|
+
/**
|
|
38
|
+
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof VerificationWebhook
|
|
41
|
+
*/
|
|
42
|
+
'internalTicketNumber'?: string;
|
|
43
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Basic authentication credentials are not required, but if present, both username and password must be provided.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface WebhookSubscriptionBasicAuthentication
|
|
16
|
+
*/
|
|
17
|
+
export interface WebhookSubscriptionBasicAuthentication {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof WebhookSubscriptionBasicAuthentication
|
|
22
|
+
*/
|
|
23
|
+
'username': string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof WebhookSubscriptionBasicAuthentication
|
|
28
|
+
*/
|
|
29
|
+
'password': string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,37 @@
|
|
|
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 { TfvBasicAuthentication } from './tfv-basic-authentication';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface WebhookSubscriptionRequestSchema
|
|
17
|
+
*/
|
|
18
|
+
export interface WebhookSubscriptionRequestSchema {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {TfvBasicAuthentication}
|
|
22
|
+
* @memberof WebhookSubscriptionRequestSchema
|
|
23
|
+
*/
|
|
24
|
+
'basicAuthentication'?: TfvBasicAuthentication;
|
|
25
|
+
/**
|
|
26
|
+
* Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof WebhookSubscriptionRequestSchema
|
|
29
|
+
*/
|
|
30
|
+
'callbackUrl': string | null;
|
|
31
|
+
/**
|
|
32
|
+
* An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof WebhookSubscriptionRequestSchema
|
|
35
|
+
*/
|
|
36
|
+
'sharedSecretKey'?: string | null;
|
|
37
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const WebhookSubscriptionTypeEnum: {
|
|
18
|
+
readonly TollfreeVerificationStatus: "TOLLFREE_VERIFICATION_STATUS";
|
|
19
|
+
readonly MessagingPortoutApprovalStatus: "MESSAGING_PORTOUT_APPROVAL_STATUS";
|
|
20
|
+
};
|
|
21
|
+
export type WebhookSubscriptionTypeEnum = typeof WebhookSubscriptionTypeEnum[keyof typeof WebhookSubscriptionTypeEnum];
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WebhookSubscriptionTypeEnum = void 0;
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
exports.WebhookSubscriptionTypeEnum = {
|
|
23
|
+
TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS',
|
|
24
|
+
MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS'
|
|
25
|
+
};
|
|
@@ -0,0 +1,62 @@
|
|
|
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 { WebhookSubscriptionBasicAuthentication } from './webhook-subscription-basic-authentication';
|
|
13
|
+
import type { WebhookSubscriptionTypeEnum } from './webhook-subscription-type-enum';
|
|
14
|
+
/**
|
|
15
|
+
* Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface WebhookSubscription
|
|
18
|
+
*/
|
|
19
|
+
export interface WebhookSubscription {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof WebhookSubscription
|
|
24
|
+
*/
|
|
25
|
+
'id'?: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof WebhookSubscription
|
|
30
|
+
*/
|
|
31
|
+
'accountId'?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Callback URL to receive status updates from Bandwidth. When a webhook subscription is registered with Bandwidth under a given account ID, it will be used to send status updates for all requests submitted under that account ID.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof WebhookSubscription
|
|
36
|
+
*/
|
|
37
|
+
'callbackUrl': string | null;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {WebhookSubscriptionTypeEnum}
|
|
41
|
+
* @memberof WebhookSubscription
|
|
42
|
+
*/
|
|
43
|
+
'type'?: WebhookSubscriptionTypeEnum;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {WebhookSubscriptionBasicAuthentication}
|
|
47
|
+
* @memberof WebhookSubscription
|
|
48
|
+
*/
|
|
49
|
+
'basicAuthentication'?: WebhookSubscriptionBasicAuthentication;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof WebhookSubscription
|
|
54
|
+
*/
|
|
55
|
+
'createdDate'?: string;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof WebhookSubscription
|
|
60
|
+
*/
|
|
61
|
+
'modifiedDate'?: string;
|
|
62
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,39 @@
|
|
|
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 { LinksObject } from './links-object';
|
|
13
|
+
import type { ModelError } from './model-error';
|
|
14
|
+
import type { WebhookSubscription } from './webhook-subscription';
|
|
15
|
+
/**
|
|
16
|
+
* A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated).
|
|
17
|
+
* @export
|
|
18
|
+
* @interface WebhookSubscriptionsListBody
|
|
19
|
+
*/
|
|
20
|
+
export interface WebhookSubscriptionsListBody {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {LinksObject}
|
|
24
|
+
* @memberof WebhookSubscriptionsListBody
|
|
25
|
+
*/
|
|
26
|
+
'links'?: LinksObject;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {Array<ModelError>}
|
|
30
|
+
* @memberof WebhookSubscriptionsListBody
|
|
31
|
+
*/
|
|
32
|
+
'errors'?: Array<ModelError>;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {Array<WebhookSubscription>}
|
|
36
|
+
* @memberof WebhookSubscriptionsListBody
|
|
37
|
+
*/
|
|
38
|
+
'data': Array<WebhookSubscription>;
|
|
39
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface AdditionalDenialReason
|
|
21
|
+
*/
|
|
22
|
+
export interface AdditionalDenialReason {
|
|
23
|
+
/**
|
|
24
|
+
* Reason code for denial.
|
|
25
|
+
* @type {number}
|
|
26
|
+
* @memberof AdditionalDenialReason
|
|
27
|
+
*/
|
|
28
|
+
'statusCode': number;
|
|
29
|
+
/**
|
|
30
|
+
* Explanation for why a verification request was declined.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof AdditionalDenialReason
|
|
33
|
+
*/
|
|
34
|
+
'reason': string;
|
|
35
|
+
/**
|
|
36
|
+
* Whether a Toll-Free Verification request qualifies for resubmission via PUT.
|
|
37
|
+
* @type {boolean}
|
|
38
|
+
* @memberof AdditionalDenialReason
|
|
39
|
+
*/
|
|
40
|
+
'resubmitAllowed': boolean;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface Address
|
|
21
|
+
*/
|
|
22
|
+
export interface Address {
|
|
23
|
+
/**
|
|
24
|
+
* The name of the business using the toll-free number.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof Address
|
|
27
|
+
*/
|
|
28
|
+
'name': string;
|
|
29
|
+
/**
|
|
30
|
+
* The address of the business using the toll-free number.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof Address
|
|
33
|
+
*/
|
|
34
|
+
'addr1': string;
|
|
35
|
+
/**
|
|
36
|
+
* The address of the business using the toll-free number.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof Address
|
|
39
|
+
*/
|
|
40
|
+
'addr2'?: string | null;
|
|
41
|
+
/**
|
|
42
|
+
* The city of the business using the toll-free number.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof Address
|
|
45
|
+
*/
|
|
46
|
+
'city': string;
|
|
47
|
+
/**
|
|
48
|
+
* The state of the business using the toll-free number.
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof Address
|
|
51
|
+
*/
|
|
52
|
+
'state': string;
|
|
53
|
+
/**
|
|
54
|
+
* The zip of the business using the toll-free number.
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof Address
|
|
57
|
+
*/
|
|
58
|
+
'zip': string;
|
|
59
|
+
/**
|
|
60
|
+
* The website of the business using the toll-free number.
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof Address
|
|
63
|
+
*/
|
|
64
|
+
'url': string;
|
|
65
|
+
}
|
|
66
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface Contact
|
|
21
|
+
*/
|
|
22
|
+
export interface Contact {
|
|
23
|
+
/**
|
|
24
|
+
* The first name of the business contact using the toll-free number.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof Contact
|
|
27
|
+
*/
|
|
28
|
+
'firstName': string;
|
|
29
|
+
/**
|
|
30
|
+
* The last name of the business contact using the toll-free number.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof Contact
|
|
33
|
+
*/
|
|
34
|
+
'lastName': string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof Contact
|
|
39
|
+
*/
|
|
40
|
+
'email': string;
|
|
41
|
+
/**
|
|
42
|
+
* Contact telephone number
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof Contact
|
|
45
|
+
*/
|
|
46
|
+
'phoneNumber': string;
|
|
47
|
+
}
|
|
48
|
+
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface FailureWebhook
|
|
21
|
+
*/
|
|
22
|
+
export interface FailureWebhook {
|
|
23
|
+
/**
|
|
24
|
+
* User\'s account ID.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof FailureWebhook
|
|
27
|
+
*/
|
|
28
|
+
'accountId'?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Toll-free telephone number in E.164 format.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof FailureWebhook
|
|
33
|
+
*/
|
|
34
|
+
'phoneNumber'?: string;
|
|
35
|
+
/**
|
|
36
|
+
* An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered.
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof FailureWebhook
|
|
39
|
+
*/
|
|
40
|
+
'errorCode'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* A description of the error that was encountered.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof FailureWebhook
|
|
45
|
+
*/
|
|
46
|
+
'errorDescription'?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Details of the errors that were encountered when processing the request.
|
|
49
|
+
* @type {Array<string>}
|
|
50
|
+
* @memberof FailureWebhook
|
|
51
|
+
*/
|
|
52
|
+
'errors'?: Array<string>;
|
|
53
|
+
/**
|
|
54
|
+
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof FailureWebhook
|
|
57
|
+
*/
|
|
58
|
+
'internalTicketNumber'?: string;
|
|
59
|
+
}
|
|
60
|
+
|