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
@@ -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
+ * Specifies relevant sources of the error, if any.
19
+ * @export
20
+ * @interface ErrorSource
21
+ */
22
+ export interface ErrorSource {
23
+ /**
24
+ * The relevant URI query parameter causing the error
25
+ * @type {string}
26
+ * @memberof ErrorSource
27
+ */
28
+ 'parameter'?: string;
29
+ /**
30
+ * The request body field that led to the error
31
+ * @type {string}
32
+ * @memberof ErrorSource
33
+ */
34
+ 'field'?: string;
35
+ /**
36
+ * The header field that contributed to the error
37
+ * @type {string}
38
+ * @memberof ErrorSource
39
+ */
40
+ 'header'?: string;
41
+ /**
42
+ * A resource ID or path linked to the error
43
+ * @type {string}
44
+ * @memberof ErrorSource
45
+ */
46
+ 'reference'?: string;
47
+ }
48
+
@@ -43,7 +43,7 @@ export interface FailureWebhook {
43
43
  * @type {string}
44
44
  * @memberof FailureWebhook
45
45
  */
46
- 'errorDescription'?: string;
46
+ 'errorMessage'?: string;
47
47
  /**
48
48
  * Details of the errors that were encountered when processing the request.
49
49
  * @type {Array<string>}
@@ -0,0 +1,44 @@
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 { MessageDirectionEnum } from './message-direction-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import type { MultiChannelMessageContent } from './multi-channel-message-content';
25
+ // May contain unused imports in some cases
26
+ // @ts-ignore
27
+ import type { PriorityEnum } from './priority-enum';
28
+ // May contain unused imports in some cases
29
+ // @ts-ignore
30
+ import type { RbmLocationResponse } from './rbm-location-response';
31
+ // May contain unused imports in some cases
32
+ // @ts-ignore
33
+ import type { RbmSuggestionResponse } from './rbm-suggestion-response';
34
+ // May contain unused imports in some cases
35
+ // @ts-ignore
36
+ import type { StatusCallbackMessage } from './status-callback-message';
37
+
38
+ /**
39
+ * @type InboundCallbackMessage
40
+ * @export
41
+ */
42
+ export type InboundCallbackMessage = StatusCallbackMessage;
43
+
44
+
@@ -0,0 +1,32 @@
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
+ * The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const InboundCallbackTypeEnum = {
24
+ MessageReceived: 'message-received',
25
+ RequestLocationResponse: 'request-location-response',
26
+ SuggestionResponse: 'suggestion-response'
27
+ } as const;
28
+
29
+ export type InboundCallbackTypeEnum = typeof InboundCallbackTypeEnum[keyof typeof InboundCallbackTypeEnum];
30
+
31
+
32
+
@@ -0,0 +1,68 @@
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 { InboundCallbackMessage } from './inbound-callback-message';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { InboundCallbackTypeEnum } from './inbound-callback-type-enum';
22
+
23
+ /**
24
+ * Represents an inbound callback.
25
+ * @export
26
+ * @interface InboundCallback
27
+ */
28
+ export interface InboundCallback {
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof InboundCallback
33
+ */
34
+ 'time': string;
35
+ /**
36
+ *
37
+ * @type {InboundCallbackTypeEnum}
38
+ * @memberof InboundCallback
39
+ */
40
+ 'type': InboundCallbackTypeEnum;
41
+ /**
42
+ * The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message.
43
+ * @type {string}
44
+ * @memberof InboundCallback
45
+ */
46
+ 'to': string;
47
+ /**
48
+ * A detailed description of the event described by the callback.
49
+ * @type {string}
50
+ * @memberof InboundCallback
51
+ */
52
+ 'description': string;
53
+ /**
54
+ *
55
+ * @type {InboundCallbackMessage}
56
+ * @memberof InboundCallback
57
+ */
58
+ 'message': InboundCallbackMessage;
59
+ /**
60
+ * 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. This field is present only when this account feature has been enabled.
61
+ * @type {string}
62
+ * @memberof InboundCallback
63
+ */
64
+ 'carrierName'?: string;
65
+ }
66
+
67
+
68
+
package/models/index.ts CHANGED
@@ -2,6 +2,7 @@ export * from './account-statistics';
2
2
  export * from './additional-denial-reason';
3
3
  export * from './address';
4
4
  export * from './answer-callback';
5
+ export * from './blocked-webhook';
5
6
  export * from './bridge-complete-callback';
6
7
  export * from './bridge-target-complete-callback';
7
8
  export * from './call-direction-enum';
@@ -13,8 +14,8 @@ export * from './call-transcription-detected-language-enum';
13
14
  export * from './call-transcription-metadata';
14
15
  export * from './call-transcription-response';
15
16
  export * from './call-transcription-track-enum';
17
+ export * from './callback';
16
18
  export * from './callback-method-enum';
17
- export * from './callback-type-enum';
18
19
  export * from './card-width-enum';
19
20
  export * from './code-request';
20
21
  export * from './conference';
@@ -33,15 +34,18 @@ export * from './create-call-response';
33
34
  export * from './create-lookup-response';
34
35
  export * from './create-message-request-error';
35
36
  export * from './create-multi-channel-message-response';
36
- export * from './deferred-result';
37
37
  export * from './disconnect-callback';
38
38
  export * from './diversion';
39
39
  export * from './dtmf-callback';
40
40
  export * from './error-object';
41
+ export * from './error-source';
41
42
  export * from './failure-webhook';
42
43
  export * from './field-error';
43
44
  export * from './file-format-enum';
44
45
  export * from './gather-callback';
46
+ export * from './inbound-callback';
47
+ export * from './inbound-callback-message';
48
+ export * from './inbound-callback-type-enum';
45
49
  export * from './initiate-callback';
46
50
  export * from './link';
47
51
  export * from './links-object';
@@ -57,8 +61,6 @@ export * from './machine-detection-mode-enum';
57
61
  export * from './machine-detection-result';
58
62
  export * from './media';
59
63
  export * from './message';
60
- export * from './message-callback';
61
- export * from './message-callback-message';
62
64
  export * from './message-direction-enum';
63
65
  export * from './message-request';
64
66
  export * from './message-status-enum';
@@ -70,18 +72,18 @@ export * from './mfa-forbidden-request-error';
70
72
  export * from './mfa-request-error';
71
73
  export * from './mfa-unauthorized-request-error';
72
74
  export * from './mms-message-content';
75
+ export * from './mms-message-content-file';
73
76
  export * from './model-error';
74
77
  export * from './multi-channel-action';
75
78
  export * from './multi-channel-action-calendar-event';
76
- export * from './multi-channel-callback-data';
77
79
  export * from './multi-channel-channel-list-object';
78
80
  export * from './multi-channel-channel-list-object-content';
79
- export * from './multi-channel-message-callback-data';
81
+ export * from './multi-channel-error';
80
82
  export * from './multi-channel-message-channel-enum';
81
- export * from './multi-channel-message-data';
82
- export * from './multi-channel-message-direction-enum';
83
+ export * from './multi-channel-message-content';
83
84
  export * from './multi-channel-message-request';
84
- export * from './multi-channel-status-enum';
85
+ export * from './multi-channel-message-response-data';
86
+ export * from './multi-channel-message-response-data-channel-list-inner';
85
87
  export * from './opt-in-workflow';
86
88
  export * from './page-info';
87
89
  export * from './priority-enum';
@@ -92,6 +94,7 @@ export * from './rbm-action-type-enum';
92
94
  export * from './rbm-action-view-location';
93
95
  export * from './rbm-card-content';
94
96
  export * from './rbm-card-content-media';
97
+ export * from './rbm-location-response';
95
98
  export * from './rbm-media-height-enum';
96
99
  export * from './rbm-message-carousel-card';
97
100
  export * from './rbm-message-content-file';
@@ -99,6 +102,7 @@ export * from './rbm-message-content-rich-card';
99
102
  export * from './rbm-message-content-text';
100
103
  export * from './rbm-message-media';
101
104
  export * from './rbm-standalone-card';
105
+ export * from './rbm-suggestion-response';
102
106
  export * from './recording-available-callback';
103
107
  export * from './recording-complete-callback';
104
108
  export * from './recording-state-enum';
@@ -108,6 +112,9 @@ export * from './redirect-callback';
108
112
  export * from './redirect-method-enum';
109
113
  export * from './sms-message-content';
110
114
  export * from './standalone-card-orientation-enum';
115
+ export * from './status-callback';
116
+ export * from './status-callback-message';
117
+ export * from './status-callback-type-enum';
111
118
  export * from './stir-shaken';
112
119
  export * from './telephone-number';
113
120
  export * from './tfv-basic-authentication';
@@ -72,7 +72,7 @@ export interface ListMessageItem {
72
72
  */
73
73
  'messageType'?: MessageTypeEnum;
74
74
  /**
75
- * The number of segments the message was sent as.
75
+ * The number of segments the user\'s message is broken into before sending over carrier networks.
76
76
  * @type {number}
77
77
  * @memberof ListMessageItem
78
78
  */
@@ -24,7 +24,7 @@ import type { PriorityEnum } from './priority-enum';
24
24
  */
25
25
  export interface MessageRequest {
26
26
  /**
27
- * The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard.
27
+ * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
28
28
  * @type {string}
29
29
  * @memberof MessageRequest
30
30
  */
package/models/message.ts CHANGED
@@ -39,7 +39,7 @@ export interface Message {
39
39
  */
40
40
  'owner'?: string;
41
41
  /**
42
- * The application ID associated with the message.
42
+ * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
43
43
  * @type {string}
44
44
  * @memberof Message
45
45
  */
@@ -51,7 +51,7 @@ export interface Message {
51
51
  */
52
52
  'time'?: string;
53
53
  /**
54
- * The number of segments the original message from the user is broken into before sending over to carrier networks.
54
+ * The number of segments the user\'s message is broken into before sending over carrier networks.
55
55
  * @type {number}
56
56
  * @memberof Message
57
57
  */
@@ -87,7 +87,7 @@ export interface Message {
87
87
  */
88
88
  'text'?: string;
89
89
  /**
90
- * The custom string set by the user.
90
+ * A custom string that will be included in callback events of the message. Max 1024 characters.
91
91
  * @type {string}
92
92
  * @memberof Message
93
93
  */
@@ -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 MmsMessageContentFile
21
+ */
22
+ export interface MmsMessageContentFile {
23
+ /**
24
+ * The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details.
25
+ * @type {string}
26
+ * @memberof MmsMessageContentFile
27
+ */
28
+ 'fileUrl': string;
29
+ }
30
+
@@ -13,6 +13,9 @@
13
13
  */
14
14
 
15
15
 
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { MmsMessageContentFile } from './mms-message-content-file';
16
19
 
17
20
  /**
18
21
  *
@@ -27,10 +30,10 @@ export interface MmsMessageContent {
27
30
  */
28
31
  'text'?: string;
29
32
  /**
30
- * A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters.
31
- * @type {Array<string>}
33
+ *
34
+ * @type {Array<MmsMessageContentFile>}
32
35
  * @memberof MmsMessageContent
33
36
  */
34
- 'media'?: Array<string>;
37
+ 'media'?: Array<MmsMessageContentFile>;
35
38
  }
36
39
 
@@ -21,6 +21,9 @@ import type { CardWidthEnum } from './card-width-enum';
21
21
  import type { MmsMessageContent } from './mms-message-content';
22
22
  // May contain unused imports in some cases
23
23
  // @ts-ignore
24
+ import type { MmsMessageContentFile } from './mms-message-content-file';
25
+ // May contain unused imports in some cases
26
+ // @ts-ignore
24
27
  import type { MultiChannelAction } from './multi-channel-action';
25
28
  // May contain unused imports in some cases
26
29
  // @ts-ignore
@@ -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
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { ErrorObject } from './error-object';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { Link } from './link';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface MultiChannelError
27
+ */
28
+ export interface MultiChannelError {
29
+ /**
30
+ *
31
+ * @type {Array<Link>}
32
+ * @memberof MultiChannelError
33
+ */
34
+ 'links'?: Array<Link>;
35
+ /**
36
+ *
37
+ * @type {object}
38
+ * @memberof MultiChannelError
39
+ */
40
+ 'data'?: object | null;
41
+ /**
42
+ *
43
+ * @type {Array<ErrorObject>}
44
+ * @memberof MultiChannelError
45
+ */
46
+ 'errors'?: Array<ErrorObject>;
47
+ }
48
+
@@ -0,0 +1,39 @@
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 { RbmMessageContentFile } from './rbm-message-content-file';
19
+
20
+ /**
21
+ * The structure of the content field of a multichannel message.
22
+ * @export
23
+ * @interface MultiChannelMessageContent
24
+ */
25
+ export interface MultiChannelMessageContent {
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof MultiChannelMessageContent
30
+ */
31
+ 'text'?: string;
32
+ /**
33
+ *
34
+ * @type {RbmMessageContentFile}
35
+ * @memberof MultiChannelMessageContent
36
+ */
37
+ 'media'?: RbmMessageContentFile;
38
+ }
39
+
@@ -0,0 +1,32 @@
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 { MultiChannelChannelListObject } from './multi-channel-channel-list-object';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { MultiChannelChannelListObjectContent } from './multi-channel-channel-list-object-content';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
25
+
26
+ /**
27
+ * @type MultiChannelMessageResponseDataChannelListInner
28
+ * @export
29
+ */
30
+ export type MultiChannelMessageResponseDataChannelListInner = MultiChannelChannelListObject;
31
+
32
+
@@ -0,0 +1,83 @@
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 { MessageDirectionEnum } from './message-direction-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { MultiChannelMessageResponseDataChannelListInner } from './multi-channel-message-response-data-channel-list-inner';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import type { PriorityEnum } from './priority-enum';
25
+
26
+ /**
27
+ * The data returned in a multichannel message response.
28
+ * @export
29
+ * @interface MultiChannelMessageResponseData
30
+ */
31
+ export interface MultiChannelMessageResponseData {
32
+ /**
33
+ * The ID of the message.
34
+ * @type {string}
35
+ * @memberof MultiChannelMessageResponseData
36
+ */
37
+ 'messageId': string;
38
+ /**
39
+ * The time the message was received by the Bandwidth API.
40
+ * @type {string}
41
+ * @memberof MultiChannelMessageResponseData
42
+ */
43
+ 'time': string;
44
+ /**
45
+ *
46
+ * @type {MessageDirectionEnum}
47
+ * @memberof MultiChannelMessageResponseData
48
+ */
49
+ 'direction': MessageDirectionEnum;
50
+ /**
51
+ * The destination phone number(s) of the message, in E164 format.
52
+ * @type {Set<string>}
53
+ * @memberof MultiChannelMessageResponseData
54
+ */
55
+ 'to': Set<string>;
56
+ /**
57
+ * A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored.
58
+ * @type {Array<MultiChannelMessageResponseDataChannelListInner>}
59
+ * @memberof MultiChannelMessageResponseData
60
+ */
61
+ 'channelList': Array<MultiChannelMessageResponseDataChannelListInner>;
62
+ /**
63
+ * A custom string that will be included in callback events of the message. Max 1024 characters.
64
+ * @type {string}
65
+ * @memberof MultiChannelMessageResponseData
66
+ */
67
+ 'tag'?: string;
68
+ /**
69
+ *
70
+ * @type {PriorityEnum}
71
+ * @memberof MultiChannelMessageResponseData
72
+ */
73
+ 'priority'?: PriorityEnum;
74
+ /**
75
+ * A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.
76
+ * @type {string}
77
+ * @memberof MultiChannelMessageResponseData
78
+ */
79
+ 'expiration'?: string;
80
+ }
81
+
82
+
83
+
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * The priority specified by the user.
18
+ * Specifies the message\'s sending priority with respect to other messages in your account. For best results and optimal throughput, reserve the \'high\' priority setting for critical messages only.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -40,7 +40,7 @@ export interface RbmActionBase {
40
40
  * @type {string}
41
41
  * @memberof RbmActionBase
42
42
  */
43
- 'postBackData': string;
43
+ 'postbackData': string;
44
44
  }
45
45
 
46
46
 
@@ -17,20 +17,20 @@
17
17
  /**
18
18
  *
19
19
  * @export
20
- * @interface DeferredResult
20
+ * @interface RbmLocationResponse
21
21
  */
22
- export interface DeferredResult {
22
+ export interface RbmLocationResponse {
23
23
  /**
24
- *
25
- * @type {object}
26
- * @memberof DeferredResult
24
+ * The latitude of the client\'s location.
25
+ * @type {number}
26
+ * @memberof RbmLocationResponse
27
27
  */
28
- 'result'?: object;
28
+ 'latitude'?: number;
29
29
  /**
30
- *
31
- * @type {boolean}
32
- * @memberof DeferredResult
30
+ * The longitude of the client\'s location.
31
+ * @type {number}
32
+ * @memberof RbmLocationResponse
33
33
  */
34
- 'setOrExpired'?: boolean;
34
+ 'longitude'?: number;
35
35
  }
36
36