@wildix/wda-stream-client 1.1.55 → 1.1.57

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 (36) hide show
  1. package/dist-cjs/WdaStream.js +6 -0
  2. package/dist-cjs/commands/GetOngoingCallAnnotationsCommand.js +21 -0
  3. package/dist-cjs/commands/GetOngoingChatAnnotationsCommand.js +21 -0
  4. package/dist-cjs/commands/GetOngoingConferenceAnnotationsCommand.js +21 -0
  5. package/dist-cjs/commands/index.js +3 -0
  6. package/dist-cjs/models/models_0.js +64 -25
  7. package/dist-cjs/models/models_1.js +7 -1
  8. package/dist-cjs/protocols/Aws_restJson1.js +300 -1
  9. package/dist-es/WdaStream.js +6 -0
  10. package/dist-es/commands/GetOngoingCallAnnotationsCommand.js +17 -0
  11. package/dist-es/commands/GetOngoingChatAnnotationsCommand.js +17 -0
  12. package/dist-es/commands/GetOngoingConferenceAnnotationsCommand.js +17 -0
  13. package/dist-es/commands/index.js +3 -0
  14. package/dist-es/models/models_0.js +62 -23
  15. package/dist-es/models/models_1.js +6 -0
  16. package/dist-es/protocols/Aws_restJson1.js +295 -2
  17. package/dist-types/WdaStream.d.ts +21 -0
  18. package/dist-types/WdaStreamClient.d.ts +5 -2
  19. package/dist-types/commands/ConsumeEventCommand.d.ts +111 -27
  20. package/dist-types/commands/DescribeEventCommand.d.ts +280 -90
  21. package/dist-types/commands/GetOngoingCallAnnotationsCommand.d.ts +286 -0
  22. package/dist-types/commands/GetOngoingCallCommand.d.ts +1 -0
  23. package/dist-types/commands/GetOngoingCallTranscriptionCommand.d.ts +2 -1
  24. package/dist-types/commands/GetOngoingChatAnnotationsCommand.d.ts +190 -0
  25. package/dist-types/commands/GetOngoingConferenceAnnotationsCommand.d.ts +134 -0
  26. package/dist-types/commands/GetOngoingConferenceCommand.d.ts +2 -1
  27. package/dist-types/commands/GetOngoingConferenceTranscriptionCommand.d.ts +3 -2
  28. package/dist-types/commands/QueryConversationsCommand.d.ts +6 -3
  29. package/dist-types/commands/index.d.ts +3 -0
  30. package/dist-types/models/models_0.d.ts +622 -277
  31. package/dist-types/models/models_1.d.ts +275 -1
  32. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  33. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  34. package/dist-types/runtimeConfig.d.ts +1 -1
  35. package/dist-types/runtimeConfig.native.d.ts +1 -1
  36. package/package.json +1 -1
package/dist-types/WdaStream.d.ts CHANGED
@@ -2,8 +2,11 @@ import { WdaStreamClient } from "./WdaStreamClient";
2
2
  import { ConsumeEventCommandInput, ConsumeEventCommandOutput } from "./commands/ConsumeEventCommand";
3
3
  import { DescribeEventCommandInput, DescribeEventCommandOutput } from "./commands/DescribeEventCommand";
4
4
  import { GetConferenceIdCommandInput, GetConferenceIdCommandOutput } from "./commands/GetConferenceIdCommand";
5
+ import { GetOngoingCallAnnotationsCommandInput, GetOngoingCallAnnotationsCommandOutput } from "./commands/GetOngoingCallAnnotationsCommand";
5
6
  import { GetOngoingCallCommandInput, GetOngoingCallCommandOutput } from "./commands/GetOngoingCallCommand";
6
7
  import { GetOngoingCallTranscriptionCommandInput, GetOngoingCallTranscriptionCommandOutput } from "./commands/GetOngoingCallTranscriptionCommand";
