bandwidth-sdk 4.0.0 → 4.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) 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 +25 -0
  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 +1113 -0
  10. package/base.ts +48 -0
  11. package/configuration.ts +1 -1
  12. package/coverage/clover.xml +674 -438
  13. package/coverage/coverage-final.json +70 -66
  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 +2 -2
  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 +50 -5
  77. package/coverage/lcov-report/node-sdk/models/index.ts.html +164 -92
  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 +1106 -526
  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/common.d.ts +1 -1
  98. package/dist/configuration.js +1 -1
  99. package/dist/models/additional-denial-reason.d.ts +36 -0
  100. package/dist/models/additional-denial-reason.js +15 -0
  101. package/dist/models/address.d.ts +60 -0
  102. package/dist/models/address.js +15 -0
  103. package/dist/models/contact.d.ts +42 -0
  104. package/dist/models/contact.js +15 -0
  105. package/dist/models/failure-webhook.d.ts +54 -0
  106. package/dist/models/failure-webhook.js +15 -0
  107. package/dist/models/index.d.ts +24 -0
  108. package/dist/models/index.js +24 -0
  109. package/dist/models/initiate-callback.d.ts +6 -0
  110. package/dist/models/links-object.d.ts +42 -0
  111. package/dist/models/links-object.js +15 -0
  112. package/dist/models/model-error.d.ts +37 -0
  113. package/dist/models/model-error.js +15 -0
  114. package/dist/models/opt-in-workflow.d.ts +30 -0
  115. package/dist/models/opt-in-workflow.js +15 -0
  116. package/dist/models/telephone-number.d.ts +24 -0
  117. package/dist/models/telephone-number.js +15 -0
  118. package/dist/models/tfv-basic-authentication.d.ts +30 -0
  119. package/dist/models/tfv-basic-authentication.js +15 -0
  120. package/dist/models/tfv-callback-status-enum.d.ts +21 -0
  121. package/dist/models/tfv-callback-status-enum.js +25 -0
  122. package/dist/models/tfv-error.d.ts +36 -0
  123. package/dist/models/tfv-error.js +15 -0
  124. package/dist/models/tfv-status-enum.d.ts +24 -0
  125. package/dist/models/tfv-status-enum.js +28 -0
  126. package/dist/models/tfv-status.d.ts +68 -0
  127. package/dist/models/tfv-status.js +15 -0
  128. package/dist/models/tfv-submission-info.d.ts +75 -0
  129. package/dist/models/tfv-submission-info.js +15 -0
  130. package/dist/models/tfv-submission-wrapper.d.ts +25 -0
  131. package/dist/models/tfv-submission-wrapper.js +15 -0
  132. package/dist/models/verification-denial-webhook.d.ts +67 -0
  133. package/dist/models/verification-denial-webhook.js +15 -0
  134. package/dist/models/verification-request.d.ts +81 -0
  135. package/dist/models/verification-request.js +15 -0
  136. package/dist/models/verification-update-request.d.ts +75 -0
  137. package/dist/models/verification-update-request.js +15 -0
  138. package/dist/models/verification-webhook.d.ts +43 -0
  139. package/dist/models/verification-webhook.js +15 -0
  140. package/dist/models/webhook-subscription-basic-authentication.d.ts +30 -0
  141. package/dist/models/webhook-subscription-basic-authentication.js +15 -0
  142. package/dist/models/webhook-subscription-request-schema.d.ts +37 -0
  143. package/dist/models/webhook-subscription-request-schema.js +15 -0
  144. package/dist/models/webhook-subscription-type-enum.d.ts +21 -0
  145. package/dist/models/webhook-subscription-type-enum.js +25 -0
  146. package/dist/models/webhook-subscription.d.ts +62 -0
  147. package/dist/models/webhook-subscription.js +15 -0
  148. package/dist/models/webhook-subscriptions-list-body.d.ts +39 -0
  149. package/dist/models/webhook-subscriptions-list-body.js +15 -0
  150. package/models/additional-denial-reason.ts +42 -0
  151. package/models/address.ts +66 -0
  152. package/models/contact.ts +48 -0
  153. package/models/failure-webhook.ts +60 -0
  154. package/models/index.ts +24 -0
  155. package/models/initiate-callback.ts +6 -0
  156. package/models/links-object.ts +48 -0
  157. package/models/model-error.ts +45 -0
  158. package/models/opt-in-workflow.ts +36 -0
  159. package/models/telephone-number.ts +30 -0
  160. package/models/tfv-basic-authentication.ts +36 -0
  161. package/models/tfv-callback-status-enum.ts +31 -0
  162. package/models/tfv-error.ts +42 -0
  163. package/models/tfv-status-enum.ts +34 -0
  164. package/models/tfv-status.ts +80 -0
  165. package/models/tfv-submission-info.ts +87 -0
  166. package/models/tfv-submission-wrapper.ts +33 -0
  167. package/models/verification-denial-webhook.ts +75 -0
  168. package/models/verification-request.ts +93 -0
  169. package/models/verification-update-request.ts +87 -0
  170. package/models/verification-webhook.ts +53 -0
  171. package/models/webhook-subscription-basic-authentication.ts +36 -0
  172. package/models/webhook-subscription-request-schema.ts +45 -0
  173. package/models/webhook-subscription-type-enum.ts +31 -0
  174. package/models/webhook-subscription.ts +74 -0
  175. package/models/webhook-subscriptions-list-body.ts +51 -0
  176. package/openapi-config.yml +0 -1
  177. package/package.json +1 -1
  178. package/tests/callUtils.ts +0 -8
  179. package/tests/smoke/phone-number-lookup-api.test.ts +2 -12
  180. package/tests/smoke/toll-free-verification-api.test.ts +18 -0
  181. package/tests/unit/api/calls-api.test.ts +5 -5
  182. package/tests/unit/api/conferences-api.test.ts +4 -4
  183. package/tests/unit/api/messages-api.test.ts +5 -14
  184. package/tests/unit/api/phone-number-lookup-api.test.ts +2 -12
  185. package/tests/unit/api/recordings-api.test.ts +6 -6
  186. package/tests/unit/api/toll-free-verification-api.test.ts +159 -0
  187. package/tests/unit/models/tfv-callback-status-enum.test.ts +8 -0
  188. package/tests/unit/models/tfv-status-enum.test.ts +11 -0
  189. package/tests/unit/models/webhook-subscription-type-enum.test.ts +8 -0
