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,23 @@
1
+ # MultiChannelMessageContent
2
+
3
+ The structure of the content field of a multichannel message.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **text** | **string** | | [optional] [default to undefined]
10
+ **media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { MultiChannelMessageContent } from 'bandwidth-sdk';
16
+
17
+ const instance: MultiChannelMessageContent = {
18
+ text,
19
+ media,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,35 @@
1
+ # MultiChannelMessageResponseData
2
+
3
+ The data returned in a multichannel message response.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **messageId** | **string** | The ID of the message. | [default to undefined]
10
+ **time** | **string** | The time the message was received by the Bandwidth API. | [default to undefined]
11
+ **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
12
+ **to** | **Set<string>** | The destination phone number(s) of the message, in E164 format. | [default to undefined]
13
+ **channelList** | [**Array<MultiChannelMessageResponseDataChannelListInner>**](MultiChannelMessageResponseDataChannelListInner.md) | 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. | [default to undefined]
14
+ **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
15
+ **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
16
+ **expiration** | **string** | 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. | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { MultiChannelMessageResponseData } from 'bandwidth-sdk';
22
+
23
+ const instance: MultiChannelMessageResponseData = {
24
+ messageId,
25
+ time,
26
+ direction,
27
+ to,
28
+ channelList,
29
+ tag,
30
+ priority,
31
+ expiration,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # MultiChannelMessageResponseDataChannelListInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
9
+ **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
10
+ **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
11
+ **content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined]
12
+ **owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { MultiChannelMessageResponseDataChannelListInner } from 'bandwidth-sdk';
18
+
19
+ const instance: MultiChannelMessageResponseDataChannelListInner = {
20
+ from,
21
+ applicationId,
22
+ channel,
23
+ content,
24
+ owner,
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,6 +1,6 @@
1
1
  # PriorityEnum
2
2
 
3
- The priority specified by the user.
3
+ 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.
4
4
 
5
5
  ## Enum
6
6
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -17,7 +17,7 @@ import { RbmActionBase } from 'bandwidth-sdk';
17
17
  const instance: RbmActionBase = {
18
18
  type,
19
19
  text,
20
- postBackData,
20
+ postbackData,
21
21
  };
22
22
  ```
23
23
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
11
11
  **phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined]
12
12
 
13
13
  ## Example
@@ -18,7 +18,7 @@ import { RbmActionDial } from 'bandwidth-sdk';
18
18
  const instance: RbmActionDial = {
19
19
  type,
20
20
  text,
21
- postBackData,
21
+ postbackData,
22
22
  phoneNumber,
23
23
  };
24
24
  ```
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
11
11
  **url** | **string** | The URL to open in browser. | [default to undefined]
12
12
 
13
13
  ## Example
@@ -18,7 +18,7 @@ import { RbmActionOpenUrl } from 'bandwidth-sdk';
18
18
  const instance: RbmActionOpenUrl = {
19
19
  type,
20
20
  text,
21
- postBackData,
21
+ postbackData,
22
22
  url,
23
23
  };
24
24
  ```
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
9
9
  **text** | **string** | Displayed text for user to click | [default to undefined]
10
- **postBackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
10
+ **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
11
11
  **latitude** | **number** | The latitude of the location. | [default to undefined]
12
12
  **longitude** | **number** | The longitude of the location. | [default to undefined]
13
13
  **label** | **string** | The label of the location. | [optional] [default to undefined]
@@ -20,7 +20,7 @@ import { RbmActionViewLocation } from 'bandwidth-sdk';
20
20
  const instance: RbmActionViewLocation = {
21
21
  type,
22
22
  text,
23
- postBackData,
23
+ postbackData,
24
24
  latitude,
25
25
  longitude,
26
26
  label,
@@ -0,0 +1,22 @@
1
+ # RbmLocationResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **latitude** | **number** | The latitude of the client\'s location. | [optional] [default to undefined]
9
+ **longitude** | **number** | The longitude of the client\'s location. | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { RbmLocationResponse } from 'bandwidth-sdk';
15
+
16
+ const instance: RbmLocationResponse = {
17
+ latitude,
18
+ longitude,
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)
@@ -0,0 +1,22 @@
1
+ # RbmSuggestionResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **text** | **string** | The text associated with the suggestion response. | [optional] [default to undefined]
9
+ **postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { RbmSuggestionResponse } from 'bandwidth-sdk';
15
+
16
+ const instance: RbmSuggestionResponse = {
17
+ text,
18
+ postbackData,
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)
@@ -0,0 +1,35 @@
1
+ # StatusCallback
2
+
3
+ Represents a status callback for an outbound MT SMS or MMS or RBM message.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **time** | **string** | | [default to undefined]
10
+ **eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined]
11
+ **type** | [**StatusCallbackTypeEnum**](StatusCallbackTypeEnum.md) | | [default to undefined]
12
+ **to** | **string** | The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number. | [default to undefined]
13
+ **description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
14
+ **message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | [default to undefined]
15
+ **errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined]
16
+ **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. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { StatusCallback } from 'bandwidth-sdk';
22
+
23
+ const instance: StatusCallback = {
24
+ time,
25
+ eventTime,
26
+ type,
27
+ to,
28
+ description,
29
+ message,
30
+ errorCode,
31
+ carrierName,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,45 @@
1
+ # StatusCallbackMessage
2
+
3
+ Message payload schema within a callback
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | A unique identifier of the message. | [default to undefined]
10
+ **owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined]
11
+ **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
12
+ **time** | **string** | | [default to undefined]
13
+ **segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined]
14
+ **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
15
+ **to** | **Set<string>** | The phone number recipients of the message. | [default to undefined]
16
+ **from** | **string** | The Bandwidth phone number or alphanumeric identifier the message was sent from. | [default to undefined]
17
+ **text** | **string** | | [optional] [default to undefined]
18
+ **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
19
+ **media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined]
20
+ **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
21
+ **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { StatusCallbackMessage } from 'bandwidth-sdk';
27
+
28
+ const instance: StatusCallbackMessage = {
29
+ id,
30
+ owner,
31
+ applicationId,
32
+ time,
33
+ segmentCount,
34
+ direction,
35
+ to,
36
+ from,
37
+ text,
38
+ tag,
39
+ media,
40
+ priority,
41
+ channel,
42
+ };
43
+ ```
44
+
45
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,15 @@
1
+ # StatusCallbackTypeEnum
2
+
3
+ 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.
4
+
5
+ ## Enum
6
+
7
+ * `MessageSending` (value: `'message-sending'`)
8
+
9
+ * `MessageDelivered` (value: `'message-delivered'`)
10
+
11
+ * `MessageFailed` (value: `'message-failed'`)
12
+
13
+ * `MessageRead` (value: `'message-read'`)
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)
package/docs/TfvStatus.md CHANGED
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
13
13
  **createdDateTime** | **string** | Date and time the verification request was created. | [optional] [default to undefined]
14
14
  **modifiedDateTime** | **string** | Date and time the verification request was last modified. | [optional] [default to undefined]
15
15
  **submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] [default to undefined]
