@wildix/wda-stream-client 1.1.60 → 1.1.61

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 (33) 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 +70 -25
  7. package/dist-cjs/models/models_1.js +7 -1
  8. package/dist-cjs/protocols/Aws_restJson1.js +396 -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 +68 -23
  15. package/dist-es/models/models_1.js +6 -0
  16. package/dist-es/protocols/Aws_restJson1.js +391 -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 +447 -93
  21. package/dist-types/commands/GetOngoingCallAnnotationsCommand.d.ts +287 -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 +719 -361
  31. package/dist-types/models/models_1.d.ts +375 -1
  32. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  33. package/package.json +1 -1
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",
@@ -107,7 +107,7 @@ declare const ConsumeEventCommand_base: {
107
107
  * time: Number("long"), // required
108
108
  * pbx: "STRING_VALUE", // required
109
109
  * company: "STRING_VALUE", // required
110
- * 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
110
+ * 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
111
111
  * data: { // CallUpdateConsumeEventData
112
112
  * caller: {
113
113
  * phone: "STRING_VALUE",
@@ -174,7 +174,7 @@ declare const ConsumeEventCommand_base: {
174
174
  * time: Number("long"), // required
175
175
  * pbx: "STRING_VALUE", // required
176
176
  * company: "STRING_VALUE", // required
177
- * 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
177
+ * 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
178
178
  * data: { // CallSplitConsumeEventData
179
179
  * caller: {
180
180
  * phone: "STRING_VALUE",
@@ -224,6 +224,35 @@ declare const ConsumeEventCommand_base: {
224
224
  * postTranscribe: true || false,
225
225
  * },
226
226
  * },
227
+ * callAnnotate: { // CallAnnotateConsumeEvent
228
+ * id: "STRING_VALUE", // required
229
+ * time: Number("long"), // required
230
+ * pbx: "STRING_VALUE", // required
231
+ * company: "STRING_VALUE", // required
232
+ * 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
233
+ * data: { // CallAnnotateConsumeEventData
234
+ * flowIndex: Number("int"), // required
235
+ * annotation: { // Annotation
236
+ * id: "STRING_VALUE", // required
237
+ * time: Number("long"), // required
238
+ * payload: { // AnnotationPayload Union: only one key present
239
+ * tag: "STRING_VALUE",
240
+ * text: "STRING_VALUE",
241
+ * variables: { // AnnotationVariablesValue
242
+ * value: "DOCUMENT_VALUE", // required
243
+ * },
244
+ * result: { // AnnotationResultValue
245
+ * value: "DOCUMENT_VALUE", // required
246
+ * },
247
+ * },
248
+ * source: { // AnnotationSource
249
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
250
+ * id: "STRING_VALUE",
251
+ * name: "STRING_VALUE",
252
+ * },
253
+ * },
254
+ * },
255
+ * },
227
256
  * callLive: { // CallLiveConsumeEvent
228
257
  * id: "STRING_VALUE", // required
229
258
  * time: Number("long"), // required
@@ -235,7 +264,7 @@ declare const ConsumeEventCommand_base: {
235
264
  * time: Number("long"), // required
236
265
  * pbx: "STRING_VALUE", // required
237
266
  * company: "STRING_VALUE", // required
238
- * 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
267
+ * 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
239
268
  * data: { // CallAgentsStartOrEndConsumeEventData
240
269
  * agents: [ // CallAgentsItemConsumeItemList // required
241
270
  * { // CallAgentsItemConsumeItem
@@ -250,7 +279,7 @@ declare const ConsumeEventCommand_base: {
250
279
  * time: Number("long"), // required
251
280
  * pbx: "STRING_VALUE", // required
252
281
  * company: "STRING_VALUE", // required
253
- * 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
282
+ * 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
254
283
  * data: {
255
284
  * agents: [ // required
256
285
  * {
@@ -265,7 +294,7 @@ declare const ConsumeEventCommand_base: {
265
294
  * time: Number("long"), // required
266
295
  * pbx: "STRING_VALUE", // required
267
296
  * company: "STRING_VALUE", // required
268
- * 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
297
+ * 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
269
298
  * data: { // CallEndConsumeEventData
270
299
  * mos: {
271
300
  * caller: "STRING_VALUE",
@@ -282,7 +311,7 @@ declare const ConsumeEventCommand_base: {
282
311
  * time: Number("long"), // required
283
312
  * pbx: "STRING_VALUE", // required
284
313
  * company: "STRING_VALUE", // required
285
- * 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
314
+ * 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
286
315
  * data: { // CallRecordStartConsumeEventData
287
316
  * fileName: "STRING_VALUE", // required
288
317
  * start: Number("long"), // required
@@ -294,7 +323,7 @@ declare const ConsumeEventCommand_base: {
294
323
  * time: Number("long"), // required
295
324
  * pbx: "STRING_VALUE", // required
296
325
  * company: "STRING_VALUE", // required
297
- * 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
326
+ * 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
298
327
  * data: { // CallRecordStopConsumeEventData
299
328
  * fileName: "STRING_VALUE", // required
300
329
  * url: "STRING_VALUE", // required
@@ -314,7 +343,7 @@ declare const ConsumeEventCommand_base: {
314
343
  * time: Number("long"), // required
315
344
  * pbx: "STRING_VALUE", // required
316
345
  * company: "STRING_VALUE", // required
317
- * 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
346
+ * 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
318
347
  * data: { // CallRecordPauseConsumeEventData
319
348
  * start: Number("long"), // required
320
349
  * reason: "pause" || "hold", // required
@@ -325,7 +354,7 @@ declare const ConsumeEventCommand_base: {
325
354
  * time: Number("long"), // required
326
355
  * pbx: "STRING_VALUE", // required
327
356
  * company: "STRING_VALUE", // required
328
- * 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
357
+ * 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
329
358
  * data: { // CallRecordUnpauseConsumeEventData
330
359
  * end: Number("long"), // required
331
360
  * },
@@ -335,7 +364,7 @@ declare const ConsumeEventCommand_base: {
335
364
  * time: Number("long"), // required
336
365
  * pbx: "STRING_VALUE", // required
337
366
  * company: "STRING_VALUE", // required
338
- * 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
367
+ * 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
339
368
  * data: { // CallAttachmentConsumeEventData
340
369
  * type: "voicemail" || "fax" || "transcription", // required
341
370
  * url: "STRING_VALUE", // required
@@ -360,7 +389,7 @@ declare const ConsumeEventCommand_base: {
360
389
  * time: Number("long"), // required
361
390
  * pbx: "STRING_VALUE", // required
362
391
  * company: "STRING_VALUE", // required
363
- * 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
392
+ * 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
364
393
  * data: { // CallTranscribeConsumeEventData
365
394
  * flowId: Number("int"), // required
366
395
  * id: "STRING_VALUE", // required
@@ -378,12 +407,12 @@ declare const ConsumeEventCommand_base: {
378
407
  * time: Number("long"), // required
379
408
  * pbx: "STRING_VALUE", // required
380
409
  * company: "STRING_VALUE", // required
381
- * 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
410
+ * 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
382
411
  * data: { // CallPostTranscriptionConsumeEventData
383
412
  * flowIndex: Number("int"), // required
384
413
  * flowStartTime: Number("long"), // required
385
414
  * callStartTime: Number("long"), // required
386
- * 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_agent_status" || "service_call" || "service_call_complete", // required
415
+ * 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_agent_status" || "service_call" || "service_call_complete", // required
387
416
  * cds: { // CdsTranscriptionPayloadReference
388
417
  * id: "STRING_VALUE", // required
389
418
  * },
@@ -394,7 +423,7 @@ declare const ConsumeEventCommand_base: {
394
423
  * room: "STRING_VALUE", // required
395
424
  * session: "STRING_VALUE", // required
396
425
  * time: Number("long"), // required
397
- * 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
426
+ * 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
398
427
  * data: { // ConferenceTimeFramesConsumeEventData
399
428
  * timeFrames: [ // ConferenceTimeFramesList // required
400
429
  * { // ConferenceTimeFramesListItem
@@ -413,7 +442,7 @@ declare const ConsumeEventCommand_base: {
413
442
  * room: "STRING_VALUE", // required
414
443
  * session: "STRING_VALUE", // required
415
444
  * time: Number("long"), // required
416
- * 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
445
+ * 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
417
446
  * provider: "STRING_VALUE",
418
447
  * direction: "internal" || "inbound" || "outbound",
419
448
  * service: "STRING_VALUE",
@@ -427,7 +456,7 @@ declare const ConsumeEventCommand_base: {
427
456
  * room: "STRING_VALUE", // required
428
457
  * session: "STRING_VALUE", // required
429
458
  * time: Number("long"), // required
430
- * 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
459
+ * 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
431
460
  * data: { // ConferenceJoinConsumeEventData
432
461
  * jid: "STRING_VALUE",
433
462
  * name: "STRING_VALUE",
@@ -441,11 +470,39 @@ declare const ConsumeEventCommand_base: {
441
470
  * xbsId: "STRING_VALUE",
442
471
  * },
443
472
  * },
473
+ * conferenceAnnotate: { // ConferenceAnnotateConsumeEvent
474
+ * room: "STRING_VALUE", // required
475
+ * session: "STRING_VALUE", // required
476
+ * time: Number("long"), // required
477
+ * 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
478
+ * data: { // ConferenceAnnotateConsumeEventData
479
+ * company: "STRING_VALUE",
480
+ * annotation: {
481
+ * id: "STRING_VALUE", // required
482
+ * time: Number("long"), // required
483
+ * payload: {// Union: only one key present
484
+ * tag: "STRING_VALUE",
485
+ * text: "STRING_VALUE",
486
+ * variables: {
487
+ * value: "DOCUMENT_VALUE", // required
488
+ * },
489
+ * result: {
490
+ * value: "DOCUMENT_VALUE", // required
491
+ * },
492
+ * },
493
+ * source: {
494
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
495
+ * id: "STRING_VALUE",
496
+ * name: "STRING_VALUE",
497
+ * },
498
+ * },
499
+ * },
500
+ * },
444
501
  * conferenceRecordStart: { // ConferenceRecordStartConsumeEvent
445
502
  * room: "STRING_VALUE", // required
446
503
  * session: "STRING_VALUE", // required
447
504
  * time: Number("long"), // required
448
- * 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
505
+ * 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
449
506
  * data: { // ConferenceRecordStartConsumeEventData
450
507
  * jid: "STRING_VALUE",
451
508
  * },
@@ -454,7 +511,7 @@ declare const ConsumeEventCommand_base: {
454
511
  * room: "STRING_VALUE", // required
455
512
  * session: "STRING_VALUE", // required
456
513
  * time: Number("long"), // required
457
- * 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
514
+ * 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
458
515
  * data: { // ConferenceTranscriptionConsumeEventData
459
516
  * id: "STRING_VALUE", // required
460
517
  * jid: "STRING_VALUE", // required
@@ -471,7 +528,7 @@ declare const ConsumeEventCommand_base: {
471
528
  * room: "STRING_VALUE", // required
472
529
  * session: "STRING_VALUE", // required
473
530
  * time: Number("long"), // required
474
- * 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
531
+ * 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
532
  * data: { // ConferenceLeaveConsumeEventData
476
533
  * jid: "STRING_VALUE",
477
534
  * },
@@ -480,7 +537,7 @@ declare const ConsumeEventCommand_base: {
480
537
  * room: "STRING_VALUE", // required
481
538
  * session: "STRING_VALUE", // required
482
539
  * time: Number("long"), // required
483
- * 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
540
+ * 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
484
541
  * data: { // ConferenceRecordStopConsumeEventData
485
542
  * jid: "STRING_VALUE", // required
486
543
  * link: "STRING_VALUE", // required
@@ -489,7 +546,7 @@ declare const ConsumeEventCommand_base: {
489
546
  * },
490
547
  * },
491
548
  * conferenceKeepAlive: { // ConferenceKeepAliveConsumeEvent
492
- * 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
549
+ * 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
493
550
  * time: Number("long"), // required
494
551
  * sessions: [ // ConferenceKeepAliveSessions // required
495
552
  * "STRING_VALUE",
@@ -499,13 +556,13 @@ declare const ConsumeEventCommand_base: {
499
556
  * room: "STRING_VALUE", // required
500
557
  * session: "STRING_VALUE", // required
501
558
  * time: Number("long"), // required
502
- * 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
559
+ * 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
503
560
  * },
504
561
  * conferenceStats: { // ConferenceStatsConsumeEvent
505
562
  * room: "STRING_VALUE", // required
506
563
  * session: "STRING_VALUE", // required
507
564
  * time: Number("long"), // required
508
- * 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
565
+ * 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
509
566
  * data: [ // ConferenceStatsConsumeEventData // required
510
567
  * { // ConferenceSpeakerTime
511
568
  * jid: "STRING_VALUE", // required
@@ -514,7 +571,7 @@ declare const ConsumeEventCommand_base: {
514
571
  * ],
515
572
  * },
516
573
  * chatMessage: { // ChatMessageConsumeEvent
517
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
574
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
518
575
  * company: "STRING_VALUE", // required
519
576
  * time: Number("long"), // required
520
577
  * data: { // ChatMessageConsumeEventData
@@ -758,7 +815,7 @@ declare const ConsumeEventCommand_base: {
758
815
  * },
759
816
  * },
760
817
  * chatNew: { // ChatNewConsumeEvent
761
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
818
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
762
819
  * company: "STRING_VALUE", // required
763
820
  * time: Number("long"), // required
764
821
  * data: { // ChatNewConsumeEventData
@@ -782,7 +839,7 @@ declare const ConsumeEventCommand_base: {
782
839
  * },
783
840
  * },
784
841
  * chatUpdate: { // ChatUpdateConsumeEvent
785
- * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE", // required
842
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
786
843
  * company: "STRING_VALUE", // required
787
844
  * time: Number("long"), // required
788
845
  * data: { // ChatUpdateConsumeEventData
@@ -802,6 +859,33 @@ declare const ConsumeEventCommand_base: {
802
859
  * ],
803
860
  * },
804
861
  * },
862
+ * chatAnnotate: { // ChatAnnotateConsumeEvent
863
+ * type: "CHAT.MESSAGE" || "CHAT.NEW" || "CHAT.UPDATE" || "CHAT.ANNOTATE", // required
864
+ * company: "STRING_VALUE", // required
865
+ * time: Number("long"), // required
866
+ * data: { // ChatAnnotateConsumeEventData
867
+ * chatId: "STRING_VALUE", // required
868
+ * annotation: {
869
+ * id: "STRING_VALUE", // required
870
+ * time: Number("long"), // required
871
+ * payload: {// Union: only one key present
872
+ * tag: "STRING_VALUE",
873
+ * text: "STRING_VALUE",
874
+ * variables: {
875
+ * value: "DOCUMENT_VALUE", // required
876
+ * },
877
+ * result: {
878
+ * value: "DOCUMENT_VALUE", // required
879
+ * },
880
+ * },
881
+ * source: {
882
+ * type: "chatbot" || "voicebot" || "user" || "system", // required
883
+ * id: "STRING_VALUE",
884
+ * name: "STRING_VALUE",
885
+ * },
886
+ * },
887
+ * },
888
+ * },
805
889
  * smsInbound: { // SmsInboundConsumeEvent
806
890
  * pbx: "STRING_VALUE", // required
807
891
  * company: "STRING_VALUE", // required