bandwidth-sdk 5.1.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 (234) hide show
  1. package/.openapi-generator/FILES +30 -18
  2. package/api/multi-channel-api.ts +1 -3
  3. package/api/toll-free-verification-api.ts +80 -0
  4. package/bandwidth.yml +518 -174
  5. package/base.ts +6 -0
  6. package/configuration.ts +1 -1
  7. package/coverage/clover.xml +213 -189
  8. package/coverage/coverage-final.json +7 -8
  9. package/coverage/lcov-report/index.html +20 -20
  10. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/index.html +15 -15
  13. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +3 -9
  17. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +251 -11
  21. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  22. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  23. package/coverage/lcov-report/node-sdk/base.ts.html +20 -2
  24. package/coverage/lcov-report/node-sdk/common.ts.html +18 -18
  25. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  26. package/coverage/lcov-report/node-sdk/index.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  66. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  69. package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
  70. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/{multi-channel-status-enum.ts.html → inbound-callback-type-enum.ts.html} +10 -13
  73. package/coverage/lcov-report/node-sdk/models/index.html +16 -31
  74. package/coverage/lcov-report/node-sdk/models/index.ts.html +31 -13
  75. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  79. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  80. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  81. package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
  82. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
  83. package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
  84. package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
  85. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  86. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  87. package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
  88. package/coverage/lcov-report/node-sdk/models/{callback-type-enum.ts.html → status-callback-type-enum.ts.html} +8 -8
  89. package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
  90. package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
  91. package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
  92. package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
  93. package/coverage/lcov.info +553 -496
  94. package/dist/api/toll-free-verification-api.d.ts +37 -0
  95. package/dist/api/toll-free-verification-api.js +92 -0
  96. package/dist/base.js +6 -0
  97. package/dist/configuration.js +1 -1
  98. package/dist/models/callback.d.ts +33 -0
  99. package/dist/models/create-multi-channel-message-response.d.ts +3 -3
  100. package/dist/models/error-object.d.ts +11 -4
  101. package/dist/models/error-source.d.ts +42 -0
  102. package/dist/models/failure-webhook.d.ts +1 -1
  103. package/dist/models/inbound-callback-message.d.ts +17 -0
  104. package/dist/models/inbound-callback-type-enum.d.ts +22 -0
  105. package/dist/models/inbound-callback-type-enum.js +26 -0
  106. package/dist/models/inbound-callback.d.ts +56 -0
  107. package/dist/models/index.d.ts +15 -9
  108. package/dist/models/index.js +15 -9
  109. package/dist/models/list-message-item.d.ts +1 -1
  110. package/dist/models/message-request.d.ts +1 -1
  111. package/dist/models/message.d.ts +3 -3
  112. package/dist/models/mms-message-content-file.d.ts +24 -0
  113. package/dist/models/mms-message-content.d.ts +4 -3
  114. package/dist/models/multi-channel-error.d.ts +38 -0
  115. package/dist/models/multi-channel-message-content.d.ts +31 -0
  116. package/dist/models/{tag.d.ts → multi-channel-message-response-data-channel-list-inner.d.ts} +3 -16
  117. package/dist/models/multi-channel-message-response-data-channel-list-inner.js +15 -0
  118. package/dist/models/multi-channel-message-response-data.d.ts +69 -0
  119. package/dist/models/multi-channel-message-response-data.js +15 -0
  120. package/dist/models/priority-enum.d.ts +1 -1
  121. package/dist/models/priority-enum.js +1 -1
  122. package/dist/models/rbm-action-base.d.ts +1 -1
  123. package/dist/models/{deferred-result.d.ts → rbm-location-response.d.ts} +10 -10
  124. package/dist/models/rbm-location-response.js +15 -0
  125. package/dist/models/rbm-suggestion-response.d.ts +30 -0
  126. package/dist/models/rbm-suggestion-response.js +15 -0
  127. package/dist/models/status-callback-message.d.ts +99 -0
  128. package/dist/models/status-callback-message.js +15 -0
  129. package/dist/models/status-callback-type-enum.d.ts +23 -0
  130. package/dist/models/status-callback-type-enum.js +27 -0
  131. package/dist/models/status-callback.d.ts +68 -0
  132. package/dist/models/status-callback.js +15 -0
  133. package/docs/Callback.md +35 -0
  134. package/docs/CreateMultiChannelMessageResponse.md +1 -1
  135. package/docs/ErrorObject.md +6 -4
  136. package/docs/ErrorSource.md +27 -0
  137. package/docs/FailureWebhook.md +2 -2
  138. package/docs/InboundCallback.md +31 -0
  139. package/docs/InboundCallbackMessage.md +50 -0
  140. package/docs/InboundCallbackTypeEnum.md +13 -0
  141. package/docs/ListMessageItem.md +1 -1
  142. package/docs/Message.md +3 -3
  143. package/docs/MessageRequest.md +1 -1
  144. package/docs/MessagesApi.md +1 -0
  145. package/docs/MmsMessageContent.md +1 -1
  146. package/docs/MmsMessageContentFile.md +20 -0
  147. package/docs/MultiChannelAction.md +2 -2
  148. package/docs/MultiChannelActionCalendarEvent.md +2 -2
  149. package/docs/MultiChannelApi.md +1 -0
  150. package/docs/MultiChannelChannelListObjectContent.md +1 -1
  151. package/docs/MultiChannelError.md +24 -0
  152. package/docs/MultiChannelMessageContent.md +23 -0
  153. package/docs/MultiChannelMessageResponseData.md +35 -0
  154. package/docs/MultiChannelMessageResponseDataChannelListInner.md +28 -0
  155. package/docs/PriorityEnum.md +1 -1
  156. package/docs/RbmActionBase.md +2 -2
  157. package/docs/RbmActionDial.md +2 -2
  158. package/docs/RbmActionOpenUrl.md +2 -2
  159. package/docs/RbmActionViewLocation.md +2 -2
  160. package/docs/RbmLocationResponse.md +22 -0
  161. package/docs/RbmSuggestionResponse.md +22 -0
  162. package/docs/StatusCallback.md +35 -0
  163. package/docs/StatusCallbackMessage.md +45 -0
  164. package/docs/StatusCallbackTypeEnum.md +15 -0
  165. package/docs/TollFreeVerificationApi.md +63 -0
  166. package/models/callback.ts +36 -0
  167. package/models/create-multi-channel-message-response.ts +3 -3
  168. package/models/error-object.ts +13 -4
  169. package/models/error-source.ts +48 -0
  170. package/models/failure-webhook.ts +1 -1
  171. package/models/inbound-callback-message.ts +44 -0
  172. package/models/inbound-callback-type-enum.ts +32 -0
  173. package/models/inbound-callback.ts +68 -0
  174. package/models/index.ts +15 -9
  175. package/models/list-message-item.ts +1 -1
  176. package/models/message-request.ts +1 -1
  177. package/models/message.ts +3 -3
  178. package/models/mms-message-content-file.ts +30 -0
  179. package/models/mms-message-content.ts +6 -3
  180. package/models/multi-channel-channel-list-object-content.ts +3 -0
  181. package/models/multi-channel-error.ts +48 -0
  182. package/models/multi-channel-message-content.ts +39 -0
  183. package/models/multi-channel-message-response-data-channel-list-inner.ts +32 -0
  184. package/models/multi-channel-message-response-data.ts +83 -0
  185. package/models/priority-enum.ts +1 -1
  186. package/models/rbm-action-base.ts +1 -1
  187. package/models/{deferred-result.ts → rbm-location-response.ts} +10 -10
  188. package/models/{tag.ts → rbm-suggestion-response.ts} +8 -8
  189. package/models/status-callback-message.ts +113 -0
  190. package/models/status-callback-type-enum.ts +33 -0
  191. package/models/status-callback.ts +80 -0
  192. package/package.json +1 -1
  193. package/tests/unit/api/toll-free-verification-api.test.ts +7 -0
  194. package/tests/unit/models/inbound-callback-type-enum.test.ts +9 -0
  195. package/tests/unit/models/status-callback-type-enum.test.ts +10 -0
  196. package/coverage/lcov-report/node-sdk/models/multi-channel-message-direction-enum.ts.html +0 -178
  197. package/dist/models/callback-type-enum.d.ts +0 -23
  198. package/dist/models/callback-type-enum.js +0 -27
  199. package/dist/models/message-callback-message.d.ts +0 -92
  200. package/dist/models/message-callback.d.ts +0 -62
  201. package/dist/models/multi-channel-callback-data.d.ts +0 -50
  202. package/dist/models/multi-channel-message-callback-data.d.ts +0 -69
  203. package/dist/models/multi-channel-message-data.d.ts +0 -75
  204. package/dist/models/multi-channel-message-direction-enum.d.ts +0 -21
  205. package/dist/models/multi-channel-message-direction-enum.js +0 -25
  206. package/dist/models/multi-channel-status-enum.d.ts +0 -23
  207. package/dist/models/multi-channel-status-enum.js +0 -27
  208. package/docs/CallbackTypeEnum.md +0 -15
  209. package/docs/DeferredResult.md +0 -22
  210. package/docs/MessageCallback.md +0 -33
  211. package/docs/MessageCallbackMessage.md +0 -43
  212. package/docs/MultiChannelCallbackData.md +0 -28
  213. package/docs/MultiChannelMessageCallbackData.md +0 -34
  214. package/docs/MultiChannelMessageData.md +0 -36
  215. package/docs/MultiChannelMessageDirectionEnum.md +0 -10
  216. package/docs/MultiChannelStatusEnum.md +0 -14
  217. package/models/callback-type-enum.ts +0 -33
  218. package/models/message-callback-message.ts +0 -104
  219. package/models/message-callback.ts +0 -74
  220. package/models/multi-channel-callback-data.ts +0 -62
  221. package/models/multi-channel-message-callback-data.ts +0 -83
  222. package/models/multi-channel-message-data.ts +0 -89
  223. package/models/multi-channel-message-direction-enum.ts +0 -31
  224. package/models/multi-channel-status-enum.ts +0 -33
  225. package/tests/unit/models/callback-type-enum.test.ts +0 -10
  226. package/tests/unit/models/multi-channel-message-direction-enum.test.ts +0 -8
  227. package/tests/unit/models/multi-channel-status-enum.test.ts +0 -10
  228. /package/dist/models/{deferred-result.js → callback.js} +0 -0
  229. /package/dist/models/{message-callback-message.js → error-source.js} +0 -0
  230. /package/dist/models/{message-callback.js → inbound-callback-message.js} +0 -0
  231. /package/dist/models/{multi-channel-callback-data.js → inbound-callback.js} +0 -0
  232. /package/dist/models/{multi-channel-message-callback-data.js → mms-message-content-file.js} +0 -0
  233. /package/dist/models/{multi-channel-message-data.js → multi-channel-error.js} +0 -0
  234. /package/dist/models/{tag.js → multi-channel-message-content.js} +0 -0
