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