16
- **blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
17
- **blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
16
+ **blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
17
+ **blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
18
18
 
19
19
  ## Example
20
20
 
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
14
14
  **optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional] [default to undefined]
15
15
  **additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
16
16
  **isvReseller** | **string** | ISV name. | [optional] [default to undefined]
17
- **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
18
- **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
19
- **businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
17
+ **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
18
+ **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
19
+ **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
20
20
 
21
21
  ## Example
22
22
 
@@ -35,7 +35,7 @@ const instance: TfvSubmissionInfo = {
35
35
  isvReseller,
36
36
  privacyPolicyUrl,
37
37
  termsAndConditionsUrl,
38
- businessDBA,
38
+ businessDba,
39
39
  };
40
40
  ```
41
41
 
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createWebhookSubscription**](#createwebhooksubscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription|
8
+ |[**deleteVerificationRequest**](#deleteverificationrequest) | **DELETE** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Delete a Toll-Free Verification Submission|
8
9
  |[**deleteWebhookSubscription**](#deletewebhooksubscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription|
9
10
  |[**getTollFreeVerificationStatus**](#gettollfreeverificationstatus) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status|
10
11
  |[**listTollFreeUseCases**](#listtollfreeusecases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases|
@@ -76,6 +77,68 @@ const { status, data } = await apiInstance.createWebhookSubscription(
76
77
 
77
78
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
78
79
 
80
+ # **deleteVerificationRequest**
81
+ > deleteVerificationRequest()
82
+
83
+ Delete a toll-free verification submission for a toll-free number.
84
+
85
+ ### Example
86
+
87
+ ```typescript
88
+ import {
89
+ TollFreeVerificationApi,
90
+ Configuration
91
+ } from 'bandwidth-sdk';
92
+
93
+ const configuration = new Configuration();
94
+ const apiInstance = new TollFreeVerificationApi(configuration);
95
+
96
+ let accountId: string; //Your Bandwidth Account ID. (default to undefined)
97
+ let phoneNumber: string; //Valid Toll-Free telephone number in E.164 format. (default to undefined)
98
+
99
+ const { status, data } = await apiInstance.deleteVerificationRequest(
100
+ accountId,
101
+ phoneNumber
102
+ );
103
+ ```
104
+
105
+ ### Parameters
106
+
107
+ |Name | Type | Description | Notes|
108
+ |------------- | ------------- | ------------- | -------------|
109
+ | **accountId** | [**string**] | Your Bandwidth Account ID. | defaults to undefined|
110
+ | **phoneNumber** | [**string**] | Valid Toll-Free telephone number in E.164 format. | defaults to undefined|
111
+
112
+
113
+ ### Return type
114
+
115
+ void (empty response body)
116
+
117
+ ### Authorization
118
+
119
+ [Basic](../README.md#Basic)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: Not defined
124
+ - **Accept**: application/json
125
+
126
+
127
+ ### HTTP response details
128
+ | Status code | Description | Response headers |
129
+ |-------------|-------------|------------------|
130
+ |**204** | No Content | - |
131
+ |**400** | Bad Request | - |
132
+ |**401** | Unauthorized | - |
133
+ |**403** | Forbidden | - |
134
+ |**404** | Cannot find the requested resource. | - |
135
+ |**405** | Method Not Allowed | - |
136
+ |**429** | Too Many Requests | - |
137
+ |**500** | Internal Server Error | - |
138
+ |**503** | Service Unavailable | - |
139
+
140
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
141
+
79
142
  # **deleteWebhookSubscription**
80
143
  > deleteWebhookSubscription()
81
144
 
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
13
13
  **phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
14
14
  **resubmitAllowed** | **boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] [default to undefined]
15
15
  **status** | **string** | | [optional] [default to 'UNVERIFIED']
16
- **blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
17
- **blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] [default to undefined]
16
+ **blocked** | **boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
17
+ **blockedReason** | **string** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] [default to undefined]
18
18
 
19
19
  ## Example
20
20
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
15
15
  **optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined]
16
16
  **additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
17
17
  **isvReseller** | **string** | ISV name. | [optional] [default to undefined]
18
- **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
19
- **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
20
- **businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
18
+ **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
19
+ **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
20
+ **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
21
21
 
22
22
  ## Example
23
23
 
@@ -37,7 +37,7 @@ const instance: VerificationRequest = {
37
37
  isvReseller,
38
38
  privacyPolicyUrl,
39
39
  termsAndConditionsUrl,
40
- businessDBA,
40
+ businessDba,
41
41
  };
42
42
  ```