8
+ import { GetOngoingChatAnnotationsCommandInput, GetOngoingChatAnnotationsCommandOutput } from "./commands/GetOngoingChatAnnotationsCommand";
9
+ import { GetOngoingConferenceAnnotationsCommandInput, GetOngoingConferenceAnnotationsCommandOutput } from "./commands/GetOngoingConferenceAnnotationsCommand";
7
10
  import { GetOngoingConferenceCommandInput, GetOngoingConferenceCommandOutput } from "./commands/GetOngoingConferenceCommand";
8
11
  import { GetOngoingConferenceTranscriptionCommandInput, GetOngoingConferenceTranscriptionCommandOutput } from "./commands/GetOngoingConferenceTranscriptionCommand";
9
12
  import { ListServicesCommandInput, ListServicesCommandOutput } from "./commands/ListServicesCommand";
@@ -38,18 +41,36 @@ export interface WdaStream {
38
41
  getOngoingCall(args: GetOngoingCallCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingCallCommandOutput>;
39
42
  getOngoingCall(args: GetOngoingCallCommandInput, cb: (err: any, data?: GetOngoingCallCommandOutput) => void): void;
40
43
  getOngoingCall(args: GetOngoingCallCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingCallCommandOutput) => void): void;
44
+ /**
45
+ * @see {@link GetOngoingCallAnnotationsCommand}
46
+ */
47
+ getOngoingCallAnnotations(args: GetOngoingCallAnnotationsCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingCallAnnotationsCommandOutput>;
48
+ getOngoingCallAnnotations(args: GetOngoingCallAnnotationsCommandInput, cb: (err: any, data?: GetOngoingCallAnnotationsCommandOutput) => void): void;
49
+ getOngoingCallAnnotations(args: GetOngoingCallAnnotationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingCallAnnotationsCommandOutput) => void): void;
41
50
  /**
42
51
  * @see {@link GetOngoingCallTranscriptionCommand}
43
52
  */
44
53
  getOngoingCallTranscription(args: GetOngoingCallTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingCallTranscriptionCommandOutput>;
45
54
  getOngoingCallTranscription(args: GetOngoingCallTranscriptionCommandInput, cb: (err: any, data?: GetOngoingCallTranscriptionCommandOutput) => void): void;
46
55
  getOngoingCallTranscription(args: GetOngoingCallTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingCallTranscriptionCommandOutput) => void): void;
56
+ /**
57
+ * @see {@link GetOngoingChatAnnotationsCommand}
58
+ */
59
+ getOngoingChatAnnotations(args: GetOngoingChatAnnotationsCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingChatAnnotationsCommandOutput>;
60
+ getOngoingChatAnnotations(args: GetOngoingChatAnnotationsCommandInput, cb: (err: any, data?: GetOngoingChatAnnotationsCommandOutput) => void): void;
61
+ getOngoingChatAnnotations(args: GetOngoingChatAnnotationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingChatAnnotationsCommandOutput) => void): void;
47
62
  /**
48
63
  * @see {@link GetOngoingConferenceCommand}
49
64
  */
50
65
  getOngoingConference(args: GetOngoingConferenceCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingConferenceCommandOutput>;
51
66
  getOngoingConference(args: GetOngoingConferenceCommandInput, cb: (err: any, data?: GetOngoingConferenceCommandOutput) => void): void;
52
67
  getOngoingConference(args: GetOngoingConferenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingConferenceCommandOutput) => void): void;
68
+ /**
69
+ * @see {@link GetOngoingConferenceAnnotationsCommand}
70
+ */
71
+ getOngoingConferenceAnnotations(args: GetOngoingConferenceAnnotationsCommandInput, options?: __HttpHandlerOptions): Promise<GetOngoingConferenceAnnotationsCommandOutput>;
72
+ getOngoingConferenceAnnotations(args: GetOngoingConferenceAnnotationsCommandInput, cb: (err: any, data?: GetOngoingConferenceAnnotationsCommandOutput) => void): void;
73
+ getOngoingConferenceAnnotations(args: GetOngoingConferenceAnnotationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOngoingConferenceAnnotationsCommandOutput) => void): void;
53
74
  /**
54
75
  * @see {@link GetOngoingConferenceTranscriptionCommand}
55
76
  */
package/dist-types/WdaStreamClient.d.ts CHANGED
@@ -1,8 +1,11 @@
1
1
  import { ConsumeEventCommandInput, ConsumeEventCommandOutput } from "./commands/ConsumeEventCommand";
2
2
  import { DescribeEventCommandInput, DescribeEventCommandOutput } from "./commands/DescribeEventCommand";
3
3
  import { GetConferenceIdCommandInput, GetConferenceIdCommandOutput } from "./commands/GetConferenceIdCommand";
4
+ import { GetOngoingCallAnnotationsCommandInput, GetOngoingCallAnnotationsCommandOutput } from "./commands/GetOngoingCallAnnotationsCommand";
4
5
  import { GetOngoingCallCommandInput, GetOngoingCallCommandOutput } from "./commands/GetOngoingCallCommand";
5
6
  import { GetOngoingCallTranscriptionCommandInput, GetOngoingCallTranscriptionCommandOutput } from "./commands/GetOngoingCallTranscriptionCommand";
7
+ import { GetOngoingChatAnnotationsCommandInput, GetOngoingChatAnnotationsCommandOutput } from "./commands/GetOngoingChatAnnotationsCommand";
8
+ import { GetOngoingConferenceAnnotationsCommandInput, GetOngoingConferenceAnnotationsCommandOutput } from "./commands/GetOngoingConferenceAnnotationsCommand";
6
9
  import { GetOngoingConferenceCommandInput, GetOngoingConferenceCommandOutput } from "./commands/GetOngoingConferenceCommand";
7
10
  import { GetOngoingConferenceTranscriptionCommandInput, GetOngoingConferenceTranscriptionCommandOutput } from "./commands/GetOngoingConferenceTranscriptionCommand";
8
11
  import { ListServicesCommandInput, ListServicesCommandOutput } from "./commands/ListServicesCommand";
@@ -21,11 +24,11 @@ export { __Client };
21
24
  /**
22
25
  * @public
23
26
  */
24
- export type ServiceInputTypes = ConsumeEventCommandInput | DescribeEventCommandInput | GetConferenceIdCommandInput | GetOngoingCallCommandInput | GetOngoingCallTranscriptionCommandInput | GetOngoingConferenceCommandInput | GetOngoingConferenceTranscriptionCommandInput | ListServicesCommandInput | QueryConversationsCommandInput | QueryPresenceCommandInput | QueryPresencesCommandInput | UpdatePresenceLastSeenCommandInput;
27
+ export type ServiceInputTypes = ConsumeEventCommandInput | DescribeEventCommandInput | GetConferenceIdCommandInput | GetOngoingCallAnnotationsCommandInput | GetOngoingCallCommandInput | GetOngoingCallTranscriptionCommandInput | GetOngoingChatAnnotationsCommandInput | GetOngoingConferenceAnnotationsCommandInput | GetOngoingConferenceCommandInput | GetOngoingConferenceTranscriptionCommandInput | ListServicesCommandInput | QueryConversationsCommandInput | QueryPresenceCommandInput | QueryPresencesCommandInput | UpdatePresenceLastSeenCommandInput;
25
28
  /**
26
29
  * @public
27
30
  */
28
- export type ServiceOutputTypes = ConsumeEventCommandOutput | DescribeEventCommandOutput | GetConferenceIdCommandOutput | GetOngoingCallCommandOutput | GetOngoingCallTranscriptionCommandOutput | GetOngoingConferenceCommandOutput | GetOngoingConferenceTranscriptionCommandOutput | ListServicesCommandOutput | QueryConversationsCommandOutput | QueryPresenceCommandOutput | QueryPresencesCommandOutput | UpdatePresenceLastSeenCommandOutput;
31
+ export type ServiceOutputTypes = ConsumeEventCommandOutput | DescribeEventCommandOutput | GetConferenceIdCommandOutput | GetOngoingCallAnnotationsCommandOutput | GetOngoingCallCommandOutput | GetOngoingCallTranscriptionCommandOutput | GetOngoingChatAnnotationsCommandOutput | GetOngoingConferenceAnnotationsCommandOutput | GetOngoingConferenceCommandOutput | GetOngoingConferenceTranscriptionCommandOutput | ListServicesCommandOutput | QueryConversationsCommandOutput | QueryPresenceCommandOutput | QueryPresencesCommandOutput | UpdatePresenceLastSeenCommandOutput;
29
32
  /**
30
33
  * @public
31
34
  */
package/dist-types/commands/ConsumeEventCommand.d.ts CHANGED
@@ -41,7 +41,7 @@ declare const ConsumeEventCommand_base: {
41
41
  * time: Number("long"), // required
42
42
  * pbx: "STRING_VALUE", // required
43
43
  * company: "STRING_VALUE", // required
44
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
44
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
45
45
  * data: { // CallStartConsumeEventData
46
46
  * caller: { // CallFlowConsumeParticipant
47
47
  * phone: "STRING_VALUE",
@@ -106,7 +106,7 @@ declare const ConsumeEventCommand_base: {
106
106
  * time: Number("long"), // required
107
107
  * pbx: "STRING_VALUE", // required
108
108
  * company: "STRING_VALUE", // required
109
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
109
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
110
110
  * data: { // CallUpdateConsumeEventData
111
111
  * caller: {
112
112
  * phone: "STRING_VALUE",
@@ -172,7 +172,7 @@ declare const ConsumeEventCommand_base: {
172
172
  * time: Number("long"), // required
173
173
  * pbx: "STRING_VALUE", // required
174
174
  * company: "STRING_VALUE", // required
175
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
175
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
176
176
  * data: { // CallSplitConsumeEventData
177
177
  * caller: {
178
178
  * phone: "STRING_VALUE",
@@ -221,6 +221,35 @@ declare const ConsumeEventCommand_base: {
221
221
  * postTranscribe: true || false,
222
222
  * },
223
223
  * },
224
+ * callAnnotate: { // CallAnnotateConsumeEvent
225
+ * id: "STRING_VALUE", // required
226
+ * time: Number("long"), // required
227
+ * pbx: "STRING_VALUE", // required
228
+ * company: "STRING_VALUE", // required
229
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
230
+ * data: { // CallAnnotateConsumeEventData
231
+ * flowIndex: Number("int"), // required
232
+ * annotation: { // Annotation
233
+ * id: "STRING_VALUE", // required
234
+ * time: Number("long"), // required
235
+ * payload: { // AnnotationPayload Union: only one key present
236
+ * tag: "STRING_VALUE",
237
+ * text: "STRING_VALUE",
238
+ * variables: { // AnnotationVariablesValue
239
+ * value: "DOCUMENT_VALUE", // required
240
+ * },
241
+ * result: { // AnnotationResultValue
242
+ * value: "DOCUMENT_VALUE", // required
243
+ * },
244
+ * },
245
+ * source: { // AnnotationSource
246
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
247
+ * id: "STRING_VALUE",
248
+ * name: "STRING_VALUE",
249
+ * },
250
+ * },
251
+ * },
252
+ * },
224
253
  * callLive: { // CallLiveConsumeEvent
225
254
  * id: "STRING_VALUE", // required
226
255
  * time: Number("long"), // required
@@ -232,7 +261,7 @@ declare const ConsumeEventCommand_base: {
232
261
  * time: Number("long"), // required
233
262
  * pbx: "STRING_VALUE", // required
234
263
  * company: "STRING_VALUE", // required
235
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
264
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
236
265
  * data: { // CallAgentsStartOrEndConsumeEventData
237
266
  * agents: [ // CallAgentsItemConsumeItemList // required
238
267
  * { // CallAgentsItemConsumeItem
@@ -247,7 +276,7 @@ declare const ConsumeEventCommand_base: {
247
276
  * time: Number("long"), // required
248
277
  * pbx: "STRING_VALUE", // required
249
278
  * company: "STRING_VALUE", // required
250
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
279
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
251
280
  * data: {
252
281
  * agents: [ // required
253
282
  * {
@@ -262,7 +291,7 @@ declare const ConsumeEventCommand_base: {
262
291
  * time: Number("long"), // required
263
292
  * pbx: "STRING_VALUE", // required
264
293
  * company: "STRING_VALUE", // required
265
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
294
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
266
295
  * data: { // CallEndConsumeEventData
267
296
  * mos: {
268
297
  * caller: "STRING_VALUE",
@@ -279,7 +308,7 @@ declare const ConsumeEventCommand_base: {
279
308
  * time: Number("long"), // required
280
309
  * pbx: "STRING_VALUE", // required
281
310
  * company: "STRING_VALUE", // required
282
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
311
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
283
312
  * data: { // CallRecordStartConsumeEventData
284
313
  * fileName: "STRING_VALUE", // required
285
314
  * start: Number("long"), // required
@@ -291,7 +320,7 @@ declare const ConsumeEventCommand_base: {
291
320
  * time: Number("long"), // required
292
321
  * pbx: "STRING_VALUE", // required
293
322
  * company: "STRING_VALUE", // required
294
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
323
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
295
324
  * data: { // CallRecordStopConsumeEventData
296
325
  * fileName: "STRING_VALUE", // required
297
326
  * url: "STRING_VALUE", // required
@@ -311,7 +340,7 @@ declare const ConsumeEventCommand_base: {
311
340
  * time: Number("long"), // required
312
341
  * pbx: "STRING_VALUE", // required
313
342
  * company: "STRING_VALUE", // required
314
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
343
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
315
344
  * data: { // CallRecordPauseConsumeEventData
316
345
  * start: Number("long"), // required
317
346
  * reason: "pause" || "hold", // required
@@ -322,7 +351,7 @@ declare const ConsumeEventCommand_base: {
322
351
  * time: Number("long"), // required
323
352
  * pbx: "STRING_VALUE", // required
324
353
  * company: "STRING_VALUE", // required
325
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
354
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
326
355
  * data: { // CallRecordUnpauseConsumeEventData
327
356
  * end: Number("long"), // required
328
357
  * },
@@ -332,7 +361,7 @@ declare const ConsumeEventCommand_base: {
332
361
  * time: Number("long"), // required
333
362
  * pbx: "STRING_VALUE", // required
334
363
  * company: "STRING_VALUE", // required
335
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
364
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
336
365
  * data: { // CallAttachmentConsumeEventData
337
366
  * type: "voicemail" || "fax" || "transcription", // required
338
367
  * url: "STRING_VALUE", // required
@@ -357,7 +386,7 @@ declare const ConsumeEventCommand_base: {
357
386
  * time: Number("long"), // required
358
387
  * pbx: "STRING_VALUE", // required
359
388
  * company: "STRING_VALUE", // required
360
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
389
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
361
390
  * data: { // CallTranscribeConsumeEventData
362
391
  * flowId: Number("int"), // required
363
392
  * id: "STRING_VALUE", // required
@@ -375,12 +404,12 @@ declare const ConsumeEventCommand_base: {
375
404
  * time: Number("long"), // required
376
405
  * pbx: "STRING_VALUE", // required
377
406
  * company: "STRING_VALUE", // required
378
- * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
407
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.ANNOTATE" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.RECORD_PAUSE" || "CALL.RECORD_UNPAUSE" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION" || "CALL.POST_TRANSCRIPTION", // required
379
408
  * data: { // CallPostTranscriptionConsumeEventData
380
409
  * flowIndex: Number("int"), // required
381
410
  * flowStartTime: Number("long"), // required
382
411
  * callStartTime: Number("long"), // required
383
- * type: "chat" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
412
+ * type: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
384
413
  * cds: { // CdsTranscriptionPayloadReference
385
414
  * id: "STRING_VALUE", // required
386
415
  * },
@@ -391,7 +420,7 @@ declare const ConsumeEventCommand_base: {
391
420
  * room: "STRING_VALUE", // required
392
421
  * session: "STRING_VALUE", // required
393
422
  * time: Number("long"), // required
394
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
423
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
395
424
  * data: { // ConferenceTimeFramesConsumeEventData
396
425
  * timeFrames: [ // ConferenceTimeFramesList // required
397
426
  * { // ConferenceTimeFramesListItem
@@ -410,7 +439,7 @@ declare const ConsumeEventCommand_base: {
410
439
  * room: "STRING_VALUE", // required
411
440
  * session: "STRING_VALUE", // required
412
441
  * time: Number("long"), // required
413
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
442
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
414
443
  * provider: "STRING_VALUE",
415
444
  * direction: "internal" || "inbound" || "outbound",
416
445
  * service: "STRING_VALUE",
@@ -424,7 +453,7 @@ declare const ConsumeEventCommand_base: {
424
453
  * room: "STRING_VALUE", // required
425
454
  * session: "STRING_VALUE", // required
426
455
  * time: Number("long"), // required
427
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
456
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
428
457
  * data: { // ConferenceJoinConsumeEventData
429
458
  * jid: "STRING_VALUE",
430
459
  * name: "STRING_VALUE",
@@ -438,11 +467,39 @@ declare const ConsumeEventCommand_base: {
438
467
  * xbsId: "STRING_VALUE",
439
468
  * },
440
469
  * },
470
+ * conferenceAnnotate: { // ConferenceAnnotateConsumeEvent
471
+ * room: "STRING_VALUE", // required
472
+ * session: "STRING_VALUE", // required
473
+ * time: Number("long"), // required
474
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
475
+ * data: { // ConferenceAnnotateConsumeEventData
476
+ * company: "STRING_VALUE",
477
+ * annotation: {
478
+ * id: "STRING_VALUE", // required
479
+ * time: Number("long"), // required
480
+ * payload: {// Union: only one key present
481
+ * tag: "STRING_VALUE",
482
+ * text: "STRING_VALUE",
483
+ * variables: {
484
+ * value: "DOCUMENT_VALUE", // required
485
+ * },
486
+ * result: {
487
+ * value: "DOCUMENT_VALUE", // required
488
+ * },
489
+ * },
490
+ * source: {
491
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
492
+ * id: "STRING_VALUE",
493
+ * name: "STRING_VALUE",
494
+ * },
495
+ * },
496
+ * },
497
+ * },
441
498
  * conferenceRecordStart: { // ConferenceRecordStartConsumeEvent
442
499
  * room: "STRING_VALUE", // required
443
500
  * session: "STRING_VALUE", // required
444
501
  * time: Number("long"), // required
445
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
502
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
446
503
  * data: { // ConferenceRecordStartConsumeEventData
447
504
  * jid: "STRING_VALUE",
448
505
  * },
@@ -451,7 +508,7 @@ declare const ConsumeEventCommand_base: {
451
508
  * room: "STRING_VALUE", // required
452
509
  * session: "STRING_VALUE", // required
453
510
  * time: Number("long"), // required
454
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
511
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
455
512
  * data: { // ConferenceTranscriptionConsumeEventData
456
513
  * id: "STRING_VALUE", // required
457
514
  * jid: "STRING_VALUE", // required
@@ -468,7 +525,7 @@ declare const ConsumeEventCommand_base: {
468
525
  * room: "STRING_VALUE", // required
469
526
  * session: "STRING_VALUE", // required
470
527
  * time: Number("long"), // required
471
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
528
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
472
529
  * data: { // ConferenceLeaveConsumeEventData
473
530
  * jid: "STRING_VALUE",
474
531
  * },
@@ -477,7 +534,7 @@ declare const ConsumeEventCommand_base: {
477
534
  * room: "STRING_VALUE", // required
478
535
  * session: "STRING_VALUE", // required
479
536
  * time: Number("long"), // required
480
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
537
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
481
538
  * data: { // ConferenceRecordStopConsumeEventData
482
539
  * jid: "STRING_VALUE", // required
483
540
  * link: "STRING_VALUE", // required
@@ -486,7 +543,7 @@ declare const ConsumeEventCommand_base: {
486
543
  * },
487
544
  * },
488
545
  * conferenceKeepAlive: { // ConferenceKeepAliveConsumeEvent
489
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
546
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
490
547
  * time: Number("long"), // required
491
548
  * sessions: [ // ConferenceKeepAliveSessions // required
492
549
  * "STRING_VALUE",
@@ -496,13 +553,13 @@ declare const ConsumeEventCommand_base: {
496
553
  * room: "STRING_VALUE", // required
497
554
  * session: "STRING_VALUE", // required
498
555
  * time: Number("long"), // required
499
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
556
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
500
557
  * },
501
558
  * conferenceStats: { // ConferenceStatsConsumeEvent
502
559
  * room: "STRING_VALUE", // required
503
560
  * session: "STRING_VALUE", // required
504
561
  * time: Number("long"), // required
505
- * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
562
+ * type: "CONFERENCE.START" || "CONFERENCE.JOIN" || "CONFERENCE.ANNOTATE" || "CONFERENCE.RECORD_START" || "CONFERENCE.TRANSCRIPTION" || "CONFERENCE.LEAVE" || "CONFERENCE.RECORD_STOP" || "CONFERENCE.KEEP_ALIVE" || "CONFERENCE.TIMEFRAMES" || "CONFERENCE.END" || "CONFERENCE.STATS", // required
506
563
  * data: [ // ConferenceStatsConsumeEventData // required
507
564
  * { // ConferenceSpeakerTime
508
565
  * jid: "STRING_VALUE", // required
@@ -511,7 +568,7 @@ declare const ConsumeEventCommand_base: {
511
568
  * ],
512
569
  * },
513
570
  * chatMessage: { // ChatMessageConsumeEvent
514
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
571
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
515
572
  * company: "STRING_VALUE", // required
516
573
  * time: Number("long"), // required
517
574
  * data: { // ChatMessageConsumeEventData
@@ -755,7 +812,7 @@ declare const ConsumeEventCommand_base: {
755
812
  * },
756
813
  * },
757
814
  * chatNew: { // ChatNewConsumeEvent
758
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
815
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
759
816
  * company: "STRING_VALUE", // required
760
817
  * time: Number("long"), // required
761
818
  * data: { // ChatNewConsumeEventData
@@ -779,7 +836,7 @@ declare const ConsumeEventCommand_base: {
779
836
  * },
780
837
  * },
781
838
  * chatUpdate: { // ChatUpdateConsumeEvent
782
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
839
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
783
840
  * company: "STRING_VALUE", // required
784
841
  * time: Number("long"), // required
785
842
  * data: { // ChatUpdateConsumeEventData
@@ -799,6 +856,33 @@ declare const ConsumeEventCommand_base: {
799
856
  * ],
800
857
  * },
801
858
  * },
859
+ * chatAnnotate: { // ChatAnnotateConsumeEvent
860
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
861
+ * company: "STRING_VALUE", // required
862
+ * time: Number("long"), // required
863
+ * data: { // ChatAnnotateConsumeEventData
864
+ * chatId: "STRING_VALUE", // required
865
+ * annotation: {
866
+ * id: "STRING_VALUE", // required
867
+ * time: Number("long"), // required
868
+ * payload: {// Union: only one key present
869
+ * tag: "STRING_VALUE",
870
+ * text: "STRING_VALUE",
871
+ * variables: {
872
+ * value: "DOCUMENT_VALUE", // required
873
+ * },
874
+ * result: {
875
+ * value: "DOCUMENT_VALUE", // required
876
+ * },
877
+ * },
878
+ * source: {
879
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
880
+ * id: "STRING_VALUE",
881
+ * name: "STRING_VALUE",
882
+ * },
883
+ * },
884
+ * },
885
+ * },
802
886
  * smsInbound: { // SmsInboundConsumeEvent
803
887
  * pbx: "STRING_VALUE", // required
804
888
  * company: "STRING_VALUE", // required