package/models/index.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  export * from './account-statistics';
2
+ export * from './additional-denial-reason';
3
+ export * from './address';
2
4
  export * from './answer-callback';
3
5
  export * from './bridge-complete-callback';
4
6
  export * from './bridge-target-complete-callback';
@@ -24,6 +26,7 @@ export * from './conference-recording-available-callback';
24
26
  export * from './conference-recording-metadata';
25
27
  export * from './conference-redirect-callback';
26
28
  export * from './conference-state-enum';
29
+ export * from './contact';
27
30
  export * from './create-call';
28
31
  export * from './create-call-response';
29
32
  export * from './create-lookup-response';
@@ -32,10 +35,12 @@ export * from './deferred-result';
32
35
  export * from './disconnect-callback';
33
36
  export * from './diversion';
34
37
  export * from './dtmf-callback';
38
+ export * from './failure-webhook';
35
39
  export * from './field-error';
36
40
  export * from './file-format-enum';
37
41
  export * from './gather-callback';
38
42
  export * from './initiate-callback';
43
+ export * from './links-object';
39
44
  export * from './list-message-direction-enum';
40
45
  export * from './list-message-item';
41
46
  export * from './lookup-request';
@@ -60,6 +65,8 @@ export * from './messaging-request-error';
60
65
  export * from './mfa-forbidden-request-error';
61
66
  export * from './mfa-request-error';
62
67
  export * from './mfa-unauthorized-request-error';
68
+ export * from './model-error';
69
+ export * from './opt-in-workflow';
63
70
  export * from './page-info';
64
71
  export * from './priority-enum';
65
72
  export * from './recording-available-callback';
@@ -71,6 +78,14 @@ export * from './redirect-callback';
71
78
  export * from './redirect-method-enum';
72
79
  export * from './stir-shaken';
73
80
  export * from './tag';
81
+ export * from './telephone-number';
82
+ export * from './tfv-basic-authentication';
83
+ export * from './tfv-callback-status-enum';
84
+ export * from './tfv-error';
85
+ export * from './tfv-status';
86
+ export * from './tfv-status-enum';
87
+ export * from './tfv-submission-info';
88
+ export * from './tfv-submission-wrapper';
74
89
  export * from './tn-lookup-request-error';
75
90
  export * from './transcribe-recording';
76
91
  export * from './transcription';
@@ -82,8 +97,17 @@ export * from './update-call';
82
97
  export * from './update-call-recording';
83
98
  export * from './update-conference';
84
99
  export * from './update-conference-member';
100
+ export * from './verification-denial-webhook';
101
+ export * from './verification-request';
102
+ export * from './verification-update-request';
103
+ export * from './verification-webhook';
85
104
  export * from './verify-code-request';
86
105
  export * from './verify-code-response';
87
106
  export * from './voice-api-error';
88
107
  export * from './voice-code-response';
108
+ export * from './webhook-subscription';
109
+ export * from './webhook-subscription-basic-authentication';
110
+ export * from './webhook-subscription-request-schema';
111
+ export * from './webhook-subscription-type-enum';
112
+ export * from './webhook-subscriptions-list-body';
89
113
  export * from './bxml';
@@ -101,6 +101,12 @@ export interface InitiateCallback {
101
101
  * @memberof InitiateCallback
102
102
  */
103
103
  'stirShaken'?: StirShaken;
104
+ /**
105
+ * The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.
106
+ * @type {string}
107
+ * @memberof InitiateCallback
108
+ */
109
+ 'uui'?: string;
104
110
  }
105
111
 
106
112
 
@@ -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 LinksObject
21
+ */
22
+ export interface LinksObject {
23
+ /**
24
+ * The first (or only) page of results matching the query.
25
+ * @type {string}
26
+ * @memberof LinksObject
27
+ */
28
+ 'first'?: string;
29
+ /**
30
+ * If more results exist than specified by \'size\', this link returns the next page of \'size\' results.
31
+ * @type {string}
32
+ * @memberof LinksObject
33
+ */
34
+ 'next'?: string;
35
+ /**
36
+ * If the results are more than one page, this link returns the previous page of \'size\' results.
37
+ * @type {string}
38
+ * @memberof LinksObject
39
+ */
40
+ 'previous'?: string;
41
+ /**
42
+ * If more results exist than specified by \'size\', this link return the last page of result.
43
+ * @type {string}
44
+ * @memberof LinksObject
45
+ */
46
+ 'last'?: string;
47
+ }
48
+
@@ -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 { TelephoneNumber } from './telephone-number';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface ModelError
24
+ */
25
+ export interface ModelError {
26
+ /**
27
+ *
28
+ * @type {number}
29
+ * @memberof ModelError
30
+ */
31
+ 'code'?: number;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof ModelError
36
+ */
37
+ 'description'?: string;
38
+ /**
39
+ *
40
+ * @type {Array<TelephoneNumber>}
41
+ * @memberof ModelError
42
+ */
43
+ 'telephoneNumbers'?: Array<TelephoneNumber>;
44
+ }
45
+
@@ -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
+ *
19
+ * @export
20
+ * @interface OptInWorkflow
21
+ */
22
+ export interface OptInWorkflow {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof OptInWorkflow
27
+ */
28
+ 'description': string;
29
+ /**
30
+ *
31
+ * @type {Array<string>}
32
+ * @memberof OptInWorkflow
33
+ */
34
+ 'imageUrls': Array<string>;
35
+ }
36
+
@@ -0,0 +1,30 @@
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 TelephoneNumber
21
+ */
22
+ export interface TelephoneNumber {
23
+ /**
24
+ * Simple Telephone Number.
25
+ * @type {string}
26
+ * @memberof TelephoneNumber
27
+ */
28
+ 'telephoneNumber'?: string;
29
+ }
30
+
@@ -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
+ *
19
+ * @export
20
+ * @interface TfvBasicAuthentication
21
+ */
22
+ export interface TfvBasicAuthentication {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof TfvBasicAuthentication
27
+ */
28
+ 'username': string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof TfvBasicAuthentication
33
+ */
34
+ 'password': string;
35
+ }
36
+
@@ -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 TfvCallbackStatusEnum = {
24
+ Verified: 'VERIFIED',
25
+ Unverified: 'UNVERIFIED'
26
+ } as const;
27
+
28
+ export type TfvCallbackStatusEnum = typeof TfvCallbackStatusEnum[keyof typeof TfvCallbackStatusEnum];
29
+
30
+
31
+
@@ -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
+ * A generic error object.
19
+ * @export
20
+ * @interface TfvError
21
+ */
22
+ export interface TfvError {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof TfvError
27
+ */
28
+ 'type'?: string;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof TfvError
33
+ */
34
+ 'description'?: string;
35
+ /**
36
+ * 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.
37
+ * @type {object}
38
+ * @memberof TfvError
39
+ */
40
+ 'errors'?: object;
41
+ }
42
+
@@ -0,0 +1,34 @@
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 TfvStatusEnum = {
24
+ Verified: 'VERIFIED',
25
+ Unverified: 'UNVERIFIED',
26
+ Pending: 'PENDING',
27
+ PartiallyVerified: 'PARTIALLY_VERIFIED',
28
+ InvalidStatus: 'INVALID_STATUS'
29
+ } as const;
30
+
31
+ export type TfvStatusEnum = typeof TfvStatusEnum[keyof typeof TfvStatusEnum];
32
+
33
+
34
+
@@ -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
+
@@ -0,0 +1,33 @@
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 { VerificationUpdateRequest } from './verification-update-request';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface TfvSubmissionWrapper
24
+ */
25
+ export interface TfvSubmissionWrapper {
26
+ /**
27
+ *
28
+ * @type {VerificationUpdateRequest}
29
+ * @memberof TfvSubmissionWrapper
30
+ */
31
+ 'submission'?: VerificationUpdateRequest;
32
+ }
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
+