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
@@ -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)
@@ -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
 
@@ -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
 
@@ -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
@@ -14,8 +14,8 @@ export * from './call-transcription-detected-language-enum';
14
14
  export * from './call-transcription-metadata';
15
15
  export * from './call-transcription-response';
16
16
  export * from './call-transcription-track-enum';
17
+ export * from './callback';
17
18
  export * from './callback-method-enum';
18
- export * from './callback-type-enum';
19
19
  export * from './card-width-enum';
20
20
  export * from './code-request';
21
21
  export * from './conference';
@@ -34,15 +34,18 @@ export * from './create-call-response';
34
34
  export * from './create-lookup-response';
35
35
  export * from './create-message-request-error';
36
36
  export * from './create-multi-channel-message-response';
37
- export * from './deferred-result';
38
37
  export * from './disconnect-callback';
39
38
  export * from './diversion';
40
39
  export * from './dtmf-callback';
41
40
  export * from './error-object';
41
+ export * from './error-source';
42
42
  export * from './failure-webhook';
43
43
  export * from './field-error';
44
44
  export * from './file-format-enum';
45
45
  export * from './gather-callback';
46
+ export * from './inbound-callback';
47
+ export * from './inbound-callback-message';
48
+ export * from './inbound-callback-type-enum';
46
49
  export * from './initiate-callback';
47
50
  export * from './link';
48
51
  export * from './links-object';
@@ -58,8 +61,6 @@ export * from './machine-detection-mode-enum';
58
61
  export * from './machine-detection-result';
59
62
  export * from './media';
60
63
  export * from './message';
61
- export * from './message-callback';
62
- export * from './message-callback-message';
63
64
  export * from './message-direction-enum';
64
65
  export * from './message-request';
65
66
  export * from './message-status-enum';
@@ -71,18 +72,18 @@ export * from './mfa-forbidden-request-error';
71
72
  export * from './mfa-request-error';
72
73
  export * from './mfa-unauthorized-request-error';
73
74
  export * from './mms-message-content';
75
+ export * from './mms-message-content-file';
74
76
  export * from './model-error';
75
77
  export * from './multi-channel-action';
76
78
  export * from './multi-channel-action-calendar-event';
77
- export * from './multi-channel-callback-data';
78
79
  export * from './multi-channel-channel-list-object';
79
80
  export * from './multi-channel-channel-list-object-content';
80
- export * from './multi-channel-message-callback-data';
81
+ export * from './multi-channel-error';
81
82
  export * from './multi-channel-message-channel-enum';
82
- export * from './multi-channel-message-data';
83
- export * from './multi-channel-message-direction-enum';
83
+ export * from './multi-channel-message-content';
84
84
  export * from './multi-channel-message-request';
85
- 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';
86
87
  export * from './opt-in-workflow';
87
88
  export * from './page-info';
88
89
  export * from './priority-enum';
@@ -93,6 +94,7 @@ export * from './rbm-action-type-enum';
93
94
  export * from './rbm-action-view-location';
94
95
  export * from './rbm-card-content';
95
96
  export * from './rbm-card-content-media';
97
+ export * from './rbm-location-response';
96
98
  export * from './rbm-media-height-enum';
97
99
  export * from './rbm-message-carousel-card';
98
100
  export * from './rbm-message-content-file';
@@ -100,6 +102,7 @@ export * from './rbm-message-content-rich-card';
100
102
  export * from './rbm-message-content-text';
101
103
  export * from './rbm-message-media';
102
104
  export * from './rbm-standalone-card';
105
+ export * from './rbm-suggestion-response';
103
106
  export * from './recording-available-callback';
104
107
  export * from './recording-complete-callback';
105
108
  export * from './recording-state-enum';
@@ -109,6 +112,9 @@ export * from './redirect-callback';
109
112
  export * from './redirect-method-enum';
110
113
  export * from './sms-message-content';
111
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';
112
118
  export * from './stir-shaken';
113
119
  export * from './telephone-number';
114
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