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
@@ -1,15 +0,0 @@
1
- # CallbackTypeEnum
2
-
3
- Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
4
-
5
- ## Enum
6
-
7
- * `MessageReceived` (value: `'message-received'`)
8
-
9
- * `MessageSending` (value: `'message-sending'`)
10
-
11
- * `MessageDelivered` (value: `'message-delivered'`)
12
-
13
- * `MessageFailed` (value: `'message-failed'`)
14
-
15
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,22 +0,0 @@
1
- # DeferredResult
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **result** | **object** | | [optional] [default to undefined]
9
- **setOrExpired** | **boolean** | | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { DeferredResult } from 'bandwidth-sdk';
15
-
16
- const instance: DeferredResult = {
17
- result,
18
- setOrExpired,
19
- };
20
- ```
21
-
22
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,33 +0,0 @@
1
- # MessageCallback
2
-
3
- Message Callback Schema
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **time** | **string** | | [default to undefined]
10
- **type** | [**CallbackTypeEnum**](CallbackTypeEnum.md) | | [default to undefined]
11
- **to** | **string** | | [default to undefined]
12
- **description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
13
- **message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) | | [default to undefined]
14
- **errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined]
15
- **carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { MessageCallback } from 'bandwidth-sdk';
21
-
22
- const instance: MessageCallback = {
23
- time,
24
- type,
25
- to,
26
- description,
27
- message,
28
- errorCode,
29
- carrierName,
30
- };
31
- ```
32
-
33
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,43 +0,0 @@
1
- # MessageCallbackMessage
2
-
3
- Message payload schema within a MessageCallback
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | | [default to undefined]
10
- **owner** | **string** | | [default to undefined]
11
- **applicationId** | **string** | | [default to undefined]
12
- **time** | **string** | | [default to undefined]
13
- **segmentCount** | **number** | | [default to undefined]
14
- **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
15
- **to** | **Set<string>** | | [default to undefined]
16
- **from** | **string** | | [default to undefined]
17
- **text** | **string** | | [default to undefined]
18
- **tag** | **string** | | [optional] [default to undefined]
19
- **media** | **Array<string>** | Optional media, applicable only for mms | [optional] [default to undefined]
20
- **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
21
-
22
- ## Example
23
-
24
- ```typescript
25
- import { MessageCallbackMessage } from 'bandwidth-sdk';
26
-
27
- const instance: MessageCallbackMessage = {
28
- id,
29
- owner,
30
- applicationId,
31
- time,
32
- segmentCount,
33
- direction,
34
- to,
35
- from,
36
- text,
37
- tag,
38
- media,
39
- priority,
40
- };
41
- ```
42
-
43
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,28 +0,0 @@
1
- # MultiChannelCallbackData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **time** | **string** | The time of the callback event. | [optional] [default to undefined]
9
- **type** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
11
- **description** | **string** | | [optional] [default to undefined]
12
- **message** | [**MultiChannelMessageCallbackData**](MultiChannelMessageCallbackData.md) | | [optional] [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { MultiChannelCallbackData } from 'bandwidth-sdk';
18
-
19
- const instance: MultiChannelCallbackData = {
20
- time,
21
- type,
22
- to,
23
- description,
24
- message,
25
- };
26
- ```
27
-
28
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,34 +0,0 @@
1
- # MultiChannelMessageCallbackData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **messageId** | **string** | The ID of the message. | [optional] [default to undefined]
9
- **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined]
11
- **from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined]
12
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
13
- **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined]
14
- **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
15
- **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
16
-
17
- ## Example
18
-
19
- ```typescript
20
- import { MultiChannelMessageCallbackData } from 'bandwidth-sdk';
21
-
22
- const instance: MultiChannelMessageCallbackData = {
23
- messageId,
24
- status,
25
- direction,
26
- from,
27
- to,
28
- applicationId,
29
- channel,
30
- tag,
31
- };
32
- ```
33
-
34
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,36 +0,0 @@
1
- # MultiChannelMessageData
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **messageId** | **string** | The ID of the message. | [optional] [default to undefined]
9
- **status** | [**MultiChannelStatusEnum**](MultiChannelStatusEnum.md) | | [optional] [default to undefined]
10
- **time** | **string** | The time the message was received by the Bandwidth API. | [optional] [default to undefined]
11
- **direction** | [**MultiChannelMessageDirectionEnum**](MultiChannelMessageDirectionEnum.md) | | [optional] [default to undefined]
12
- **from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [optional] [default to undefined]
13
- **to** | **string** | The phone number the message should be sent to in E164 format. | [optional] [default to undefined]
14
- **applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined]
15
- **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
16
- **tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import { MultiChannelMessageData } from 'bandwidth-sdk';
22
-
23
- const instance: MultiChannelMessageData = {
24
- messageId,
25
- status,
26
- time,
27
- direction,
28
- from,
29
- to,
30
- applicationId,
31
- channel,
32
- tag,
33
- };
34
- ```
35
-
36
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,10 +0,0 @@
1
- # MultiChannelMessageDirectionEnum
2
-
3
-
4
- ## Enum
5
-
6
- * `Inbound` (value: `'INBOUND'`)
7
-
8
- * `Outbound` (value: `'OUTBOUND'`)
9
-
10
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,14 +0,0 @@
1
- # MultiChannelStatusEnum
2
-
3
-
4
- ## Enum
5
-
6
- * `Queued` (value: `'QUEUED'`)
7
-
8
- * `Sending` (value: `'SENDING'`)
9
-
10
- * `Delivered` (value: `'DELIVERED'`)
11
-
12
- * `Failed` (value: `'FAILED'`)
13
-
14
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,33 +0,0 @@
1
- /* 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
- * Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
19
- * @export
20
- * @enum {string}
21
- */
22
-
23
- export const CallbackTypeEnum = {
24
- MessageReceived: 'message-received',
25
- MessageSending: 'message-sending',
26
- MessageDelivered: 'message-delivered',
27
- MessageFailed: 'message-failed'
28
- } as const;
29
-
30
- export type CallbackTypeEnum = typeof CallbackTypeEnum[keyof typeof CallbackTypeEnum];
31
-
32
-
33
-
@@ -1,104 +0,0 @@
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 { PriorityEnum } from './priority-enum';
22
-
23
- /**
24
- * Message payload schema within a MessageCallback
25
- * @export
26
- * @interface MessageCallbackMessage
27
- */
28
- export interface MessageCallbackMessage {
29
- /**
30
- *
31
- * @type {string}
32
- * @memberof MessageCallbackMessage
33
- */
34
- 'id': string;
35
- /**
36
- *
37
- * @type {string}
38
- * @memberof MessageCallbackMessage
39
- */
40
- 'owner': string;
41
- /**
42
- *
43
- * @type {string}
44
- * @memberof MessageCallbackMessage
45
- */
46
- 'applicationId': string;
47
- /**
48
- *
49
- * @type {string}
50
- * @memberof MessageCallbackMessage
51
- */
52
- 'time': string;
53
- /**
54
- *
55
- * @type {number}
56
- * @memberof MessageCallbackMessage
57
- */
58
- 'segmentCount': number;
59
- /**
60
- *
61
- * @type {MessageDirectionEnum}
62
- * @memberof MessageCallbackMessage
63
- */
64
- 'direction': MessageDirectionEnum;
65
- /**
66
- *
67
- * @type {Set<string>}
68
- * @memberof MessageCallbackMessage
69
- */
70
- 'to': Set<string>;
71
- /**
72
- *
73
- * @type {string}
74
- * @memberof MessageCallbackMessage
75
- */
76
- 'from': string;
77
- /**
78
- *
79
- * @type {string}
80
- * @memberof MessageCallbackMessage
81
- */
82
- 'text': string;
83
- /**
84
- *
85
- * @type {string}
86
- * @memberof MessageCallbackMessage
87
- */
88
- 'tag'?: string;
89
- /**
90
- * Optional media, applicable only for mms
91
- * @type {Array<string>}
92
- * @memberof MessageCallbackMessage
93
- */
94
- 'media'?: Array<string> | null;
95
- /**
96
- *
97
- * @type {PriorityEnum}
98
- * @memberof MessageCallbackMessage
99
- */
100
- 'priority'?: PriorityEnum;
101
- }
102
-
103
-
104
-
@@ -1,74 +0,0 @@
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 { CallbackTypeEnum } from './callback-type-enum';
19
- // May contain unused imports in some cases
20
- // @ts-ignore
21
- import type { MessageCallbackMessage } from './message-callback-message';
22
-
23
- /**
24
- * Message Callback Schema
25
- * @export
26
- * @interface MessageCallback
27
- */
28
- export interface MessageCallback {
29
- /**
30
- *
31
- * @type {string}
32
- * @memberof MessageCallback
33
- */
34
- 'time': string;
35
- /**
36
- *
37
- * @type {CallbackTypeEnum}
38
- * @memberof MessageCallback
39
- */
40
- 'type': CallbackTypeEnum;
41
- /**
42
- *
43
- * @type {string}
44
- * @memberof MessageCallback
45
- */
46
- 'to': string;
47
- /**
48
- * A detailed description of the event described by the callback.
49
- * @type {string}
50
- * @memberof MessageCallback
51
- */
52
- 'description': string;
53
- /**
54
- *
55
- * @type {MessageCallbackMessage}
56
- * @memberof MessageCallback
57
- */
58
- 'message': MessageCallbackMessage;
59
- /**
60
- * Optional error code, applicable only when type is `message-failed`.
61
- * @type {number}
62
- * @memberof MessageCallback
63
- */
64
- 'errorCode'?: number | null;
65
- /**
66
- * 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.
67
- * @type {string}
68
- * @memberof MessageCallback
69
- */
70
- 'carrierName'?: string | null;
71
- }
72
-
73
-
74
-
@@ -1,62 +0,0 @@
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 { MultiChannelMessageCallbackData } from './multi-channel-message-callback-data';
19
- // May contain unused imports in some cases
20
- // @ts-ignore
21
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
22
-
23
- /**
24
- *
25
- * @export
26
- * @interface MultiChannelCallbackData
27
- */
28
- export interface MultiChannelCallbackData {
29
- /**
30
- * The time of the callback event.
31
- * @type {string}
32
- * @memberof MultiChannelCallbackData
33
- */
34
- 'time'?: string;
35
- /**
36
- *
37
- * @type {MultiChannelStatusEnum}
38
- * @memberof MultiChannelCallbackData
39
- */
40
- 'type'?: MultiChannelStatusEnum;
41
- /**
42
- * The phone number the message should be sent to in E164 format.
43
- * @type {string}
44
- * @memberof MultiChannelCallbackData
45
- */
46
- 'to'?: string;
47
- /**
48
- *
49
- * @type {string}
50
- * @memberof MultiChannelCallbackData
51
- */
52
- 'description'?: string;
53
- /**
54
- *
55
- * @type {MultiChannelMessageCallbackData}
56
- * @memberof MultiChannelCallbackData
57
- */
58
- 'message'?: MultiChannelMessageCallbackData;
59
- }
60
-
61
-
62
-
@@ -1,83 +0,0 @@
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 { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
19
- // May contain unused imports in some cases
20
- // @ts-ignore
21
- import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum';
22
- // May contain unused imports in some cases
23
- // @ts-ignore
24
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
25
-
26
- /**
27
- *
28
- * @export
29
- * @interface MultiChannelMessageCallbackData
30
- */
31
- export interface MultiChannelMessageCallbackData {
32
- /**
33
- * The ID of the message.
34
- * @type {string}
35
- * @memberof MultiChannelMessageCallbackData
36
- */
37
- 'messageId'?: string;
38
- /**
39
- *
40
- * @type {MultiChannelStatusEnum}
41
- * @memberof MultiChannelMessageCallbackData
42
- */
43
- 'status'?: MultiChannelStatusEnum;
44
- /**
45
- *
46
- * @type {MultiChannelMessageDirectionEnum}
47
- * @memberof MultiChannelMessageCallbackData
48
- */
49
- 'direction'?: MultiChannelMessageDirectionEnum;
50
- /**
51
- * The sender ID of the message. This could be an alphanumeric sender ID.
52
- * @type {string}
53
- * @memberof MultiChannelMessageCallbackData
54
- */
55
- 'from'?: string;
56
- /**
57
- * The phone number the message should be sent to in E164 format.
58
- * @type {string}
59
- * @memberof MultiChannelMessageCallbackData
60
- */
61
- 'to'?: string;
62
- /**
63
- * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
64
- * @type {string}
65
- * @memberof MultiChannelMessageCallbackData
66
- */
67
- 'applicationId'?: string;
68
- /**
69
- *
70
- * @type {MultiChannelMessageChannelEnum}
71
- * @memberof MultiChannelMessageCallbackData
72
- */
73
- 'channel'?: MultiChannelMessageChannelEnum;
74
- /**
75
- * A custom string that will be included in callback events of the message. Max 1024 characters.
76
- * @type {string}
77
- * @memberof MultiChannelMessageCallbackData
78
- */
79
- 'tag'?: string;
80
- }
81
-
82
-
83
-
@@ -1,89 +0,0 @@
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 { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
19
- // May contain unused imports in some cases
20
- // @ts-ignore
21
- import type { MultiChannelMessageDirectionEnum } from './multi-channel-message-direction-enum';
22
- // May contain unused imports in some cases
23
- // @ts-ignore
24
- import type { MultiChannelStatusEnum } from './multi-channel-status-enum';
25
-
26
- /**
27
- *
28
- * @export
29
- * @interface MultiChannelMessageData
30
- */
31
- export interface MultiChannelMessageData {
32
- /**
33
- * The ID of the message.
34
- * @type {string}
35
- * @memberof MultiChannelMessageData
36
- */
37
- 'messageId'?: string;
38
- /**
39
- *
40
- * @type {MultiChannelStatusEnum}
41
- * @memberof MultiChannelMessageData
42
- */
43
- 'status'?: MultiChannelStatusEnum;
44
- /**
45
- * The time the message was received by the Bandwidth API.
46
- * @type {string}
47
- * @memberof MultiChannelMessageData
48
- */
49
- 'time'?: string;
50
- /**
51
- *
52
- * @type {MultiChannelMessageDirectionEnum}
53
- * @memberof MultiChannelMessageData
54
- */
55
- 'direction'?: MultiChannelMessageDirectionEnum;
56
- /**
57
- * The sender ID of the message. This could be an alphanumeric sender ID.
58
- * @type {string}
59
- * @memberof MultiChannelMessageData
60
- */
61
- 'from'?: string;
62
- /**
63
- * The phone number the message should be sent to in E164 format.
64
- * @type {string}
65
- * @memberof MultiChannelMessageData
66
- */
67
- 'to'?: string;
68
- /**
69
- * The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
70
- * @type {string}
71
- * @memberof MultiChannelMessageData
72
- */
73
- 'applicationId'?: string;
74
- /**
75
- *
76
- * @type {MultiChannelMessageChannelEnum}
77
- * @memberof MultiChannelMessageData
78
- */
79
- 'channel'?: MultiChannelMessageChannelEnum;
80
- /**
81
- * A custom string that will be included in callback events of the message. Max 1024 characters.
82
- * @type {string}
83
- * @memberof MultiChannelMessageData
84
- */
85
- 'tag'?: string;
86
- }
87
-
88
-
89
-