bandwidth-sdk 3.2.1 → 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 +28 -8
- package/README.md +3 -4
- package/api/toll-free-verification-api.ts +715 -0
- package/api.ts +1 -0
- package/bandwidth.yml +1638 -589
- package/base.ts +48 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +677 -442
- package/coverage/coverage-final.json +70 -65
- 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 +184 -0
- 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 +65 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +162 -105
- 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 +1115 -530
- 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/address.d.ts +60 -0
- package/dist/models/callback-type-enum.d.ts +23 -0
- package/dist/models/callback-type-enum.js +27 -0
- package/dist/models/contact.d.ts +42 -0
- package/dist/models/failure-webhook.d.ts +54 -0
- package/dist/models/index.d.ts +27 -8
- package/dist/models/index.js +27 -8
- package/dist/models/links-object.d.ts +42 -0
- package/dist/models/{message-sending-callback-message.d.ts → message-callback-message.d.ts} +17 -17
- package/dist/models/message-callback.d.ts +56 -0
- package/dist/models/model-error.d.ts +37 -0
- package/dist/models/opt-in-workflow.d.ts +30 -0
- package/dist/models/{transcription-list.d.ts → telephone-number.d.ts} +6 -7
- 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/callback-type-enum.ts +33 -0
- package/models/contact.ts +48 -0
- package/models/failure-webhook.ts +60 -0
- package/models/index.ts +27 -8
- package/models/links-object.ts +48 -0
- package/models/{message-sending-callback-message.ts → message-callback-message.ts} +17 -17
- package/models/message-callback.ts +68 -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/{transcription-list.ts → tfv-submission-wrapper.ts} +6 -6
- 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/callback-type-enum.test.ts +10 -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
- package/dist/models/inbound-message-callback-message.d.ts +0 -92
- package/dist/models/inbound-message-callback.d.ts +0 -49
- package/dist/models/message-delivered-callback-message.d.ts +0 -92
- package/dist/models/message-delivered-callback.d.ts +0 -49
- package/dist/models/message-failed-callback-message.d.ts +0 -92
- package/dist/models/message-failed-callback.d.ts +0 -55
- package/dist/models/message-sending-callback.d.ts +0 -49
- package/dist/models/transcription-metadata.d.ts +0 -42
- package/models/inbound-message-callback-message.ts +0 -104
- package/models/inbound-message-callback.ts +0 -57
- package/models/message-delivered-callback-message.ts +0 -104
- package/models/message-delivered-callback.ts +0 -57
- package/models/message-failed-callback-message.ts +0 -104
- package/models/message-failed-callback.ts +0 -63
- package/models/message-sending-callback.ts +0 -57
- package/models/transcription-metadata.ts +0 -48
- /package/dist/models/{inbound-message-callback-message.js → additional-denial-reason.js} +0 -0
- /package/dist/models/{inbound-message-callback.js → address.js} +0 -0
- /package/dist/models/{message-delivered-callback-message.js → contact.js} +0 -0
- /package/dist/models/{message-delivered-callback.js → failure-webhook.js} +0 -0
- /package/dist/models/{message-failed-callback-message.js → links-object.js} +0 -0
- /package/dist/models/{message-failed-callback.js → message-callback-message.js} +0 -0
- /package/dist/models/{message-sending-callback-message.js → message-callback.js} +0 -0
- /package/dist/models/{message-sending-callback.js → model-error.js} +0 -0
- /package/dist/models/{transcription-list.js → opt-in-workflow.js} +0 -0
- /package/dist/models/{transcription-metadata.js → telephone-number.js} +0 -0
|
@@ -0,0 +1,80 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { TfvStatusEnum } from './tfv-status-enum';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { TfvSubmissionInfo } from './tfv-submission-info';
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @export
|
|
26
|
+
* @interface TfvStatus
|
|
27
|
+
*/
|
|
28
|
+
export interface TfvStatus {
|
|
29
|
+
/**
|
|
30
|
+
* Toll-free telephone number in E.164 format.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof TfvStatus
|
|
33
|
+
*/
|
|
34
|
+
'phoneNumber'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {TfvStatusEnum}
|
|
38
|
+
* @memberof TfvStatus
|
|
39
|
+
*/
|
|
40
|
+
'status'?: TfvStatusEnum;
|
|
41
|
+
/**
|
|
42
|
+
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof TfvStatus
|
|
45
|
+
*/
|
|
46
|
+
'internalTicketNumber'?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Explanation for why a verification request was declined.
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof TfvStatus
|
|
51
|
+
*/
|
|
52
|
+
'declineReasonDescription'?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Whether a Toll-Free Verification request qualifies for resubmission via PUT.
|
|
55
|
+
* @type {boolean}
|
|
56
|
+
* @memberof TfvStatus
|
|
57
|
+
*/
|
|
58
|
+
'resubmitAllowed'?: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Date and time the verification request was created.
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof TfvStatus
|
|
63
|
+
*/
|
|
64
|
+
'createdDateTime'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Date and time the verification request was last modified.
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof TfvStatus
|
|
69
|
+
*/
|
|
70
|
+
'modifiedDateTime'?: string;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {TfvSubmissionInfo}
|
|
74
|
+
* @memberof TfvStatus
|
|
75
|
+
*/
|
|
76
|
+
'submission'?: TfvSubmissionInfo;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
@@ -0,0 +1,87 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { Address } from './address';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { Contact } from './contact';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { OptInWorkflow } from './opt-in-workflow';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface TfvSubmissionInfo
|
|
30
|
+
*/
|
|
31
|
+
export interface TfvSubmissionInfo {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Address}
|
|
35
|
+
* @memberof TfvSubmissionInfo
|
|
36
|
+
*/
|
|
37
|
+
'businessAddress'?: Address;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Contact}
|
|
41
|
+
* @memberof TfvSubmissionInfo
|
|
42
|
+
*/
|
|
43
|
+
'businessContact'?: Contact;
|
|
44
|
+
/**
|
|
45
|
+
* Estimated monthly volume of messages from the toll-free number.
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof TfvSubmissionInfo
|
|
48
|
+
*/
|
|
49
|
+
'messageVolume'?: number;
|
|
50
|
+
/**
|
|
51
|
+
* The category of the use case.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof TfvSubmissionInfo
|
|
54
|
+
*/
|
|
55
|
+
'useCase'?: string;
|
|
56
|
+
/**
|
|
57
|
+
* A general idea of the use case and customer.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof TfvSubmissionInfo
|
|
60
|
+
*/
|
|
61
|
+
'useCaseSummary'?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Example of message content.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof TfvSubmissionInfo
|
|
66
|
+
*/
|
|
67
|
+
'productionMessageContent'?: string;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {OptInWorkflow}
|
|
71
|
+
* @memberof TfvSubmissionInfo
|
|
72
|
+
*/
|
|
73
|
+
'optInWorkflow'?: OptInWorkflow;
|
|
74
|
+
/**
|
|
75
|
+
* Any additional information.
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof TfvSubmissionInfo
|
|
78
|
+
*/
|
|
79
|
+
'additionalInformation'?: string | null;
|
|
80
|
+
/**
|
|
81
|
+
* ISV name.
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof TfvSubmissionInfo
|
|
84
|
+
*/
|
|
85
|
+
'isvReseller'?: string | null;
|
|
86
|
+
}
|
|
87
|
+
|
|
@@ -15,19 +15,19 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import {
|
|
18
|
+
import type { VerificationUpdateRequest } from './verification-update-request';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
*
|
|
22
22
|
* @export
|
|
23
|
-
* @interface
|
|
23
|
+
* @interface TfvSubmissionWrapper
|
|
24
24
|
*/
|
|
25
|
-
export interface
|
|
25
|
+
export interface TfvSubmissionWrapper {
|
|
26
26
|
/**
|
|
27
27
|
*
|
|
28
|
-
* @type {
|
|
29
|
-
* @memberof
|
|
28
|
+
* @type {VerificationUpdateRequest}
|
|
29
|
+
* @memberof TfvSubmissionWrapper
|
|
30
30
|
*/
|
|
31
|
-
'
|
|
31
|
+
'submission'?: VerificationUpdateRequest;
|
|
32
32
|
}
|
|
33
33
|
|
|
@@ -0,0 +1,75 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { AdditionalDenialReason } from './additional-denial-reason';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface VerificationDenialWebhook
|
|
24
|
+
*/
|
|
25
|
+
export interface VerificationDenialWebhook {
|
|
26
|
+
/**
|
|
27
|
+
* User\'s account ID.
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof VerificationDenialWebhook
|
|
30
|
+
*/
|
|
31
|
+
'accountId'?: string;
|
|
32
|
+
/**
|
|
33
|
+
* An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
|
|
34
|
+
* @type {Array<AdditionalDenialReason>}
|
|
35
|
+
* @memberof VerificationDenialWebhook
|
|
36
|
+
*/
|
|
37
|
+
'additionalDenialReasons'?: Array<AdditionalDenialReason>;
|
|
38
|
+
/**
|
|
39
|
+
* Explanation for why a verification request was declined.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof VerificationDenialWebhook
|
|
42
|
+
*/
|
|
43
|
+
'declineReasonDescription'?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Reason code for denial.
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof VerificationDenialWebhook
|
|
48
|
+
*/
|
|
49
|
+
'denialStatusCode'?: number;
|
|
50
|
+
/**
|
|
51
|
+
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof VerificationDenialWebhook
|
|
54
|
+
*/
|
|
55
|
+
'internalTicketNumber'?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Toll-free telephone number in E.164 format.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof VerificationDenialWebhook
|
|
60
|
+
*/
|
|
61
|
+
'phoneNumber'?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Whether a Toll-Free Verification request qualifies for resubmission via PUT.
|
|
64
|
+
* @type {boolean}
|
|
65
|
+
* @memberof VerificationDenialWebhook
|
|
66
|
+
*/
|
|
67
|
+
'resubmitAllowed'?: boolean;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof VerificationDenialWebhook
|
|
72
|
+
*/
|
|
73
|
+
'status'?: string;
|
|
74
|
+
}
|
|
75
|
+
|
|
@@ -0,0 +1,93 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { Address } from './address';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { Contact } from './contact';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { OptInWorkflow } from './opt-in-workflow';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface VerificationRequest
|
|
30
|
+
*/
|
|
31
|
+
export interface VerificationRequest {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Address}
|
|
35
|
+
* @memberof VerificationRequest
|
|
36
|
+
*/
|
|
37
|
+
'businessAddress': Address;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Contact}
|
|
41
|
+
* @memberof VerificationRequest
|
|
42
|
+
*/
|
|
43
|
+
'businessContact': Contact;
|
|
44
|
+
/**
|
|
45
|
+
* Estimated monthly volume of messages from the toll-free number.
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof VerificationRequest
|
|
48
|
+
*/
|
|
49
|
+
'messageVolume': number;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {Array<string>}
|
|
53
|
+
* @memberof VerificationRequest
|
|
54
|
+
*/
|
|
55
|
+
'phoneNumbers': Array<string>;
|
|
56
|
+
/**
|
|
57
|
+
* The category of the use case.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof VerificationRequest
|
|
60
|
+
*/
|
|
61
|
+
'useCase': string;
|
|
62
|
+
/**
|
|
63
|
+
* A general idea of the use case and customer.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof VerificationRequest
|
|
66
|
+
*/
|
|
67
|
+
'useCaseSummary': string;
|
|
68
|
+
/**
|
|
69
|
+
* Example of message content.
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof VerificationRequest
|
|
72
|
+
*/
|
|
73
|
+
'productionMessageContent': string;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {OptInWorkflow}
|
|
77
|
+
* @memberof VerificationRequest
|
|
78
|
+
*/
|
|
79
|
+
'optInWorkflow': OptInWorkflow;
|
|
80
|
+
/**
|
|
81
|
+
* Any additional information.
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof VerificationRequest
|
|
84
|
+
*/
|
|
85
|
+
'additionalInformation'?: string | null;
|
|
86
|
+
/**
|
|
87
|
+
* ISV name.
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof VerificationRequest
|
|
90
|
+
*/
|
|
91
|
+
'isvReseller'?: string | null;
|
|
92
|
+
}
|
|
93
|
+
|
|
@@ -0,0 +1,87 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { Address } from './address';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { Contact } from './contact';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { OptInWorkflow } from './opt-in-workflow';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface VerificationUpdateRequest
|
|
30
|
+
*/
|
|
31
|
+
export interface VerificationUpdateRequest {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Address}
|
|
35
|
+
* @memberof VerificationUpdateRequest
|
|
36
|
+
*/
|
|
37
|
+
'businessAddress': Address;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Contact}
|
|
41
|
+
* @memberof VerificationUpdateRequest
|
|
42
|
+
*/
|
|
43
|
+
'businessContact': Contact;
|
|
44
|
+
/**
|
|
45
|
+
* Estimated monthly volume of messages from the toll-free number.
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof VerificationUpdateRequest
|
|
48
|
+
*/
|
|
49
|
+
'messageVolume': number;
|
|
50
|
+
/**
|
|
51
|
+
* The category of the use case.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof VerificationUpdateRequest
|
|
54
|
+
*/
|
|
55
|
+
'useCase': string;
|
|
56
|
+
/**
|
|
57
|
+
* A general idea of the use case and customer.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof VerificationUpdateRequest
|
|
60
|
+
*/
|
|
61
|
+
'useCaseSummary': string;
|
|
62
|
+
/**
|
|
63
|
+
* Example of message content.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof VerificationUpdateRequest
|
|
66
|
+
*/
|
|
67
|
+
'productionMessageContent': string;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {OptInWorkflow}
|
|
71
|
+
* @memberof VerificationUpdateRequest
|
|
72
|
+
*/
|
|
73
|
+
'optInWorkflow': OptInWorkflow;
|
|
74
|
+
/**
|
|
75
|
+
* Any additional information.
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof VerificationUpdateRequest
|
|
78
|
+
*/
|
|
79
|
+
'additionalInformation'?: string | null;
|
|
80
|
+
/**
|
|
81
|
+
* ISV name.
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof VerificationUpdateRequest
|
|
84
|
+
*/
|
|
85
|
+
'isvReseller'?: string | null;
|
|
86
|
+
}
|
|
87
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { TfvCallbackStatusEnum } from './tfv-callback-status-enum';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface VerificationWebhook
|
|
24
|
+
*/
|
|
25
|
+
export interface VerificationWebhook {
|
|
26
|
+
/**
|
|
27
|
+
* User\'s account ID.
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof VerificationWebhook
|
|
30
|
+
*/
|
|
31
|
+
'accountId'?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Toll-free telephone number in E.164 format.
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof VerificationWebhook
|
|
36
|
+
*/
|
|
37
|
+
'phoneNumber'?: string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {TfvCallbackStatusEnum}
|
|
41
|
+
* @memberof VerificationWebhook
|
|
42
|
+
*/
|
|
43
|
+
'status'?: TfvCallbackStatusEnum;
|
|
44
|
+
/**
|
|
45
|
+
* Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof VerificationWebhook
|
|
48
|
+
*/
|
|
49
|
+
'internalTicketNumber'?: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
* Basic authentication credentials are not required, but if present, both username and password must be provided.
|
|
19
|
+
* @export
|
|
20
|
+
* @interface WebhookSubscriptionBasicAuthentication
|
|
21
|
+
*/
|
|
22
|
+
export interface WebhookSubscriptionBasicAuthentication {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof WebhookSubscriptionBasicAuthentication
|
|
27
|
+
*/
|
|
28
|
+
'username': string;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof WebhookSubscriptionBasicAuthentication
|
|
33
|
+
*/
|
|
34
|
+
'password': string;
|
|
35
|
+
}
|
|
36
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { TfvBasicAuthentication } from './tfv-basic-authentication';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface WebhookSubscriptionRequestSchema
|
|
24
|
+
*/
|
|
25
|
+
export interface WebhookSubscriptionRequestSchema {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {TfvBasicAuthentication}
|
|
29
|
+
* @memberof WebhookSubscriptionRequestSchema
|
|
30
|
+
*/
|
|
31
|
+
'basicAuthentication'?: TfvBasicAuthentication;
|
|
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 WebhookSubscriptionRequestSchema
|
|
36
|
+
*/
|
|
37
|
+
'callbackUrl': string | null;
|
|
38
|
+
/**
|
|
39
|
+
* An ASCII string submitted by the user as a shared secret key for generating an HMAC header for callbacks.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof WebhookSubscriptionRequestSchema
|
|
42
|
+
*/
|
|
43
|
+
'sharedSecretKey'?: string | null;
|
|
44
|
+
}
|
|
45
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
export const WebhookSubscriptionTypeEnum = {
|
|
24
|
+
TollfreeVerificationStatus: 'TOLLFREE_VERIFICATION_STATUS',
|
|
25
|
+
MessagingPortoutApprovalStatus: 'MESSAGING_PORTOUT_APPROVAL_STATUS'
|
|
26
|
+
} as const;
|
|
27
|
+
|
|
28
|
+
export type WebhookSubscriptionTypeEnum = typeof WebhookSubscriptionTypeEnum[keyof typeof WebhookSubscriptionTypeEnum];
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,74 @@
|
|
|
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
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { WebhookSubscriptionBasicAuthentication } from './webhook-subscription-basic-authentication';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { WebhookSubscriptionTypeEnum } from './webhook-subscription-type-enum';
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Information about a webhook that Bandwidth should send upon the completion of event customer has subscribed to.
|
|
25
|
+
* @export
|
|
26
|
+
* @interface WebhookSubscription
|
|
27
|
+
*/
|
|
28
|
+
export interface WebhookSubscription {
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof WebhookSubscription
|
|
33
|
+
*/
|
|
34
|
+
'id'?: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof WebhookSubscription
|
|
39
|
+
*/
|
|
40
|
+
'accountId'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* 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.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof WebhookSubscription
|
|
45
|
+
*/
|
|
46
|
+
'callbackUrl': string | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {WebhookSubscriptionTypeEnum}
|
|
50
|
+
* @memberof WebhookSubscription
|
|
51
|
+
*/
|
|
52
|
+
'type'?: WebhookSubscriptionTypeEnum;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {WebhookSubscriptionBasicAuthentication}
|
|
56
|
+
* @memberof WebhookSubscription
|
|
57
|
+
*/
|
|
58
|
+
'basicAuthentication'?: WebhookSubscriptionBasicAuthentication;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof WebhookSubscription
|
|
63
|
+
*/
|
|
64
|
+
'createdDate'?: string;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof WebhookSubscription
|
|
69
|
+
*/
|
|
70
|
+
'modifiedDate'?: string;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|