bandwidth-sdk 5.0.0 → 6.0.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 (254) hide show
  1. package/.github/workflows/test-pr.yml +2 -2
  2. package/.openapi-generator/FILES +32 -18
  3. package/api/multi-channel-api.ts +1 -3
  4. package/api/toll-free-verification-api.ts +80 -0
  5. package/bandwidth.yml +549 -194
  6. package/base.ts +6 -0
  7. package/configuration.ts +1 -1
  8. package/coverage/clover.xml +214 -189
  9. package/coverage/coverage-final.json +7 -8
  10. package/coverage/lcov-report/index.html +20 -20
  11. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/index.html +15 -15
  14. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +3 -9
  18. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +251 -11
  22. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  24. package/coverage/lcov-report/node-sdk/base.ts.html +20 -2
  25. package/coverage/lcov-report/node-sdk/common.ts.html +18 -18
  26. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  27. package/coverage/lcov-report/node-sdk/index.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/{multi-channel-status-enum.ts.html → inbound-callback-type-enum.ts.html} +10 -13
  74. package/coverage/lcov-report/node-sdk/models/index.html +16 -31
  75. package/coverage/lcov-report/node-sdk/models/index.ts.html +34 -13
  76. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  83. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  84. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  89. package/coverage/lcov-report/node-sdk/models/{callback-type-enum.ts.html → status-callback-type-enum.ts.html} +8 -8
  90. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  93. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  94. package/coverage/lcov.info +554 -496
  95. package/dist/api/toll-free-verification-api.d.ts +37 -0
  96. package/dist/api/toll-free-verification-api.js +92 -0
  97. package/dist/base.js +6 -0
  98. package/dist/configuration.js +1 -1
  99. package/dist/models/blocked-webhook.d.ts +55 -0
  100. package/dist/models/callback.d.ts +33 -0
  101. package/dist/models/create-multi-channel-message-response.d.ts +3 -3
  102. package/dist/models/error-object.d.ts +11 -4
  103. package/dist/models/error-source.d.ts +42 -0
  104. package/dist/models/failure-webhook.d.ts +1 -1
  105. package/dist/models/inbound-callback-message.d.ts +17 -0
  106. package/dist/models/inbound-callback-type-enum.d.ts +22 -0
  107. package/dist/models/inbound-callback-type-enum.js +26 -0
  108. package/dist/models/inbound-callback.d.ts +56 -0
  109. package/dist/models/index.d.ts +16 -9
  110. package/dist/models/index.js +16 -9
  111. package/dist/models/list-message-item.d.ts +1 -1
  112. package/dist/models/message-request.d.ts +1 -1
  113. package/dist/models/message.d.ts +3 -3
  114. package/dist/models/mms-message-content-file.d.ts +24 -0
  115. package/dist/models/mms-message-content.d.ts +4 -3
  116. package/dist/models/multi-channel-error.d.ts +38 -0
  117. package/dist/models/multi-channel-message-content.d.ts +31 -0
  118. package/dist/models/multi-channel-message-content.js +15 -0
  119. package/dist/models/{tag.d.ts → multi-channel-message-response-data-channel-list-inner.d.ts} +3 -16
  120. package/dist/models/multi-channel-message-response-data-channel-list-inner.js +15 -0
  121. package/dist/models/multi-channel-message-response-data.d.ts +69 -0
  122. package/dist/models/multi-channel-message-response-data.js +15 -0
  123. package/dist/models/priority-enum.d.ts +1 -1
  124. package/dist/models/priority-enum.js +1 -1
  125. package/dist/models/rbm-action-base.d.ts +1 -1
  126. package/dist/models/{deferred-result.d.ts → rbm-location-response.d.ts} +10 -10
  127. package/dist/models/rbm-location-response.js +15 -0
  128. package/dist/models/rbm-suggestion-response.d.ts +30 -0
  129. package/dist/models/rbm-suggestion-response.js +15 -0
  130. package/dist/models/status-callback-message.d.ts +99 -0
  131. package/dist/models/status-callback-message.js +15 -0
  132. package/dist/models/status-callback-type-enum.d.ts +23 -0
  133. package/dist/models/status-callback-type-enum.js +27 -0
  134. package/dist/models/status-callback.d.ts +68 -0
  135. package/dist/models/status-callback.js +15 -0
  136. package/dist/models/tfv-status.d.ts +2 -2
  137. package/dist/models/tfv-submission-info.d.ts +4 -4
  138. package/dist/models/verification-denial-webhook.d.ts +2 -2
  139. package/dist/models/verification-request.d.ts +4 -4
  140. package/dist/models/verification-update-request.d.ts +4 -4
  141. package/docs/BlockedWebhook.md +30 -0
  142. package/docs/Callback.md +35 -0
  143. package/docs/CreateMultiChannelMessageResponse.md +1 -1
  144. package/docs/ErrorObject.md +6 -4
  145. package/docs/ErrorSource.md +27 -0
  146. package/docs/FailureWebhook.md +2 -2
  147. package/docs/InboundCallback.md +31 -0
  148. package/docs/InboundCallbackMessage.md +50 -0
  149. package/docs/InboundCallbackTypeEnum.md +13 -0
  150. package/docs/ListMessageItem.md +1 -1
  151. package/docs/Message.md +3 -3
  152. package/docs/MessageRequest.md +1 -1
  153. package/docs/MessagesApi.md +1 -0
  154. package/docs/MmsMessageContent.md +1 -1
  155. package/docs/MmsMessageContentFile.md +20 -0
  156. package/docs/MultiChannelAction.md +2 -2
  157. package/docs/MultiChannelActionCalendarEvent.md +2 -2
  158. package/docs/MultiChannelApi.md +1 -0
  159. package/docs/MultiChannelChannelListObjectContent.md +1 -1
  160. package/docs/MultiChannelError.md +24 -0
  161. package/docs/MultiChannelMessageContent.md +23 -0
  162. package/docs/MultiChannelMessageResponseData.md +35 -0
  163. package/docs/MultiChannelMessageResponseDataChannelListInner.md +28 -0
  164. package/docs/PriorityEnum.md +1 -1
  165. package/docs/RbmActionBase.md +2 -2
  166. package/docs/RbmActionDial.md +2 -2
  167. package/docs/RbmActionOpenUrl.md +2 -2
  168. package/docs/RbmActionViewLocation.md +2 -2
  169. package/docs/RbmLocationResponse.md +22 -0
  170. package/docs/RbmSuggestionResponse.md +22 -0
  171. package/docs/StatusCallback.md +35 -0
  172. package/docs/StatusCallbackMessage.md +45 -0
  173. package/docs/StatusCallbackTypeEnum.md +15 -0
  174. package/docs/TfvStatus.md +2 -2
  175. package/docs/TfvSubmissionInfo.md +4 -4
  176. package/docs/TollFreeVerificationApi.md +63 -0
  177. package/docs/VerificationDenialWebhook.md +2 -2
  178. package/docs/VerificationRequest.md +4 -4
  179. package/docs/VerificationUpdateRequest.md +4 -4
  180. package/models/blocked-webhook.ts +65 -0
  181. package/models/callback.ts +36 -0
  182. package/models/create-multi-channel-message-response.ts +3 -3
  183. package/models/error-object.ts +13 -4
  184. package/models/error-source.ts +48 -0
  185. package/models/failure-webhook.ts +1 -1
  186. package/models/inbound-callback-message.ts +44 -0
  187. package/models/inbound-callback-type-enum.ts +32 -0
  188. package/models/inbound-callback.ts +68 -0
  189. package/models/index.ts +16 -9
  190. package/models/list-message-item.ts +1 -1
  191. package/models/message-request.ts +1 -1
  192. package/models/message.ts +3 -3
  193. package/models/mms-message-content-file.ts +30 -0
  194. package/models/mms-message-content.ts +6 -3
  195. package/models/multi-channel-channel-list-object-content.ts +3 -0
  196. package/models/multi-channel-error.ts +48 -0
  197. package/models/multi-channel-message-content.ts +39 -0
  198. package/models/multi-channel-message-response-data-channel-list-inner.ts +32 -0
  199. package/models/multi-channel-message-response-data.ts +83 -0
  200. package/models/priority-enum.ts +1 -1
  201. package/models/rbm-action-base.ts +1 -1
  202. package/models/{deferred-result.ts → rbm-location-response.ts} +10 -10
  203. package/models/{tag.ts → rbm-suggestion-response.ts} +8 -8
  204. package/models/status-callback-message.ts +113 -0
  205. package/models/status-callback-type-enum.ts +33 -0
  206. package/models/status-callback.ts +80 -0
  207. package/models/tfv-status.ts +2 -2
  208. package/models/tfv-submission-info.ts +4 -4
  209. package/models/verification-denial-webhook.ts +2 -2
  210. package/models/verification-request.ts +4 -4
  211. package/models/verification-update-request.ts +4 -4
  212. package/package.json +1 -1
  213. package/tests/unit/api/toll-free-verification-api.test.ts +7 -0
  214. package/tests/unit/models/inbound-callback-type-enum.test.ts +9 -0
  215. package/tests/unit/models/status-callback-type-enum.test.ts +10 -0
  216. package/coverage/lcov-report/node-sdk/models/multi-channel-message-direction-enum.ts.html +0 -178
  217. package/dist/models/callback-type-enum.d.ts +0 -23
  218. package/dist/models/callback-type-enum.js +0 -27
  219. package/dist/models/message-callback-message.d.ts +0 -92
  220. package/dist/models/message-callback.d.ts +0 -62
  221. package/dist/models/multi-channel-callback-data.d.ts +0 -50
  222. package/dist/models/multi-channel-message-callback-data.d.ts +0 -69
  223. package/dist/models/multi-channel-message-data.d.ts +0 -75
  224. package/dist/models/multi-channel-message-direction-enum.d.ts +0 -21
  225. package/dist/models/multi-channel-message-direction-enum.js +0 -25
  226. package/dist/models/multi-channel-status-enum.d.ts +0 -23
  227. package/dist/models/multi-channel-status-enum.js +0 -27
  228. package/docs/CallbackTypeEnum.md +0 -15
  229. package/docs/DeferredResult.md +0 -22
  230. package/docs/MessageCallback.md +0 -33
  231. package/docs/MessageCallbackMessage.md +0 -43
  232. package/docs/MultiChannelCallbackData.md +0 -28
  233. package/docs/MultiChannelMessageCallbackData.md +0 -34
  234. package/docs/MultiChannelMessageData.md +0 -36
  235. package/docs/MultiChannelMessageDirectionEnum.md +0 -10
  236. package/docs/MultiChannelStatusEnum.md +0 -14
  237. package/models/callback-type-enum.ts +0 -33
  238. package/models/message-callback-message.ts +0 -104
  239. package/models/message-callback.ts +0 -74
  240. package/models/multi-channel-callback-data.ts +0 -62
  241. package/models/multi-channel-message-callback-data.ts +0 -83
  242. package/models/multi-channel-message-data.ts +0 -89
  243. package/models/multi-channel-message-direction-enum.ts +0 -31
  244. package/models/multi-channel-status-enum.ts +0 -33
  245. package/tests/unit/models/callback-type-enum.test.ts +0 -10
  246. package/tests/unit/models/multi-channel-message-direction-enum.test.ts +0 -8
  247. package/tests/unit/models/multi-channel-status-enum.test.ts +0 -10
  248. /package/dist/models/{deferred-result.js → blocked-webhook.js} +0 -0
  249. /package/dist/models/{message-callback-message.js → callback.js} +0 -0
  250. /package/dist/models/{message-callback.js → error-source.js} +0 -0
  251. /package/dist/models/{multi-channel-callback-data.js → inbound-callback-message.js} +0 -0
  252. /package/dist/models/{multi-channel-message-callback-data.js → inbound-callback.js} +0 -0
  253. /package/dist/models/{multi-channel-message-data.js → mms-message-content-file.js} +0 -0
  254. /package/dist/models/{tag.js → multi-channel-error.js} +0 -0
@@ -1,92 +0,0 @@
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 { MessageDirectionEnum } from './message-direction-enum';
13
- import type { PriorityEnum } from './priority-enum';
14
- /**
15
- * Message payload schema within a MessageCallback
16
- * @export
17
- * @interface MessageCallbackMessage
18
- */
19
- export interface MessageCallbackMessage {
20
- /**
21
- *
22
- * @type {string}
23
- * @memberof MessageCallbackMessage
24
- */
25
- 'id': string;
26
- /**
27
- *
28
- * @type {string}
29
- * @memberof MessageCallbackMessage
30
- */
31
- 'owner': string;
32
- /**
33
- *
34
- * @type {string}
35
- * @memberof MessageCallbackMessage
36
- */
37
- 'applicationId': string;
38
- /**
39
- *
40
- * @type {string}
41
- * @memberof MessageCallbackMessage
42
- */
43
- 'time': string;
44
- /**
45
- *
46
- * @type {number}
47
- * @memberof MessageCallbackMessage
48
- */
49
- 'segmentCount': number;
50
- /**
51
- *
52
- * @type {MessageDirectionEnum}
53
- * @memberof MessageCallbackMessage
54
- */
55
- 'direction': MessageDirectionEnum;
56
- /**
57
- *
58
- * @type {Set<string>}
59
- * @memberof MessageCallbackMessage
60
- */
61
- 'to': Set<string>;
62
- /**
63
- *
64
- * @type {string}
65
- * @memberof MessageCallbackMessage
66
- */
67
- 'from': string;
68
- /**
69
- *
70
- * @type {string}
71
- * @memberof MessageCallbackMessage
72
- */
73
- 'text': string;
74
- /**
75
- *
76
- * @type {string}
77
- * @memberof MessageCallbackMessage
78
- */
79
- 'tag'?: string;
80
- /**
81
- * Optional media, applicable only for mms
82
- * @type {Array<string>}
83
- * @memberof MessageCallbackMessage
84
- */
85
- 'media'?: Array<string> | null;
86
- /**
87
- *
88
- * @type {PriorityEnum}
89
- * @memberof MessageCallbackMessage
90
- */
91
- 'priority'?: PriorityEnum;
92
- }
@@ -1,62 +0,0 @@
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
- /**
57
- * The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to.
58
- * @type {string}
59
- * @memberof MessageCallback
60
- */
61
- 'carrierName'?: string | null;
62
- }
@@ -1,50 +0,0 @@
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 { MultiChannelMessageCallbackData } from './multi-channel-message-callback-data';
13
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
14
- /**
15
- *
16
- * @export
17
- * @interface MultiChannelCallbackData
18
- */
19
- export interface MultiChannelCallbackData {
20
- /**
21
- * The time of the callback event.
22
- * @type {string}
23
- * @memberof MultiChannelCallbackData
24
- */
25
- 'time'?: string;
26
- /**
27
- *
28
- * @type {MultiChannelStatusEnum}
29
- * @memberof MultiChannelCallbackData
30
- */
31
- 'type'?: MultiChannelStatusEnum;
32
- /**
33
- * The phone number the message should be sent to in E164 format.
34
- * @type {string}
35
- * @memberof MultiChannelCallbackData
36
- */
37
- 'to'?: string;
38
- /**
39
- *
40
- * @type {string}
41
- * @memberof MultiChannelCallbackData
42
- */
43
- 'description'?: string;
44
- /**
45
- *
46
- * @type {MultiChannelMessageCallbackData}
47
- * @memberof MultiChannelCallbackData
48
- */
49
- 'message'?: MultiChannelMessageCallbackData;
50
- }
@@ -1,69 +0,0 @@
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 { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
13
- import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum';
14
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
15
- /**
16
- *
17
- * @export
18
- * @interface MultiChannelMessageCallbackData
19
- */
20
- export interface MultiChannelMessageCallbackData {
21
- /**
22
- * The ID of the message.
23
- * @type {string}
24
- * @memberof MultiChannelMessageCallbackData
25
- */
26
- 'messageId'?: string;
27
- /**
28
- *
29
- * @type {MultiChannelStatusEnum}
30
- * @memberof MultiChannelMessageCallbackData
31
- */
32
- 'status'?: MultiChannelStatusEnum;
33
- /**
34
- *
35
- * @type {MultiChannelMessageDirectionEnum}
36
- * @memberof MultiChannelMessageCallbackData
37
- */
38
- 'direction'?: MultiChannelMessageDirectionEnum;
39
- /**
40
- * The sender ID of the message. This could be an alphanumeric sender ID.
41
- * @type {string}
42
- * @memberof MultiChannelMessageCallbackData
43
- */
44
- 'from'?: string;
45
- /**
46
- * The phone number the message should be sent to in E164 format.
47
- * @type {string}
48
- * @memberof MultiChannelMessageCallbackData
49
- */
50
- 'to'?: string;
51
- /**
52
- * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
53
- * @type {string}
54
- * @memberof MultiChannelMessageCallbackData
55
- */
56
- 'applicationId'?: string;
57
- /**
58
- *
59
- * @type {MultiChannelMessageChannelEnum}
60
- * @memberof MultiChannelMessageCallbackData
61
- */
62
- 'channel'?: MultiChannelMessageChannelEnum;
63
- /**
64
- * A custom string that will be included in callback events of the message. Max 1024 characters.
65
- * @type {string}
66
- * @memberof MultiChannelMessageCallbackData
67
- */
68
- 'tag'?: string;
69
- }
@@ -1,75 +0,0 @@
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 { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
13
- import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum';
14
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
15
- /**
16
- *
17
- * @export
18
- * @interface MultiChannelMessageData
19
- */
20
- export interface MultiChannelMessageData {
21
- /**
22
- * The ID of the message.
23
- * @type {string}
24
- * @memberof MultiChannelMessageData
25
- */
26
- 'messageId'?: string;
27
- /**
28
- *
29
- * @type {MultiChannelStatusEnum}
30
- * @memberof MultiChannelMessageData
31
- */
32
- 'status'?: MultiChannelStatusEnum;
33
- /**
34
- * The time the message was received by the Bandwidth API.
35
- * @type {string}
36
- * @memberof MultiChannelMessageData
37
- */
38
- 'time'?: string;
39
- /**
40
- *
41
- * @type {MultiChannelMessageDirectionEnum}
42
- * @memberof MultiChannelMessageData
43
- */
44
- 'direction'?: MultiChannelMessageDirectionEnum;
45
- /**
46
- * The sender ID of the message. This could be an alphanumeric sender ID.
47
- * @type {string}
48
- * @memberof MultiChannelMessageData
49
- */
50
- 'from'?: string;
51
- /**
52
- * The phone number the message should be sent to in E164 format.
53
- * @type {string}
54
- * @memberof MultiChannelMessageData
55
- */
56
- 'to'?: string;
57
- /**
58
- * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
59
- * @type {string}
60
- * @memberof MultiChannelMessageData
61
- */
62
- 'applicationId'?: string;
63
- /**
64
- *
65
- * @type {MultiChannelMessageChannelEnum}
66
- * @memberof MultiChannelMessageData
67
- */
68
- 'channel'?: MultiChannelMessageChannelEnum;
69
- /**
70
- * A custom string that will be included in callback events of the message. Max 1024 characters.
71
- * @type {string}
72
- * @memberof MultiChannelMessageData
73
- */
74
- 'tag'?: string;
75
- }
@@ -1,21 +0,0 @@
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 MultiChannelMessageDirectionEnum: {
18
- readonly Inbound: "INBOUND";
19
- readonly Outbound: "OUTBOUND";
20
- };
21
- export type MultiChannelMessageDirectionEnum = typeof MultiChannelMessageDirectionEnum[keyof typeof MultiChannelMessageDirectionEnum];
@@ -1,25 +0,0 @@
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.MultiChannelMessageDirectionEnum = void 0;
17
- /**
18
- *
19
- * @export
20
- * @enum {string}
21
- */
22
- exports.MultiChannelMessageDirectionEnum = {
23
- Inbound: 'INBOUND',
24
- Outbound: 'OUTBOUND'
25
- };
@@ -1,23 +0,0 @@
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 MultiChannelStatusEnum: {
18
- readonly Queued: "QUEUED";
19
- readonly Sending: "SENDING";
20
- readonly Delivered: "DELIVERED";
21
- readonly Failed: "FAILED";
22
- };
23
- export type MultiChannelStatusEnum = typeof MultiChannelStatusEnum[keyof typeof MultiChannelStatusEnum];
@@ -1,27 +0,0 @@
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.MultiChannelStatusEnum = void 0;
17
- /**
18
- *
19
- * @export
20
- * @enum {string}
21
- */
22
- exports.MultiChannelStatusEnum = {
23
- Queued: 'QUEUED',
24
- Sending: 'SENDING',
25
- Delivered: 'DELIVERED',
26
- Failed: 'FAILED'
27
- };
@@ -1,15 +0,0 @@
1
- # CallbackTypeEnum
2
-
3
- Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
4
-
5
- ## Enum
6
-
7
- * `MessageReceived` (value: `'message-received'`)
8
-
9
- * `MessageSending` (value: `'message-sending'`)
10
-
11
- * `MessageDelivered` (value: `'message-delivered'`)
12
-
13
- * `MessageFailed` (value: `'message-failed'`)
14
-
15
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,22 +0,0 @@
1
- # DeferredResult
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **result** | **object** | | [optional] [default to undefined]
9
- **setOrExpired** | **boolean** | | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { DeferredResult } from 'bandwidth-sdk';
15
-
16
- const instance: DeferredResult = {
17
- result,
18
- setOrExpired,
19
- };
20
- ```
21
-
22
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,33 +0,0 @@
1
- # MessageCallback
2
-
3
- Message Callback Schema
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **time** | **string** | | [default to undefined]
10
- **type** | [**CallbackTypeEnum**](CallbackTypeEnum.md) | | [default to undefined]
11
- **to** | **string** | | [default to undefined]
12
- **description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
13
- **message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) | | [default to undefined]
14
- **errorCode** | **number** | Optional error code, applicable only when type is &#x60;message-failed&#x60;. | [optional] [default to undefined]
15
- **carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { MessageCallback } from 'bandwidth-sdk';
21
-
22
- const instance: MessageCallback = {
23
- time,
24
- type,
25
- to,
26
- description,
27
- message,
28
- errorCode,
29
- carrierName,
30
- };
31
- ```
32
-
33
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,43 +0,0 @@
1
- # MessageCallbackMessage
2
-
3
- Message payload schema within a MessageCallback
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | | [default to undefined]
10
- **owner** | **string** | | [default to undefined]
11
- **applicationId** | **string** | | [default to undefined]
12
- **time** | **string** | | [default to undefined]
13
- **segmentCount** | **number** | | [default to undefined]
14
- **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
15
- **to** | **Set&lt;string&gt;** | | [default to undefined]
16
- **from** | **string** | | [default to undefined]
17
- **text** | **string** | | [default to undefined]
18
- **tag** | **string** | | [optional] [default to undefined]
19
- **media** | **Array&lt;string&gt;** | Optional media, applicable only for mms | [optional] [default to undefined]
20
- **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
21
-
22
- ## Example
23
-
24
- ```typescript
25
- import { MessageCallbackMessage } from 'bandwidth-sdk';
26
-
27
- const instance: MessageCallbackMessage = {
28
- id,
29
- owner,
30
- applicationId,
31
- time,
32
- segmentCount,
33
- direction,
34
- to,
35
- from,
36
- text,
37
- tag,
38
- media,
39
- priority,
40
- };
41
- ```
42
-
43
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,28 +0,0 @@
1
- # MultiChannelCallbackData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **time** | **string** | The time of the callback event. | [optional] [default to undefined]
9
- **type** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
11
- **description** | **string** | | [optional] [default to undefined]
12
- **message** | [**MultiChannelMessageCallbackData**](MultiChannelMessageCallbackData.md) | | [optional] [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { MultiChannelCallbackData } from 'bandwidth-sdk';
18
-
19
- const instance: MultiChannelCallbackData = {
20
- time,
21
- type,
22
- to,
23
- description,
24
- message,
25
- };
26
- ```
27
-
28
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,34 +0,0 @@
1
- # MultiChannelMessageCallbackData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **messageId** | **string** | The ID of the message. | [optional] [default to undefined]
9
- **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined]
11
- **from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined]
12
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
13
- **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined]
14
- **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
15
- **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { MultiChannelMessageCallbackData } from 'bandwidth-sdk';
21
-
22
- const instance: MultiChannelMessageCallbackData = {
23
- messageId,
24
- status,
25
- direction,
26
- from,
27
- to,
28
- applicationId,
29
- channel,
30
- tag,
31
- };
32
- ```
33
-
34
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,36 +0,0 @@
1
- # MultiChannelMessageData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **messageId** | **string** | The ID of the message. | [optional] [default to undefined]
9
- **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **time** | **string** | The time the message was received by the Bandwidth API. | [optional] [default to undefined]
11
- **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined]
12
- **from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined]
13
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
14
- **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined]
15
- **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
16
- **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import { MultiChannelMessageData } from 'bandwidth-sdk';
22
-
23
- const instance: MultiChannelMessageData = {
24
- messageId,
25
- status,
26
- time,
27
- direction,
28
- from,
29
- to,
30
- applicationId,
31
- channel,
32
- tag,
33
- };
34
- ```
35
-
36
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,10 +0,0 @@
1
- # MultiChannelMessageDirectionEnum
2
-
3
-
4
- ## Enum
5
-
6
- * `Inbound` (value: `'INBOUND'`)
7
-
8
- * `Outbound` (value: `'OUTBOUND'`)
9
-
10
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)