@wildix/wim-voicebots-client 1.0.8 → 1.0.10

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.
@@ -94,6 +94,7 @@ export interface BotDialogflowCxEndpoint {
94
94
  * @enum
95
95
  */
96
96
  export declare const VoiceBotEmbeddedToolType: {
97
+ readonly DELEGATE: "DELEGATE";
97
98
  readonly HANGUP: "HANGUP";
98
99
  readonly TRANSFER: "TRANSFER";
99
100
  };
@@ -113,6 +114,71 @@ export interface VoiceBotEmbeddedTool {
113
114
  */
114
115
  parameters?: __DocumentType;
115
116
  }
117
+ /**
118
+ * @public
119
+ */
120
+ export interface VoiceBotFunctionIntegrationWebhookAuthorizationBasic {
121
+ username: string;
122
+ password: string;
123
+ }
124
+ /**
125
+ * @public
126
+ */
127
+ export interface VoiceBotFunctionIntegrationWebhookAuthorizationBearer {
128
+ token: string;
129
+ }
130
+ /**
131
+ * @public
132
+ */
133
+ export interface VoiceBotFunctionIntegrationWebhookAuthorizationOAuth {
134
+ clientId: string;
135
+ clientSecret: string;
136
+ endpointUrl: string;
137
+ scope?: string;
138
+ }
139
+ /**
140
+ * @public
141
+ */
142
+ export type VoiceBotFunctionIntegrationWebhookAuthorization = VoiceBotFunctionIntegrationWebhookAuthorization.BasicMember | VoiceBotFunctionIntegrationWebhookAuthorization.BearerMember | VoiceBotFunctionIntegrationWebhookAuthorization.OauthMember | VoiceBotFunctionIntegrationWebhookAuthorization.$UnknownMember;
143
+ /**
144
+ * @public
145
+ */
146
+ export declare namespace VoiceBotFunctionIntegrationWebhookAuthorization {
147
+ interface BearerMember {
148
+ bearer: VoiceBotFunctionIntegrationWebhookAuthorizationBearer;
149
+ basic?: never;
150
+ oauth?: never;
151
+ $unknown?: never;
152
+ }
153
+ interface BasicMember {
154
+ bearer?: never;
155
+ basic: VoiceBotFunctionIntegrationWebhookAuthorizationBasic;
156
+ oauth?: never;
157
+ $unknown?: never;
158
+ }
159
+ interface OauthMember {
160
+ bearer?: never;
161
+ basic?: never;
162
+ oauth: VoiceBotFunctionIntegrationWebhookAuthorizationOAuth;
163
+ $unknown?: never;
164
+ }
165
+ /**
166
+ * @public
167
+ */
168
+ interface $UnknownMember {
169
+ bearer?: never;
170
+ basic?: never;
171
+ oauth?: never;
172
+ $unknown: [string, any];
173
+ }
174
+ interface Visitor<T> {
175
+ bearer: (value: VoiceBotFunctionIntegrationWebhookAuthorizationBearer) => T;
176
+ basic: (value: VoiceBotFunctionIntegrationWebhookAuthorizationBasic) => T;
177
+ oauth: (value: VoiceBotFunctionIntegrationWebhookAuthorizationOAuth) => T;
178
+ _: (name: string, value: any) => T;
179
+ }
180
+ const visit: <T>(value: VoiceBotFunctionIntegrationWebhookAuthorization, visitor: Visitor<T>) => T;
181
+ }
116
182
  /**
117
183
  * @public
118
184
  */
@@ -126,8 +192,7 @@ export interface VoiceBotFunctionIntegrationWebhookHeader {
126
192
  export interface VoiceBotFunctionIntegrationWebhook {
127
193
  url: string;
128
194
  async?: boolean;
129
- timeout?: number;
130
- authorization?: __DocumentType;
195
+ authorization?: VoiceBotFunctionIntegrationWebhookAuthorization;
131
196
  headers?: (VoiceBotFunctionIntegrationWebhookHeader)[];
132
197
  parameters?: __DocumentType;
133
198
  }
@@ -475,6 +540,78 @@ export interface PlaybackWebsocketEvent {
475
540
  type: string;
476
541
  event: PlaybackEvent;
477
542
  }
543
+ /**
544
+ * @public
545
+ */
546
+ export interface TraceErrorResult {
547
+ internal: boolean;
548
+ message: string;
549
+ }
550
+ /**
551
+ * @public
552
+ */
553
+ export type TraceActivityResult = TraceActivityResult.ErrorMember | TraceActivityResult.TextMember | TraceActivityResult.$UnknownMember;
554
+ /**
555
+ * @public
556
+ */
557
+ export declare namespace TraceActivityResult {
558
+ interface ErrorMember {
559
+ error: TraceErrorResult;
560
+ text?: never;
561
+ $unknown?: never;
562
+ }
563
+ interface TextMember {
564
+ error?: never;
565
+ text: string;
566
+ $unknown?: never;
567
+ }
568
+ /**
569
+ * @public
570
+ */
571
+ interface $UnknownMember {
572
+ error?: never;
573
+ text?: never;
574
+ $unknown: [string, any];
575
+ }
576
+ interface Visitor<T> {
577
+ error: (value: TraceErrorResult) => T;
578
+ text: (value: string) => T;
579
+ _: (name: string, value: any) => T;
580
+ }
581
+ const visit: <T>(value: TraceActivityResult, visitor: Visitor<T>) => T;
582
+ }
583
+ /**
584
+ * @public
585
+ * @enum
586
+ */
587
+ export declare const TraceActivityStatus: {
588
+ readonly CANCELLED: "cancelled";
589
+ readonly COMPLETE: "complete";
590
+ readonly ERROR: "error";
591
+ readonly PENDING: "pending";
592
+ };
593
+ /**
594
+ * @public
595
+ */
596
+ export type TraceActivityStatus = typeof TraceActivityStatus[keyof typeof TraceActivityStatus];
597
+ /**
598
+ * @public
599
+ */
600
+ export interface TraceConnectEventTrigger {
601
+ parameters?: __DocumentType;
602
+ }
603
+ /**
604
+ * @public
605
+ */
606
+ export interface TraceDisconnectEventTrigger {
607
+ parameters?: __DocumentType;
608
+ }
609
+ /**
610
+ * @public
611
+ */
612
+ export interface TraceDurationTimeoutTaskTrigger {
613
+ parameters?: __DocumentType;
614
+ }
478
615
  /**
479
616
  * @public
480
617
  */
@@ -485,16 +622,6 @@ export interface ReplyEvent {
485
622
  startTime: number;
486
623
  endTime: number;
487
624
  }
488
- /**
489
- * @public
490
- */
491
- export interface ReplyWebhookEvent {
492
- sessionId: string;
493
- botId: string;
494
- callId: string;
495
- flowIndex: number;
496
- event: ReplyEvent;
497
- }
498
625
  /**
499
626
  * @public
500
627
  */
@@ -521,83 +648,707 @@ export interface SayWebsocketCommand {
521
648
  /**
522
649
  * @public
523
650
  */
524
- export interface SessionEndedEvent {
651
+ export interface TraceSilenceTimeoutTaskTrigger {
652
+ parameters?: __DocumentType;
653
+ }
654
+ /**
655
+ * @public
656
+ */
657
+ export interface TranscriptionEvent {
525
658
  type: VoiceBotEventType;
526
- error?: string;
659
+ id: string;
660
+ text: string;
527
661
  time: number;
528
662
  }
529
663
  /**
530
664
  * @public
531
665
  */
532
- export interface SessionEndedWebhookEvent {
666
+ export interface TranscriptionWebsocketEvent {
667
+ type: string;
668
+ event: TranscriptionEvent;
669
+ }
670
+ /**
671
+ * @public
672
+ */
673
+ export interface TransferWebsocketCommandData {
674
+ context: string;
675
+ extension: string;
676
+ type: VoiceBotCommandType;
677
+ }
678
+ /**
679
+ * @public
680
+ */
681
+ export interface TransferWebsocketCommand {
682
+ type: string;
683
+ command: TransferWebsocketCommandData;
684
+ }
685
+ /**
686
+ * @public
687
+ */
688
+ export type TraceActivityTrigger = TraceActivityTrigger.CompleteEventMember | TraceActivityTrigger.ConnectEventMember | TraceActivityTrigger.DisconnectEventMember | TraceActivityTrigger.DurationTimeoutTaskMember | TraceActivityTrigger.HangupCommandMember | TraceActivityTrigger.InterruptionEventMember | TraceActivityTrigger.PlaybackEventMember | TraceActivityTrigger.ReplyEventMember | TraceActivityTrigger.SayCommandMember | TraceActivityTrigger.SilenceTimeoutTaskMember | TraceActivityTrigger.TranscriptionEventMember | TraceActivityTrigger.TransferCommandMember | TraceActivityTrigger.$UnknownMember;
689
+ /**
690
+ * @public
691
+ */
692
+ export declare namespace TraceActivityTrigger {
693
+ interface ConnectEventMember {
694
+ connectEvent: TraceConnectEventTrigger;
695
+ disconnectEvent?: never;
696
+ replyEvent?: never;
697
+ completeEvent?: never;
698
+ interruptionEvent?: never;
699
+ playbackEvent?: never;
700
+ transcriptionEvent?: never;
701
+ sayCommand?: never;
702
+ hangupCommand?: never;
703
+ transferCommand?: never;
704
+ silenceTimeoutTask?: never;
705
+ durationTimeoutTask?: never;
706
+ $unknown?: never;
707
+ }
708
+ interface DisconnectEventMember {
709
+ connectEvent?: never;
710
+ disconnectEvent: TraceDisconnectEventTrigger;
711
+ replyEvent?: never;
712
+ completeEvent?: never;
713
+ interruptionEvent?: never;
714
+ playbackEvent?: never;
715
+ transcriptionEvent?: never;
716
+ sayCommand?: never;
717
+ hangupCommand?: never;
718
+ transferCommand?: never;
719
+ silenceTimeoutTask?: never;
720
+ durationTimeoutTask?: never;
721
+ $unknown?: never;
722
+ }
723
+ interface ReplyEventMember {
724
+ connectEvent?: never;
725
+ disconnectEvent?: never;
726
+ replyEvent: ReplyWebsocketEvent;
727
+ completeEvent?: never;
728
+ interruptionEvent?: never;
729
+ playbackEvent?: never;
730
+ transcriptionEvent?: never;
731
+ sayCommand?: never;
732
+ hangupCommand?: never;
733
+ transferCommand?: never;
734
+ silenceTimeoutTask?: never;
735
+ durationTimeoutTask?: never;
736
+ $unknown?: never;
737
+ }
738
+ interface CompleteEventMember {
739
+ connectEvent?: never;
740
+ disconnectEvent?: never;
741
+ replyEvent?: never;
742
+ completeEvent: CompleteWebsocketEvent;
743
+ interruptionEvent?: never;
744
+ playbackEvent?: never;
745
+ transcriptionEvent?: never;
746
+ sayCommand?: never;
747
+ hangupCommand?: never;
748
+ transferCommand?: never;
749
+ silenceTimeoutTask?: never;
750
+ durationTimeoutTask?: never;
751
+ $unknown?: never;
752
+ }
753
+ interface InterruptionEventMember {
754
+ connectEvent?: never;
755
+ disconnectEvent?: never;
756
+ replyEvent?: never;
757
+ completeEvent?: never;
758
+ interruptionEvent: InterruptionWebsocketEvent;
759
+ playbackEvent?: never;
760
+ transcriptionEvent?: never;
761
+ sayCommand?: never;
762
+ hangupCommand?: never;
763
+ transferCommand?: never;
764
+ silenceTimeoutTask?: never;
765
+ durationTimeoutTask?: never;
766
+ $unknown?: never;
767
+ }
768
+ interface PlaybackEventMember {
769
+ connectEvent?: never;
770
+ disconnectEvent?: never;
771
+ replyEvent?: never;
772
+ completeEvent?: never;
773
+ interruptionEvent?: never;
774
+ playbackEvent: PlaybackWebsocketEvent;
775
+ transcriptionEvent?: never;
776
+ sayCommand?: never;
777
+ hangupCommand?: never;
778
+ transferCommand?: never;
779
+ silenceTimeoutTask?: never;
780
+ durationTimeoutTask?: never;
781
+ $unknown?: never;
782
+ }
783
+ interface TranscriptionEventMember {
784
+ connectEvent?: never;
785
+ disconnectEvent?: never;
786
+ replyEvent?: never;
787
+ completeEvent?: never;
788
+ interruptionEvent?: never;
789
+ playbackEvent?: never;
790
+ transcriptionEvent: TranscriptionWebsocketEvent;
791
+ sayCommand?: never;
792
+ hangupCommand?: never;
793
+ transferCommand?: never;
794
+ silenceTimeoutTask?: never;
795
+ durationTimeoutTask?: never;
796
+ $unknown?: never;
797
+ }
798
+ interface SayCommandMember {
799
+ connectEvent?: never;
800
+ disconnectEvent?: never;
801
+ replyEvent?: never;
802
+ completeEvent?: never;
803
+ interruptionEvent?: never;
804
+ playbackEvent?: never;
805
+ transcriptionEvent?: never;
806
+ sayCommand: SayWebsocketCommand;
807
+ hangupCommand?: never;
808
+ transferCommand?: never;
809
+ silenceTimeoutTask?: never;
810
+ durationTimeoutTask?: never;
811
+ $unknown?: never;
812
+ }
813
+ interface HangupCommandMember {
814
+ connectEvent?: never;
815
+ disconnectEvent?: never;
816
+ replyEvent?: never;
817
+ completeEvent?: never;
818
+ interruptionEvent?: never;
819
+ playbackEvent?: never;
820
+ transcriptionEvent?: never;
821
+ sayCommand?: never;
822
+ hangupCommand: HangupWebsocketCommand;
823
+ transferCommand?: never;
824
+ silenceTimeoutTask?: never;
825
+ durationTimeoutTask?: never;
826
+ $unknown?: never;
827
+ }
828
+ interface TransferCommandMember {
829
+ connectEvent?: never;
830
+ disconnectEvent?: never;
831
+ replyEvent?: never;
832
+ completeEvent?: never;
833
+ interruptionEvent?: never;
834
+ playbackEvent?: never;
835
+ transcriptionEvent?: never;
836
+ sayCommand?: never;
837
+ hangupCommand?: never;
838
+ transferCommand: TransferWebsocketCommand;
839
+ silenceTimeoutTask?: never;
840
+ durationTimeoutTask?: never;
841
+ $unknown?: never;
842
+ }
843
+ interface SilenceTimeoutTaskMember {
844
+ connectEvent?: never;
845
+ disconnectEvent?: never;
846
+ replyEvent?: never;
847
+ completeEvent?: never;
848
+ interruptionEvent?: never;
849
+ playbackEvent?: never;
850
+ transcriptionEvent?: never;
851
+ sayCommand?: never;
852
+ hangupCommand?: never;
853
+ transferCommand?: never;
854
+ silenceTimeoutTask: TraceSilenceTimeoutTaskTrigger;
855
+ durationTimeoutTask?: never;
856
+ $unknown?: never;
857
+ }
858
+ interface DurationTimeoutTaskMember {
859
+ connectEvent?: never;
860
+ disconnectEvent?: never;
861
+ replyEvent?: never;
862
+ completeEvent?: never;
863
+ interruptionEvent?: never;
864
+ playbackEvent?: never;
865
+ transcriptionEvent?: never;
866
+ sayCommand?: never;
867
+ hangupCommand?: never;
868
+ transferCommand?: never;
869
+ silenceTimeoutTask?: never;
870
+ durationTimeoutTask: TraceDurationTimeoutTaskTrigger;
871
+ $unknown?: never;
872
+ }
873
+ /**
874
+ * @public
875
+ */
876
+ interface $UnknownMember {
877
+ connectEvent?: never;
878
+ disconnectEvent?: never;
879
+ replyEvent?: never;
880
+ completeEvent?: never;
881
+ interruptionEvent?: never;
882
+ playbackEvent?: never;
883
+ transcriptionEvent?: never;
884
+ sayCommand?: never;
885
+ hangupCommand?: never;
886
+ transferCommand?: never;
887
+ silenceTimeoutTask?: never;
888
+ durationTimeoutTask?: never;
889
+ $unknown: [string, any];
890
+ }
891
+ interface Visitor<T> {
892
+ connectEvent: (value: TraceConnectEventTrigger) => T;
893
+ disconnectEvent: (value: TraceDisconnectEventTrigger) => T;
894
+ replyEvent: (value: ReplyWebsocketEvent) => T;
895
+ completeEvent: (value: CompleteWebsocketEvent) => T;
896
+ interruptionEvent: (value: InterruptionWebsocketEvent) => T;
897
+ playbackEvent: (value: PlaybackWebsocketEvent) => T;
898
+ transcriptionEvent: (value: TranscriptionWebsocketEvent) => T;
899
+ sayCommand: (value: SayWebsocketCommand) => T;
900
+ hangupCommand: (value: HangupWebsocketCommand) => T;
901
+ transferCommand: (value: TransferWebsocketCommand) => T;
902
+ silenceTimeoutTask: (value: TraceSilenceTimeoutTaskTrigger) => T;
903
+ durationTimeoutTask: (value: TraceDurationTimeoutTaskTrigger) => T;
904
+ _: (name: string, value: any) => T;
905
+ }
906
+ const visit: <T>(value: TraceActivityTrigger, visitor: Visitor<T>) => T;
907
+ }
908
+ /**
909
+ * @public
910
+ */
911
+ export interface TraceActivity {
912
+ id: string;
913
+ version: number;
914
+ status: TraceActivityStatus;
915
+ trigger: TraceActivityTrigger;
916
+ result?: TraceActivityResult;
917
+ start: number;
918
+ duration?: number;
919
+ }
920
+ /**
921
+ * @public
922
+ */
923
+ export type TraceSegmentCompletionMessageItem = TraceSegmentCompletionMessageItem.BotMember | TraceSegmentCompletionMessageItem.UserMember | TraceSegmentCompletionMessageItem.$UnknownMember;
924
+ /**
925
+ * @public
926
+ */
927
+ export declare namespace TraceSegmentCompletionMessageItem {
928
+ interface UserMember {
929
+ user: string;
930
+ bot?: never;
931
+ $unknown?: never;
932
+ }
933
+ interface BotMember {
934
+ user?: never;
935
+ bot: string;
936
+ $unknown?: never;
937
+ }
938
+ /**
939
+ * @public
940
+ */
941
+ interface $UnknownMember {
942
+ user?: never;
943
+ bot?: never;
944
+ $unknown: [string, any];
945
+ }
946
+ interface Visitor<T> {
947
+ user: (value: string) => T;
948
+ bot: (value: string) => T;
949
+ _: (name: string, value: any) => T;
950
+ }
951
+ const visit: <T>(value: TraceSegmentCompletionMessageItem, visitor: Visitor<T>) => T;
952
+ }
953
+ /**
954
+ * @public
955
+ */
956
+ export interface TraceSegmentCompletionInput {
957
+ messages: TraceSegmentCompletionMessageItem;
958
+ }
959
+ /**
960
+ * @public
961
+ */
962
+ export type TraceToolCall = TraceToolCall.DelegationMember | TraceToolCall.FunctionMember | TraceToolCall.HangupMember | TraceToolCall.TransferMember | TraceToolCall.$UnknownMember;
963
+ /**
964
+ * @public
965
+ */
966
+ export declare namespace TraceToolCall {
967
+ interface TransferMember {
968
+ transfer: string;
969
+ hangup?: never;
970
+ delegation?: never;
971
+ function?: never;
972
+ $unknown?: never;
973
+ }
974
+ interface HangupMember {
975
+ transfer?: never;
976
+ hangup: string;
977
+ delegation?: never;
978
+ function?: never;
979
+ $unknown?: never;
980
+ }
981
+ interface DelegationMember {
982
+ transfer?: never;
983
+ hangup?: never;
984
+ delegation: string;
985
+ function?: never;
986
+ $unknown?: never;
987
+ }
988
+ interface FunctionMember {
989
+ transfer?: never;
990
+ hangup?: never;
991
+ delegation?: never;
992
+ function: string;
993
+ $unknown?: never;
994
+ }
995
+ /**
996
+ * @public
997
+ */
998
+ interface $UnknownMember {
999
+ transfer?: never;
1000
+ hangup?: never;
1001
+ delegation?: never;
1002
+ function?: never;
1003
+ $unknown: [string, any];
1004
+ }
1005
+ interface Visitor<T> {
1006
+ transfer: (value: string) => T;
1007
+ hangup: (value: string) => T;
1008
+ delegation: (value: string) => T;
1009
+ function: (value: string) => T;
1010
+ _: (name: string, value: any) => T;
1011
+ }
1012
+ const visit: <T>(value: TraceToolCall, visitor: Visitor<T>) => T;
1013
+ }
1014
+ /**
1015
+ * @public
1016
+ */
1017
+ export type TraceSegmentInput = TraceSegmentInput.CompletionMember | TraceSegmentInput.ToolMember | TraceSegmentInput.$UnknownMember;
1018
+ /**
1019
+ * @public
1020
+ */
1021
+ export declare namespace TraceSegmentInput {
1022
+ interface CompletionMember {
1023
+ completion: TraceSegmentCompletionInput;
1024
+ tool?: never;
1025
+ $unknown?: never;
1026
+ }
1027
+ interface ToolMember {
1028
+ completion?: never;
1029
+ tool: TraceToolCall;
1030
+ $unknown?: never;
1031
+ }
1032
+ /**
1033
+ * @public
1034
+ */
1035
+ interface $UnknownMember {
1036
+ completion?: never;
1037
+ tool?: never;
1038
+ $unknown: [string, any];
1039
+ }
1040
+ interface Visitor<T> {
1041
+ completion: (value: TraceSegmentCompletionInput) => T;
1042
+ tool: (value: TraceToolCall) => T;
1043
+ _: (name: string, value: any) => T;
1044
+ }
1045
+ const visit: <T>(value: TraceSegmentInput, visitor: Visitor<T>) => T;
1046
+ }
1047
+ /**
1048
+ * @public
1049
+ */
1050
+ export type TraceToolResult = TraceToolResult.DelegationMember | TraceToolResult.FunctionMember | TraceToolResult.HangupMember | TraceToolResult.TransferMember | TraceToolResult.$UnknownMember;
1051
+ /**
1052
+ * @public
1053
+ */
1054
+ export declare namespace TraceToolResult {
1055
+ interface TransferMember {
1056
+ transfer: string;
1057
+ hangup?: never;
1058
+ delegation?: never;
1059
+ function?: never;
1060
+ $unknown?: never;
1061
+ }
1062
+ interface HangupMember {
1063
+ transfer?: never;
1064
+ hangup: string;
1065
+ delegation?: never;
1066
+ function?: never;
1067
+ $unknown?: never;
1068
+ }
1069
+ interface DelegationMember {
1070
+ transfer?: never;
1071
+ hangup?: never;
1072
+ delegation: string;
1073
+ function?: never;
1074
+ $unknown?: never;
1075
+ }
1076
+ interface FunctionMember {
1077
+ transfer?: never;
1078
+ hangup?: never;
1079
+ delegation?: never;
1080
+ function: string;
1081
+ $unknown?: never;
1082
+ }
1083
+ /**
1084
+ * @public
1085
+ */
1086
+ interface $UnknownMember {
1087
+ transfer?: never;
1088
+ hangup?: never;
1089
+ delegation?: never;
1090
+ function?: never;
1091
+ $unknown: [string, any];
1092
+ }
1093
+ interface Visitor<T> {
1094
+ transfer: (value: string) => T;
1095
+ hangup: (value: string) => T;
1096
+ delegation: (value: string) => T;
1097
+ function: (value: string) => T;
1098
+ _: (name: string, value: any) => T;
1099
+ }
1100
+ const visit: <T>(value: TraceToolResult, visitor: Visitor<T>) => T;
1101
+ }
1102
+ /**
1103
+ * @public
1104
+ */
1105
+ export type TraceSegmentResult = TraceSegmentResult.ErrorMember | TraceSegmentResult.JsonMember | TraceSegmentResult.TextMember | TraceSegmentResult.ToolsMember | TraceSegmentResult.$UnknownMember;
1106
+ /**
1107
+ * @public
1108
+ */
1109
+ export declare namespace TraceSegmentResult {
1110
+ interface ErrorMember {
1111
+ error: TraceErrorResult;
1112
+ tools?: never;
1113
+ text?: never;
1114
+ json?: never;
1115
+ $unknown?: never;
1116
+ }
1117
+ interface ToolsMember {
1118
+ error?: never;
1119
+ tools: (TraceToolResult)[];
1120
+ text?: never;
1121
+ json?: never;
1122
+ $unknown?: never;
1123
+ }
1124
+ interface TextMember {
1125
+ error?: never;
1126
+ tools?: never;
1127
+ text: string;
1128
+ json?: never;
1129
+ $unknown?: never;
1130
+ }
1131
+ interface JsonMember {
1132
+ error?: never;
1133
+ tools?: never;
1134
+ text?: never;
1135
+ json: __DocumentType;
1136
+ $unknown?: never;
1137
+ }
1138
+ /**
1139
+ * @public
1140
+ */
1141
+ interface $UnknownMember {
1142
+ error?: never;
1143
+ tools?: never;
1144
+ text?: never;
1145
+ json?: never;
1146
+ $unknown: [string, any];
1147
+ }
1148
+ interface Visitor<T> {
1149
+ error: (value: TraceErrorResult) => T;
1150
+ tools: (value: (TraceToolResult)[]) => T;
1151
+ text: (value: string) => T;
1152
+ json: (value: __DocumentType) => T;
1153
+ _: (name: string, value: any) => T;
1154
+ }
1155
+ const visit: <T>(value: TraceSegmentResult, visitor: Visitor<T>) => T;
1156
+ }
1157
+ /**
1158
+ * @public
1159
+ * @enum
1160
+ */
1161
+ export declare const TraceSegmentStatus: {
1162
+ readonly COMPLETE: "complete";
1163
+ readonly ERROR: "error";
1164
+ readonly PENDING: "pending";
1165
+ };
1166
+ /**
1167
+ * @public
1168
+ */
1169
+ export type TraceSegmentStatus = typeof TraceSegmentStatus[keyof typeof TraceSegmentStatus];
1170
+ /**
1171
+ * @public
1172
+ */
1173
+ export interface TraceSegment {
1174
+ id: string;
1175
+ activityId: string;
1176
+ version: number;
1177
+ status: TraceSegmentStatus;
1178
+ input: TraceSegmentInput;
1179
+ result?: TraceSegmentResult;
1180
+ start: number;
1181
+ duration?: number;
1182
+ }
1183
+ /**
1184
+ * @public
1185
+ * @enum
1186
+ */
1187
+ export declare const TraceSessionStatus: {
1188
+ readonly COMPLETE: "complete";
1189
+ readonly COMPLETE_WITH_ERROR: "complete_with_error";
1190
+ readonly PENDING: "pending";
1191
+ };
1192
+ /**
1193
+ * @public
1194
+ */
1195
+ export type TraceSessionStatus = typeof TraceSessionStatus[keyof typeof TraceSessionStatus];
1196
+ /**
1197
+ * @public
1198
+ */
1199
+ export interface TraceSession {
533
1200
  sessionId: string;
1201
+ connectionId: string;
1202
+ company: string;
534
1203
  botId: string;
1204
+ botName: string;
535
1205
  callId: string;
536
1206
  flowIndex: number;
537
- event: SessionEndedEvent;
1207
+ language?: string;
1208
+ callerName?: string;
1209
+ callerNumber?: string;
1210
+ status: TraceSessionStatus;
1211
+ start: number;
1212
+ duration?: number;
538
1213
  }
539
1214
  /**
540
1215
  * @public
541
1216
  */
542
- export interface SessionStartedEvent {
543
- type: VoiceBotEventType;
1217
+ export type PubSubBroadcastItem = PubSubBroadcastItem.ActivityMember | PubSubBroadcastItem.SegmentMember | PubSubBroadcastItem.SessionMember | PubSubBroadcastItem.$UnknownMember;
1218
+ /**
1219
+ * @public
1220
+ */
1221
+ export declare namespace PubSubBroadcastItem {
1222
+ interface SessionMember {
1223
+ session: TraceSession;
1224
+ activity?: never;
1225
+ segment?: never;
1226
+ $unknown?: never;
1227
+ }
1228
+ interface ActivityMember {
1229
+ session?: never;
1230
+ activity: TraceActivity;
1231
+ segment?: never;
1232
+ $unknown?: never;
1233
+ }
1234
+ interface SegmentMember {
1235
+ session?: never;
1236
+ activity?: never;
1237
+ segment: TraceSegment;
1238
+ $unknown?: never;
1239
+ }
544
1240
  /**
545
- * The language code that represents the language spoken in the session.
546
1241
  * @public
547
1242
  */
548
- language: string;
549
- time: number;
1243
+ interface $UnknownMember {
1244
+ session?: never;
1245
+ activity?: never;
1246
+ segment?: never;
1247
+ $unknown: [string, any];
1248
+ }
1249
+ interface Visitor<T> {
1250
+ session: (value: TraceSession) => T;
1251
+ activity: (value: TraceActivity) => T;
1252
+ segment: (value: TraceSegment) => T;
1253
+ _: (name: string, value: any) => T;
1254
+ }
1255
+ const visit: <T>(value: PubSubBroadcastItem, visitor: Visitor<T>) => T;
550
1256
  }
551
1257
  /**
552
1258
  * @public
553
1259
  */
554
- export interface SessionStartedWebhookEvent {
1260
+ export interface PubSubBroadcastWebsocketEvent {
1261
+ event: string;
1262
+ topic: string;
1263
+ items: (PubSubBroadcastItem)[];
1264
+ }
1265
+ /**
1266
+ * @public
1267
+ */
1268
+ export interface PubSubSubscribedWebsocketEvent {
1269
+ event: string;
1270
+ topic: string;
1271
+ }
1272
+ /**
1273
+ * @public
1274
+ */
1275
+ export interface PubSubSubscribeWebsocketCommand {
1276
+ action: string;
1277
+ topic: string;
1278
+ }
1279
+ /**
1280
+ * @public
1281
+ */
1282
+ export interface PubSubUnsubscribedWebsocketEvent {
1283
+ event: string;
1284
+ topic: string;
1285
+ }
1286
+ /**
1287
+ * @public
1288
+ */
1289
+ export interface PubSubUnsubscribeWebsocketCommand {
1290
+ action: string;
1291
+ topic: string;
1292
+ }
1293
+ /**
1294
+ * @public
1295
+ */
1296
+ export interface ReplyWebhookEvent {
555
1297
  sessionId: string;
556
1298
  botId: string;
557
1299
  callId: string;
558
1300
  flowIndex: number;
559
- event: SessionStartedEvent;
1301
+ event: ReplyEvent;
560
1302
  }
561
1303
  /**
562
1304
  * @public
563
1305
  */
564
- export interface TranscriptionEvent {
1306
+ export interface SessionEndedEvent {
565
1307
  type: VoiceBotEventType;
566
- id: string;
567
- text: string;
1308
+ error?: string;
568
1309
  time: number;
569
1310
  }
570
1311
  /**
571
1312
  * @public
572
1313
  */
573
- export interface TranscriptionWebhookEvent {
1314
+ export interface SessionEndedWebhookEvent {
574
1315
  sessionId: string;
575
1316
  botId: string;
576
1317
  callId: string;
577
1318
  flowIndex: number;
578
- event: TranscriptionEvent;
1319
+ event: SessionEndedEvent;
579
1320
  }
580
1321
  /**
581
1322
  * @public
582
1323
  */
583
- export interface TranscriptionWebsocketEvent {
584
- type: string;
585
- event: TranscriptionEvent;
1324
+ export interface SessionStartedEvent {
1325
+ type: VoiceBotEventType;
1326
+ /**
1327
+ * The language code that represents the language spoken in the session.
1328
+ * @public
1329
+ */
1330
+ language: string;
1331
+ time: number;
586
1332
  }
587
1333
  /**
588
1334
  * @public
589
1335
  */
590
- export interface TransferWebsocketCommandData {
591
- context: string;
592
- extension: string;
593
- type: VoiceBotCommandType;
1336
+ export interface SessionStartedWebhookEvent {
1337
+ sessionId: string;
1338
+ botId: string;
1339
+ callId: string;
1340
+ flowIndex: number;
1341
+ event: SessionStartedEvent;
594
1342
  }
595
1343
  /**
596
1344
  * @public
597
1345
  */
598
- export interface TransferWebsocketCommand {
599
- type: string;
600
- command: TransferWebsocketCommandData;
1346
+ export interface TranscriptionWebhookEvent {
1347
+ sessionId: string;
1348
+ botId: string;
1349
+ callId: string;
1350
+ flowIndex: number;
1351
+ event: TranscriptionEvent;
601
1352
  }
602
1353
  /**
603
1354
  * @public
@@ -618,19 +1369,32 @@ export interface DescribeEventOutput {
618
1369
  PlaybackWebhookEvent?: PlaybackWebhookEvent;
619
1370
  InterruptionWebhookEvent?: InterruptionWebhookEvent;
620
1371
  CompleteWebhookEvent?: CompleteWebhookEvent;
1372
+ PubSubBroadcastWebsocketEvent?: PubSubBroadcastWebsocketEvent;
1373
+ PubSubSubscribeWebsocketCommand?: PubSubSubscribeWebsocketCommand;
1374
+ PubSubSubscribedWebsocketEvent?: PubSubSubscribedWebsocketEvent;
1375
+ PubSubUnsubscribeWebsocketCommand?: PubSubUnsubscribeWebsocketCommand;
1376
+ PubSubUnsubscribedWebsocketEvent?: PubSubUnsubscribedWebsocketEvent;
621
1377
  }
622
1378
  /**
623
1379
  * @public
624
1380
  */
625
- export interface GetVoiceBotInput {
1381
+ export interface GetTraceInput {
626
1382
  company?: string;
627
- botId: string;
1383
+ sessionId: string;
628
1384
  }
629
1385
  /**
630
1386
  * @public
631
1387
  */
632
- export interface GetVoiceBotOutput {
633
- bot: VoiceBot;
1388
+ export interface Trace {
1389
+ session: TraceSession;
1390
+ activities: (TraceActivity)[];
1391
+ segments: (TraceSegment)[];
1392
+ }
1393
+ /**
1394
+ * @public
1395
+ */
1396
+ export interface GetTraceOutput {
1397
+ trace: Trace;
634
1398
  }
635
1399
  /**
636
1400
  * @public
@@ -644,6 +1408,31 @@ export declare class VoiceBotNotFoundException extends __BaseException {
644
1408
  */
645
1409
  constructor(opts: __ExceptionOptionType<VoiceBotNotFoundException, __BaseException>);
646
1410
  }
1411
+ /**
1412
+ * @public
1413
+ */
1414
+ export interface GetVoiceBotInput {
1415
+ company?: string;
1416
+ botId: string;
1417
+ }
1418
+ /**
1419
+ * @public
1420
+ */
1421
+ export interface GetVoiceBotOutput {
1422
+ bot: VoiceBot;
1423
+ }
1424
+ /**
1425
+ * @public
1426
+ */
1427
+ export interface ListTracesInput {
1428
+ company?: string;
1429
+ }
1430
+ /**
1431
+ * @public
1432
+ */
1433
+ export interface ListTracesOutput {
1434
+ traces: (TraceSession)[];
1435
+ }
647
1436
  /**
648
1437
  * @public
649
1438
  */