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.
Files changed (212) hide show
  1. package/.github/CODEOWNERS +1 -1
  2. package/.github/workflows/deploy.yml +8 -2
  3. package/.github/workflows/test-pr.yml +2 -2
  4. package/.github/workflows/test-smoke.yml +39 -10
  5. package/.openapi-generator/FILES +28 -8
  6. package/README.md +3 -4
  7. package/api/toll-free-verification-api.ts +715 -0
  8. package/api.ts +1 -0
  9. package/bandwidth.yml +1638 -589
  10. package/base.ts +48 -0
  11. package/configuration.ts +1 -1
  12. package/coverage/clover.xml +677 -442
  13. package/coverage/coverage-final.json +70 -65
  14. package/coverage/lcov-report/index.html +26 -26
  15. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
  16. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
  17. package/coverage/lcov-report/node-sdk/api/index.html +24 -9
  18. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
  19. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
  20. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
  21. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +11 -11
  22. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
  23. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
  24. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +2230 -0
  25. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
  26. package/coverage/lcov-report/node-sdk/api.ts.html +16 -13
  27. package/coverage/lcov-report/node-sdk/base.ts.html +158 -14
  28. package/coverage/lcov-report/node-sdk/common.ts.html +32 -32
  29. package/coverage/lcov-report/node-sdk/configuration.ts.html +16 -16
  30. package/coverage/lcov-report/node-sdk/index.html +7 -7
  31. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
  32. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +6 -6
  33. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
  34. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
  35. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +6 -6
  36. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
  65. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
  66. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +31 -31
  68. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
  69. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
  70. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
  71. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
  72. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
  73. package/coverage/lcov-report/node-sdk/models/callback-type-enum.ts.html +184 -0
  74. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
  75. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
  76. package/coverage/lcov-report/node-sdk/models/index.html +65 -5
  77. package/coverage/lcov-report/node-sdk/models/index.ts.html +162 -105
  78. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
  79. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +2 -2
  80. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
  81. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
  82. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
  83. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
  84. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  85. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
  86. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
  87. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +178 -0
  88. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +187 -0
  89. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +178 -0
  90. package/coverage/lcov.info +1115 -530
  91. package/custom_templates/README.mustache +3 -4
  92. package/dist/api/toll-free-verification-api.d.ts +338 -0
  93. package/dist/api/toll-free-verification-api.js +870 -0
  94. package/dist/api.d.ts +1 -0
  95. package/dist/api.js +1 -0
  96. package/dist/base.js +48 -0
  97. package/dist/configuration.js +1 -1
  98. package/dist/models/additional-denial-reason.d.ts +36 -0
  99. package/dist/models/address.d.ts +60 -0
  100. package/dist/models/callback-type-enum.d.ts +23 -0
  101. package/dist/models/callback-type-enum.js +27 -0
  102. package/dist/models/contact.d.ts +42 -0
  103. package/dist/models/failure-webhook.d.ts +54 -0
  104. package/dist/models/index.d.ts +27 -8
  105. package/dist/models/index.js +27 -8
  106. package/dist/models/links-object.d.ts +42 -0
  107. package/dist/models/{message-sending-callback-message.d.ts → message-callback-message.d.ts} +17 -17
  108. package/dist/models/message-callback.d.ts +56 -0
  109. package/dist/models/model-error.d.ts +37 -0
  110. package/dist/models/opt-in-workflow.d.ts +30 -0
  111. package/dist/models/{transcription-list.d.ts → telephone-number.d.ts} +6 -7
  112. package/dist/models/tfv-basic-authentication.d.ts +30 -0
  113. package/dist/models/tfv-basic-authentication.js +15 -0
  114. package/dist/models/tfv-callback-status-enum.d.ts +21 -0
  115. package/dist/models/tfv-callback-status-enum.js +25 -0
  116. package/dist/models/tfv-error.d.ts +36 -0
  117. package/dist/models/tfv-error.js +15 -0
  118. package/dist/models/tfv-status-enum.d.ts +24 -0
  119. package/dist/models/tfv-status-enum.js +28 -0
  120. package/dist/models/tfv-status.d.ts +68 -0
  121. package/dist/models/tfv-status.js +15 -0
  122. package/dist/models/tfv-submission-info.d.ts +75 -0
  123. package/dist/models/tfv-submission-info.js +15 -0
  124. package/dist/models/tfv-submission-wrapper.d.ts +25 -0
  125. package/dist/models/tfv-submission-wrapper.js +15 -0
  126. package/dist/models/verification-denial-webhook.d.ts +67 -0
  127. package/dist/models/verification-denial-webhook.js +15 -0
  128. package/dist/models/verification-request.d.ts +81 -0
  129. package/dist/models/verification-request.js +15 -0
  130. package/dist/models/verification-update-request.d.ts +75 -0
  131. package/dist/models/verification-update-request.js +15 -0
  132. package/dist/models/verification-webhook.d.ts +43 -0
  133. package/dist/models/verification-webhook.js +15 -0
  134. package/dist/models/webhook-subscription-basic-authentication.d.ts +30 -0
  135. package/dist/models/webhook-subscription-basic-authentication.js +15 -0
  136. package/dist/models/webhook-subscription-request-schema.d.ts +37 -0
  137. package/dist/models/webhook-subscription-request-schema.js +15 -0
  138. package/dist/models/webhook-subscription-type-enum.d.ts +21 -0
  139. package/dist/models/webhook-subscription-type-enum.js +25 -0
  140. package/dist/models/webhook-subscription.d.ts +62 -0
  141. package/dist/models/webhook-subscription.js +15 -0
  142. package/dist/models/webhook-subscriptions-list-body.d.ts +39 -0
  143. package/dist/models/webhook-subscriptions-list-body.js +15 -0
  144. package/models/additional-denial-reason.ts +42 -0
  145. package/models/address.ts +66 -0
  146. package/models/callback-type-enum.ts +33 -0
  147. package/models/contact.ts +48 -0
  148. package/models/failure-webhook.ts +60 -0
  149. package/models/index.ts +27 -8
  150. package/models/links-object.ts +48 -0
  151. package/models/{message-sending-callback-message.ts → message-callback-message.ts} +17 -17
  152. package/models/message-callback.ts +68 -0
  153. package/models/model-error.ts +45 -0
  154. package/models/opt-in-workflow.ts +36 -0
  155. package/models/telephone-number.ts +30 -0
  156. package/models/tfv-basic-authentication.ts +36 -0
  157. package/models/tfv-callback-status-enum.ts +31 -0
  158. package/models/tfv-error.ts +42 -0
  159. package/models/tfv-status-enum.ts +34 -0
  160. package/models/tfv-status.ts +80 -0
  161. package/models/tfv-submission-info.ts +87 -0
  162. package/models/{transcription-list.ts → tfv-submission-wrapper.ts} +6 -6
  163. package/models/verification-denial-webhook.ts +75 -0
  164. package/models/verification-request.ts +93 -0
  165. package/models/verification-update-request.ts +87 -0
  166. package/models/verification-webhook.ts +53 -0
  167. package/models/webhook-subscription-basic-authentication.ts +36 -0
  168. package/models/webhook-subscription-request-schema.ts +45 -0
  169. package/models/webhook-subscription-type-enum.ts +31 -0
  170. package/models/webhook-subscription.ts +74 -0
  171. package/models/webhook-subscriptions-list-body.ts +51 -0
  172. package/openapi-config.yml +0 -1
  173. package/package.json +1 -1
  174. package/tests/callUtils.ts +0 -8
  175. package/tests/smoke/phone-number-lookup-api.test.ts +2 -12
  176. package/tests/smoke/toll-free-verification-api.test.ts +18 -0
  177. package/tests/unit/api/calls-api.test.ts +5 -5
  178. package/tests/unit/api/conferences-api.test.ts +4 -4
  179. package/tests/unit/api/messages-api.test.ts +5 -14
  180. package/tests/unit/api/phone-number-lookup-api.test.ts +2 -12
  181. package/tests/unit/api/recordings-api.test.ts +6 -6
  182. package/tests/unit/api/toll-free-verification-api.test.ts +159 -0
  183. package/tests/unit/models/callback-type-enum.test.ts +10 -0
  184. package/tests/unit/models/tfv-callback-status-enum.test.ts +8 -0
  185. package/tests/unit/models/tfv-status-enum.test.ts +11 -0
  186. package/tests/unit/models/webhook-subscription-type-enum.test.ts +8 -0
  187. package/dist/models/inbound-message-callback-message.d.ts +0 -92
  188. package/dist/models/inbound-message-callback.d.ts +0 -49
  189. package/dist/models/message-delivered-callback-message.d.ts +0 -92
  190. package/dist/models/message-delivered-callback.d.ts +0 -49
  191. package/dist/models/message-failed-callback-message.d.ts +0 -92
  192. package/dist/models/message-failed-callback.d.ts +0 -55
  193. package/dist/models/message-sending-callback.d.ts +0 -49
  194. package/dist/models/transcription-metadata.d.ts +0 -42
  195. package/models/inbound-message-callback-message.ts +0 -104
  196. package/models/inbound-message-callback.ts +0 -57
  197. package/models/message-delivered-callback-message.ts +0 -104
  198. package/models/message-delivered-callback.ts +0 -57
  199. package/models/message-failed-callback-message.ts +0 -104
  200. package/models/message-failed-callback.ts +0 -63
  201. package/models/message-sending-callback.ts +0 -57
  202. package/models/transcription-metadata.ts +0 -48
  203. /package/dist/models/{inbound-message-callback-message.js → additional-denial-reason.js} +0 -0
  204. /package/dist/models/{inbound-message-callback.js → address.js} +0 -0
  205. /package/dist/models/{message-delivered-callback-message.js → contact.js} +0 -0
  206. /package/dist/models/{message-delivered-callback.js → failure-webhook.js} +0 -0
  207. /package/dist/models/{message-failed-callback-message.js → links-object.js} +0 -0
  208. /package/dist/models/{message-failed-callback.js → message-callback-message.js} +0 -0
  209. /package/dist/models/{message-sending-callback-message.js → message-callback.js} +0 -0
  210. /package/dist/models/{message-sending-callback.js → model-error.js} +0 -0
  211. /package/dist/models/{transcription-list.js → opt-in-workflow.js} +0 -0
  212. /package/dist/models/{transcription-metadata.js → telephone-number.js} +0 -0
