@vonage/client-sdk 2.6.1 → 2.6.2-snapshot.20260820113314
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.
- package/api_docs/ts/assets/hierarchy.js +1 -0
- package/api_docs/ts/assets/highlight.css +1 -1
- package/api_docs/ts/assets/icons.js +17 -14
- package/api_docs/ts/assets/icons.svg +1 -1
- package/api_docs/ts/assets/main.js +5 -4
- package/api_docs/ts/assets/navigation.js +1 -1
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/assets/style.css +1460 -1224
- package/api_docs/ts/classes/ClientConfig.html +207 -16
- package/api_docs/ts/classes/ClientInitConfig.html +130 -14
- package/api_docs/ts/classes/VonageClient.html +1697 -335
- package/api_docs/ts/enums/CallDisconnectReason.html +54 -3
- package/api_docs/ts/enums/CancelReason.html +66 -6
- package/api_docs/ts/enums/HangupReason.html +70 -7
- package/api_docs/ts/enums/LegStatus.html +62 -5
- package/api_docs/ts/enums/LoggingLevel.html +74 -8
- package/api_docs/ts/enums/MemberChannelType.html +94 -13
- package/api_docs/ts/enums/OrderBy.html +58 -2
- package/api_docs/ts/enums/PresentingOrder.html +62 -8
- package/api_docs/ts/enums/SessionErrorReason.html +62 -5
- package/api_docs/ts/enums/VoiceChannelType.html +66 -6
- package/api_docs/ts/enums/VonageErrorType.html +70 -7
- package/api_docs/ts/functions/none.html +42 -2
- package/api_docs/ts/functions/some.html +48 -3
- package/api_docs/ts/hierarchy.html +30 -0
- package/api_docs/ts/index.html +102 -26
- package/api_docs/ts/interfaces/CallSayParams.html +75 -8
- package/api_docs/ts/interfaces/Channel.html +67 -6
- package/api_docs/ts/interfaces/Conversation.html +127 -20
- package/api_docs/ts/interfaces/ConversationProperties.html +75 -8
- package/api_docs/ts/interfaces/ConversationTimestamp.html +75 -5
- package/api_docs/ts/interfaces/ConversationsPage.html +81 -8
- package/api_docs/ts/interfaces/CreateConversationParameters.html +88 -15
- package/api_docs/ts/interfaces/EmergencyCallData.html +67 -6
- package/api_docs/ts/interfaces/EmergencyCallOptions.html +57 -4
- package/api_docs/ts/interfaces/EphemeralConversationEvent.html +81 -12
- package/api_docs/ts/interfaces/EventsPage.html +81 -8
- package/api_docs/ts/interfaces/GetCallLegsParameters.html +69 -8
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +87 -14
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +69 -8
- package/api_docs/ts/interfaces/GetConversationsParameters.html +81 -12
- package/api_docs/ts/interfaces/Leg.html +131 -21
- package/api_docs/ts/interfaces/LegChannel.html +75 -8
- package/api_docs/ts/interfaces/LegsPage.html +81 -8
- package/api_docs/ts/interfaces/Location.html +67 -6
- package/api_docs/ts/interfaces/Member.html +81 -12
- package/api_docs/ts/interfaces/MemberChannel.html +69 -8
- package/api_docs/ts/interfaces/MemberEventBody.html +75 -7
- package/api_docs/ts/interfaces/MemberTimestamp.html +75 -5
- package/api_docs/ts/interfaces/MembersPage.html +81 -8
- package/api_docs/ts/interfaces/MessageAudioEventBody.html +67 -5
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +67 -5
- package/api_docs/ts/interfaces/MessageFileEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageImageEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageLocationEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageTemplateEventBody.html +93 -9
- package/api_docs/ts/interfaces/MessageTextEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageVCardEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageVideoEventBody.html +67 -6
- package/api_docs/ts/interfaces/RTCQuality.html +123 -11
- package/api_docs/ts/interfaces/RtcStats.html +179 -18
- package/api_docs/ts/interfaces/Template.html +59 -4
- package/api_docs/ts/interfaces/UpdateConversationParameters.html +87 -14
- package/api_docs/ts/interfaces/User.html +107 -16
- package/api_docs/ts/interfaces/UserChannels.html +139 -13
- package/api_docs/ts/interfaces/UserTimestamp.html +75 -5
- package/api_docs/ts/interfaces/VonageError.html +89 -12
- package/api_docs/ts/interfaces/VonageEvent.html +131 -22
- package/api_docs/ts/interfaces/Whatsapp.html +59 -4
- package/api_docs/ts/modules.html +69 -74
- package/api_docs/ts/types/ClientConfigObject.html +52 -5
- package/api_docs/ts/types/ClientInitConfigObject.html +59 -4
- package/api_docs/ts/types/ConfigRegion.html +34 -2
- package/api_docs/ts/types/ConversationEvent.html +34 -2
- package/api_docs/ts/types/CustomData.html +34 -2
- package/api_docs/ts/types/Json.html +34 -2
- package/api_docs/ts/types/JsonValue.html +34 -2
- package/api_docs/ts/types/MemberStatus.html +34 -2
- package/api_docs/ts/types/Option.html +38 -2
- package/api_docs/ts/types/PersistentConversationEvent.html +34 -2
- package/api_docs/ts/types/Topics.html +34 -2
- package/api_docs/ts/types/VonageLogger.html +59 -4
- package/api_docs/ts/variables/Topics.html +34 -0
- package/api_docs/ts/variables/VonageError.html +38 -0
- package/dist/client/VonageClient.d.ts +704 -704
- package/dist/client/index.cjs +45072 -36319
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.mjs +44700 -35947
- package/dist/coreExtend.d.ts +107 -107
- package/dist/kotlin/JsUnions.d.ts +443 -443
- package/dist/kotlin/clientsdk-clientcore_js.d.ts +724 -145
- package/dist/utils/ClientConfig.d.ts +104 -104
- package/dist/utils/ConversationEventBodies.d.ts +125 -125
- package/dist/utils/ConversationModels.d.ts +170 -170
- package/dist/utils/Enums.d.ts +56 -56
- package/dist/utils/ErrorModels.d.ts +23 -23
- package/dist/utils/JsonUtils.d.ts +15 -15
- package/dist/utils/Option.d.ts +19 -19
- package/dist/utils/RequestParameterModels.d.ts +134 -134
- package/dist/utils/index.d.ts +10 -10
- package/dist/utils/jsEnumToVonageObject.d.ts +10 -10
- package/dist/utils/logging.d.ts +53 -53
- package/dist/utils/vonage.d.ts +2 -2
- package/dist/vonageClientSDK.js +44299 -35558
- package/dist/vonageClientSDK.min.js +25 -25
- package/dist/vonageClientSDK.min.mjs +26 -26
- package/dist/vonageClientSDK.mjs +44299 -35558
- package/package.json +6 -6
- package/typedoc.json +3 -0
- package/api_docs/ts/variables/Topics-1.html +0 -2
- package/api_docs/ts/variables/VonageError-1.html +0 -3
|
@@ -1,443 +1,443 @@
|
|
|
1
|
-
import { vonage } from './clientsdk-clientcore_js';
|
|
2
|
-
/**
|
|
3
|
-
* The EmbeddedInfo type
|
|
4
|
-
*
|
|
5
|
-
* @property kind The kind property of EmbeddedInfo
|
|
6
|
-
* @property memberId The memberId property of EmbeddedInfo
|
|
7
|
-
* @property user The user property of EmbeddedInfo
|
|
8
|
-
* @interface
|
|
9
|
-
*/
|
|
10
|
-
export type EmbeddedInfo = Omit<vonage.EmbeddedInfoJS, 'kind'> & {
|
|
11
|
-
kind: 'embeddedInfo';
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* The System type
|
|
15
|
-
*
|
|
16
|
-
* @property kind The kind property of System
|
|
17
|
-
* @interface
|
|
18
|
-
*/
|
|
19
|
-
export type System = Omit<typeof vonage.SystemJS, 'kind'> & {
|
|
20
|
-
kind: 'system';
|
|
21
|
-
};
|
|
22
|
-
/**
|
|
23
|
-
* A From is a discriminated union of {@link EmbeddedInfo}, {@link System}
|
|
24
|
-
*/
|
|
25
|
-
export type From = EmbeddedInfo | System;
|
|
26
|
-
/**
|
|
27
|
-
* The EphemeralConversationEvent type
|
|
28
|
-
*
|
|
29
|
-
* @property kind The kind property of EphemeralConversationEvent
|
|
30
|
-
* @property timestamp The timestamp property of EphemeralConversationEvent
|
|
31
|
-
* @property conversationId The conversationId property of EphemeralConversationEvent
|
|
32
|
-
* @property from The {@link From} property of EphemeralConversationEvent
|
|
33
|
-
* @property body The body property of EphemeralConversationEvent
|
|
34
|
-
* @interface
|
|
35
|
-
* @group Chat
|
|
36
|
-
*/
|
|
37
|
-
export type EphemeralConversationEvent = Omit<vonage.EphemeralConversationEventJS, 'kind' | 'from'> & {
|
|
38
|
-
kind: 'ephemeral';
|
|
39
|
-
from: From;
|
|
40
|
-
};
|
|
41
|
-
/**
|
|
42
|
-
* A NonPersistentConversationEvent is a {@link EphemeralConversationEvent}
|
|
43
|
-
* @group Chat
|
|
44
|
-
*/
|
|
45
|
-
export type NonPersistentConversationEvent = EphemeralConversationEvent;
|
|
46
|
-
import { MessageAudioEventBody } from '../utils/ConversationEventBodies';
|
|
47
|
-
import { MemberStatus } from '../utils/ConversationEventBodies';
|
|
48
|
-
import { MessageFileEventBody } from '../utils/ConversationEventBodies';
|
|
49
|
-
import { MessageImageEventBody } from '../utils/ConversationEventBodies';
|
|
50
|
-
import { MessageLocationEventBody } from '../utils/ConversationEventBodies';
|
|
51
|
-
import { MessageTemplateEventBody } from '../utils/ConversationEventBodies';
|
|
52
|
-
import { MessageTextEventBody } from '../utils/ConversationEventBodies';
|
|
53
|
-
import { MessageVCardEventBody } from '../utils/ConversationEventBodies';
|
|
54
|
-
import { MessageVideoEventBody } from '../utils/ConversationEventBodies';
|
|
55
|
-
/**
|
|
56
|
-
* The CustomConversationEvent type
|
|
57
|
-
*
|
|
58
|
-
* @property kind The kind property of CustomConversationEvent
|
|
59
|
-
* @property id The id property of CustomConversationEvent
|
|
60
|
-
* @property timestamp The timestamp property of CustomConversationEvent
|
|
61
|
-
* @property conversationId The conversationId property of CustomConversationEvent
|
|
62
|
-
* @property from The {@link From} property of CustomConversationEvent
|
|
63
|
-
* @property eventType The eventType property of CustomConversationEvent
|
|
64
|
-
* @property body The body property of CustomConversationEvent
|
|
65
|
-
* @interface
|
|
66
|
-
* @group Chat
|
|
67
|
-
*/
|
|
68
|
-
export type CustomConversationEvent = Omit<vonage.CustomConversationEventJS, 'kind' | 'from'> & {
|
|
69
|
-
kind: 'custom';
|
|
70
|
-
from: From;
|
|
71
|
-
};
|
|
72
|
-
/**
|
|
73
|
-
* The EventDeleteConversationEvent type
|
|
74
|
-
*
|
|
75
|
-
* @property kind The kind property of EventDeleteConversationEvent
|
|
76
|
-
* @property id The id property of EventDeleteConversationEvent
|
|
77
|
-
* @property timestamp The timestamp property of EventDeleteConversationEvent
|
|
78
|
-
* @property conversationId The conversationId property of EventDeleteConversationEvent
|
|
79
|
-
* @property from The {@link From} property of EventDeleteConversationEvent
|
|
80
|
-
* @property body The body property of EventDeleteConversationEvent
|
|
81
|
-
* @interface
|
|
82
|
-
* @group Chat
|
|
83
|
-
*/
|
|
84
|
-
export type EventDeleteConversationEvent = Omit<vonage.EventDeleteConversationEventJS, 'kind' | 'from'> & {
|
|
85
|
-
kind: 'event:delete';
|
|
86
|
-
from: From;
|
|
87
|
-
};
|
|
88
|
-
/**
|
|
89
|
-
* The MemberInvitedEvent type
|
|
90
|
-
*
|
|
91
|
-
* @property kind The kind property of MemberInvitedEvent
|
|
92
|
-
* @property id The event id
|
|
93
|
-
* @property timestamp The event timestamp
|
|
94
|
-
* @property conversationId The conversation id
|
|
95
|
-
* @property from The event sender
|
|
96
|
-
* @property body The invited member
|
|
97
|
-
* @interface
|
|
98
|
-
* @group Chat
|
|
99
|
-
*/
|
|
100
|
-
export type MemberInvitedEvent = Omit<vonage.MemberInvitedEventJS, 'kind' | 'from'> & {
|
|
101
|
-
kind: 'member:invited';
|
|
102
|
-
from: From;
|
|
103
|
-
};
|
|
104
|
-
/**
|
|
105
|
-
* The MemberJoinedEvent type
|
|
106
|
-
*
|
|
107
|
-
* @property kind The kind property of MemberJoinedEvent
|
|
108
|
-
* @property id The id property of MemberJoinedEvent
|
|
109
|
-
* @property timestamp The timestamp property of MemberJoinedEvent
|
|
110
|
-
* @property conversationId The conversationId property of MemberJoinedEvent
|
|
111
|
-
* @property from The {@link From} property of MemberJoinedEvent
|
|
112
|
-
* @property body The body property of MemberJoinedEvent
|
|
113
|
-
* @interface
|
|
114
|
-
* @group Chat
|
|
115
|
-
*/
|
|
116
|
-
export type MemberJoinedEvent = Omit<vonage.MemberJoinedEventJS, 'kind' | 'from'> & {
|
|
117
|
-
kind: 'member:joined';
|
|
118
|
-
from: From;
|
|
119
|
-
};
|
|
120
|
-
/**
|
|
121
|
-
* The MemberLeftEvent type
|
|
122
|
-
*
|
|
123
|
-
* @property kind The kind property of MemberLeftEvent
|
|
124
|
-
* @property id The id property of MemberLeftEvent
|
|
125
|
-
* @property timestamp The timestamp property of MemberLeftEvent
|
|
126
|
-
* @property conversationId The conversationId property of MemberLeftEvent
|
|
127
|
-
* @property from The {@link From} property of MemberLeftEvent
|
|
128
|
-
* @property body The body property of MemberLeftEvent
|
|
129
|
-
* @interface
|
|
130
|
-
* @group Chat
|
|
131
|
-
*/
|
|
132
|
-
export type MemberLeftEvent = Omit<vonage.MemberLeftEventJS, 'kind' | 'from'> & {
|
|
133
|
-
kind: 'member:left';
|
|
134
|
-
from: From;
|
|
135
|
-
};
|
|
136
|
-
/**
|
|
137
|
-
* The MessageAudioEvent type
|
|
138
|
-
*
|
|
139
|
-
* @property kind The kind property of MessageAudioEvent
|
|
140
|
-
* @property id The id property of MessageAudioEvent
|
|
141
|
-
* @property timestamp The timestamp property of MessageAudioEvent
|
|
142
|
-
* @property conversationId The conversationId property of MessageAudioEvent
|
|
143
|
-
* @property from The {@link From} property of MessageAudioEvent
|
|
144
|
-
* @property body The body property of MessageAudioEvent
|
|
145
|
-
* @property memberStatuses The memberStatuses property of MessageAudioEvent
|
|
146
|
-
* @interface
|
|
147
|
-
* @group Chat
|
|
148
|
-
*/
|
|
149
|
-
export type MessageAudioEvent = Omit<vonage.MessageAudioEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
150
|
-
kind: 'message:audio';
|
|
151
|
-
from: From;
|
|
152
|
-
body: MessageAudioEventBody;
|
|
153
|
-
memberStatuses: MemberStatus;
|
|
154
|
-
};
|
|
155
|
-
/**
|
|
156
|
-
* The MessageCustomEvent type
|
|
157
|
-
*
|
|
158
|
-
* @property kind The kind property of MessageCustomEvent
|
|
159
|
-
* @property id The id property of MessageCustomEvent
|
|
160
|
-
* @property timestamp The timestamp property of MessageCustomEvent
|
|
161
|
-
* @property conversationId The conversationId property of MessageCustomEvent
|
|
162
|
-
* @property from The {@link From} property of MessageCustomEvent
|
|
163
|
-
* @property body The body property of MessageCustomEvent
|
|
164
|
-
* @property memberStatuses The memberStatuses property of MessageCustomEvent
|
|
165
|
-
* @interface
|
|
166
|
-
* @group Chat
|
|
167
|
-
*/
|
|
168
|
-
export type MessageCustomEvent = Omit<vonage.MessageCustomEventJS, 'kind' | 'from' | 'memberStatuses'> & {
|
|
169
|
-
kind: 'message:custom';
|
|
170
|
-
from: From;
|
|
171
|
-
memberStatuses: MemberStatus;
|
|
172
|
-
};
|
|
173
|
-
/**
|
|
174
|
-
* The MessageDeliveredEvent type
|
|
175
|
-
*
|
|
176
|
-
* @property kind The kind property of MessageDeliveredEvent
|
|
177
|
-
* @property id The id property of MessageDeliveredEvent
|
|
178
|
-
* @property timestamp The timestamp property of MessageDeliveredEvent
|
|
179
|
-
* @property conversationId The conversationId property of MessageDeliveredEvent
|
|
180
|
-
* @property from The {@link From} property of MessageDeliveredEvent
|
|
181
|
-
* @property body The body property of MessageDeliveredEvent
|
|
182
|
-
* @interface
|
|
183
|
-
* @group Chat
|
|
184
|
-
*/
|
|
185
|
-
export type MessageDeliveredEvent = Omit<vonage.MessageDeliveredEventJS, 'kind' | 'from'> & {
|
|
186
|
-
kind: 'message:delivered';
|
|
187
|
-
from: From;
|
|
188
|
-
};
|
|
189
|
-
/**
|
|
190
|
-
* The MessageFileEvent type
|
|
191
|
-
*
|
|
192
|
-
* @property kind The kind property of MessageFileEvent
|
|
193
|
-
* @property id The id property of MessageFileEvent
|
|
194
|
-
* @property timestamp The timestamp property of MessageFileEvent
|
|
195
|
-
* @property conversationId The conversationId property of MessageFileEvent
|
|
196
|
-
* @property from The {@link From} property of MessageFileEvent
|
|
197
|
-
* @property body The body property of MessageFileEvent
|
|
198
|
-
* @property memberStatuses The memberStatuses property of MessageFileEvent
|
|
199
|
-
* @interface
|
|
200
|
-
* @group Chat
|
|
201
|
-
*/
|
|
202
|
-
export type MessageFileEvent = Omit<vonage.MessageFileEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
203
|
-
kind: 'message:file';
|
|
204
|
-
from: From;
|
|
205
|
-
body: MessageFileEventBody;
|
|
206
|
-
memberStatuses: MemberStatus;
|
|
207
|
-
};
|
|
208
|
-
/**
|
|
209
|
-
* The MessageImageEvent type
|
|
210
|
-
*
|
|
211
|
-
* @property kind The kind property of MessageImageEvent
|
|
212
|
-
* @property id The id property of MessageImageEvent
|
|
213
|
-
* @property timestamp The timestamp property of MessageImageEvent
|
|
214
|
-
* @property conversationId The conversationId property of MessageImageEvent
|
|
215
|
-
* @property from The {@link From} property of MessageImageEvent
|
|
216
|
-
* @property body The body property of MessageImageEvent
|
|
217
|
-
* @property memberStatuses The memberStatuses property of MessageImageEvent
|
|
218
|
-
* @interface
|
|
219
|
-
* @group Chat
|
|
220
|
-
*/
|
|
221
|
-
export type MessageImageEvent = Omit<vonage.MessageImageEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
222
|
-
kind: 'message:image';
|
|
223
|
-
from: From;
|
|
224
|
-
body: MessageImageEventBody;
|
|
225
|
-
memberStatuses: MemberStatus;
|
|
226
|
-
};
|
|
227
|
-
/**
|
|
228
|
-
* The MessageLocationEvent type
|
|
229
|
-
*
|
|
230
|
-
* @property kind The kind property of MessageLocationEvent
|
|
231
|
-
* @property id The id property of MessageLocationEvent
|
|
232
|
-
* @property timestamp The timestamp property of MessageLocationEvent
|
|
233
|
-
* @property conversationId The conversationId property of MessageLocationEvent
|
|
234
|
-
* @property from The {@link From} property of MessageLocationEvent
|
|
235
|
-
* @property body The body property of MessageLocationEvent
|
|
236
|
-
* @property memberStatuses The memberStatuses property of MessageLocationEvent
|
|
237
|
-
* @interface
|
|
238
|
-
* @group Chat
|
|
239
|
-
*/
|
|
240
|
-
export type MessageLocationEvent = Omit<vonage.MessageLocationEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
241
|
-
kind: 'message:location';
|
|
242
|
-
from: From;
|
|
243
|
-
body: MessageLocationEventBody;
|
|
244
|
-
memberStatuses: MemberStatus;
|
|
245
|
-
};
|
|
246
|
-
/**
|
|
247
|
-
* The MessageRejectedEvent type
|
|
248
|
-
*
|
|
249
|
-
* @property kind The kind property of MessageRejectedEvent
|
|
250
|
-
* @property id The id property of MessageRejectedEvent
|
|
251
|
-
* @property timestamp The timestamp property of MessageRejectedEvent
|
|
252
|
-
* @property conversationId The conversationId property of MessageRejectedEvent
|
|
253
|
-
* @property from The {@link From} property of MessageRejectedEvent
|
|
254
|
-
* @property body The body property of MessageRejectedEvent
|
|
255
|
-
* @interface
|
|
256
|
-
* @group Chat
|
|
257
|
-
*/
|
|
258
|
-
export type MessageRejectedEvent = Omit<vonage.MessageRejectedEventJS, 'kind' | 'from'> & {
|
|
259
|
-
kind: 'message:rejected';
|
|
260
|
-
from: From;
|
|
261
|
-
};
|
|
262
|
-
/**
|
|
263
|
-
* The MessageSeenEvent type
|
|
264
|
-
*
|
|
265
|
-
* @property kind The kind property of MessageSeenEvent
|
|
266
|
-
* @property id The id property of MessageSeenEvent
|
|
267
|
-
* @property timestamp The timestamp property of MessageSeenEvent
|
|
268
|
-
* @property conversationId The conversationId property of MessageSeenEvent
|
|
269
|
-
* @property from The {@link From} property of MessageSeenEvent
|
|
270
|
-
* @property body The body property of MessageSeenEvent
|
|
271
|
-
* @interface
|
|
272
|
-
* @group Chat
|
|
273
|
-
*/
|
|
274
|
-
export type MessageSeenEvent = Omit<vonage.MessageSeenEventJS, 'kind' | 'from'> & {
|
|
275
|
-
kind: 'message:seen';
|
|
276
|
-
from: From;
|
|
277
|
-
};
|
|
278
|
-
/**
|
|
279
|
-
* The MessageSubmittedEvent type
|
|
280
|
-
*
|
|
281
|
-
* @property kind The kind property of MessageSubmittedEvent
|
|
282
|
-
* @property id The id property of MessageSubmittedEvent
|
|
283
|
-
* @property timestamp The timestamp property of MessageSubmittedEvent
|
|
284
|
-
* @property conversationId The conversationId property of MessageSubmittedEvent
|
|
285
|
-
* @property from The {@link From} property of MessageSubmittedEvent
|
|
286
|
-
* @property body The body property of MessageSubmittedEvent
|
|
287
|
-
* @interface
|
|
288
|
-
* @group Chat
|
|
289
|
-
*/
|
|
290
|
-
export type MessageSubmittedEvent = Omit<vonage.MessageSubmittedEventJS, 'kind' | 'from'> & {
|
|
291
|
-
kind: 'message:submitted';
|
|
292
|
-
from: From;
|
|
293
|
-
};
|
|
294
|
-
/**
|
|
295
|
-
* The MessageTemplateEvent type
|
|
296
|
-
*
|
|
297
|
-
* @property kind The kind property of MessageTemplateEvent
|
|
298
|
-
* @property id The id property of MessageTemplateEvent
|
|
299
|
-
* @property timestamp The timestamp property of MessageTemplateEvent
|
|
300
|
-
* @property conversationId The conversationId property of MessageTemplateEvent
|
|
301
|
-
* @property from The {@link From} property of MessageTemplateEvent
|
|
302
|
-
* @property memberStatuses The memberStatuses property of MessageTemplateEvent
|
|
303
|
-
* @property body The body property of MessageTemplateEvent
|
|
304
|
-
* @interface
|
|
305
|
-
* @group Chat
|
|
306
|
-
*/
|
|
307
|
-
export type MessageTemplateEvent = Omit<vonage.MessageTemplateEventJS, 'kind' | 'from' | 'memberStatuses' | 'body'> & {
|
|
308
|
-
kind: 'message:template';
|
|
309
|
-
from: From;
|
|
310
|
-
memberStatuses: MemberStatus;
|
|
311
|
-
body: MessageTemplateEventBody;
|
|
312
|
-
};
|
|
313
|
-
/**
|
|
314
|
-
* The MessageTextEvent type
|
|
315
|
-
*
|
|
316
|
-
* @property kind The kind property of MessageTextEvent
|
|
317
|
-
* @property id The id property of MessageTextEvent
|
|
318
|
-
* @property timestamp The timestamp property of MessageTextEvent
|
|
319
|
-
* @property conversationId The conversationId property of MessageTextEvent
|
|
320
|
-
* @property from The {@link From} property of MessageTextEvent
|
|
321
|
-
* @property body The body property of MessageTextEvent
|
|
322
|
-
* @property memberStatuses The memberStatuses property of MessageTextEvent
|
|
323
|
-
* @interface
|
|
324
|
-
* @group Chat
|
|
325
|
-
*/
|
|
326
|
-
export type MessageTextEvent = Omit<vonage.MessageTextEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
327
|
-
kind: 'message:text';
|
|
328
|
-
from: From;
|
|
329
|
-
body: MessageTextEventBody;
|
|
330
|
-
memberStatuses: MemberStatus;
|
|
331
|
-
};
|
|
332
|
-
/**
|
|
333
|
-
* The MessageUndeliverableEvent type
|
|
334
|
-
*
|
|
335
|
-
* @property kind The kind property of MessageUndeliverableEvent
|
|
336
|
-
* @property id The id property of MessageUndeliverableEvent
|
|
337
|
-
* @property timestamp The timestamp property of MessageUndeliverableEvent
|
|
338
|
-
* @property conversationId The conversationId property of MessageUndeliverableEvent
|
|
339
|
-
* @property from The {@link From} property of MessageUndeliverableEvent
|
|
340
|
-
* @property body The body property of MessageUndeliverableEvent
|
|
341
|
-
* @interface
|
|
342
|
-
* @group Chat
|
|
343
|
-
*/
|
|
344
|
-
export type MessageUndeliverableEvent = Omit<vonage.MessageUndeliverableEventJS, 'kind' | 'from'> & {
|
|
345
|
-
kind: 'message:undeliverable';
|
|
346
|
-
from: From;
|
|
347
|
-
};
|
|
348
|
-
/**
|
|
349
|
-
* The MessageVCardEvent type
|
|
350
|
-
*
|
|
351
|
-
* @property kind The kind property of MessageVCardEvent
|
|
352
|
-
* @property id The id property of MessageVCardEvent
|
|
353
|
-
* @property timestamp The timestamp property of MessageVCardEvent
|
|
354
|
-
* @property conversationId The conversationId property of MessageVCardEvent
|
|
355
|
-
* @property from The {@link From} property of MessageVCardEvent
|
|
356
|
-
* @property body The body property of MessageVCardEvent
|
|
357
|
-
* @property memberStatuses The memberStatuses property of MessageVCardEvent
|
|
358
|
-
* @interface
|
|
359
|
-
* @group Chat
|
|
360
|
-
*/
|
|
361
|
-
export type MessageVCardEvent = Omit<vonage.MessageVCardEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
362
|
-
kind: 'message:vcard';
|
|
363
|
-
from: From;
|
|
364
|
-
body: MessageVCardEventBody;
|
|
365
|
-
memberStatuses: MemberStatus;
|
|
366
|
-
};
|
|
367
|
-
/**
|
|
368
|
-
* The MessageVideoEvent type
|
|
369
|
-
*
|
|
370
|
-
* @property kind The kind property of MessageVideoEvent
|
|
371
|
-
* @property id The id property of MessageVideoEvent
|
|
372
|
-
* @property timestamp The timestamp property of MessageVideoEvent
|
|
373
|
-
* @property conversationId The conversationId property of MessageVideoEvent
|
|
374
|
-
* @property from The {@link From} property of MessageVideoEvent
|
|
375
|
-
* @property body The body property of MessageVideoEvent
|
|
376
|
-
* @property memberStatuses The memberStatuses property of MessageVideoEvent
|
|
377
|
-
* @interface
|
|
378
|
-
* @group Chat
|
|
379
|
-
*/
|
|
380
|
-
export type MessageVideoEvent = Omit<vonage.MessageVideoEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
381
|
-
kind: 'message:video';
|
|
382
|
-
from: From;
|
|
383
|
-
body: MessageVideoEventBody;
|
|
384
|
-
memberStatuses: MemberStatus;
|
|
385
|
-
};
|
|
386
|
-
/**
|
|
387
|
-
* A PersistentConversationEvent is a discriminated union of {@link CustomConversationEvent}, {@link EventDeleteConversationEvent}, {@link MemberInvitedEvent}, {@link MemberJoinedEvent}, {@link MemberLeftEvent}, {@link MessageAudioEvent}, {@link MessageCustomEvent}, {@link MessageDeliveredEvent}, {@link MessageFileEvent}, {@link MessageImageEvent}, {@link MessageLocationEvent}, {@link MessageRejectedEvent}, {@link MessageSeenEvent}, {@link MessageSubmittedEvent}, {@link MessageTemplateEvent}, {@link MessageTextEvent}, {@link MessageUndeliverableEvent}, {@link MessageVCardEvent}, {@link MessageVideoEvent}
|
|
388
|
-
* @group Chat
|
|
389
|
-
*/
|
|
390
|
-
export type PersistentConversationEvent = CustomConversationEvent | EventDeleteConversationEvent | MemberInvitedEvent | MemberJoinedEvent | MemberLeftEvent | MessageAudioEvent | MessageCustomEvent | MessageDeliveredEvent | MessageFileEvent | MessageImageEvent | MessageLocationEvent | MessageRejectedEvent | MessageSeenEvent | MessageSubmittedEvent | MessageTemplateEvent | MessageTextEvent | MessageUndeliverableEvent | MessageVCardEvent | MessageVideoEvent;
|
|
391
|
-
/**
|
|
392
|
-
* A
|
|
393
|
-
*/
|
|
394
|
-
export type
|
|
395
|
-
/**
|
|
396
|
-
* A
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
*
|
|
406
|
-
*/
|
|
407
|
-
export type
|
|
408
|
-
/**
|
|
409
|
-
* A
|
|
410
|
-
*/
|
|
411
|
-
export type
|
|
412
|
-
/**
|
|
413
|
-
* A
|
|
414
|
-
*/
|
|
415
|
-
export type
|
|
416
|
-
/**
|
|
417
|
-
* A
|
|
418
|
-
*/
|
|
419
|
-
export type
|
|
420
|
-
/**
|
|
421
|
-
* A
|
|
422
|
-
*/
|
|
423
|
-
export type
|
|
424
|
-
/**
|
|
425
|
-
* A SessionErrorReasonJS is a union of 'EXPIRED_TOKEN', 'TRANSPORT_CLOSED', 'PING_TIMEOUT'
|
|
426
|
-
*/
|
|
427
|
-
export type SessionErrorReasonJS = 'EXPIRED_TOKEN' | 'TRANSPORT_CLOSED' | 'PING_TIMEOUT';
|
|
428
|
-
/**
|
|
429
|
-
* A
|
|
430
|
-
*/
|
|
431
|
-
export type
|
|
432
|
-
/**
|
|
433
|
-
* A
|
|
434
|
-
*/
|
|
435
|
-
export type
|
|
436
|
-
/**
|
|
437
|
-
* A
|
|
438
|
-
*/
|
|
439
|
-
export type
|
|
440
|
-
/**
|
|
441
|
-
* A
|
|
442
|
-
*/
|
|
443
|
-
export type
|
|
1
|
+
import { vonage } from './clientsdk-clientcore_js';
|
|
2
|
+
/**
|
|
3
|
+
* The EmbeddedInfo type
|
|
4
|
+
*
|
|
5
|
+
* @property kind The kind property of EmbeddedInfo
|
|
6
|
+
* @property memberId The memberId property of EmbeddedInfo
|
|
7
|
+
* @property user The user property of EmbeddedInfo
|
|
8
|
+
* @interface
|
|
9
|
+
*/
|
|
10
|
+
export type EmbeddedInfo = Omit<vonage.EmbeddedInfoJS, 'kind'> & {
|
|
11
|
+
kind: 'embeddedInfo';
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* The System type
|
|
15
|
+
*
|
|
16
|
+
* @property kind The kind property of System
|
|
17
|
+
* @interface
|
|
18
|
+
*/
|
|
19
|
+
export type System = Omit<typeof vonage.SystemJS, 'kind'> & {
|
|
20
|
+
kind: 'system';
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* A From is a discriminated union of {@link EmbeddedInfo}, {@link System}
|
|
24
|
+
*/
|
|
25
|
+
export type From = EmbeddedInfo | System;
|
|
26
|
+
/**
|
|
27
|
+
* The EphemeralConversationEvent type
|
|
28
|
+
*
|
|
29
|
+
* @property kind The kind property of EphemeralConversationEvent
|
|
30
|
+
* @property timestamp The timestamp property of EphemeralConversationEvent
|
|
31
|
+
* @property conversationId The conversationId property of EphemeralConversationEvent
|
|
32
|
+
* @property from The {@link From} property of EphemeralConversationEvent
|
|
33
|
+
* @property body The body property of EphemeralConversationEvent
|
|
34
|
+
* @interface
|
|
35
|
+
* @group Chat
|
|
36
|
+
*/
|
|
37
|
+
export type EphemeralConversationEvent = Omit<vonage.EphemeralConversationEventJS, 'kind' | 'from'> & {
|
|
38
|
+
kind: 'ephemeral';
|
|
39
|
+
from: From;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* A NonPersistentConversationEvent is a {@link EphemeralConversationEvent}
|
|
43
|
+
* @group Chat
|
|
44
|
+
*/
|
|
45
|
+
export type NonPersistentConversationEvent = EphemeralConversationEvent;
|
|
46
|
+
import { MessageAudioEventBody } from '../utils/ConversationEventBodies';
|
|
47
|
+
import { MemberStatus } from '../utils/ConversationEventBodies';
|
|
48
|
+
import { MessageFileEventBody } from '../utils/ConversationEventBodies';
|
|
49
|
+
import { MessageImageEventBody } from '../utils/ConversationEventBodies';
|
|
50
|
+
import { MessageLocationEventBody } from '../utils/ConversationEventBodies';
|
|
51
|
+
import { MessageTemplateEventBody } from '../utils/ConversationEventBodies';
|
|
52
|
+
import { MessageTextEventBody } from '../utils/ConversationEventBodies';
|
|
53
|
+
import { MessageVCardEventBody } from '../utils/ConversationEventBodies';
|
|
54
|
+
import { MessageVideoEventBody } from '../utils/ConversationEventBodies';
|
|
55
|
+
/**
|
|
56
|
+
* The CustomConversationEvent type
|
|
57
|
+
*
|
|
58
|
+
* @property kind The kind property of CustomConversationEvent
|
|
59
|
+
* @property id The id property of CustomConversationEvent
|
|
60
|
+
* @property timestamp The timestamp property of CustomConversationEvent
|
|
61
|
+
* @property conversationId The conversationId property of CustomConversationEvent
|
|
62
|
+
* @property from The {@link From} property of CustomConversationEvent
|
|
63
|
+
* @property eventType The eventType property of CustomConversationEvent
|
|
64
|
+
* @property body The body property of CustomConversationEvent
|
|
65
|
+
* @interface
|
|
66
|
+
* @group Chat
|
|
67
|
+
*/
|
|
68
|
+
export type CustomConversationEvent = Omit<vonage.CustomConversationEventJS, 'kind' | 'from'> & {
|
|
69
|
+
kind: 'custom';
|
|
70
|
+
from: From;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* The EventDeleteConversationEvent type
|
|
74
|
+
*
|
|
75
|
+
* @property kind The kind property of EventDeleteConversationEvent
|
|
76
|
+
* @property id The id property of EventDeleteConversationEvent
|
|
77
|
+
* @property timestamp The timestamp property of EventDeleteConversationEvent
|
|
78
|
+
* @property conversationId The conversationId property of EventDeleteConversationEvent
|
|
79
|
+
* @property from The {@link From} property of EventDeleteConversationEvent
|
|
80
|
+
* @property body The body property of EventDeleteConversationEvent
|
|
81
|
+
* @interface
|
|
82
|
+
* @group Chat
|
|
83
|
+
*/
|
|
84
|
+
export type EventDeleteConversationEvent = Omit<vonage.EventDeleteConversationEventJS, 'kind' | 'from'> & {
|
|
85
|
+
kind: 'event:delete';
|
|
86
|
+
from: From;
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* The MemberInvitedEvent type
|
|
90
|
+
*
|
|
91
|
+
* @property kind The kind property of MemberInvitedEvent
|
|
92
|
+
* @property id The event id
|
|
93
|
+
* @property timestamp The event timestamp
|
|
94
|
+
* @property conversationId The conversation id
|
|
95
|
+
* @property from The event sender
|
|
96
|
+
* @property body The invited member
|
|
97
|
+
* @interface
|
|
98
|
+
* @group Chat
|
|
99
|
+
*/
|
|
100
|
+
export type MemberInvitedEvent = Omit<vonage.MemberInvitedEventJS, 'kind' | 'from'> & {
|
|
101
|
+
kind: 'member:invited';
|
|
102
|
+
from: From;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
* The MemberJoinedEvent type
|
|
106
|
+
*
|
|
107
|
+
* @property kind The kind property of MemberJoinedEvent
|
|
108
|
+
* @property id The id property of MemberJoinedEvent
|
|
109
|
+
* @property timestamp The timestamp property of MemberJoinedEvent
|
|
110
|
+
* @property conversationId The conversationId property of MemberJoinedEvent
|
|
111
|
+
* @property from The {@link From} property of MemberJoinedEvent
|
|
112
|
+
* @property body The body property of MemberJoinedEvent
|
|
113
|
+
* @interface
|
|
114
|
+
* @group Chat
|
|
115
|
+
*/
|
|
116
|
+
export type MemberJoinedEvent = Omit<vonage.MemberJoinedEventJS, 'kind' | 'from'> & {
|
|
117
|
+
kind: 'member:joined';
|
|
118
|
+
from: From;
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* The MemberLeftEvent type
|
|
122
|
+
*
|
|
123
|
+
* @property kind The kind property of MemberLeftEvent
|
|
124
|
+
* @property id The id property of MemberLeftEvent
|
|
125
|
+
* @property timestamp The timestamp property of MemberLeftEvent
|
|
126
|
+
* @property conversationId The conversationId property of MemberLeftEvent
|
|
127
|
+
* @property from The {@link From} property of MemberLeftEvent
|
|
128
|
+
* @property body The body property of MemberLeftEvent
|
|
129
|
+
* @interface
|
|
130
|
+
* @group Chat
|
|
131
|
+
*/
|
|
132
|
+
export type MemberLeftEvent = Omit<vonage.MemberLeftEventJS, 'kind' | 'from'> & {
|
|
133
|
+
kind: 'member:left';
|
|
134
|
+
from: From;
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* The MessageAudioEvent type
|
|
138
|
+
*
|
|
139
|
+
* @property kind The kind property of MessageAudioEvent
|
|
140
|
+
* @property id The id property of MessageAudioEvent
|
|
141
|
+
* @property timestamp The timestamp property of MessageAudioEvent
|
|
142
|
+
* @property conversationId The conversationId property of MessageAudioEvent
|
|
143
|
+
* @property from The {@link From} property of MessageAudioEvent
|
|
144
|
+
* @property body The body property of MessageAudioEvent
|
|
145
|
+
* @property memberStatuses The memberStatuses property of MessageAudioEvent
|
|
146
|
+
* @interface
|
|
147
|
+
* @group Chat
|
|
148
|
+
*/
|
|
149
|
+
export type MessageAudioEvent = Omit<vonage.MessageAudioEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
150
|
+
kind: 'message:audio';
|
|
151
|
+
from: From;
|
|
152
|
+
body: MessageAudioEventBody;
|
|
153
|
+
memberStatuses: MemberStatus;
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* The MessageCustomEvent type
|
|
157
|
+
*
|
|
158
|
+
* @property kind The kind property of MessageCustomEvent
|
|
159
|
+
* @property id The id property of MessageCustomEvent
|
|
160
|
+
* @property timestamp The timestamp property of MessageCustomEvent
|
|
161
|
+
* @property conversationId The conversationId property of MessageCustomEvent
|
|
162
|
+
* @property from The {@link From} property of MessageCustomEvent
|
|
163
|
+
* @property body The body property of MessageCustomEvent
|
|
164
|
+
* @property memberStatuses The memberStatuses property of MessageCustomEvent
|
|
165
|
+
* @interface
|
|
166
|
+
* @group Chat
|
|
167
|
+
*/
|
|
168
|
+
export type MessageCustomEvent = Omit<vonage.MessageCustomEventJS, 'kind' | 'from' | 'memberStatuses'> & {
|
|
169
|
+
kind: 'message:custom';
|
|
170
|
+
from: From;
|
|
171
|
+
memberStatuses: MemberStatus;
|
|
172
|
+
};
|
|
173
|
+
/**
|
|
174
|
+
* The MessageDeliveredEvent type
|
|
175
|
+
*
|
|
176
|
+
* @property kind The kind property of MessageDeliveredEvent
|
|
177
|
+
* @property id The id property of MessageDeliveredEvent
|
|
178
|
+
* @property timestamp The timestamp property of MessageDeliveredEvent
|
|
179
|
+
* @property conversationId The conversationId property of MessageDeliveredEvent
|
|
180
|
+
* @property from The {@link From} property of MessageDeliveredEvent
|
|
181
|
+
* @property body The body property of MessageDeliveredEvent
|
|
182
|
+
* @interface
|
|
183
|
+
* @group Chat
|
|
184
|
+
*/
|
|
185
|
+
export type MessageDeliveredEvent = Omit<vonage.MessageDeliveredEventJS, 'kind' | 'from'> & {
|
|
186
|
+
kind: 'message:delivered';
|
|
187
|
+
from: From;
|
|
188
|
+
};
|
|
189
|
+
/**
|
|
190
|
+
* The MessageFileEvent type
|
|
191
|
+
*
|
|
192
|
+
* @property kind The kind property of MessageFileEvent
|
|
193
|
+
* @property id The id property of MessageFileEvent
|
|
194
|
+
* @property timestamp The timestamp property of MessageFileEvent
|
|
195
|
+
* @property conversationId The conversationId property of MessageFileEvent
|
|
196
|
+
* @property from The {@link From} property of MessageFileEvent
|
|
197
|
+
* @property body The body property of MessageFileEvent
|
|
198
|
+
* @property memberStatuses The memberStatuses property of MessageFileEvent
|
|
199
|
+
* @interface
|
|
200
|
+
* @group Chat
|
|
201
|
+
*/
|
|
202
|
+
export type MessageFileEvent = Omit<vonage.MessageFileEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
203
|
+
kind: 'message:file';
|
|
204
|
+
from: From;
|
|
205
|
+
body: MessageFileEventBody;
|
|
206
|
+
memberStatuses: MemberStatus;
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* The MessageImageEvent type
|
|
210
|
+
*
|
|
211
|
+
* @property kind The kind property of MessageImageEvent
|
|
212
|
+
* @property id The id property of MessageImageEvent
|
|
213
|
+
* @property timestamp The timestamp property of MessageImageEvent
|
|
214
|
+
* @property conversationId The conversationId property of MessageImageEvent
|
|
215
|
+
* @property from The {@link From} property of MessageImageEvent
|
|
216
|
+
* @property body The body property of MessageImageEvent
|
|
217
|
+
* @property memberStatuses The memberStatuses property of MessageImageEvent
|
|
218
|
+
* @interface
|
|
219
|
+
* @group Chat
|
|
220
|
+
*/
|
|
221
|
+
export type MessageImageEvent = Omit<vonage.MessageImageEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
222
|
+
kind: 'message:image';
|
|
223
|
+
from: From;
|
|
224
|
+
body: MessageImageEventBody;
|
|
225
|
+
memberStatuses: MemberStatus;
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* The MessageLocationEvent type
|
|
229
|
+
*
|
|
230
|
+
* @property kind The kind property of MessageLocationEvent
|
|
231
|
+
* @property id The id property of MessageLocationEvent
|
|
232
|
+
* @property timestamp The timestamp property of MessageLocationEvent
|
|
233
|
+
* @property conversationId The conversationId property of MessageLocationEvent
|
|
234
|
+
* @property from The {@link From} property of MessageLocationEvent
|
|
235
|
+
* @property body The body property of MessageLocationEvent
|
|
236
|
+
* @property memberStatuses The memberStatuses property of MessageLocationEvent
|
|
237
|
+
* @interface
|
|
238
|
+
* @group Chat
|
|
239
|
+
*/
|
|
240
|
+
export type MessageLocationEvent = Omit<vonage.MessageLocationEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
241
|
+
kind: 'message:location';
|
|
242
|
+
from: From;
|
|
243
|
+
body: MessageLocationEventBody;
|
|
244
|
+
memberStatuses: MemberStatus;
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* The MessageRejectedEvent type
|
|
248
|
+
*
|
|
249
|
+
* @property kind The kind property of MessageRejectedEvent
|
|
250
|
+
* @property id The id property of MessageRejectedEvent
|
|
251
|
+
* @property timestamp The timestamp property of MessageRejectedEvent
|
|
252
|
+
* @property conversationId The conversationId property of MessageRejectedEvent
|
|
253
|
+
* @property from The {@link From} property of MessageRejectedEvent
|
|
254
|
+
* @property body The body property of MessageRejectedEvent
|
|
255
|
+
* @interface
|
|
256
|
+
* @group Chat
|
|
257
|
+
*/
|
|
258
|
+
export type MessageRejectedEvent = Omit<vonage.MessageRejectedEventJS, 'kind' | 'from'> & {
|
|
259
|
+
kind: 'message:rejected';
|
|
260
|
+
from: From;
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* The MessageSeenEvent type
|
|
264
|
+
*
|
|
265
|
+
* @property kind The kind property of MessageSeenEvent
|
|
266
|
+
* @property id The id property of MessageSeenEvent
|
|
267
|
+
* @property timestamp The timestamp property of MessageSeenEvent
|
|
268
|
+
* @property conversationId The conversationId property of MessageSeenEvent
|
|
269
|
+
* @property from The {@link From} property of MessageSeenEvent
|
|
270
|
+
* @property body The body property of MessageSeenEvent
|
|
271
|
+
* @interface
|
|
272
|
+
* @group Chat
|
|
273
|
+
*/
|
|
274
|
+
export type MessageSeenEvent = Omit<vonage.MessageSeenEventJS, 'kind' | 'from'> & {
|
|
275
|
+
kind: 'message:seen';
|
|
276
|
+
from: From;
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* The MessageSubmittedEvent type
|
|
280
|
+
*
|
|
281
|
+
* @property kind The kind property of MessageSubmittedEvent
|
|
282
|
+
* @property id The id property of MessageSubmittedEvent
|
|
283
|
+
* @property timestamp The timestamp property of MessageSubmittedEvent
|
|
284
|
+
* @property conversationId The conversationId property of MessageSubmittedEvent
|
|
285
|
+
* @property from The {@link From} property of MessageSubmittedEvent
|
|
286
|
+
* @property body The body property of MessageSubmittedEvent
|
|
287
|
+
* @interface
|
|
288
|
+
* @group Chat
|
|
289
|
+
*/
|
|
290
|
+
export type MessageSubmittedEvent = Omit<vonage.MessageSubmittedEventJS, 'kind' | 'from'> & {
|
|
291
|
+
kind: 'message:submitted';
|
|
292
|
+
from: From;
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* The MessageTemplateEvent type
|
|
296
|
+
*
|
|
297
|
+
* @property kind The kind property of MessageTemplateEvent
|
|
298
|
+
* @property id The id property of MessageTemplateEvent
|
|
299
|
+
* @property timestamp The timestamp property of MessageTemplateEvent
|
|
300
|
+
* @property conversationId The conversationId property of MessageTemplateEvent
|
|
301
|
+
* @property from The {@link From} property of MessageTemplateEvent
|
|
302
|
+
* @property memberStatuses The memberStatuses property of MessageTemplateEvent
|
|
303
|
+
* @property body The body property of MessageTemplateEvent
|
|
304
|
+
* @interface
|
|
305
|
+
* @group Chat
|
|
306
|
+
*/
|
|
307
|
+
export type MessageTemplateEvent = Omit<vonage.MessageTemplateEventJS, 'kind' | 'from' | 'memberStatuses' | 'body'> & {
|
|
308
|
+
kind: 'message:template';
|
|
309
|
+
from: From;
|
|
310
|
+
memberStatuses: MemberStatus;
|
|
311
|
+
body: MessageTemplateEventBody;
|
|
312
|
+
};
|
|
313
|
+
/**
|
|
314
|
+
* The MessageTextEvent type
|
|
315
|
+
*
|
|
316
|
+
* @property kind The kind property of MessageTextEvent
|
|
317
|
+
* @property id The id property of MessageTextEvent
|
|
318
|
+
* @property timestamp The timestamp property of MessageTextEvent
|
|
319
|
+
* @property conversationId The conversationId property of MessageTextEvent
|
|
320
|
+
* @property from The {@link From} property of MessageTextEvent
|
|
321
|
+
* @property body The body property of MessageTextEvent
|
|
322
|
+
* @property memberStatuses The memberStatuses property of MessageTextEvent
|
|
323
|
+
* @interface
|
|
324
|
+
* @group Chat
|
|
325
|
+
*/
|
|
326
|
+
export type MessageTextEvent = Omit<vonage.MessageTextEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
327
|
+
kind: 'message:text';
|
|
328
|
+
from: From;
|
|
329
|
+
body: MessageTextEventBody;
|
|
330
|
+
memberStatuses: MemberStatus;
|
|
331
|
+
};
|
|
332
|
+
/**
|
|
333
|
+
* The MessageUndeliverableEvent type
|
|
334
|
+
*
|
|
335
|
+
* @property kind The kind property of MessageUndeliverableEvent
|
|
336
|
+
* @property id The id property of MessageUndeliverableEvent
|
|
337
|
+
* @property timestamp The timestamp property of MessageUndeliverableEvent
|
|
338
|
+
* @property conversationId The conversationId property of MessageUndeliverableEvent
|
|
339
|
+
* @property from The {@link From} property of MessageUndeliverableEvent
|
|
340
|
+
* @property body The body property of MessageUndeliverableEvent
|
|
341
|
+
* @interface
|
|
342
|
+
* @group Chat
|
|
343
|
+
*/
|
|
344
|
+
export type MessageUndeliverableEvent = Omit<vonage.MessageUndeliverableEventJS, 'kind' | 'from'> & {
|
|
345
|
+
kind: 'message:undeliverable';
|
|
346
|
+
from: From;
|
|
347
|
+
};
|
|
348
|
+
/**
|
|
349
|
+
* The MessageVCardEvent type
|
|
350
|
+
*
|
|
351
|
+
* @property kind The kind property of MessageVCardEvent
|
|
352
|
+
* @property id The id property of MessageVCardEvent
|
|
353
|
+
* @property timestamp The timestamp property of MessageVCardEvent
|
|
354
|
+
* @property conversationId The conversationId property of MessageVCardEvent
|
|
355
|
+
* @property from The {@link From} property of MessageVCardEvent
|
|
356
|
+
* @property body The body property of MessageVCardEvent
|
|
357
|
+
* @property memberStatuses The memberStatuses property of MessageVCardEvent
|
|
358
|
+
* @interface
|
|
359
|
+
* @group Chat
|
|
360
|
+
*/
|
|
361
|
+
export type MessageVCardEvent = Omit<vonage.MessageVCardEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
362
|
+
kind: 'message:vcard';
|
|
363
|
+
from: From;
|
|
364
|
+
body: MessageVCardEventBody;
|
|
365
|
+
memberStatuses: MemberStatus;
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
368
|
+
* The MessageVideoEvent type
|
|
369
|
+
*
|
|
370
|
+
* @property kind The kind property of MessageVideoEvent
|
|
371
|
+
* @property id The id property of MessageVideoEvent
|
|
372
|
+
* @property timestamp The timestamp property of MessageVideoEvent
|
|
373
|
+
* @property conversationId The conversationId property of MessageVideoEvent
|
|
374
|
+
* @property from The {@link From} property of MessageVideoEvent
|
|
375
|
+
* @property body The body property of MessageVideoEvent
|
|
376
|
+
* @property memberStatuses The memberStatuses property of MessageVideoEvent
|
|
377
|
+
* @interface
|
|
378
|
+
* @group Chat
|
|
379
|
+
*/
|
|
380
|
+
export type MessageVideoEvent = Omit<vonage.MessageVideoEventJS, 'kind' | 'from' | 'body' | 'memberStatuses'> & {
|
|
381
|
+
kind: 'message:video';
|
|
382
|
+
from: From;
|
|
383
|
+
body: MessageVideoEventBody;
|
|
384
|
+
memberStatuses: MemberStatus;
|
|
385
|
+
};
|
|
386
|
+
/**
|
|
387
|
+
* A PersistentConversationEvent is a discriminated union of {@link CustomConversationEvent}, {@link EventDeleteConversationEvent}, {@link MemberInvitedEvent}, {@link MemberJoinedEvent}, {@link MemberLeftEvent}, {@link MessageAudioEvent}, {@link MessageCustomEvent}, {@link MessageDeliveredEvent}, {@link MessageFileEvent}, {@link MessageImageEvent}, {@link MessageLocationEvent}, {@link MessageRejectedEvent}, {@link MessageSeenEvent}, {@link MessageSubmittedEvent}, {@link MessageTemplateEvent}, {@link MessageTextEvent}, {@link MessageUndeliverableEvent}, {@link MessageVCardEvent}, {@link MessageVideoEvent}
|
|
388
|
+
* @group Chat
|
|
389
|
+
*/
|
|
390
|
+
export type PersistentConversationEvent = CustomConversationEvent | EventDeleteConversationEvent | MemberInvitedEvent | MemberJoinedEvent | MemberLeftEvent | MessageAudioEvent | MessageCustomEvent | MessageDeliveredEvent | MessageFileEvent | MessageImageEvent | MessageLocationEvent | MessageRejectedEvent | MessageSeenEvent | MessageSubmittedEvent | MessageTemplateEvent | MessageTextEvent | MessageUndeliverableEvent | MessageVCardEvent | MessageVideoEvent;
|
|
391
|
+
/**
|
|
392
|
+
* A CSErrorCodesJS is a union of 'CONVERSATION_DUPLICATE_NAME', 'MEMBER_ALREADY_JOINED', 'MEMBER_ALREADY_INVITED', 'CONVERSATION_NOT_FOUND', 'MEMBER_NOT_FOUND', 'USER_NOT_FOUND', 'INVALID_CURSOR', 'VALIDATION_FAIL', 'CONVERSATION_MAX_NUMBER_OF_MEMBERS', 'CUSTOM_DATA_OVERALL_LIMIT_EXCEEDED'
|
|
393
|
+
*/
|
|
394
|
+
export type CSErrorCodesJS = 'CONVERSATION_DUPLICATE_NAME' | 'MEMBER_ALREADY_JOINED' | 'MEMBER_ALREADY_INVITED' | 'CONVERSATION_NOT_FOUND' | 'MEMBER_NOT_FOUND' | 'USER_NOT_FOUND' | 'INVALID_CURSOR' | 'VALIDATION_FAIL' | 'CONVERSATION_MAX_NUMBER_OF_MEMBERS' | 'CUSTOM_DATA_OVERALL_LIMIT_EXCEEDED';
|
|
395
|
+
/**
|
|
396
|
+
* A SessionErrorCodesJS is a union of 'EMPTY_TOKEN', 'FORCED_DISCONNECT', 'TIMEOUT', 'INTERNAL_FAILURE', 'NO_ACTIVE_SESSION', 'ALREADY_ACTIVE_SESSION', 'INVALID_TOKEN', 'EXPIRED_TOKEN', 'INVALID_USER', 'AUTHORIZATION_ERROR', 'INVALID_SESSION', 'MAX_OPEN_SESSIONS', 'INVALID_SOCKET_TRANSPORT', 'CLIENT_DISCONNECT', 'PING_TIMEOUT_DISCONNECT', 'TRANSPORT_CLOSED_DISCONNECT'
|
|
397
|
+
*/
|
|
398
|
+
export type SessionErrorCodesJS = 'EMPTY_TOKEN' | 'FORCED_DISCONNECT' | 'TIMEOUT' | 'INTERNAL_FAILURE' | 'NO_ACTIVE_SESSION' | 'ALREADY_ACTIVE_SESSION' | 'INVALID_TOKEN' | 'EXPIRED_TOKEN' | 'INVALID_USER' | 'AUTHORIZATION_ERROR' | 'INVALID_SESSION' | 'MAX_OPEN_SESSIONS' | 'INVALID_SOCKET_TRANSPORT' | 'CLIENT_DISCONNECT' | 'PING_TIMEOUT_DISCONNECT' | 'TRANSPORT_CLOSED_DISCONNECT';
|
|
399
|
+
/**
|
|
400
|
+
* A VoiceChannelTypeJS is a union of 'app', 'phone', 'sip', 'websocket'
|
|
401
|
+
*/
|
|
402
|
+
export type VoiceChannelTypeJS = 'app' | 'phone' | 'sip' | 'websocket';
|
|
403
|
+
/**
|
|
404
|
+
* A ConversationEvent is a union of {@link NonPersistentConversationEvent}, {@link PersistentConversationEvent}
|
|
405
|
+
* @group Chat
|
|
406
|
+
*/
|
|
407
|
+
export type ConversationEvent = NonPersistentConversationEvent | PersistentConversationEvent;
|
|
408
|
+
/**
|
|
409
|
+
* A CancelReasonJS is a union of 'RemoteCancel', 'AnsweredElsewhere', 'RejectedElsewhere', 'RemoteTimeout'
|
|
410
|
+
*/
|
|
411
|
+
export type CancelReasonJS = 'RemoteCancel' | 'AnsweredElsewhere' | 'RejectedElsewhere' | 'RemoteTimeout';
|
|
412
|
+
/**
|
|
413
|
+
* A ConversationState is a union of 'ACTIVE', 'INACTIVE', 'DELETED'
|
|
414
|
+
*/
|
|
415
|
+
export type ConversationState = 'ACTIVE' | 'INACTIVE' | 'DELETED';
|
|
416
|
+
/**
|
|
417
|
+
* A MemberState is a union of 'INVITED', 'JOINED', 'LEFT', 'UNKNOWN'
|
|
418
|
+
*/
|
|
419
|
+
export type MemberState = 'INVITED' | 'JOINED' | 'LEFT' | 'UNKNOWN';
|
|
420
|
+
/**
|
|
421
|
+
* A ConversationChannelType is a union of 'APP', 'PHONE', 'PSTN', 'sip', 'VBC', 'WEBSOCKET', 'SMS', 'MMS', 'WHATSAPP', 'VIBER', 'MESSENGER'
|
|
422
|
+
*/
|
|
423
|
+
export type ConversationChannelType = 'APP' | 'PHONE' | 'PSTN' | 'sip' | 'VBC' | 'WEBSOCKET' | 'SMS' | 'MMS' | 'WHATSAPP' | 'VIBER' | 'MESSENGER';
|
|
424
|
+
/**
|
|
425
|
+
* A SessionErrorReasonJS is a union of 'EXPIRED_TOKEN', 'TRANSPORT_CLOSED', 'PING_TIMEOUT'
|
|
426
|
+
*/
|
|
427
|
+
export type SessionErrorReasonJS = 'EXPIRED_TOKEN' | 'TRANSPORT_CLOSED' | 'PING_TIMEOUT';
|
|
428
|
+
/**
|
|
429
|
+
* A VonageErrorTypeJS is a union of 'CS_ERROR', 'NETWORK_ERROR', 'SESSION_ERROR', 'INTERNAL_ERROR', 'UNKNOWN_ERROR'
|
|
430
|
+
*/
|
|
431
|
+
export type VonageErrorTypeJS = 'CS_ERROR' | 'NETWORK_ERROR' | 'SESSION_ERROR' | 'INTERNAL_ERROR' | 'UNKNOWN_ERROR';
|
|
432
|
+
/**
|
|
433
|
+
* A LegStatusJS is a union of 'RINGING', 'ANSWERED', 'COMPLETED'
|
|
434
|
+
*/
|
|
435
|
+
export type LegStatusJS = 'RINGING' | 'ANSWERED' | 'COMPLETED';
|
|
436
|
+
/**
|
|
437
|
+
* A CallDisconnectReasonJS is a 'networkChange'
|
|
438
|
+
*/
|
|
439
|
+
export type CallDisconnectReasonJS = 'networkChange';
|
|
440
|
+
/**
|
|
441
|
+
* A HangupReasonJS is a union of 'REMOTE_HANGUP', 'REMOTE_REJECT', 'REMOTE_NO_ANSWER_TIMEOUT', 'LOCAL_HANGUP', 'MEDIA_TIMEOUT'
|
|
442
|
+
*/
|
|
443
|
+
export type HangupReasonJS = 'REMOTE_HANGUP' | 'REMOTE_REJECT' | 'REMOTE_NO_ANSWER_TIMEOUT' | 'LOCAL_HANGUP' | 'MEDIA_TIMEOUT';
|