43
43
 
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
14
14
  **optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [default to undefined]
15
15
  **additionalInformation** | **string** | Any additional information. | [optional] [default to undefined]
16
16
  **isvReseller** | **string** | ISV name. | [optional] [default to undefined]
17
- **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
18
- **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] [default to undefined]
19
- **businessDBA** | **string** | The company \'Doing Business As\'. (Not Available Until 5/28/2025) | [optional] [default to undefined]
17
+ **privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
18
+ **termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
19
+ **businessDba** | **string** | The company \'Doing Business As\'. | [optional] [default to undefined]
20
20
 
21
21
  ## Example
22
22
 
@@ -35,7 +35,7 @@ const instance: VerificationUpdateRequest = {
35
35
  isvReseller,
36
36
  privacyPolicyUrl,
37
37
  termsAndConditionsUrl,
38
- businessDBA,
38
+ businessDba,
39
39
  };
40
40
  ```
41
41
 
@@ -0,0 +1,65 @@
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 { TfvCallbackStatusEnum } from './tfv-callback-status-enum';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface BlockedWebhook
24
+ */
25
+ export interface BlockedWebhook {
26
+ /**
27
+ * User\'s account ID.
28
+ * @type {string}
29
+ * @memberof BlockedWebhook
30
+ */
31
+ 'accountId'?: string;
32
+ /**
33
+ * Toll-free telephone number in E.164 format.
34
+ * @type {string}
35
+ * @memberof BlockedWebhook
36
+ */
37
+ 'phoneNumber'?: string;
38
+ /**
39
+ *
40
+ * @type {TfvCallbackStatusEnum}
41
+ * @memberof BlockedWebhook
42
+ */
43
+ 'status'?: TfvCallbackStatusEnum;
44
+ /**
45
+ * Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
46
+ * @type {string}
47
+ * @memberof BlockedWebhook
48
+ */
49
+ 'internalTicketNumber'?: string;
50
+ /**
51
+ * Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
52
+ * @type {boolean}
53
+ * @memberof BlockedWebhook
54
+ */
55
+ 'blocked'?: boolean;
56
+ /**
57
+ * The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
58
+ * @type {string}
59
+ * @memberof BlockedWebhook
60
+ */
61
+ 'blockedReason'?: string;
62
+ }
63
+
64
+
65
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { InboundCallback } from './inbound-callback';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { InboundCallbackMessage } from './inbound-callback-message';
22
+ // May contain unused imports in some cases
23
+ // @ts-ignore
24
+ import type { InboundCallbackTypeEnum } from './inbound-callback-type-enum';
25
+ // May contain unused imports in some cases
26
+ // @ts-ignore
27
+ import type { StatusCallback } from './status-callback';
28
+
29
+ /**
30
+ * @type Callback
31
+ * Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
32
+ * @export
33
+ */
34
+ export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sent' } & StatusCallback | { type: 'request-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
35
+
36
+
@@ -21,7 +21,7 @@ import type { ErrorObject } from './error-object';
21
21
  import type { Link } from './link';
22
22
  // May contain unused imports in some cases
23
23
  // @ts-ignore
24
- import type { MultiChannelMessageData } from './multi-channel-message-data';
24
+ import type { MultiChannelMessageResponseData } from './multi-channel-message-response-data';
25
25
 
26
26
  /**
27
27
  *
@@ -37,10 +37,10 @@ export interface CreateMultiChannelMessageResponse {
37
37
  'links'?: Array<Link>;
38
38
  /**
39
39
  *
40
- * @type {MultiChannelMessageData}
40
+ * @type {MultiChannelMessageResponseData}
41
41
  * @memberof CreateMultiChannelMessageResponse
42
42
  */
43
- 'data'?: MultiChannelMessageData;
43
+ 'data'?: MultiChannelMessageResponseData;
44
44
  /**
45
45
  *
46
46
  * @type {Array<ErrorObject>}
@@ -13,6 +13,9 @@
13
13
  */
14
14
 
15
15
 
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { ErrorSource } from './error-source';
16
19
 
17
20
  /**
18
21
  *
@@ -21,16 +24,22 @@
21
24
  */
22
25
  export interface ErrorObject {
23
26
  /**
24
- *
27
+ * A concise summary of the error used for categorization.
25
28
  * @type {string}
26
29
  * @memberof ErrorObject
27
30
  */
28
- 'code'?: string;
31
+ 'type': string;
29
32
  /**
30
- *
33
+ * A detailed explanation of the error.
31
34
  * @type {string}
32
35
  * @memberof ErrorObject
33
36
  */
34
- 'message'?: string;
37
+ 'description': string;
38
+ /**
39
+ *
40
+ * @type {ErrorSource}
41
+ * @memberof ErrorObject
42
+ */
43
+ 'source': ErrorSource;
35
44
  }
36
45