@@ -0,0 +1,56 @@
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 { CallbackTypeEnum } from './callback-type-enum';
13
+ import type { MessageCallbackMessage } from './message-callback-message';
14
+ /**
15
+ * Message Callback Schema
16
+ * @export
17
+ * @interface MessageCallback
18
+ */
19
+ export interface MessageCallback {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof MessageCallback
24
+ */
25
+ 'time': string;
26
+ /**
27
+ *
28
+ * @type {CallbackTypeEnum}
29
+ * @memberof MessageCallback
30
+ */
31
+ 'type': CallbackTypeEnum;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof MessageCallback
36
+ */
37
+ 'to': string;
38
+ /**
39
+ * A detailed description of the event described by the callback.
40
+ * @type {string}
41
+ * @memberof MessageCallback
42
+ */
43
+ 'description': string;
44
+ /**
45
+ *
46
+ * @type {MessageCallbackMessage}
47
+ * @memberof MessageCallback
48
+ */
49
+ 'message': MessageCallbackMessage;
50
+ /**
51
+ * Optional error code, applicable only when type is `message-failed`.
52
+ * @type {number}
53
+ * @memberof MessageCallback
54
+ */
55
+ 'errorCode'?: number | null;
56
+ }
@@ -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 { TelephoneNumber } from './telephone-number';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ModelError
17
+ */
18
+ export interface ModelError {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof ModelError
23
+ */
24
+ 'code'?: number;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ModelError
29
+ */
30
+ 'description'?: string;
31
+ /**
32
+ *
33
+ * @type {Array<TelephoneNumber>}
34
+ * @memberof ModelError
35
+ */
36
+ 'telephoneNumbers'?: Array<TelephoneNumber>;
37
+ }
@@ -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
+ *
14
+ * @export
15
+ * @interface OptInWorkflow
16
+ */
17
+ export interface OptInWorkflow {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof OptInWorkflow
22
+ */
23
+ 'description': string;
24
+ /**
25
+ *
26
+ * @type {Array<string>}
27
+ * @memberof OptInWorkflow
28
+ */
29
+ 'imageUrls': Array<string>;
30
+ }
@@ -9,17 +9,16 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { Transcription } from './transcription';
13
12
  /**
14
13
  *
15
14
  * @export
16
- * @interface TranscriptionList
15
+ * @interface TelephoneNumber
17
16
  */
18
- export interface TranscriptionList {
17
+ export interface TelephoneNumber {
19
18
  /**
20
- *
21
- * @type {Array<Transcription>}
22
- * @memberof TranscriptionList
19
+ * Simple Telephone Number.
20
+ * @type {string}
21
+ * @memberof TelephoneNumber
23
22
  */
24
- 'transcripts'?: Array<Transcription>;
23
+ 'telephoneNumber'?: string;
25
24
  }
@@ -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
+ *
14
+ * @export
15
+ * @interface TfvBasicAuthentication
16
+ */
17
+ export interface TfvBasicAuthentication {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TfvBasicAuthentication
22
+ */
23
+ 'username': string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof TfvBasicAuthentication
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,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 TfvCallbackStatusEnum: {
18
+ readonly Verified: "VERIFIED";
19
+ readonly Unverified: "UNVERIFIED";
20
+ };
21
+ export type TfvCallbackStatusEnum = typeof TfvCallbackStatusEnum[keyof typeof TfvCallbackStatusEnum];
@@ -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.TfvCallbackStatusEnum = void 0;
17
+ /**
18
+ *
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.TfvCallbackStatusEnum = {
23
+ Verified: 'VERIFIED',
24
+ Unverified: 'UNVERIFIED'
25
+ };
@@ -0,0 +1,36 @@
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
+ * A generic error object.
14
+ * @export
15
+ * @interface TfvError
16
+ */
17
+ export interface TfvError {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TfvError
22
+ */
23
+ 'type'?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof TfvError
28
+ */
29
+ 'description'?: string;
30
+ /**
31
+ * Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field.
32
+ * @type {object}
33
+ * @memberof TfvError
34
+ */
35
+ 'errors'?: object;
36
+ }
@@ -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,24 @@
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 TfvStatusEnum: {
18
+ readonly Verified: "VERIFIED";
19
+ readonly Unverified: "UNVERIFIED";
20
+ readonly Pending: "PENDING";
21
+ readonly PartiallyVerified: "PARTIALLY_VERIFIED";
22
+ readonly InvalidStatus: "INVALID_STATUS";
23
+ };
24
+ export type TfvStatusEnum = typeof TfvStatusEnum[keyof typeof TfvStatusEnum];
@@ -0,0 +1,28 @@
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.TfvStatusEnum = void 0;
17
+ /**
18
+ *
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.TfvStatusEnum = {
23
+ Verified: 'VERIFIED',
24
+ Unverified: 'UNVERIFIED',
25
+ Pending: 'PENDING',
26
+ PartiallyVerified: 'PARTIALLY_VERIFIED',
27
+ InvalidStatus: 'INVALID_STATUS'
28
+ };
@@ -0,0 +1,68 @@
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 { TfvStatusEnum } from './tfv-status-enum';
13
+ import type { TfvSubmissionInfo } from './tfv-submission-info';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface TfvStatus
18
+ */
19
+ export interface TfvStatus {
20
+ /**
21
+ * Toll-free telephone number in E.164 format.
22
+ * @type {string}
23
+ * @memberof TfvStatus
24
+ */
25
+ 'phoneNumber'?: string;
26
+ /**
27
+ *
28
+ * @type {TfvStatusEnum}
29
+ * @memberof TfvStatus
30
+ */
31
+ 'status'?: TfvStatusEnum;
32
+ /**
33
+ * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.
34
+ * @type {string}
35
+ * @memberof TfvStatus
36
+ */
37
+ 'internalTicketNumber'?: string;
38
+ /**
39
+ * Explanation for why a verification request was declined.
40
+ * @type {string}
41
+ * @memberof TfvStatus
42
+ */
43
+ 'declineReasonDescription'?: string;
44
+ /**
45
+ * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
46
+ * @type {boolean}
47
+ * @memberof TfvStatus
48
+ */
49
+ 'resubmitAllowed'?: boolean;
50
+ /**
51
+ * Date and time the verification request was created.
52
+ * @type {string}
53
+ * @memberof TfvStatus
54
+ */
55
+ 'createdDateTime'?: string;
56
+ /**
57
+ * Date and time the verification request was last modified.
58
+ * @type {string}
59
+ * @memberof TfvStatus
60
+ */
61
+ 'modifiedDateTime'?: string;
62
+ /**
63
+ *
64
+ * @type {TfvSubmissionInfo}
65
+ * @memberof TfvStatus
66
+ */
67
+ 'submission'?: TfvSubmissionInfo;
68
+ }
@@ -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,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 TfvSubmissionInfo
19
+ */
20
+ export interface TfvSubmissionInfo {
21
+ /**
22
+ *
23
+ * @type {Address}
24
+ * @memberof TfvSubmissionInfo
25
+ */
26
+ 'businessAddress'?: Address;
27
+ /**
28
+ *
29
+ * @type {Contact}
30
+ * @memberof TfvSubmissionInfo
31
+ */
32
+ 'businessContact'?: Contact;
33
+ /**
34
+ * Estimated monthly volume of messages from the toll-free number.
35
+ * @type {number}
36
+ * @memberof TfvSubmissionInfo
37
+ */
38
+ 'messageVolume'?: number;
39
+ /**
40
+ * The category of the use case.
41
+ * @type {string}
42
+ * @memberof TfvSubmissionInfo
43
+ */
44
+ 'useCase'?: string;
45
+ /**
46
+ * A general idea of the use case and customer.
47
+ * @type {string}
48
+ * @memberof TfvSubmissionInfo
49
+ */
50
+ 'useCaseSummary'?: string;
51
+ /**
52
+ * Example of message content.
53
+ * @type {string}
54
+ * @memberof TfvSubmissionInfo
55
+ */
56
+ 'productionMessageContent'?: string;
57
+ /**
58
+ *
59
+ * @type {OptInWorkflow}
60
+ * @memberof TfvSubmissionInfo
61
+ */
62
+ 'optInWorkflow'?: OptInWorkflow;
63
+ /**
64
+ * Any additional information.
65
+ * @type {string}
66
+ * @memberof TfvSubmissionInfo
67
+ */
68
+ 'additionalInformation'?: string | null;
69
+ /**
70
+ * ISV name.
71
+ * @type {string}
72
+ * @memberof TfvSubmissionInfo
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,25 @@
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 { VerificationUpdateRequest } from './verification-update-request';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TfvSubmissionWrapper
17
+ */
18
+ export interface TfvSubmissionWrapper {
19
+ /**
20
+ *
21
+ * @type {VerificationUpdateRequest}
22
+ * @memberof TfvSubmissionWrapper
23
+ */
24
+ 'submission'?: VerificationUpdateRequest;
25
+ }
@@ -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,67 @@
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 { AdditionalDenialReason } from './additional-denial-reason';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface VerificationDenialWebhook
17
+ */
18
+ export interface VerificationDenialWebhook {
19
+ /**
20
+ * User\'s account ID.
21
+ * @type {string}
22
+ * @memberof VerificationDenialWebhook
23
+ */
24
+ 'accountId'?: string;
25
+ /**
26
+ * An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.
27
+ * @type {Array<AdditionalDenialReason>}
28
+ * @memberof VerificationDenialWebhook
29
+ */
30
+ 'additionalDenialReasons'?: Array<AdditionalDenialReason>;
31
+ /**
32
+ * Explanation for why a verification request was declined.
33
+ * @type {string}
34
+ * @memberof VerificationDenialWebhook
35
+ */
36
+ 'declineReasonDescription'?: string;
37
+ /**
38
+ * Reason code for denial.
39
+ * @type {number}
40
+ * @memberof VerificationDenialWebhook
41
+ */
42
+ 'denialStatusCode'?: number;
43
+ /**
44
+ * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
45
+ * @type {string}
46
+ * @memberof VerificationDenialWebhook
47
+ */
48
+ 'internalTicketNumber'?: string;
49
+ /**
50
+ * Toll-free telephone number in E.164 format.
51
+ * @type {string}
52
+ * @memberof VerificationDenialWebhook
53
+ */
54
+ 'phoneNumber'?: string;
55
+ /**
56
+ * Whether a Toll-Free Verification request qualifies for resubmission via PUT.
57
+ * @type {boolean}
58
+ * @memberof VerificationDenialWebhook
59
+ */
60
+ 'resubmitAllowed'?: boolean;
61
+ /**
62
+ *
63
+ * @type {string}
64
+ * @memberof VerificationDenialWebhook
65
+ */
66
+ 'status'?: string;
67
+ }
@@ -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 });