@wildix/xbees-conversations-client 1.0.45 → 1.0.47

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.
@@ -1,6 +1,5 @@
1
1
  import { ConversationsServiceException as __BaseException } from "./ConversationsServiceException";
2
2
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
3
- import { DocumentType as __DocumentType } from "@smithy/types";
4
3
  /**
5
4
  * @public
6
5
  */
@@ -26,1648 +25,36 @@ export declare class ForbiddenException extends __BaseException {
26
25
  /**
27
26
  * @public
28
27
  */
29
- export interface CallFlowAttachmentDestination {
30
- phone?: string;
31
- name?: string;
32
- email?: string;
33
- userId?: string;
34
- userExtension?: string;
35
- userDepartment?: string;
36
- groupId?: string;
37
- groupName?: string;
38
- }
39
- /**
40
- * @public
41
- * @enum
42
- */
43
- export declare const CallFlowAttachmentType: {
44
- readonly FAX: "FAX";
45
- readonly VOICEMAIL: "VOICEMAIL";
46
- };
47
- /**
48
- * @public
49
- */
50
- export type CallFlowAttachmentType = typeof CallFlowAttachmentType[keyof typeof CallFlowAttachmentType];
51
- /**
52
- * @public
53
- * @enum
54
- */
55
- export declare const CallParticipantRole: {
56
- readonly AGENT: "AGENT";
57
- readonly CLIENT: "CLIENT";
58
- };
59
- /**
60
- * @public
61
- */
62
- export type CallParticipantRole = typeof CallParticipantRole[keyof typeof CallParticipantRole];
63
- /**
64
- * @public
65
- * @enum
66
- */
67
- export declare const CallParticipantType: {
68
- readonly LOCAL: "LOCAL";
69
- readonly REMOTE: "REMOTE";
70
- };
71
- /**
72
- * @public
73
- */
74
- export type CallParticipantType = typeof CallParticipantType[keyof typeof CallParticipantType];
75
- /**
76
- * @public
77
- * @enum
78
- */
79
- export declare const CallDevice: {
80
- readonly COLLABORATION_ANDROID: "COLLABORATION_ANDROID";
81
- readonly COLLABORATION_IOS: "COLLABORATION_IOS";
82
- readonly COLLABORATION_WEB: "COLLABORATION_WEB";
83
- readonly UNKNOWN: "UNKNOWN";
84
- readonly WILDIX_DEVICE: "WILDIX_DEVICE";
85
- readonly WILDIX_PHONE: "WILDIX_PHONE";
86
- readonly XBEES_ANDROID: "XBEES_ANDROID";
87
- readonly XBEES_IOS: "XBEES_IOS";
88
- readonly XBEES_WEB: "XBEES_WEB";
89
- };
90
- /**
91
- * @public
92
- */
93
- export type CallDevice = typeof CallDevice[keyof typeof CallDevice];
94
- /**
95
- * @public
96
- */
97
- export interface CallParticipant {
98
- type: CallParticipantType;
99
- phone?: string;
100
- name?: string;
101
- company?: string;
102
- email?: string;
103
- userId?: string;
104
- userExtension?: string;
105
- userDepartment?: string;
106
- groupId?: string;
107
- groupName?: string;
108
- userAgent?: string;
109
- userDevice?: CallDevice;
110
- role: CallParticipantRole;
111
- license?: string;
112
- }
113
- /**
114
- * @public
115
- * @enum
116
- */
117
- export declare const ConversationStatus: {
118
- readonly COMPLETED: "COMPLETED";
119
- readonly MISSED: "MISSED";
120
- };
121
- /**
122
- * @public
123
- */
124
- export type ConversationStatus = typeof ConversationStatus[keyof typeof ConversationStatus];
125
- /**
126
- * @public
127
- * @enum
128
- */
129
- export declare const CallDirection: {
130
- readonly INBOUND: "INBOUND";
131
- readonly INTERNAL: "INTERNAL";
132
- readonly OUTBOUND: "OUTBOUND";
133
- readonly UNDEFINED: "UNDEFINED";
134
- };
135
- /**
136
- * @public
137
- */
138
- export type CallDirection = typeof CallDirection[keyof typeof CallDirection];
139
- /**
140
- * @public
141
- * @enum
142
- */
143
- export declare const License: {
144
- readonly XBEES: "x-bees";
145
- };
146
- /**
147
- * @public
148
- */
149
- export type License = typeof License[keyof typeof License];
150
- /**
151
- * @public
152
- * @enum
153
- */
154
- export declare const CallRecordOwner: {
155
- readonly CALLEE: "callee";
156
- readonly CALLER: "caller";
157
- readonly SYSTEM: "system";
158
- };
159
- /**
160
- * @public
161
- */
162
- export type CallRecordOwner = typeof CallRecordOwner[keyof typeof CallRecordOwner];
163
- /**
164
- * @public
165
- * @enum
166
- */
167
- export declare const CallRecordPauseReason: {
168
- readonly HOLD: "hold";
169
- readonly PAUSE: "pause";
170
- };
171
- /**
172
- * @public
173
- */
174
- export type CallRecordPauseReason = typeof CallRecordPauseReason[keyof typeof CallRecordPauseReason];
175
- /**
176
- * @public
177
- */
178
- export interface CallRecordPause {
179
- start?: number;
180
- end?: number;
181
- reason?: CallRecordPauseReason;
182
- }
183
- /**
184
- * @public
185
- */
186
- export interface RecordingsData {
187
- fileName: string;
188
- start: number;
189
- end: number;
190
- owner: CallRecordOwner;
191
- url: string;
192
- pauses: (CallRecordPause)[];
193
- }
194
- /**
195
- * @public
196
- * @enum
197
- */
198
- export declare const CallFlowTranscriptionStatus: {
199
- readonly AVAILABLE: "AVAILABLE";
200
- readonly UNAVAILABLE: "UNAVAILABLE";
201
- };
202
- /**
203
- * @public
204
- */
205
- export type CallFlowTranscriptionStatus = typeof CallFlowTranscriptionStatus[keyof typeof CallFlowTranscriptionStatus];
206
- /**
207
- * @public
208
- * @enum
209
- */
210
- export declare const CallTranscriptionSpeaker: {
211
- readonly CALLEE: "callee";
212
- readonly CALLER: "caller";
213
- };
214
- /**
215
- * @public
216
- */
217
- export type CallTranscriptionSpeaker = typeof CallTranscriptionSpeaker[keyof typeof CallTranscriptionSpeaker];
218
- /**
219
- * @public
220
- */
221
- export interface CallTranscriptionChunk {
222
- id: string;
223
- time: number;
224
- speaker: CallTranscriptionSpeaker;
225
- text: string;
226
- language?: string;
227
- isFinal: boolean;
228
- start: number;
229
- end: number;
230
- sentiment: string;
231
- }
232
- /**
233
- * @public
234
- * @enum
235
- */
236
- export declare const ConferenceDirection: {
237
- readonly INBOUND: "INBOUND";
238
- readonly INTERNAL: "INTERNAL";
239
- readonly OUTBOUND: "OUTBOUND";
240
- };
241
- /**
242
- * @public
243
- */
244
- export type ConferenceDirection = typeof ConferenceDirection[keyof typeof ConferenceDirection];
245
- /**
246
- * @public
247
- * @enum
248
- */
249
- export declare const PbxLicenseType: {
250
- readonly BASIC: "basic";
251
- readonly BUSINESS: "business";
252
- readonly ESSENTIAL: "essential";
253
- readonly PREMIUM: "premium";
254
- readonly WIZYCONF: "wizyconf";
255
- };
256
- /**
257
- * @public
258
- */
259
- export type PbxLicenseType = typeof PbxLicenseType[keyof typeof PbxLicenseType];
260
- /**
261
- * @public
262
- * @enum
263
- */
264
- export declare const ConferenceParticipantRole: {
265
- readonly AGENT: "AGENT";
266
- readonly CLIENT: "CLIENT";
267
- };
268
- /**
269
- * @public
270
- */
271
- export type ConferenceParticipantRole = typeof ConferenceParticipantRole[keyof typeof ConferenceParticipantRole];
272
- /**
273
- * @public
274
- * @enum
275
- */
276
- export declare const ConferenceParticipantType: {
277
- readonly EXTERNAL: "EXTERNAL";
278
- readonly EXTERNAL_DIAL_IN: "EXTERNAL_DIAL_IN";
279
- readonly PBX: "PBX";
280
- readonly PBX_SIP: "PBX_SIP";
281
- readonly XBS: "XBS";
282
- };
283
- /**
284
- * @public
285
- */
286
- export type ConferenceParticipantType = typeof ConferenceParticipantType[keyof typeof ConferenceParticipantType];
287
- /**
288
- * @public
289
- */
290
- export interface ConferenceParticipant {
291
- type: ConferenceParticipantType;
292
- role?: ConferenceParticipantRole;
293
- /**
294
- * A unique identifier to avoid duplicates if user re-connect from different devices.
295
- * @public
296
- */
297
- jid?: string;
298
- name?: string;
299
- email?: string;
300
- phone?: string;
301
- department?: string;
302
- company?: string;
303
- pbxSerial?: string;
304
- pbxExtension?: string;
305
- pbxGroupId?: string;
306
- xbsId?: string;
307
- license?: PbxLicenseType;
308
- }
309
- /**
310
- * @public
311
- */
312
- export interface ConferenceAnalyticsRecordParticipant {
313
- jid: string;
314
- info: ConferenceParticipant;
315
- totalDuration: number;
316
- totalSpeakDuration: number;
317
- joinTime: number;
318
- }
319
- /**
320
- * @public
321
- */
322
- export interface ConferenceRecording {
323
- url: string;
324
- start: number;
325
- end: number;
326
- }
327
- /**
328
- * @public
329
- * @enum
330
- */
331
- export declare const ConferenceTranscriptionStatus: {
332
- readonly AVAILABLE: "AVAILABLE";
333
- readonly UNAVAILABLE: "UNAVAILABLE";
334
- };
335
- /**
336
- * @public
337
- */
338
- export type ConferenceTranscriptionStatus = typeof ConferenceTranscriptionStatus[keyof typeof ConferenceTranscriptionStatus];
339
- /**
340
- * @public
341
- */
342
- export interface ConferenceTranscriptionChunk {
343
- id: string;
344
- time: number;
345
- jid: string;
346
- text: string;
347
- language?: string;
348
- isFinal: boolean;
349
- start: number;
350
- end: number;
351
- sentiment: string;
352
- }
353
- /**
354
- * @public
355
- */
356
- export interface CallTranscription {
357
- flowIndex: number;
358
- flowStartTime: number;
359
- callStartTime: number;
360
- chunks: Record<string, CallTranscriptionChunk>;
361
- }
362
- /**
363
- * @public
364
- * @enum
365
- */
366
- export declare const LiveEventType: {
367
- readonly CALL: "call";
368
- readonly CALL_COMPLETE: "call_complete";
369
- readonly CALL_INTERRUPTED: "call_interrupted";
370
- readonly CALL_TRANSCRIPTION: "call_transcription";
371
- readonly CHAT: "chat";
372
- readonly CHAT_COMPLETE: "chat_complete";
373
- readonly CHAT_COST: "call_cost";
374
- readonly CHAT_INTERRUPTED: "chat_interrupted";
375
- readonly CHAT_MISSED: "chat_missed";
376
- readonly CONFERENCE: "conference";
377
- readonly CONFERENCE_COMPLETE: "conference_complete";
378
- readonly CONFERENCE_INTERRUPTED: "conference_interrupted";
379
- readonly CONFERENCE_JOIN: "conference_join";
380
- readonly CONFERENCE_LEAVE: "conference_leave";
381
- readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
382
- };
383
- /**
384
- * @public
385
- */
386
- export type LiveEventType = typeof LiveEventType[keyof typeof LiveEventType];
387
- /**
388
- * @public
389
- */
390
- export interface CallAnalyticsCostRecordEvent {
391
- id: string;
392
- pbx: string;
393
- time: number;
394
- company: string;
395
- licenses: (License)[];
396
- transcriptions: (CallTranscription)[];
397
- type: LiveEventType;
398
- flowIndex: number;
399
- cost: number;
400
- }
401
- /**
402
- * @public
403
- */
404
- export interface CallAnalyticsLiveCompleteEvent {
405
- id: string;
406
- pbx: string;
407
- time: number;
408
- company: string;
409
- licenses: (License)[];
410
- event: LiveEventType;
411
- flows: number;
412
- }
413
- /**
414
- * @public
415
- */
416
- export interface CallAnalyticsLiveInterruptedEvent {
417
- id: string;
418
- pbx: string;
419
- time: number;
420
- company: string;
421
- licenses: (License)[];
422
- event: LiveEventType;
423
- flows: number;
424
- }
425
- /**
426
- * @public
427
- * @enum
428
- */
429
- export declare const CallAnalyticsLiveProgressEventTrigger: {
430
- readonly AGENTS_CANCEL: "call.agents_cancel";
431
- readonly AGENTS_START: "call.agents_start";
432
- readonly ATTACHMENT: "call.attachment";
433
- readonly RECORD_START: "call.record_start";
434
- readonly RECORD_STOP: "call.record_stop";
435
- readonly SPLIT: "call.split";
436
- readonly START: "call.start";
437
- readonly TRANSCRIPTION: "call.transcription";
438
- readonly UPDATE: "call.update";
439
- };
440
- /**
441
- * @public
442
- */
443
- export type CallAnalyticsLiveProgressEventTrigger = typeof CallAnalyticsLiveProgressEventTrigger[keyof typeof CallAnalyticsLiveProgressEventTrigger];
444
- /**
445
- * @public
446
- * @enum
447
- */
448
- export declare const CallFlowStatus: {
449
- readonly CONNECTING: "CONNECTING";
450
- readonly HOLD: "HOLD";
451
- readonly TALKING: "TALKING";
452
- };
453
- /**
454
- * @public
455
- */
456
- export type CallFlowStatus = typeof CallFlowStatus[keyof typeof CallFlowStatus];
457
- /**
458
- * @public
459
- */
460
- export interface CallAnalyticsLiveProgressEventFlow {
461
- flowIndex: number;
462
- startTime: number;
463
- endTime: number;
464
- connectTime?: number;
465
- talkTime?: number;
466
- waitTime?: number;
467
- duration: number;
468
- caller?: CallParticipant;
469
- callee?: CallParticipant;
470
- service?: string;
471
- serviceNumber?: string;
472
- destination?: string;
473
- direction?: CallDirection;
474
- trunkName?: string;
475
- trunkDirection?: string;
476
- queueName?: string;
477
- queueId?: string;
478
- tags?: (string)[];
479
- flags?: (string)[];
480
- callerMos?: string;
481
- calleeMos?: string;
482
- xhoppersConfId?: string;
483
- recordings?: (string)[];
484
- recordingsData?: (RecordingsData)[];
485
- mergeWith?: string;
486
- splitReason?: string;
487
- splitTransferType?: string;
488
- remotePhone?: string;
489
- remotePhoneCountryCode?: number;
490
- remotePhoneCountryCodeStr?: string;
491
- remotePhoneLocation?: string;
492
- callStatus?: ConversationStatus;
493
- transcriptionStatus?: CallFlowTranscriptionStatus;
494
- transcriptionLanguage?: string;
495
- attachment?: string;
496
- attachmentType?: CallFlowAttachmentType;
497
- attachmentDestinations?: (CallFlowAttachmentDestination)[];
498
- status: CallFlowStatus;
499
- /**
500
- * Time of the last status change in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
501
- * @public
502
- */
503
- statusChangeDate: string;
504
- }
505
- /**
506
- * @public
507
- */
508
- export interface CallAnalyticsLiveProgressEvent {
509
- id: string;
510
- pbx: string;
511
- time: number;
512
- company: string;
513
- licenses: (License)[];
514
- event: LiveEventType;
515
- /**
516
- * An original event that triggers current one.
517
- * @public
518
- */
519
- eventTrigger: CallAnalyticsLiveProgressEventTrigger;
520
- start: string;
521
- flows: (CallAnalyticsLiveProgressEventFlow)[];
522
- }
523
- /**
524
- * @public
525
- */
526
- export interface CallAnalyticsLiveTranscriptionEvent {
527
- id: string;
528
- pbx: string;
529
- time: number;
530
- company: string;
531
- licenses: (License)[];
532
- event: LiveEventType;
533
- flowIndex: number;
534
- flowStartTime: number;
535
- callStartTime: number;
536
- chunk: CallTranscriptionChunk;
537
- participant?: CallParticipant;
538
- }
539
- /**
540
- * @public
541
- * @enum
542
- */
543
- export declare const CallEndBy: {
544
- readonly CALLEE: "CALLEE";
545
- readonly CALLER: "CALLER";
546
- };
547
- /**
548
- * @public
549
- */
550
- export type CallEndBy = typeof CallEndBy[keyof typeof CallEndBy];
551
- /**
552
- * @public
553
- */
554
- export interface CallAnalyticsRecordEventFlow {
555
- flowIndex: number;
556
- startTime: number;
557
- endTime: number;
558
- connectTime?: number;
559
- talkTime?: number;
560
- waitTime?: number;
561
- duration: number;
562
- caller?: CallParticipant;
563
- callee?: CallParticipant;
564
- service?: string;
565
- serviceNumber?: string;
566
- destination?: string;
567
- direction?: CallDirection;
568
- trunkName?: string;
569
- trunkDirection?: string;
570
- queueName?: string;
571
- queueId?: string;
572
- tags?: (string)[];
573
- flags?: (string)[];
574
- callerMos?: string;
575
- calleeMos?: string;
576
- xhoppersConfId?: string;
577
- recordings?: (string)[];
578
- recordingsData?: (RecordingsData)[];
579
- mergeWith?: string;
580
- splitReason?: string;
581
- splitTransferType?: string;
582
- remotePhone?: string;
583
- remotePhoneCountryCode?: number;
584
- remotePhoneCountryCodeStr?: string;
585
- remotePhoneLocation?: string;
586
- callStatus?: ConversationStatus;
587
- transcriptionStatus?: CallFlowTranscriptionStatus;
588
- transcriptionLanguage?: string;
589
- attachment?: string;
590
- attachmentType?: CallFlowAttachmentType;
591
- attachmentDestinations?: (CallFlowAttachmentDestination)[];
592
- }
593
- /**
594
- * @public
595
- */
596
- export interface CallAnalyticsRecordEvent {
597
- id: string;
598
- pbx: string;
599
- time: number;
600
- company: string;
601
- licenses: (License)[];
602
- flows: (CallAnalyticsRecordEventFlow)[];
603
- endCause?: string;
604
- endCauseStr?: string;
605
- endBy: CallEndBy;
606
- totalConnectTime: number;
607
- totalTalkTime: number;
608
- totalWaitTime: number;
609
- type: LiveEventType;
610
- complete: boolean;
611
- }
612
- /**
613
- * @public
614
- */
615
- export interface CallAnalyticsTranscriptionRecordEvent {
616
- id: string;
617
- pbx: string;
618
- time: number;
619
- company: string;
620
- licenses: (License)[];
621
- transcriptions: (CallTranscription)[];
622
- type: LiveEventType;
623
- complete: boolean;
624
- }
625
- /**
626
- * @public
627
- * @enum
628
- */
629
- export declare const CallEventType: {
630
- readonly COST_RECORD_EVENT: "CallAnalyticsCostRecordEvent";
631
- readonly LIVE_COMPLETE_EVENT: "CallAnalyticsLiveCompleteEvent";
632
- readonly LIVE_INTERRUPTED_EVENT: "CallAnalyticsLiveInterruptedEvent";
633
- readonly LIVE_PROGRESS_EVENT: "CallAnalyticsLiveProgressEvent";
634
- readonly LIVE_TRANSCRIPTION_EVENT: "CallAnalyticsLiveTranscriptionEvent";
635
- readonly RECORD_EVENT: "CallAnalyticsRecordEvent";
636
- readonly TRANSCRIPTION_RECORD_EVENT: "CallAnalyticsTranscriptionRecordEvent";
637
- };
638
- /**
639
- * @public
640
- */
641
- export type CallEventType = typeof CallEventType[keyof typeof CallEventType];
642
- /**
643
- * @public
644
- */
645
- export interface ChatAnalyticsLiveCompleteEvent {
646
- id: string;
647
- time: number;
648
- company: string;
649
- event: LiveEventType;
650
- }
651
- /**
652
- * @public
653
- */
654
- export interface ChatAnalyticsLiveInterruptedEvent {
655
- id: string;
656
- time: number;
657
- company: string;
658
- event: LiveEventType;
659
- }
660
- /**
661
- * @public
662
- */
663
- export interface ChatAnalyticsLiveMissedEvent {
664
- id: string;
665
- time: number;
666
- company: string;
667
- event: LiveEventType;
668
- }
669
- /**
670
- * @public
671
- */
672
- export interface User {
673
- id: string;
674
- name?: string;
675
- email?: string;
676
- phone?: string;
677
- picture?: string;
678
- locale?: string;
679
- timeZone?: string;
680
- company?: string;
681
- bot?: boolean;
682
- pbxDomain?: string;
683
- pbxPort?: string;
684
- pbxExtension?: string;
685
- pbxSerial?: string;
686
- pbxUserId?: string;
687
- createdAt?: string;
688
- updatedAt?: string;
689
- }
690
- /**
691
- * @public
692
- * @enum
693
- */
694
- export declare const ChannelType: {
695
- readonly DIRECT: "direct";
696
- readonly GROUP: "group";
697
- };
698
- /**
699
- * @public
700
- */
701
- export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
702
- /**
703
- * @public
704
- * @enum
705
- */
706
- export declare const ChatDirection: {
707
- readonly INBOUND: "INBOUND";
708
- readonly INTERNAL: "INTERNAL";
709
- readonly OUTBOUND: "OUTBOUND";
710
- };
711
- /**
712
- * @public
713
- */
714
- export type ChatDirection = typeof ChatDirection[keyof typeof ChatDirection];
715
- /**
716
- * @public
717
- * @enum
718
- */
719
- export declare const ChatParticipantRole: {
720
- readonly AGENT: "AGENT";
721
- readonly CLIENT: "CLIENT";
722
- };
723
- /**
724
- * @public
725
- */
726
- export type ChatParticipantRole = typeof ChatParticipantRole[keyof typeof ChatParticipantRole];
727
- /**
728
- * @public
729
- * @enum
730
- */
731
- export declare const ChatParticipantType: {
732
- readonly LOCAL: "LOCAL";
733
- readonly REMOTE: "REMOTE";
734
- };
735
- /**
736
- * @public
737
- */
738
- export type ChatParticipantType = typeof ChatParticipantType[keyof typeof ChatParticipantType];
739
- /**
740
- * @public
741
- */
742
- export interface ChatParticipant {
743
- id: string;
744
- name?: string;
745
- email?: string;
746
- phone?: string;
747
- picture?: string;
748
- locale?: string;
749
- timeZone?: string;
750
- company?: string;
751
- bot?: boolean;
752
- pbxDomain?: string;
753
- pbxPort?: string;
754
- pbxExtension?: string;
755
- pbxSerial?: string;
756
- pbxUserId?: string;
757
- createdAt?: string;
758
- updatedAt?: string;
759
- type: ChatParticipantType;
760
- role: ChatParticipantRole;
761
- }
762
- /**
763
- * @public
764
- * @enum
765
- */
766
- export declare const ChatStatus: {
767
- readonly COMPLETED: "COMPLETED";
768
- readonly MISSED: "MISSED";
769
- readonly WAITFIRSTREPLY: "WAITFIRSTREPLY";
770
- readonly WAITREPLYFROMAGENT: "WAITREPLYFROMAGENT";
771
- readonly WAITREPLYFROMGUEST: "WAITREPLYFROMGUEST";
772
- };
773
- /**
774
- * @public
775
- */
776
- export type ChatStatus = typeof ChatStatus[keyof typeof ChatStatus];
777
- /**
778
- * @public
779
- * @enum
780
- */
781
- export declare const ChatTag: {
782
- readonly SMS: "sms";
783
- readonly TELEPHONY: "telephony";
784
- };
785
- /**
786
- * @public
787
- */
788
- export type ChatTag = typeof ChatTag[keyof typeof ChatTag];
789
- /**
790
- * @public
791
- */
792
- export interface ChatAnalyticsLiveProgressEvent {
793
- id: string;
794
- time: number;
795
- company: string;
796
- event: LiveEventType;
797
- start: string;
798
- channelId: string;
799
- channelType: ChannelType;
800
- subject: string;
801
- service?: string;
802
- serviceTitle?: string;
803
- participants: (ChatParticipant)[];
804
- agents: (User)[];
805
- agentsCount: number;
806
- customers: (User)[];
807
- customersCount: number;
808
- tags?: (ChatTag)[];
809
- direction: ChatDirection;
810
- status: ChatStatus;
811
- }
812
- /**
813
- * @public
814
- */
815
- export interface ChatAnalyticsManagerMissedEvent {
816
- id: string;
817
- time: number;
818
- company: string;
819
- event: string;
820
- }
821
- /**
822
- * @public
823
- */
824
- export interface ChatAnalyticsRecordParticipant {
825
- id: string;
826
- info: ChatParticipant;
827
- }
828
- /**
829
- * @public
830
- */
831
- export interface ChatAnalyticsRecordEvent {
832
- id: string;
833
- time: number;
834
- company: string;
835
- type: string;
836
- duration?: number;
837
- subject?: string;
838
- direction?: ChatDirection;
839
- service?: string;
840
- serviceTitle?: string;
841
- tags?: (ChatTag)[];
842
- status?: ChatStatus;
843
- participants?: (ChatAnalyticsRecordParticipant)[];
844
- }
845
- /**
846
- * @public
847
- * @enum
848
- */
849
- export declare const ChatEventType: {
850
- readonly LIVE_COMPLETE_EVENT: "ChatAnalyticsLiveCompleteEvent";
851
- readonly LIVE_INTERRUPTED_EVENT: "ChatAnalyticsLiveInterruptedEvent";
852
- readonly LIVE_MISSED_EVENT: "ChatAnalyticsLiveMissedEvent";
853
- readonly LIVE_PROGRESS_EVENT: "ChatAnalyticsLiveProgressEvent";
854
- readonly MANAGER_MISSED_EVENT: "ChatAnalyticsManagerMissedEvent";
855
- readonly RECORD_EVENT: "ChatAnalyticsRecordEvent";
856
- };
857
- /**
858
- * @public
859
- */
860
- export type ChatEventType = typeof ChatEventType[keyof typeof ChatEventType];
861
- /**
862
- * @public
863
- */
864
- export interface ConferenceAnalyticsLiveCompleteEvent {
865
- id: string;
866
- time: number;
867
- company: string;
868
- event: LiveEventType;
869
- }
870
- /**
871
- * @public
872
- */
873
- export interface ConferenceAnalyticsLiveInterruptedEvent {
874
- id: string;
875
- time: number;
876
- company: string;
877
- event: LiveEventType;
878
- }
879
- /**
880
- * @public
881
- */
882
- export interface ConferenceAnalyticsLiveJoinEvent {
883
- id: string;
884
- time: number;
885
- company: string;
886
- event: LiveEventType;
887
- participant: ConferenceParticipant;
888
- }
889
- /**
890
- * @public
891
- */
892
- export interface ConferenceAnalyticsLiveLeaveEvent {
893
- id: string;
894
- time: number;
895
- company: string;
896
- event: LiveEventType;
897
- participant: ConferenceParticipant;
898
- }
899
- /**
900
- * @public
901
- */
902
- export interface ConferenceAnalyticsLiveProgressEvent {
903
- id: string;
904
- time: number;
905
- company: string;
906
- event: LiveEventType;
907
- start: string;
908
- subject: string;
909
- participants: (ConferenceParticipant)[];
910
- transcriptionStatus: ConferenceTranscriptionStatus;
911
- transcriptionLanguage?: string;
912
- }
913
- /**
914
- * @public
915
- */
916
- export interface ConferenceAnalyticsLiveTranscriptionEvent {
917
- id: string;
918
- time: number;
919
- company: string;
920
- event: LiveEventType;
921
- conferenceStartTime: number;
922
- transcriptionStartTime: number;
923
- chunk: ConferenceTranscriptionChunk;
924
- participant?: ConferenceParticipant;
925
- }
926
- /**
927
- * @public
928
- */
929
- export interface ConferenceAnalyticsRecordEvent {
930
- id: string;
931
- time: number;
932
- company: string;
933
- pbx?: string;
934
- startTime: number;
935
- endTime: number;
936
- duration: number;
937
- waitTime?: number;
938
- subject?: string;
939
- direction: ConferenceDirection;
940
- service?: string;
941
- status?: ConversationStatus;
942
- participants: (ConferenceAnalyticsRecordParticipant)[];
943
- recordings?: (ConferenceRecording)[];
944
- transcriptionStatus: ConferenceTranscriptionStatus;
945
- transcriptionLanguage?: string;
946
- type: LiveEventType;
947
- transcriptions?: string;
948
- }
949
- /**
950
- * @public
951
- */
952
- export interface ConferenceTranscription {
953
- start: number;
954
- end: number;
955
- chunks: Record<string, ConferenceTranscriptionChunk>;
956
- }
957
- /**
958
- * @public
959
- */
960
- export interface ConferenceAnalyticsTranscriptionRecordEvent {
961
- id: string;
962
- time: number;
963
- company: string;
964
- transcriptions: (ConferenceTranscription)[];
965
- type: LiveEventType;
966
- subject?: string;
967
- participants?: Record<string, ConferenceParticipant>;
968
- }
969
- /**
970
- * @public
971
- * @enum
972
- */
973
- export declare const ConferenceEventType: {
974
- readonly LIVE_COMPLETE_EVENT: "ConferenceAnalyticsLiveCompleteEvent";
975
- readonly LIVE_INTERRUPTED_EVENT: "ConferenceAnalyticsLiveInterruptedEvent";
976
- readonly LIVE_JOIN_EVENT: "ConferenceAnalyticsLiveJoinEvent";
977
- readonly LIVE_LEAVE_EVENT: "ConferenceAnalyticsLiveLeaveEvent";
978
- readonly LIVE_PROGRESS_EVENT: "ConferenceAnalyticsLiveProgressEvent";
979
- readonly LIVE_TRANSCRIPTION_EVENT: "ConferenceAnalyticsLiveTranscriptionEvent";
980
- readonly RECORD_EVENT: "ConferenceAnalyticsRecordEvent";
981
- readonly TRANSCRIPTION_RECORD_EVENT: "ConferenceAnalyticsTranscriptionRecordEvent";
982
- };
983
- /**
984
- * @public
985
- */
986
- export type ConferenceEventType = typeof ConferenceEventType[keyof typeof ConferenceEventType];
987
- /**
988
- * @public
989
- */
990
- export interface SmsInboundConsumeEventData {
991
- /**
992
- * A unique ID of the SMS message (example fb0ee129-f98f-4d7f-af1e-32b657aa3a56)
993
- * @public
994
- */
995
- id: string;
996
- from: string;
997
- to: string;
998
- message: string;
999
- }
1000
- /**
1001
- * @public
1002
- * @enum
1003
- */
1004
- export declare const SmsConsumeEventType: {
1005
- readonly SMS_INBOUND: "SMS.INBOUND";
1006
- readonly SMS_STATUS: "SMS.STATUS";
1007
- };
1008
- /**
1009
- * @public
1010
- */
1011
- export type SmsConsumeEventType = typeof SmsConsumeEventType[keyof typeof SmsConsumeEventType];
1012
- /**
1013
- * @public
1014
- * @enum
1015
- */
1016
- export declare const SmsChannelType: {
1017
- readonly ONE_WAY: "1-way-sms";
1018
- readonly TWO_WAY: "2-way-sms";
1019
- };
1020
- /**
1021
- * @public
1022
- */
1023
- export type SmsChannelType = typeof SmsChannelType[keyof typeof SmsChannelType];
1024
- /**
1025
- * @public
1026
- * @enum
1027
- */
1028
- export declare const SmsStatus: {
1029
- readonly DELIVERED: "delivered";
1030
- readonly ERROR: "error";
1031
- readonly SENT: "sent";
1032
- readonly TRYING: "trying";
1033
- };
1034
- /**
1035
- * @public
1036
- */
1037
- export type SmsStatus = typeof SmsStatus[keyof typeof SmsStatus];
1038
- /**
1039
- * @public
1040
- */
1041
- export interface SmsStatusConsumeEventData {
1042
- id: string;
1043
- from: string;
1044
- to: string;
1045
- status: SmsStatus;
1046
- channel: SmsChannelType;
1047
- parts: number;
1048
- }
1049
- /**
1050
- * @public
1051
- */
1052
- export interface SmsInboundEvent {
1053
- pbx: string;
1054
- company: string;
1055
- time: number;
1056
- type: SmsConsumeEventType;
1057
- data: SmsInboundConsumeEventData;
1058
- }
1059
- /**
1060
- * @public
1061
- */
1062
- export interface SmsStatusEvent {
1063
- pbx: string;
1064
- company: string;
1065
- time: number;
1066
- type: SmsConsumeEventType;
1067
- data: SmsStatusConsumeEventData;
1068
- }
1069
- /**
1070
- * @public
1071
- */
1072
- export interface DescribeEventInput {
1073
- SmsInboundEvent?: SmsInboundEvent;
1074
- SmsStatusEvent?: SmsStatusEvent;
1075
- }
1076
- /**
1077
- * @public
1078
- * @enum
1079
- */
1080
- export declare const PresenceAnalyticsEventType: {
1081
- readonly PRESENCE: "PRESENCE";
1082
- readonly PRESENCE_TELEPHONY: "PRESENCE_TELEPHONY";
1083
- };
1084
- /**
1085
- * @public
1086
- */
1087
- export type PresenceAnalyticsEventType = typeof PresenceAnalyticsEventType[keyof typeof PresenceAnalyticsEventType];
1088
- /**
1089
- * @public
1090
- */
1091
- export interface PresenceAnalyticsConferenceEvent {
1092
- id?: string;
1093
- ext?: string;
1094
- type?: PresenceAnalyticsEventType;
1095
- time?: number;
1096
- pbx?: string;
1097
- company?: string;
1098
- email?: string;
1099
- status?: string;
1100
- sourceId?: string;
1101
- isJoined?: boolean;
1102
- isLeaved?: boolean;
1103
- participant?: ConferenceParticipant;
1104
- }
1105
- /**
1106
- * @public
1107
- */
1108
- export interface PresenceAnalyticsStatusEvent {
1109
- id?: string;
1110
- ext?: string;
1111
- type?: PresenceAnalyticsEventType;
1112
- time?: number;
1113
- pbx?: string;
1114
- company?: string;
1115
- email?: string;
1116
- status?: string;
1117
- sourceId?: string;
1118
- locationAddress?: string;
1119
- locationLat?: string;
1120
- locationLng?: string;
1121
- message?: string;
1122
- until?: string;
1123
- }
1124
- /**
1125
- * @public
1126
- */
1127
- export interface PresenceAnalyticsTelephonyEvent {
1128
- id?: string;
1129
- ext?: string;
1130
- type?: PresenceAnalyticsEventType;
1131
- time?: number;
1132
- pbx?: string;
1133
- company?: string;
1134
- email?: string;
1135
- status?: string;
1136
- sourceId?: string;
1137
- }
1138
- /**
1139
- * @public
1140
- * @enum
1141
- */
1142
- export declare const PresenceEventType: {
1143
- readonly CONFERENCE_EVENT: "PresenceAnalyticsConferenceEvent";
1144
- readonly STATUS_EVENT: "PresenceAnalyticsStatusEvent";
1145
- readonly TELEPHONY_EVENT: "PresenceAnalyticsTelephonyEvent";
1146
- };
1147
- /**
1148
- * @public
1149
- */
1150
- export type PresenceEventType = typeof PresenceEventType[keyof typeof PresenceEventType];
1151
- /**
1152
- * @public
1153
- * @enum
1154
- */
1155
- export declare const WebhookEventType: {
1156
- readonly CALL_COMPLETED: "call:completed";
1157
- readonly CALL_LIVE_COMPLETED: "call:live:completed";
1158
- readonly CALL_LIVE_INTERRUPTED: "call:live:interrupted";
1159
- readonly CALL_LIVE_PROGRESS: "call:live:progress";
1160
- readonly CALL_LIVE_TRANSCRIPTION: "call:live:transcription";
1161
- readonly CHAT_COMPLETED: "chat:completed";
1162
- readonly CHAT_LIVE_COMPLETED: "chat:live:completed";
1163
- readonly CHAT_LIVE_INTERRUPTED: "chat:live:interrupted";
1164
- readonly CHAT_LIVE_PROGRESS: "chat:live:progress";
1165
- readonly CHAT_MANAGER_MISSED: "chat:manager:missed";
1166
- readonly CONFERENCE_COMPLETED: "conference:completed";
1167
- readonly CONFERENCE_LIVE_COMPLETED: "conference:live:completed";
1168
- readonly CONFERENCE_LIVE_INTERRUPTED: "conference:live:interrupted";
1169
- readonly CONFERENCE_LIVE_JOIN: "conference:live:join";
1170
- readonly CONFERENCE_LIVE_LEAVE: "conference:live:leave";
1171
- readonly CONFERENCE_LIVE_PROGRESS: "conference:live:progress";
1172
- readonly CONFERENCE_LIVE_TRANSCRIPTION: "conference:live:transcription";
1173
- readonly OLD_CALL_END: "call:end";
1174
- readonly OLD_CALL_START: "call:start";
1175
- readonly OLD_CALL_UPDATE: "call:update";
1176
- readonly PRESENCE_CONFERENCE: "presence:conference";
1177
- readonly PRESENCE_TELEPHONY: "presence:telephony";
1178
- readonly PRESENCE_USER: "presence:user";
1179
- };
1180
- /**
1181
- * @public
1182
- */
1183
- export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
1184
- /**
1185
- * @public
1186
- */
1187
- export interface WebhookCallCompletedEvent {
1188
- id: string;
1189
- pbx?: string;
1190
- company?: string;
1191
- type: WebhookEventType;
1192
- time: number;
1193
- integrationId: string;
1194
- data: CallAnalyticsRecordEvent;
1195
- }
1196
- /**
1197
- * @public
1198
- */
1199
- export interface WebhookCallLiveCompletedEvent {
1200
- id: string;
1201
- pbx?: string;
1202
- company?: string;
1203
- type: WebhookEventType;
1204
- time: number;
1205
- integrationId: string;
1206
- data: CallAnalyticsLiveCompleteEvent;
1207
- }
1208
- /**
1209
- * @public
1210
- */
1211
- export interface WebhookCallLiveInterruptedEvent {
1212
- id: string;
1213
- pbx?: string;
1214
- company?: string;
1215
- type: WebhookEventType;
1216
- time: number;
1217
- integrationId: string;
1218
- data: CallAnalyticsLiveInterruptedEvent;
1219
- }
1220
- /**
1221
- * @public
1222
- */
1223
- export interface WebhookCallLiveProgressEvent {
1224
- id: string;
1225
- pbx?: string;
1226
- company?: string;
1227
- type: WebhookEventType;
1228
- time: number;
1229
- integrationId: string;
1230
- data: CallAnalyticsLiveProgressEvent;
1231
- }
1232
- /**
1233
- * @public
1234
- */
1235
- export interface WebhookCallLiveTranscriptionEvent {
1236
- id: string;
1237
- pbx?: string;
1238
- company?: string;
1239
- type: WebhookEventType;
1240
- time: number;
1241
- integrationId: string;
1242
- data: CallAnalyticsLiveTranscriptionEvent;
1243
- }
1244
- /**
1245
- * @public
1246
- */
1247
- export interface WebhookChatCompletedEvent {
1248
- id: string;
1249
- pbx?: string;
1250
- company?: string;
1251
- type: WebhookEventType;
1252
- time: number;
1253
- integrationId: string;
1254
- data: ChatAnalyticsRecordEvent;
1255
- }
1256
- /**
1257
- * @public
1258
- */
1259
- export interface WebhookChatLiveCompletedEvent {
1260
- id: string;
1261
- pbx?: string;
1262
- company?: string;
1263
- type: WebhookEventType;
1264
- time: number;
1265
- integrationId: string;
1266
- data: ChatAnalyticsLiveCompleteEvent;
1267
- }
1268
- /**
1269
- * @public
1270
- */
1271
- export interface WebhookChatLiveInterruptedEvent {
1272
- id: string;
1273
- pbx?: string;
1274
- company?: string;
1275
- type: WebhookEventType;
1276
- time: number;
1277
- integrationId: string;
1278
- data: ChatAnalyticsLiveInterruptedEvent;
1279
- }
1280
- /**
1281
- * @public
1282
- */
1283
- export interface WebhookChatLiveProgressEvent {
1284
- id: string;
1285
- pbx?: string;
1286
- company?: string;
1287
- type: WebhookEventType;
1288
- time: number;
1289
- integrationId: string;
1290
- data: ChatAnalyticsLiveProgressEvent;
1291
- }
1292
- /**
1293
- * @public
1294
- */
1295
- export interface WebhookChatManagerMissedEvent {
1296
- id: string;
1297
- pbx?: string;
1298
- company?: string;
1299
- type: WebhookEventType;
1300
- time: number;
1301
- integrationId: string;
1302
- data: ChatAnalyticsManagerMissedEvent;
1303
- }
1304
- /**
1305
- * @public
1306
- */
1307
- export interface WebhookConferenceCompletedEvent {
1308
- id: string;
1309
- pbx?: string;
1310
- company?: string;
1311
- type: WebhookEventType;
1312
- time: number;
1313
- integrationId: string;
1314
- data: ConferenceAnalyticsRecordEvent;
1315
- }
1316
- /**
1317
- * @public
1318
- */
1319
- export interface WebhookConferenceLiveCompletedEvent {
1320
- id: string;
1321
- pbx?: string;
1322
- company?: string;
1323
- type: WebhookEventType;
1324
- time: number;
1325
- integrationId: string;
1326
- data: ConferenceAnalyticsLiveCompleteEvent;
1327
- }
1328
- /**
1329
- * @public
1330
- */
1331
- export interface WebhookConferenceLiveInterruptedEvent {
1332
- id: string;
1333
- pbx?: string;
1334
- company?: string;
1335
- type: WebhookEventType;
1336
- time: number;
1337
- integrationId: string;
1338
- data: ConferenceAnalyticsLiveInterruptedEvent;
1339
- }
1340
- /**
1341
- * @public
1342
- */
1343
- export interface WebhookConferenceLiveJoinEvent {
1344
- id: string;
1345
- pbx?: string;
1346
- company?: string;
1347
- type: WebhookEventType;
1348
- time: number;
1349
- integrationId: string;
1350
- data: ConferenceAnalyticsLiveJoinEvent;
1351
- }
1352
- /**
1353
- * @public
1354
- */
1355
- export interface WebhookConferenceLiveLeaveEvent {
1356
- id: string;
1357
- pbx?: string;
1358
- company?: string;
1359
- type: WebhookEventType;
1360
- time: number;
1361
- integrationId: string;
1362
- data: ConferenceAnalyticsLiveLeaveEvent;
1363
- }
1364
- /**
1365
- * @public
1366
- */
1367
- export interface WebhookConferenceLiveProgressEvent {
1368
- id: string;
1369
- pbx?: string;
1370
- company?: string;
1371
- type: WebhookEventType;
1372
- time: number;
1373
- integrationId: string;
1374
- data: ConferenceAnalyticsLiveProgressEvent;
1375
- }
1376
- /**
1377
- * @public
1378
- */
1379
- export interface WebhookConferenceLiveTranscriptionEvent {
28
+ export interface User {
1380
29
  id: string;
1381
- pbx?: string;
1382
- company?: string;
1383
- type: WebhookEventType;
1384
- time: number;
1385
- integrationId: string;
1386
- data: ConferenceAnalyticsLiveTranscriptionEvent;
1387
- }
1388
- /**
1389
- * @public
1390
- */
1391
- export interface WebhookOutdatedCallParticipant {
1392
- type: string;
1393
- phone?: string;
1394
30
  name?: string;
1395
- company?: string;
1396
31
  email?: string;
1397
- userId?: string;
1398
- userExtension?: string;
1399
- userDepartment?: string;
1400
- groupId?: string;
1401
- groupName?: string;
1402
- userAgent?: string;
1403
- userDevice?: CallDevice;
1404
- role: string;
1405
- license?: string;
1406
- }
1407
- /**
1408
- * @public
1409
- */
1410
- export interface WebhookOutdatedCallEventData {
1411
- status?: string;
1412
- caller?: WebhookOutdatedCallParticipant;
1413
- callee?: WebhookOutdatedCallParticipant;
1414
- service?: string;
1415
- destination?: string;
1416
- trunkName?: string;
1417
- queueId?: string;
1418
- queueName?: string;
1419
- tags: (string)[];
1420
- flags: (string)[];
1421
- endCause?: string;
1422
- endCauseStr?: string;
1423
- endBy?: string;
1424
- }
1425
- /**
1426
- * @public
1427
- */
1428
- export interface WebhookOutdatedCallEndEvent {
1429
- id: string;
1430
- pbx?: string;
1431
- company?: string;
1432
- type: WebhookEventType;
1433
- time: number;
1434
- integrationId: string;
1435
- data: WebhookOutdatedCallEventData;
1436
- }
1437
- /**
1438
- * @public
1439
- */
1440
- export interface WebhookOutdatedCallStartEvent {
1441
- id: string;
1442
- pbx?: string;
1443
- company?: string;
1444
- type: WebhookEventType;
1445
- time: number;
1446
- integrationId: string;
1447
- data: WebhookOutdatedCallEventData;
1448
- }
1449
- /**
1450
- * @public
1451
- */
1452
- export interface WebhookOutdatedCallUpdateEvent {
1453
- id: string;
1454
- pbx?: string;
1455
- company?: string;
1456
- type: WebhookEventType;
1457
- time: number;
1458
- integrationId: string;
1459
- data: WebhookOutdatedCallEventData;
1460
- }
1461
- /**
1462
- * @public
1463
- */
1464
- export interface WebhookPresenceConferenceEventData {
1465
- extension: string;
1466
- isJoined: boolean;
1467
- isLeaved: boolean;
1468
- participant: ConferenceParticipant;
1469
- }
1470
- /**
1471
- * @public
1472
- */
1473
- export interface WebhookPresenceConferenceEvent {
1474
- id: string;
1475
- pbx?: string;
1476
- company?: string;
1477
- type: WebhookEventType;
1478
- time: number;
1479
- integrationId: string;
1480
- data: WebhookPresenceConferenceEventData;
1481
- }
1482
- /**
1483
- * @public
1484
- */
1485
- export interface WebhookPresenceTelephonyEventData {
1486
- extension: string;
1487
- email: string;
1488
- sourceId: string;
1489
- status: string;
1490
- }
1491
- /**
1492
- * @public
1493
- */
1494
- export interface WebhookPresenceTelephonyEvent {
1495
- id: string;
1496
- pbx?: string;
1497
- company?: string;
1498
- type: WebhookEventType;
1499
- time: number;
1500
- integrationId: string;
1501
- data: WebhookPresenceTelephonyEventData;
1502
- }
1503
- /**
1504
- * @public
1505
- */
1506
- export interface WebhookPresenceUserEventLocationData {
1507
- address: string;
1508
- lat: string;
1509
- lng: string;
1510
- }
1511
- /**
1512
- * @public
1513
- */
1514
- export interface WebhookPresenceUserEventData {
1515
- extension: string;
1516
- email: string;
1517
- sourceId: string;
1518
- status: string;
1519
- until: string;
1520
- message: string;
1521
- location: WebhookPresenceUserEventLocationData;
1522
- }
1523
- /**
1524
- * @public
1525
- */
1526
- export interface WebhookPresenceUserEvent {
1527
- id: string;
1528
- pbx?: string;
32
+ phone?: string;
33
+ picture?: string;
34
+ locale?: string;
35
+ timeZone?: string;
1529
36
  company?: string;
1530
- type: WebhookEventType;
1531
- time: number;
1532
- integrationId: string;
1533
- data: WebhookPresenceUserEventData;
37
+ bot?: boolean;
38
+ pbxDomain?: string;
39
+ pbxPort?: string;
40
+ pbxExtension?: string;
41
+ pbxSerial?: string;
42
+ pbxUserId?: string;
43
+ createdAt?: string;
44
+ updatedAt?: string;
1534
45
  }
1535
46
  /**
1536
47
  * @public
1537
48
  * @enum
1538
49
  */
1539
- export declare const WebsocketEvent: {
1540
- readonly AUTHORIZED: "authorized";
1541
- readonly BROADCAST: "broadcast";
1542
- readonly SUBSCRIBED: "subscribed";
1543
- };
1544
- /**
1545
- * @public
1546
- */
1547
- export type WebsocketEvent = typeof WebsocketEvent[keyof typeof WebsocketEvent];
1548
- /**
1549
- * @public
1550
- * @enum
1551
- */
1552
- export declare const WebsocketTopic: {
1553
- readonly CONVERSATIONS: "conversations";
1554
- readonly PRESENCE: "presence";
1555
- readonly TRANSCRIPTIONS: "transcriptions";
50
+ export declare const ChannelType: {
51
+ readonly DIRECT: "direct";
52
+ readonly GROUP: "group";
1556
53
  };
1557
54
  /**
1558
55
  * @public
1559
56
  */
1560
- export type WebsocketTopic = typeof WebsocketTopic[keyof typeof WebsocketTopic];
1561
- /**
1562
- * @public
1563
- */
1564
- export interface WebsocketConversationsBroadcastEvent {
1565
- event: WebsocketEvent;
1566
- topic: WebsocketTopic;
1567
- data: __DocumentType;
1568
- meta?: __DocumentType;
1569
- }
1570
- /**
1571
- * @public
1572
- */
1573
- export interface WebsocketPresenceData {
1574
- id?: string;
1575
- company?: string;
1576
- extension?: string;
1577
- status?: string;
1578
- telephony?: string;
1579
- conference?: string;
1580
- message?: string;
1581
- until?: string;
1582
- address?: string;
1583
- lng?: string;
1584
- lat?: string;
1585
- seen?: string;
1586
- }
1587
- /**
1588
- * @public
1589
- */
1590
- export interface WebsocketPresenceDataList {
1591
- member?: WebsocketPresenceData;
1592
- }
1593
- /**
1594
- * @public
1595
- */
1596
- export interface WebsocketPresenceBroadcastEvent {
1597
- event: WebsocketEvent;
1598
- topic: WebsocketTopic;
1599
- delta?: WebsocketPresenceData;
1600
- data?: WebsocketPresenceDataList;
1601
- meta?: __DocumentType;
1602
- }
1603
- /**
1604
- * @public
1605
- */
1606
- export interface WebsocketTranscriptionsBroadcastEvent {
1607
- event: WebsocketEvent;
1608
- topic: WebsocketTopic;
1609
- data: __DocumentType;
1610
- meta?: __DocumentType;
1611
- }
1612
- /**
1613
- * @public
1614
- */
1615
- export interface DescribeEventOutput {
1616
- CallAnalyticsLiveProgressEvent?: CallAnalyticsLiveProgressEvent;
1617
- CallAnalyticsLiveCompleteEvent?: CallAnalyticsLiveCompleteEvent;
1618
- CallAnalyticsLiveInterruptedEvent?: CallAnalyticsLiveInterruptedEvent;
1619
- CallAnalyticsLiveTranscriptionEvent?: CallAnalyticsLiveTranscriptionEvent;
1620
- CallAnalyticsRecordEvent?: CallAnalyticsRecordEvent;
1621
- CallAnalyticsTranscriptionRecordEvent?: CallAnalyticsTranscriptionRecordEvent;
1622
- CallAnalyticsCostRecordEvent?: CallAnalyticsCostRecordEvent;
1623
- ChatAnalyticsLiveCompleteEvent?: ChatAnalyticsLiveCompleteEvent;
1624
- ChatAnalyticsLiveInterruptedEvent?: ChatAnalyticsLiveInterruptedEvent;
1625
- ChatAnalyticsLiveMissedEvent?: ChatAnalyticsLiveMissedEvent;
1626
- ChatAnalyticsLiveProgressEvent?: ChatAnalyticsLiveProgressEvent;
1627
- ChatAnalyticsManagerMissedEvent?: ChatAnalyticsManagerMissedEvent;
1628
- ChatAnalyticsRecordEvent?: ChatAnalyticsRecordEvent;
1629
- ConferenceAnalyticsLiveProgressEvent?: ConferenceAnalyticsLiveProgressEvent;
1630
- ConferenceAnalyticsLiveCompleteEvent?: ConferenceAnalyticsLiveCompleteEvent;
1631
- ConferenceAnalyticsLiveInterruptedEvent?: ConferenceAnalyticsLiveInterruptedEvent;
1632
- ConferenceAnalyticsLiveTranscriptionEvent?: ConferenceAnalyticsLiveTranscriptionEvent;
1633
- ConferenceAnalyticsLiveJoinEvent?: ConferenceAnalyticsLiveJoinEvent;
1634
- ConferenceAnalyticsLiveLeaveEvent?: ConferenceAnalyticsLiveLeaveEvent;
1635
- ConferenceAnalyticsRecordEvent?: ConferenceAnalyticsRecordEvent;
1636
- ConferenceAnalyticsTranscriptionRecordEvent?: ConferenceAnalyticsTranscriptionRecordEvent;
1637
- PresenceAnalyticsStatusEvent?: PresenceAnalyticsStatusEvent;
1638
- PresenceAnalyticsConferenceEvent?: PresenceAnalyticsConferenceEvent;
1639
- PresenceAnalyticsTelephonyEvent?: PresenceAnalyticsTelephonyEvent;
1640
- WebsocketPresenceBroadcastEvent?: WebsocketPresenceBroadcastEvent;
1641
- WebsocketConversationsBroadcastEvent?: WebsocketConversationsBroadcastEvent;
1642
- WebsocketTranscriptionsBroadcastEvent?: WebsocketTranscriptionsBroadcastEvent;
1643
- WebhookPresenceUserEvent?: WebhookPresenceUserEvent;
1644
- WebhookPresenceTelephonyEvent?: WebhookPresenceTelephonyEvent;
1645
- WebhookPresenceConferenceEvent?: WebhookPresenceConferenceEvent;
1646
- WebhookCallLiveProgressEvent?: WebhookCallLiveProgressEvent;
1647
- WebhookCallLiveCompletedEvent?: WebhookCallLiveCompletedEvent;
1648
- WebhookCallLiveInterruptedEvent?: WebhookCallLiveInterruptedEvent;
1649
- WebhookCallLiveTranscriptionEvent?: WebhookCallLiveTranscriptionEvent;
1650
- WebhookCallCompletedEvent?: WebhookCallCompletedEvent;
1651
- WebhookConferenceLiveProgressEvent?: WebhookConferenceLiveProgressEvent;
1652
- WebhookConferenceLiveCompletedEvent?: WebhookConferenceLiveCompletedEvent;
1653
- WebhookConferenceLiveInterruptedEvent?: WebhookConferenceLiveInterruptedEvent;
1654
- WebhookConferenceLiveJoinEvent?: WebhookConferenceLiveJoinEvent;
1655
- WebhookConferenceLiveLeaveEvent?: WebhookConferenceLiveLeaveEvent;
1656
- WebhookConferenceLiveTranscriptionEvent?: WebhookConferenceLiveTranscriptionEvent;
1657
- WebhookConferenceCompletedEvent?: WebhookConferenceCompletedEvent;
1658
- WebhookChatLiveProgressEvent?: WebhookChatLiveProgressEvent;
1659
- WebhookChatLiveCompletedEvent?: WebhookChatLiveCompletedEvent;
1660
- WebhookChatLiveInterruptedEvent?: WebhookChatLiveInterruptedEvent;
1661
- WebhookChatManagerMissedEvent?: WebhookChatManagerMissedEvent;
1662
- WebhookChatCompletedEvent?: WebhookChatCompletedEvent;
1663
- WebhookOutdatedCallStartEvent?: WebhookOutdatedCallStartEvent;
1664
- WebhookOutdatedCallUpdateEvent?: WebhookOutdatedCallUpdateEvent;
1665
- WebhookOutdatedCallEndEvent?: WebhookOutdatedCallEndEvent;
1666
- CallEventType?: CallEventType;
1667
- ConferenceEventType?: ConferenceEventType;
1668
- ChatEventType?: ChatEventType;
1669
- PresenceEventType?: PresenceEventType;
1670
- }
57
+ export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
1671
58
  /**
1672
59
  * @public
1673
60
  */
@@ -1755,35 +142,167 @@ export declare class MemberAlreadyExistException extends __BaseException {
1755
142
  /**
1756
143
  * @public
1757
144
  */
1758
- export interface AddChannelMembersInput {
145
+ export interface AddChannelMembersInput {
146
+ channelId: string;
147
+ /**
148
+ * User ID for server side calls
149
+ * @public
150
+ */
151
+ userId?: string;
152
+ /**
153
+ * True to not send a system message that members added from the conversartion. Default - false.
154
+ * @public
155
+ */
156
+ silent?: boolean;
157
+ members?: (string)[];
158
+ membersToInvite?: (UserToInvite)[];
159
+ }
160
+ /**
161
+ * @public
162
+ */
163
+ export interface AddChannelMembersOutput {
164
+ /**
165
+ * The list of members added to the channel
166
+ * @public
167
+ */
168
+ members: (ChannelMember)[];
169
+ /**
170
+ * The list of users added to the channel
171
+ * @public
172
+ */
173
+ users: (User)[];
174
+ }
175
+ /**
176
+ * @public
177
+ */
178
+ export type AssignChannelAssigneeRequest = AssignChannelAssigneeRequest.EmailMember | AssignChannelAssigneeRequest.IdMember | AssignChannelAssigneeRequest.$UnknownMember;
179
+ /**
180
+ * @public
181
+ */
182
+ export declare namespace AssignChannelAssigneeRequest {
183
+ interface IdMember {
184
+ id: string;
185
+ email?: never;
186
+ $unknown?: never;
187
+ }
188
+ interface EmailMember {
189
+ id?: never;
190
+ email: string;
191
+ $unknown?: never;
192
+ }
193
+ /**
194
+ * @public
195
+ */
196
+ interface $UnknownMember {
197
+ id?: never;
198
+ email?: never;
199
+ $unknown: [string, any];
200
+ }
201
+ interface Visitor<T> {
202
+ id: (value: string) => T;
203
+ email: (value: string) => T;
204
+ _: (name: string, value: any) => T;
205
+ }
206
+ const visit: <T>(value: AssignChannelAssigneeRequest, visitor: Visitor<T>) => T;
207
+ }
208
+ /**
209
+ * @public
210
+ */
211
+ export interface AssignChannelOptions {
212
+ /**
213
+ * True to add all members that are in service to the conversation. Default - false.
214
+ * @public
215
+ */
216
+ addAgentFromService?: boolean;
217
+ }
218
+ /**
219
+ * @public
220
+ */
221
+ export type AssignChannelServiceRequest = AssignChannelServiceRequest.IdMember | AssignChannelServiceRequest.NameMember | AssignChannelServiceRequest.UriMember | AssignChannelServiceRequest.$UnknownMember;
222
+ /**
223
+ * @public
224
+ */
225
+ export declare namespace AssignChannelServiceRequest {
226
+ interface UriMember {
227
+ uri: string;
228
+ id?: never;
229
+ name?: never;
230
+ $unknown?: never;
231
+ }
232
+ interface IdMember {
233
+ uri?: never;
234
+ id: string;
235
+ name?: never;
236
+ $unknown?: never;
237
+ }
238
+ interface NameMember {
239
+ uri?: never;
240
+ id?: never;
241
+ name: string;
242
+ $unknown?: never;
243
+ }
244
+ /**
245
+ * @public
246
+ */
247
+ interface $UnknownMember {
248
+ uri?: never;
249
+ id?: never;
250
+ name?: never;
251
+ $unknown: [string, any];
252
+ }
253
+ interface Visitor<T> {
254
+ uri: (value: string) => T;
255
+ id: (value: string) => T;
256
+ name: (value: string) => T;
257
+ _: (name: string, value: any) => T;
258
+ }
259
+ const visit: <T>(value: AssignChannelServiceRequest, visitor: Visitor<T>) => T;
260
+ }
261
+ /**
262
+ * @public
263
+ */
264
+ export interface AssignChannelInput {
1759
265
  channelId: string;
266
+ userId?: string;
1760
267
  /**
1761
- * User ID for server side calls
268
+ * True to not send a system message that channel was assigned to specific service or user. Default - false.
1762
269
  * @public
1763
270
  */
1764
- userId?: string;
271
+ silent?: boolean;
1765
272
  /**
1766
- * True to not send a system message that members added from the conversartion. Default - false.
273
+ * Service information to assign to. If service is not empty than `addAgentFromService` option could be used.
1767
274
  * @public
1768
275
  */
1769
- silent?: boolean;
1770
- members?: (string)[];
1771
- membersToInvite?: (UserToInvite)[];
276
+ service?: AssignChannelServiceRequest;
277
+ /**
278
+ * A user that should be assigned to the channel. If service was specified than this field can be optional.
279
+ * @public
280
+ */
281
+ assignee?: AssignChannelAssigneeRequest;
282
+ options?: AssignChannelOptions;
1772
283
  }
1773
284
  /**
1774
285
  * @public
1775
286
  */
1776
- export interface AddChannelMembersOutput {
287
+ export interface AssignService {
288
+ uri: string;
289
+ id: string;
290
+ name: string;
291
+ }
292
+ /**
293
+ * @public
294
+ */
295
+ export interface AssignChannelOutput {
1777
296
  /**
1778
- * The list of members added to the channel
297
+ * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
1779
298
  * @public
1780
299
  */
1781
- members: (ChannelMember)[];
300
+ assignee?: User;
1782
301
  /**
1783
- * The list of users added to the channel
302
+ * A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
1784
303
  * @public
1785
304
  */
1786
- users: (User)[];
305
+ service?: AssignService;
1787
306
  }
1788
307
  /**
1789
308
  * @public
@@ -2062,91 +581,90 @@ export interface DeleteMessageReactionOutput {
2062
581
  /**
2063
582
  * @public
2064
583
  */
2065
- export interface GetChannelInput {
2066
- channelId: string;
584
+ export interface DescribeEventInput {
2067
585
  }
2068
586
  /**
2069
587
  * @public
2070
588
  */
2071
- export interface GetChannelOutput {
589
+ export interface WebhookChatChannelCreatedOrUpdatedEventData {
2072
590
  channel: Channel;
591
+ members: (ChannelMember)[];
592
+ users: (User)[];
2073
593
  }
2074
594
  /**
2075
595
  * @public
596
+ * @enum
2076
597
  */
2077
- export interface GetChannelMemberInput {
2078
- channelId: string;
2079
- memberId: string;
2080
- }
2081
- /**
2082
- * @public
2083
- */
2084
- export interface GetChannelMemberOutput {
2085
- member: ChannelMember;
2086
- user: User;
2087
- }
598
+ export declare const WebhookEventType: {
599
+ readonly CHANNEL_CREATED: "chat:channel:created";
600
+ readonly CHANNEL_UPDATED: "chat:channel:updated";
601
+ readonly MEMBER_ADDED: "chat:member:added";
602
+ readonly MEMBER_REMOVED: "chat:member:removed";
603
+ readonly MESSAGE_DELETED: "chat:message:deleted";
604
+ readonly MESSAGE_NEW: "chat:message:new";
605
+ readonly MESSAGE_UPDATED: "chat:message:updated";
606
+ readonly REACTION_DELETED: "chat:reaction:deleted";
607
+ readonly REACTION_NEW: "chat:reaction:new";
608
+ };
2088
609
  /**
2089
610
  * @public
2090
611
  */
2091
- export interface GetDirectChannelIdInput {
2092
- userId?: string;
2093
- memberId?: string;
2094
- memberToInvite?: UserToInvite;
2095
- }
612
+ export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
2096
613
  /**
2097
614
  * @public
2098
615
  */
2099
- export interface GetDirectChannelIdOutput {
2100
- channelId: string;
616
+ export interface WebhookChatChannelCreatedEvent {
617
+ id: string;
618
+ company: string;
619
+ type: WebhookEventType;
620
+ time: number;
621
+ integrationId?: string;
622
+ botId?: string;
623
+ data: WebhookChatChannelCreatedOrUpdatedEventData;
2101
624
  }
2102
625
  /**
2103
626
  * @public
2104
627
  */
2105
- export declare class FileNotFoundException extends __BaseException {
2106
- readonly name: "FileNotFoundException";
2107
- readonly $fault: "client";
2108
- /**
2109
- * @internal
2110
- */
2111
- constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
628
+ export interface WebhookChatChannelUpdatedEvent {
629
+ id: string;
630
+ company: string;
631
+ type: WebhookEventType;
632
+ time: number;
633
+ integrationId?: string;
634
+ botId?: string;
635
+ data: WebhookChatChannelCreatedOrUpdatedEventData;
2112
636
  }
2113
637
  /**
2114
638
  * @public
2115
639
  */
2116
- export interface GetFilePresignedDownloadUrlInput {
2117
- /**
2118
- * Channel Id.
2119
- * @public
2120
- */
2121
- channelId: string;
2122
- /**
2123
- * Message Id.
2124
- * @public
2125
- */
2126
- messageId: string;
2127
- fileId: string;
2128
- /**
2129
- * File category. Channel files or conference recordings. Default: channels.
2130
- * @public
2131
- */
2132
- category?: ConversationFileCategory;
640
+ export interface WebhookChatMemberAddedOrRemovedEventData {
641
+ channel: Channel;
642
+ member: ChannelMember;
643
+ user: User;
2133
644
  }
2134
645
  /**
2135
646
  * @public
2136
647
  */
2137
- export interface GetFilePresignedDownloadUrlOutput {
2138
- /**
2139
- * Presigned URL for download file.
2140
- * @public
2141
- */
2142
- presignedDownloadUrl: string;
648
+ export interface WebhookChatMemberAddedEvent {
649
+ id: string;
650
+ company: string;
651
+ type: WebhookEventType;
652
+ time: number;
653
+ integrationId?: string;
654
+ botId?: string;
655
+ data: WebhookChatMemberAddedOrRemovedEventData;
2143
656
  }
2144
657
  /**
2145
658
  * @public
2146
659
  */
2147
- export interface GetMessageInput {
2148
- channelId: string;
2149
- messageId: string;
660
+ export interface WebhookChatMemberRemovedEvent {
661
+ id: string;
662
+ company: string;
663
+ type: WebhookEventType;
664
+ time: number;
665
+ integrationId?: string;
666
+ botId?: string;
667
+ data: WebhookChatMemberAddedOrRemovedEventData;
2150
668
  }
2151
669
  /**
2152
670
  * @public
@@ -2228,6 +746,7 @@ export type MessageSmsStatus = typeof MessageSmsStatus[keyof typeof MessageSmsSt
2228
746
  */
2229
747
  export declare const MessageType: {
2230
748
  readonly REGULAR: "regular";
749
+ readonly SYSTEM: "system";
2231
750
  };
2232
751
  /**
2233
752
  * @public
@@ -2257,6 +776,193 @@ export interface Message {
2257
776
  createdAt: string;
2258
777
  updatedAt?: string;
2259
778
  }
779
+ /**
780
+ * @public
781
+ */
782
+ export interface WebhookChatMessageUpdatedOrDeletedEventData {
783
+ channel: Channel;
784
+ message: Message;
785
+ }
786
+ /**
787
+ * @public
788
+ */
789
+ export interface WebhookChatMessageDeletedEvent {
790
+ id: string;
791
+ company: string;
792
+ type: WebhookEventType;
793
+ time: number;
794
+ integrationId?: string;
795
+ botId?: string;
796
+ data: WebhookChatMessageUpdatedOrDeletedEventData;
797
+ }
798
+ /**
799
+ * @public
800
+ */
801
+ export interface WebhookChatMessageNewEventData {
802
+ channel: Channel;
803
+ members: (ChannelMember)[];
804
+ users: (User)[];
805
+ message: Message;
806
+ }
807
+ /**
808
+ * @public
809
+ */
810
+ export interface WebhookChatMessageNewEvent {
811
+ id: string;
812
+ company: string;
813
+ type: WebhookEventType;
814
+ time: number;
815
+ integrationId?: string;
816
+ botId?: string;
817
+ data: WebhookChatMessageNewEventData;
818
+ }
819
+ /**
820
+ * @public
821
+ */
822
+ export interface WebhookChatMessageUpdatedEvent {
823
+ id: string;
824
+ company: string;
825
+ type: WebhookEventType;
826
+ time: number;
827
+ integrationId?: string;
828
+ botId?: string;
829
+ data: WebhookChatMessageUpdatedOrDeletedEventData;
830
+ }
831
+ /**
832
+ * @public
833
+ */
834
+ export interface WebhookChatReactionNewOrDeletedEventData {
835
+ channel: Channel;
836
+ message: Message;
837
+ reaction: Reaction;
838
+ }
839
+ /**
840
+ * @public
841
+ */
842
+ export interface WebhookChatReactionDeletedEvent {
843
+ id: string;
844
+ company: string;
845
+ type: WebhookEventType;
846
+ time: number;
847
+ integrationId?: string;
848
+ botId?: string;
849
+ data: WebhookChatReactionNewOrDeletedEventData;
850
+ }
851
+ /**
852
+ * @public
853
+ */
854
+ export interface WebhookChatReactionNewEvent {
855
+ id: string;
856
+ company: string;
857
+ type: WebhookEventType;
858
+ time: number;
859
+ integrationId?: string;
860
+ botId?: string;
861
+ data: WebhookChatReactionNewOrDeletedEventData;
862
+ }
863
+ /**
864
+ * @public
865
+ */
866
+ export interface DescribeEventOutput {
867
+ WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent;
868
+ WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent;
869
+ WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent;
870
+ WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent;
871
+ WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent;
872
+ WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent;
873
+ WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent;
874
+ WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent;
875
+ WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent;
876
+ }
877
+ /**
878
+ * @public
879
+ */
880
+ export interface GetChannelInput {
881
+ channelId: string;
882
+ }
883
+ /**
884
+ * @public
885
+ */
886
+ export interface GetChannelOutput {
887
+ channel: Channel;
888
+ }
889
+ /**
890
+ * @public
891
+ */
892
+ export interface GetChannelMemberInput {
893
+ channelId: string;
894
+ memberId: string;
895
+ }
896
+ /**
897
+ * @public
898
+ */
899
+ export interface GetChannelMemberOutput {
900
+ member: ChannelMember;
901
+ user: User;
902
+ }
903
+ /**
904
+ * @public
905
+ */
906
+ export interface GetDirectChannelIdInput {
907
+ userId?: string;
908
+ memberId?: string;
909
+ memberToInvite?: UserToInvite;
910
+ }
911
+ /**
912
+ * @public
913
+ */
914
+ export interface GetDirectChannelIdOutput {
915
+ channelId: string;
916
+ }
917
+ /**
918
+ * @public
919
+ */
920
+ export declare class FileNotFoundException extends __BaseException {
921
+ readonly name: "FileNotFoundException";
922
+ readonly $fault: "client";
923
+ /**
924
+ * @internal
925
+ */
926
+ constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
927
+ }
928
+ /**
929
+ * @public
930
+ */
931
+ export interface GetFilePresignedDownloadUrlInput {
932
+ /**
933
+ * Channel Id.
934
+ * @public
935
+ */
936
+ channelId: string;
937
+ /**
938
+ * Message Id.
939
+ * @public
940
+ */
941
+ messageId: string;
942
+ fileId: string;
943
+ /**
944
+ * File category. Channel files or conference recordings. Default: channels.
945
+ * @public
946
+ */
947
+ category?: ConversationFileCategory;
948
+ }
949
+ /**
950
+ * @public
951
+ */
952
+ export interface GetFilePresignedDownloadUrlOutput {
953
+ /**
954
+ * Presigned URL for download file.
955
+ * @public
956
+ */
957
+ presignedDownloadUrl: string;
958
+ }
959
+ /**
960
+ * @public
961
+ */
962
+ export interface GetMessageInput {
963
+ channelId: string;
964
+ messageId: string;
965
+ }
2260
966
  /**
2261
967
  * @public
2262
968
  */