@@ -61,7 +61,7 @@ export interface ListMessageItem {
61
61
  */
62
62
  'messageType'?: MessageTypeEnum;
63
63
  /**
64
- * The number of segments the message was sent as.
64
+ * The number of segments the user\'s message is broken into before sending over carrier networks.
65
65
  * @type {number}
66
66
  * @memberof ListMessageItem
67
67
  */
@@ -17,7 +17,7 @@ import type { PriorityEnum } from './priority-enum';
17
17
  */
18
18
  export interface MessageRequest {
19
19
  /**
20
- * The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard.
20
+ * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
21
21
  * @type {string}
22
22
  * @memberof MessageRequest
23
23
  */
@@ -30,7 +30,7 @@ export interface Message {
30
30
  */
31
31
  'owner'?: string;
32
32
  /**
33
- * The application ID associated with the message.
33
+ * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
34
34
  * @type {string}
35
35
  * @memberof Message
36
36
  */
@@ -42,7 +42,7 @@ export interface Message {
42
42
  */
43
43
  'time'?: string;
44
44
  /**
45
- * The number of segments the original message from the user is broken into before sending over to carrier networks.
45
+ * The number of segments the user\'s message is broken into before sending over carrier networks.
46
46
  * @type {number}
47
47
  * @memberof Message
48
48
  */
@@ -78,7 +78,7 @@ export interface Message {
78
78
  */
79
79
  'text'?: string;
80
80
  /**
81
- * The custom string set by the user.
81
+ * A custom string that will be included in callback events of the message. Max 1024 characters.
82
82
  * @type {string}
83
83
  * @memberof Message
84
84
  */
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface MmsMessageContentFile
16
+ */
17
+ export interface MmsMessageContentFile {
18
+ /**
19
+ * 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.
20
+ * @type {string}
21
+ * @memberof MmsMessageContentFile
22
+ */
23
+ 'fileUrl': string;
24
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { MmsMessageContentFile } from './mms-message-content-file';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -22,9 +23,9 @@ export interface MmsMessageContent {
22
23
  */
23
24
  'text'?: string;
24
25
  /**
25
- * A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters.
26
- * @type {Array<string>}
26
+ *
27
+ * @type {Array<MmsMessageContentFile>}
27
28
  * @memberof MmsMessageContent
28
29
  */
29
- 'media'?: Array<string>;
30
+ 'media'?: Array<MmsMessageContentFile>;
30
31
  }
@@ -0,0 +1,38 @@
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 { ErrorObject } from './error-object';
13
+ import type { Link } from './link';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface MultiChannelError
18
+ */
19
+ export interface MultiChannelError {
20
+ /**
21
+ *
22
+ * @type {Array<Link>}
23
+ * @memberof MultiChannelError
24
+ */
25
+ 'links'?: Array<Link>;
26
+ /**
27
+ *
28
+ * @type {object}
29
+ * @memberof MultiChannelError
30
+ */
31
+ 'data'?: object | null;
32
+ /**
33
+ *
34
+ * @type {Array<ErrorObject>}
35
+ * @memberof MultiChannelError
36
+ */
37
+ 'errors'?: Array<ErrorObject>;
38
+ }
@@ -0,0 +1,31 @@
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 { RbmMessageContentFile } from './rbm-message-content-file';
13
+ /**
14
+ * The structure of the content field of a multichannel message.
15
+ * @export
16
+ * @interface MultiChannelMessageContent
17
+ */
18
+ export interface MultiChannelMessageContent {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof MultiChannelMessageContent
23
+ */
24
+ 'text'?: string;
25
+ /**
26
+ *
27
+ * @type {RbmMessageContentFile}
28
+ * @memberof MultiChannelMessageContent
29
+ */
30
+ 'media'?: RbmMessageContentFile;
31
+ }
@@ -9,22 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { MultiChannelChannelListObject } from './multi-channel-channel-list-object';
12
13
  /**
13
- *
14
+ * @type MultiChannelMessageResponseDataChannelListInner
14
15
  * @export
15
- * @interface Tag
16
16
  */
17
- export interface Tag {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof Tag
22
- */
23
- 'key'?: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof Tag
28
- */
29
- 'value'?: string;
30
- }
17
+ export type MultiChannelMessageResponseDataChannelListInner = MultiChannelChannelListObject;
@@ -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,69 @@
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 { MultiChannelMessageResponseDataChannelListInner } from './multi-channel-message-response-data-channel-list-inner';
14
+ import type { PriorityEnum } from './priority-enum';
15
+ /**
16
+ * The data returned in a multichannel message response.
17
+ * @export
18
+ * @interface MultiChannelMessageResponseData
19
+ */
20
+ export interface MultiChannelMessageResponseData {
21
+ /**
22
+ * The ID of the message.
23
+ * @type {string}
24
+ * @memberof MultiChannelMessageResponseData
25
+ */
26
+ 'messageId': string;
27
+ /**
28
+ * The time the message was received by the Bandwidth API.
29
+ * @type {string}
30
+ * @memberof MultiChannelMessageResponseData
31
+ */
32
+ 'time': string;
33
+ /**
34
+ *
35
+ * @type {MessageDirectionEnum}
36
+ * @memberof MultiChannelMessageResponseData
37
+ */
38
+ 'direction': MessageDirectionEnum;
39
+ /**
40
+ * The destination phone number(s) of the message, in E164 format.
41
+ * @type {Set<string>}
42
+ * @memberof MultiChannelMessageResponseData
43
+ */
44
+ 'to': Set<string>;
45
+ /**
46
+ * 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.
47
+ * @type {Array<MultiChannelMessageResponseDataChannelListInner>}
48
+ * @memberof MultiChannelMessageResponseData
49
+ */
50
+ 'channelList': Array<MultiChannelMessageResponseDataChannelListInner>;
51
+ /**
52
+ * A custom string that will be included in callback events of the message. Max 1024 characters.
53
+ * @type {string}
54
+ * @memberof MultiChannelMessageResponseData
55
+ */
56
+ 'tag'?: string;
57
+ /**
58
+ *
59
+ * @type {PriorityEnum}
60
+ * @memberof MultiChannelMessageResponseData
61
+ */
62
+ 'priority'?: PriorityEnum;
63
+ /**
64
+ * 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.
65
+ * @type {string}
66
+ * @memberof MultiChannelMessageResponseData
67
+ */
68
+ 'expiration'?: string;
69
+ }
@@ -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 });
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The priority specified by the user.
13
+ * 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.
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.PriorityEnum = void 0;
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
  */
@@ -33,5 +33,5 @@ export interface RbmActionBase {
33
33
  * @type {string}
34
34
  * @memberof RbmActionBase
35
35
  */
36
- 'postBackData': string;
36
+ 'postbackData': string;
37
37
  }
@@ -12,19 +12,19 @@
12
12
  /**
13
13
  *
14
14
  * @export
15
- * @interface DeferredResult
15
+ * @interface RbmLocationResponse
16
16
  */
17
- export interface DeferredResult {
17
+ export interface RbmLocationResponse {
18
18
  /**
19
- *
20
- * @type {object}
21
- * @memberof DeferredResult
19
+ * The latitude of the client\'s location.
20
+ * @type {number}
21
+ * @memberof RbmLocationResponse
22
22
  */
23
- 'result'?: object;
23
+ 'latitude'?: number;
24
24
  /**
25
- *
26
- * @type {boolean}
27
- * @memberof DeferredResult
25
+ * The longitude of the client\'s location.
26
+ * @type {number}
27
+ * @memberof RbmLocationResponse
28
28
  */
29
- 'setOrExpired'?: boolean;
29
+ 'longitude'?: number;
30
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,30 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RbmSuggestionResponse
16
+ */
17
+ export interface RbmSuggestionResponse {
18
+ /**
19
+ * The text associated with the suggestion response.
20
+ * @type {string}
21
+ * @memberof RbmSuggestionResponse
22
+ */
23
+ 'text'?: string;
24
+ /**
25
+ * Base64 payload the customer receives when the reply is clicked.
26
+ * @type {string}
27
+ * @memberof RbmSuggestionResponse
28
+ */
29
+ 'postbackData'?: 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,99 @@
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 { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
14
+ import type { PriorityEnum } from './priority-enum';
15
+ /**
16
+ * Message payload schema within a callback
17
+ * @export
18
+ * @interface StatusCallbackMessage
19
+ */
20
+ export interface StatusCallbackMessage {
21
+ /**
22
+ * A unique identifier of the message.
23
+ * @type {string}
24
+ * @memberof StatusCallbackMessage
25
+ */
26
+ 'id': string;
27
+ /**
28
+ * The Bandwidth phone number or alphanumeric identifier associated with the message.
29
+ * @type {string}
30
+ * @memberof StatusCallbackMessage
31
+ */
32
+ 'owner': string;
33
+ /**
34
+ * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
35
+ * @type {string}
36
+ * @memberof StatusCallbackMessage
37
+ */
38
+ 'applicationId': string;
39
+ /**
40
+ *
41
+ * @type {string}
42
+ * @memberof StatusCallbackMessage
43
+ */
44
+ 'time': string;
45
+ /**
46
+ * The number of segments the user\'s message is broken into before sending over carrier networks.
47
+ * @type {number}
48
+ * @memberof StatusCallbackMessage
49
+ */
50
+ 'segmentCount': number;
51
+ /**
52
+ *
53
+ * @type {MessageDirectionEnum}
54
+ * @memberof StatusCallbackMessage
55
+ */
56
+ 'direction': MessageDirectionEnum;
57
+ /**
58
+ * The phone number recipients of the message.
59
+ * @type {Set<string>}
60
+ * @memberof StatusCallbackMessage
61
+ */
62
+ 'to': Set<string>;
63
+ /**
64
+ * The Bandwidth phone number or alphanumeric identifier the message was sent from.
65
+ * @type {string}
66
+ * @memberof StatusCallbackMessage
67
+ */
68
+ 'from': string;
69
+ /**
70
+ *
71
+ * @type {string}
72
+ * @memberof StatusCallbackMessage
73
+ */
74
+ 'text'?: string;
75
+ /**
76
+ * A custom string that will be included in callback events of the message. Max 1024 characters.
77
+ * @type {string}
78
+ * @memberof StatusCallbackMessage
79
+ */
80
+ 'tag'?: string;
81
+ /**
82
+ * Optional media, not applicable for sms
83
+ * @type {Array<string>}
84
+ * @memberof StatusCallbackMessage
85
+ */
86
+ 'media'?: Array<string>;
87
+ /**
88
+ *
89
+ * @type {PriorityEnum}
90
+ * @memberof StatusCallbackMessage
91
+ */
92
+ 'priority'?: PriorityEnum;
93
+ /**
94
+ *
95
+ * @type {MultiChannelMessageChannelEnum}
96
+ * @memberof StatusCallbackMessage
97
+ */
98
+ 'channel'?: MultiChannelMessageChannelEnum;
99
+ }
@@ -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,23 @@
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
+ * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const StatusCallbackTypeEnum: {
18
+ readonly MessageSending: "message-sending";
19
+ readonly MessageDelivered: "message-delivered";
20
+ readonly MessageFailed: "message-failed";
21
+ readonly MessageRead: "message-read";
22
+ };
23
+ export type StatusCallbackTypeEnum = typeof StatusCallbackTypeEnum[keyof typeof StatusCallbackTypeEnum];
@@ -0,0 +1,27 @@
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.StatusCallbackTypeEnum = void 0;
17
+ /**
18
+ * The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-delivered` indicates that the message was successfully sent. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.StatusCallbackTypeEnum = {
23
+ MessageSending: 'message-sending',
24
+ MessageDelivered: 'message-delivered',
25
+ MessageFailed: 'message-failed',
26
+ MessageRead: 'message-read'
27
+ };
@@ -0,0 +1,68 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { StatusCallbackMessage } from './status-callback-message';
13
+ import type { StatusCallbackTypeEnum } from './status-callback-type-enum';
14
+ /**
15
+ * Represents a status callback for an outbound MT SMS or MMS or RBM message.
16
+ * @export
17
+ * @interface StatusCallback
18
+ */
19
+ export interface StatusCallback {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof StatusCallback
24
+ */
25
+ 'time': string;
26
+ /**
27
+ * Represents the time at which the message was read, for `message-read` callbacks.
28
+ * @type {string}
29
+ * @memberof StatusCallback
30
+ */
31
+ 'eventTime'?: string;
32
+ /**
33
+ *
34
+ * @type {StatusCallbackTypeEnum}
35
+ * @memberof StatusCallback
36
+ */
37
+ 'type': StatusCallbackTypeEnum;
38
+ /**
39
+ * The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number.
40
+ * @type {string}
41
+ * @memberof StatusCallback
42
+ */
43
+ 'to': string;
44
+ /**
45
+ * A detailed description of the event described by the callback.
46
+ * @type {string}
47
+ * @memberof StatusCallback
48
+ */
49
+ 'description': string;
50
+ /**
51
+ *
52
+ * @type {StatusCallbackMessage}
53
+ * @memberof StatusCallback
54
+ */
55
+ 'message': StatusCallbackMessage;
56
+ /**
57
+ * Optional error code, applicable only when type is `message-failed`.
58
+ * @type {number}
59
+ * @memberof StatusCallback
60
+ */
61
+ 'errorCode'?: number;
62
+ /**
63
+ * 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.
64
+ * @type {string}
65
+ * @memberof StatusCallback
66
+ */
67
+ 'carrierName'?: string;
68
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Bandwidth
6
+ * Bandwidth\'s Communication APIs
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: letstalk@bandwidth.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });