@scout9/admin 1.0.0-alpha.0.0.67 → 1.0.0-alpha.0.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/api.d.ts +1968 -229
- package/build/api.js +218 -11
- package/package.json +1 -1
- package/src/api.ts +1932 -239
- package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts
CHANGED
|
@@ -605,12 +605,30 @@ export interface ContextualizerResponse {
|
|
|
605
605
|
* @interface Conversation
|
|
606
606
|
*/
|
|
607
607
|
export interface Conversation {
|
|
608
|
+
/**
|
|
609
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
610
|
+
* @type {string}
|
|
611
|
+
* @memberof Conversation
|
|
612
|
+
*/
|
|
613
|
+
'$id'?: string;
|
|
614
|
+
/**
|
|
615
|
+
* Business/organization this conversation belongs to
|
|
616
|
+
* @type {string}
|
|
617
|
+
* @memberof Conversation
|
|
618
|
+
*/
|
|
619
|
+
'$business': string;
|
|
608
620
|
/**
|
|
609
621
|
* Default agent persona id assigned to the conversation(s)
|
|
610
622
|
* @type {string}
|
|
611
623
|
* @memberof Conversation
|
|
612
624
|
*/
|
|
613
625
|
'$agent': string;
|
|
626
|
+
/**
|
|
627
|
+
* Customer this conversation is with
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof Conversation
|
|
630
|
+
*/
|
|
631
|
+
'$customer': string;
|
|
614
632
|
/**
|
|
615
633
|
* Initial contexts to load when starting the conversation
|
|
616
634
|
* @type {Array<string>}
|
|
@@ -619,80 +637,158 @@ export interface Conversation {
|
|
|
619
637
|
'initialContexts'?: Array<string>;
|
|
620
638
|
/**
|
|
621
639
|
*
|
|
622
|
-
* @type {
|
|
640
|
+
* @type {ConversationChannel}
|
|
641
|
+
* @memberof Conversation
|
|
642
|
+
*/
|
|
643
|
+
'channel': ConversationChannel;
|
|
644
|
+
/**
|
|
645
|
+
*
|
|
646
|
+
* @type {ConversationChannelProps}
|
|
647
|
+
* @memberof Conversation
|
|
648
|
+
*/
|
|
649
|
+
'channelProps'?: ConversationChannelProps;
|
|
650
|
+
/**
|
|
651
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
652
|
+
* @type {boolean}
|
|
623
653
|
* @memberof Conversation
|
|
624
654
|
*/
|
|
625
|
-
'
|
|
655
|
+
'locked'?: boolean | null;
|
|
626
656
|
/**
|
|
627
|
-
*
|
|
657
|
+
* Machine-readable lock reason.
|
|
628
658
|
* @type {string}
|
|
629
659
|
* @memberof Conversation
|
|
630
660
|
*/
|
|
631
|
-
'
|
|
661
|
+
'lockCode'?: ConversationLockCodeEnum;
|
|
632
662
|
/**
|
|
633
|
-
*
|
|
663
|
+
* Human-readable locked reason.
|
|
634
664
|
* @type {string}
|
|
635
665
|
* @memberof Conversation
|
|
636
|
-
* @deprecated
|
|
637
666
|
*/
|
|
638
|
-
'
|
|
667
|
+
'lockedReason'?: string | null;
|
|
639
668
|
/**
|
|
640
|
-
*
|
|
641
|
-
* @type {
|
|
669
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
670
|
+
* @type {number}
|
|
642
671
|
* @memberof Conversation
|
|
643
672
|
*/
|
|
644
|
-
'
|
|
673
|
+
'lockAttempts'?: number | null;
|
|
645
674
|
/**
|
|
646
|
-
*
|
|
647
|
-
* @type {
|
|
675
|
+
* Contact that received a forward handoff.
|
|
676
|
+
* @type {string}
|
|
648
677
|
* @memberof Conversation
|
|
649
678
|
*/
|
|
650
|
-
'
|
|
651
|
-
}
|
|
652
|
-
/**
|
|
653
|
-
*
|
|
654
|
-
* @export
|
|
655
|
-
* @interface ConversationAllOf
|
|
656
|
-
*/
|
|
657
|
-
export interface ConversationAllOf {
|
|
679
|
+
'forwardedTo'?: string | null;
|
|
658
680
|
/**
|
|
659
|
-
*
|
|
681
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
660
682
|
* @type {string}
|
|
661
|
-
* @memberof
|
|
683
|
+
* @memberof Conversation
|
|
662
684
|
*/
|
|
663
|
-
'
|
|
685
|
+
'forwarded'?: string | null;
|
|
664
686
|
/**
|
|
665
|
-
*
|
|
687
|
+
* Operator or workflow note attached to the forward.
|
|
666
688
|
* @type {string}
|
|
667
|
-
* @memberof
|
|
668
|
-
* @deprecated
|
|
689
|
+
* @memberof Conversation
|
|
669
690
|
*/
|
|
670
|
-
'
|
|
691
|
+
'forwardNote'?: string | null;
|
|
671
692
|
/**
|
|
672
|
-
*
|
|
673
|
-
* @type {
|
|
674
|
-
* @memberof
|
|
693
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof Conversation
|
|
675
696
|
*/
|
|
676
|
-
'
|
|
697
|
+
'initiated'?: string;
|
|
677
698
|
/**
|
|
678
|
-
*
|
|
679
|
-
* @type {
|
|
680
|
-
* @memberof
|
|
699
|
+
* Detected intent attached at conversation start or first customer message.
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof Conversation
|
|
702
|
+
*/
|
|
703
|
+
'intent'?: string | null;
|
|
704
|
+
/**
|
|
705
|
+
* Confidence score for the detected intent.
|
|
706
|
+
* @type {number}
|
|
707
|
+
* @memberof Conversation
|
|
708
|
+
*/
|
|
709
|
+
'intentScore'?: number | null;
|
|
710
|
+
/**
|
|
711
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof Conversation
|
|
714
|
+
*/
|
|
715
|
+
'read'?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Server-assigned conversation metadata.
|
|
718
|
+
* @type {{ [key: string]: any; }}
|
|
719
|
+
* @memberof Conversation
|
|
720
|
+
*/
|
|
721
|
+
'metadata'?: {
|
|
722
|
+
[key: string]: any;
|
|
723
|
+
};
|
|
724
|
+
/**
|
|
725
|
+
* Metadata for anticipating a preflight response.
|
|
726
|
+
* @type {{ [key: string]: any; }}
|
|
727
|
+
* @memberof Conversation
|
|
728
|
+
*/
|
|
729
|
+
'anticipate'?: {
|
|
730
|
+
[key: string]: any;
|
|
731
|
+
};
|
|
732
|
+
/**
|
|
733
|
+
* Command-flow configuration attached to this conversation.
|
|
734
|
+
* @type {{ [key: string]: any; }}
|
|
735
|
+
* @memberof Conversation
|
|
736
|
+
*/
|
|
737
|
+
'command'?: {
|
|
738
|
+
[key: string]: any;
|
|
739
|
+
};
|
|
740
|
+
/**
|
|
741
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
742
|
+
* @type {string}
|
|
743
|
+
* @memberof Conversation
|
|
681
744
|
*/
|
|
682
|
-
'
|
|
745
|
+
'ingress'?: ConversationIngressEnum;
|
|
683
746
|
}
|
|
747
|
+
export declare const ConversationLockCodeEnum: {
|
|
748
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
749
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
750
|
+
readonly RuntimeError: "runtime_error";
|
|
751
|
+
readonly ManualMode: "manual_mode";
|
|
752
|
+
readonly PolicyBlock: "policy_block";
|
|
753
|
+
};
|
|
754
|
+
export type ConversationLockCodeEnum = typeof ConversationLockCodeEnum[keyof typeof ConversationLockCodeEnum];
|
|
755
|
+
export declare const ConversationIngressEnum: {
|
|
756
|
+
readonly Auto: "auto";
|
|
757
|
+
readonly Manual: "manual";
|
|
758
|
+
readonly App: "app";
|
|
759
|
+
readonly Webhook: "webhook";
|
|
760
|
+
};
|
|
761
|
+
export type ConversationIngressEnum = typeof ConversationIngressEnum[keyof typeof ConversationIngressEnum];
|
|
684
762
|
/**
|
|
685
763
|
* Base props all conversation types will have
|
|
686
764
|
* @export
|
|
687
765
|
* @interface ConversationBase
|
|
688
766
|
*/
|
|
689
767
|
export interface ConversationBase {
|
|
768
|
+
/**
|
|
769
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
770
|
+
* @type {string}
|
|
771
|
+
* @memberof ConversationBase
|
|
772
|
+
*/
|
|
773
|
+
'$id'?: string;
|
|
774
|
+
/**
|
|
775
|
+
* Business/organization this conversation belongs to
|
|
776
|
+
* @type {string}
|
|
777
|
+
* @memberof ConversationBase
|
|
778
|
+
*/
|
|
779
|
+
'$business'?: string;
|
|
690
780
|
/**
|
|
691
781
|
* Default agent persona id assigned to the conversation(s)
|
|
692
782
|
* @type {string}
|
|
693
783
|
* @memberof ConversationBase
|
|
694
784
|
*/
|
|
695
785
|
'$agent'?: string;
|
|
786
|
+
/**
|
|
787
|
+
* Customer this conversation is with
|
|
788
|
+
* @type {string}
|
|
789
|
+
* @memberof ConversationBase
|
|
790
|
+
*/
|
|
791
|
+
'$customer'?: string;
|
|
696
792
|
/**
|
|
697
793
|
* Initial contexts to load when starting the conversation
|
|
698
794
|
* @type {Array<string>}
|
|
@@ -701,30 +797,184 @@ export interface ConversationBase {
|
|
|
701
797
|
'initialContexts'?: Array<string>;
|
|
702
798
|
/**
|
|
703
799
|
*
|
|
704
|
-
* @type {
|
|
800
|
+
* @type {ConversationChannel}
|
|
801
|
+
* @memberof ConversationBase
|
|
802
|
+
*/
|
|
803
|
+
'channel'?: ConversationChannel;
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {ConversationChannelProps}
|
|
807
|
+
* @memberof ConversationBase
|
|
808
|
+
*/
|
|
809
|
+
'channelProps'?: ConversationChannelProps;
|
|
810
|
+
/**
|
|
811
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
812
|
+
* @type {boolean}
|
|
813
|
+
* @memberof ConversationBase
|
|
814
|
+
*/
|
|
815
|
+
'locked'?: boolean | null;
|
|
816
|
+
/**
|
|
817
|
+
* Machine-readable lock reason.
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof ConversationBase
|
|
820
|
+
*/
|
|
821
|
+
'lockCode'?: ConversationBaseLockCodeEnum;
|
|
822
|
+
/**
|
|
823
|
+
* Human-readable locked reason.
|
|
824
|
+
* @type {string}
|
|
825
|
+
* @memberof ConversationBase
|
|
826
|
+
*/
|
|
827
|
+
'lockedReason'?: string | null;
|
|
828
|
+
/**
|
|
829
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
830
|
+
* @type {number}
|
|
831
|
+
* @memberof ConversationBase
|
|
832
|
+
*/
|
|
833
|
+
'lockAttempts'?: number | null;
|
|
834
|
+
/**
|
|
835
|
+
* Contact that received a forward handoff.
|
|
836
|
+
* @type {string}
|
|
837
|
+
* @memberof ConversationBase
|
|
838
|
+
*/
|
|
839
|
+
'forwardedTo'?: string | null;
|
|
840
|
+
/**
|
|
841
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
842
|
+
* @type {string}
|
|
843
|
+
* @memberof ConversationBase
|
|
844
|
+
*/
|
|
845
|
+
'forwarded'?: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* Operator or workflow note attached to the forward.
|
|
848
|
+
* @type {string}
|
|
849
|
+
* @memberof ConversationBase
|
|
850
|
+
*/
|
|
851
|
+
'forwardNote'?: string | null;
|
|
852
|
+
/**
|
|
853
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof ConversationBase
|
|
856
|
+
*/
|
|
857
|
+
'initiated'?: string;
|
|
858
|
+
/**
|
|
859
|
+
* Detected intent attached at conversation start or first customer message.
|
|
860
|
+
* @type {string}
|
|
861
|
+
* @memberof ConversationBase
|
|
862
|
+
*/
|
|
863
|
+
'intent'?: string | null;
|
|
864
|
+
/**
|
|
865
|
+
* Confidence score for the detected intent.
|
|
866
|
+
* @type {number}
|
|
867
|
+
* @memberof ConversationBase
|
|
868
|
+
*/
|
|
869
|
+
'intentScore'?: number | null;
|
|
870
|
+
/**
|
|
871
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof ConversationBase
|
|
874
|
+
*/
|
|
875
|
+
'read'?: string;
|
|
876
|
+
/**
|
|
877
|
+
* Server-assigned conversation metadata.
|
|
878
|
+
* @type {{ [key: string]: any; }}
|
|
879
|
+
* @memberof ConversationBase
|
|
880
|
+
*/
|
|
881
|
+
'metadata'?: {
|
|
882
|
+
[key: string]: any;
|
|
883
|
+
};
|
|
884
|
+
/**
|
|
885
|
+
* Metadata for anticipating a preflight response.
|
|
886
|
+
* @type {{ [key: string]: any; }}
|
|
887
|
+
* @memberof ConversationBase
|
|
888
|
+
*/
|
|
889
|
+
'anticipate'?: {
|
|
890
|
+
[key: string]: any;
|
|
891
|
+
};
|
|
892
|
+
/**
|
|
893
|
+
* Command-flow configuration attached to this conversation.
|
|
894
|
+
* @type {{ [key: string]: any; }}
|
|
895
|
+
* @memberof ConversationBase
|
|
896
|
+
*/
|
|
897
|
+
'command'?: {
|
|
898
|
+
[key: string]: any;
|
|
899
|
+
};
|
|
900
|
+
/**
|
|
901
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
902
|
+
* @type {string}
|
|
705
903
|
* @memberof ConversationBase
|
|
706
904
|
*/
|
|
707
|
-
'
|
|
905
|
+
'ingress'?: ConversationBaseIngressEnum;
|
|
708
906
|
}
|
|
907
|
+
export declare const ConversationBaseLockCodeEnum: {
|
|
908
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
909
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
910
|
+
readonly RuntimeError: "runtime_error";
|
|
911
|
+
readonly ManualMode: "manual_mode";
|
|
912
|
+
readonly PolicyBlock: "policy_block";
|
|
913
|
+
};
|
|
914
|
+
export type ConversationBaseLockCodeEnum = typeof ConversationBaseLockCodeEnum[keyof typeof ConversationBaseLockCodeEnum];
|
|
915
|
+
export declare const ConversationBaseIngressEnum: {
|
|
916
|
+
readonly Auto: "auto";
|
|
917
|
+
readonly Manual: "manual";
|
|
918
|
+
readonly App: "app";
|
|
919
|
+
readonly Webhook: "webhook";
|
|
920
|
+
};
|
|
921
|
+
export type ConversationBaseIngressEnum = typeof ConversationBaseIngressEnum[keyof typeof ConversationBaseIngressEnum];
|
|
922
|
+
/**
|
|
923
|
+
* Canonical channel that initiated and should continue the customer conversation.
|
|
924
|
+
* @export
|
|
925
|
+
* @enum {string}
|
|
926
|
+
*/
|
|
927
|
+
export declare const ConversationChannel: {
|
|
928
|
+
readonly Web: "web";
|
|
929
|
+
readonly DemoPhoneTest: "demo_phone_test";
|
|
930
|
+
readonly SmsPhone: "sms_phone";
|
|
931
|
+
readonly Outlook: "outlook";
|
|
932
|
+
readonly Gmail: "gmail";
|
|
933
|
+
readonly Iphone: "iphone";
|
|
934
|
+
readonly Android: "android";
|
|
935
|
+
readonly Teams: "teams";
|
|
936
|
+
readonly Discord: "discord";
|
|
937
|
+
readonly Whatsapp: "whatsapp";
|
|
938
|
+
};
|
|
939
|
+
export type ConversationChannel = typeof ConversationChannel[keyof typeof ConversationChannel];
|
|
709
940
|
/**
|
|
710
|
-
*
|
|
941
|
+
* Channel-specific properties needed to continue a conversation on its canonical channel.
|
|
711
942
|
* @export
|
|
712
|
-
* @interface
|
|
943
|
+
* @interface ConversationChannelProps
|
|
713
944
|
*/
|
|
714
|
-
export interface
|
|
945
|
+
export interface ConversationChannelProps {
|
|
946
|
+
[key: string]: any;
|
|
715
947
|
/**
|
|
716
|
-
*
|
|
948
|
+
* Subject line for email-style channels such as Gmail and Outlook.
|
|
717
949
|
* @type {string}
|
|
718
|
-
* @memberof
|
|
950
|
+
* @memberof ConversationChannelProps
|
|
719
951
|
*/
|
|
720
952
|
'subject'?: string;
|
|
721
953
|
/**
|
|
722
|
-
*
|
|
954
|
+
* Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
|
|
723
955
|
* @type {string}
|
|
724
|
-
* @memberof
|
|
956
|
+
* @memberof ConversationChannelProps
|
|
725
957
|
*/
|
|
726
958
|
'platformEmailThreadId'?: string;
|
|
959
|
+
/**
|
|
960
|
+
* Twilio message sid that initiated this conversation.
|
|
961
|
+
* @type {string}
|
|
962
|
+
* @memberof ConversationChannelProps
|
|
963
|
+
*/
|
|
964
|
+
'smsMessageSid'?: string;
|
|
965
|
+
/**
|
|
966
|
+
* Persisted channel-resolution path used for the current conversation.
|
|
967
|
+
* @type {string}
|
|
968
|
+
* @memberof ConversationChannelProps
|
|
969
|
+
*/
|
|
970
|
+
'channelResolutionPath'?: ConversationChannelPropsChannelResolutionPathEnum;
|
|
727
971
|
}
|
|
972
|
+
export declare const ConversationChannelPropsChannelResolutionPathEnum: {
|
|
973
|
+
readonly Production: "twilio_production";
|
|
974
|
+
readonly LegacyPmt: "twilio_legacy_pmt";
|
|
975
|
+
readonly FreeBridge: "twilio_free_bridge";
|
|
976
|
+
};
|
|
977
|
+
export type ConversationChannelPropsChannelResolutionPathEnum = typeof ConversationChannelPropsChannelResolutionPathEnum[keyof typeof ConversationChannelPropsChannelResolutionPathEnum];
|
|
728
978
|
/**
|
|
729
979
|
*
|
|
730
980
|
* @export
|
|
@@ -767,13 +1017,6 @@ export interface ConversationContextField {
|
|
|
767
1017
|
* @memberof ConversationContextField
|
|
768
1018
|
*/
|
|
769
1019
|
'logic'?: Logic;
|
|
770
|
-
/**
|
|
771
|
-
* The conditions of the conversation
|
|
772
|
-
* @type {Array<ConversationContextGroup>}
|
|
773
|
-
* @memberof ConversationContextField
|
|
774
|
-
* @deprecated
|
|
775
|
-
*/
|
|
776
|
-
'conditions'?: Array<ConversationContextGroup>;
|
|
777
1020
|
/**
|
|
778
1021
|
* The triggers of the conversation
|
|
779
1022
|
* @type {Array<string>}
|
|
@@ -887,12 +1130,30 @@ export type ConversationContextValueOneOfInner = boolean | number | string;
|
|
|
887
1130
|
* @interface ConversationCreateRequest
|
|
888
1131
|
*/
|
|
889
1132
|
export interface ConversationCreateRequest {
|
|
1133
|
+
/**
|
|
1134
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
1135
|
+
* @type {string}
|
|
1136
|
+
* @memberof ConversationCreateRequest
|
|
1137
|
+
*/
|
|
1138
|
+
'$id'?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* Business/organization this conversation belongs to
|
|
1141
|
+
* @type {string}
|
|
1142
|
+
* @memberof ConversationCreateRequest
|
|
1143
|
+
*/
|
|
1144
|
+
'$business': string;
|
|
890
1145
|
/**
|
|
891
1146
|
* Default agent persona id assigned to the conversation(s)
|
|
892
1147
|
* @type {string}
|
|
893
1148
|
* @memberof ConversationCreateRequest
|
|
894
1149
|
*/
|
|
895
1150
|
'$agent': string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Customer this conversation is with
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof ConversationCreateRequest
|
|
1155
|
+
*/
|
|
1156
|
+
'$customer': string;
|
|
896
1157
|
/**
|
|
897
1158
|
* Initial contexts to load when starting the conversation
|
|
898
1159
|
* @type {Array<string>}
|
|
@@ -901,35 +1162,112 @@ export interface ConversationCreateRequest {
|
|
|
901
1162
|
'initialContexts'?: Array<string>;
|
|
902
1163
|
/**
|
|
903
1164
|
*
|
|
904
|
-
* @type {
|
|
1165
|
+
* @type {ConversationChannel}
|
|
1166
|
+
* @memberof ConversationCreateRequest
|
|
1167
|
+
*/
|
|
1168
|
+
'channel': ConversationChannel;
|
|
1169
|
+
/**
|
|
1170
|
+
*
|
|
1171
|
+
* @type {ConversationChannelProps}
|
|
1172
|
+
* @memberof ConversationCreateRequest
|
|
1173
|
+
*/
|
|
1174
|
+
'channelProps'?: ConversationChannelProps;
|
|
1175
|
+
/**
|
|
1176
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
1177
|
+
* @type {boolean}
|
|
905
1178
|
* @memberof ConversationCreateRequest
|
|
906
1179
|
*/
|
|
907
|
-
'
|
|
1180
|
+
'locked'?: boolean | null;
|
|
908
1181
|
/**
|
|
909
|
-
*
|
|
1182
|
+
* Machine-readable lock reason.
|
|
910
1183
|
* @type {string}
|
|
911
1184
|
* @memberof ConversationCreateRequest
|
|
912
1185
|
*/
|
|
913
|
-
'
|
|
1186
|
+
'lockCode'?: ConversationCreateRequestLockCodeEnum;
|
|
914
1187
|
/**
|
|
915
|
-
*
|
|
1188
|
+
* Human-readable locked reason.
|
|
916
1189
|
* @type {string}
|
|
917
1190
|
* @memberof ConversationCreateRequest
|
|
918
|
-
* @deprecated
|
|
919
1191
|
*/
|
|
920
|
-
'
|
|
1192
|
+
'lockedReason'?: string | null;
|
|
921
1193
|
/**
|
|
922
|
-
*
|
|
923
|
-
* @type {
|
|
1194
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
1195
|
+
* @type {number}
|
|
924
1196
|
* @memberof ConversationCreateRequest
|
|
925
1197
|
*/
|
|
926
|
-
'
|
|
1198
|
+
'lockAttempts'?: number | null;
|
|
927
1199
|
/**
|
|
928
|
-
*
|
|
929
|
-
* @type {
|
|
1200
|
+
* Contact that received a forward handoff.
|
|
1201
|
+
* @type {string}
|
|
1202
|
+
* @memberof ConversationCreateRequest
|
|
1203
|
+
*/
|
|
1204
|
+
'forwardedTo'?: string | null;
|
|
1205
|
+
/**
|
|
1206
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
1207
|
+
* @type {string}
|
|
1208
|
+
* @memberof ConversationCreateRequest
|
|
1209
|
+
*/
|
|
1210
|
+
'forwarded'?: string | null;
|
|
1211
|
+
/**
|
|
1212
|
+
* Operator or workflow note attached to the forward.
|
|
1213
|
+
* @type {string}
|
|
1214
|
+
* @memberof ConversationCreateRequest
|
|
1215
|
+
*/
|
|
1216
|
+
'forwardNote'?: string | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
1219
|
+
* @type {string}
|
|
1220
|
+
* @memberof ConversationCreateRequest
|
|
1221
|
+
*/
|
|
1222
|
+
'initiated'?: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* Detected intent attached at conversation start or first customer message.
|
|
1225
|
+
* @type {string}
|
|
1226
|
+
* @memberof ConversationCreateRequest
|
|
1227
|
+
*/
|
|
1228
|
+
'intent'?: string | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* Confidence score for the detected intent.
|
|
1231
|
+
* @type {number}
|
|
1232
|
+
* @memberof ConversationCreateRequest
|
|
1233
|
+
*/
|
|
1234
|
+
'intentScore'?: number | null;
|
|
1235
|
+
/**
|
|
1236
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
1237
|
+
* @type {string}
|
|
1238
|
+
* @memberof ConversationCreateRequest
|
|
1239
|
+
*/
|
|
1240
|
+
'read'?: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* Server-assigned conversation metadata.
|
|
1243
|
+
* @type {{ [key: string]: any; }}
|
|
1244
|
+
* @memberof ConversationCreateRequest
|
|
1245
|
+
*/
|
|
1246
|
+
'metadata'?: {
|
|
1247
|
+
[key: string]: any;
|
|
1248
|
+
};
|
|
1249
|
+
/**
|
|
1250
|
+
* Metadata for anticipating a preflight response.
|
|
1251
|
+
* @type {{ [key: string]: any; }}
|
|
1252
|
+
* @memberof ConversationCreateRequest
|
|
1253
|
+
*/
|
|
1254
|
+
'anticipate'?: {
|
|
1255
|
+
[key: string]: any;
|
|
1256
|
+
};
|
|
1257
|
+
/**
|
|
1258
|
+
* Command-flow configuration attached to this conversation.
|
|
1259
|
+
* @type {{ [key: string]: any; }}
|
|
930
1260
|
* @memberof ConversationCreateRequest
|
|
931
1261
|
*/
|
|
932
|
-
'
|
|
1262
|
+
'command'?: {
|
|
1263
|
+
[key: string]: any;
|
|
1264
|
+
};
|
|
1265
|
+
/**
|
|
1266
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof ConversationCreateRequest
|
|
1269
|
+
*/
|
|
1270
|
+
'ingress'?: ConversationCreateRequestIngressEnum;
|
|
933
1271
|
/**
|
|
934
1272
|
* Appends a prefix to the conversation id, if a conversation id is prefixed with test, or dev, it will mute text messages
|
|
935
1273
|
* @type {string}
|
|
@@ -937,6 +1275,21 @@ export interface ConversationCreateRequest {
|
|
|
937
1275
|
*/
|
|
938
1276
|
'idPrefix'?: string;
|
|
939
1277
|
}
|
|
1278
|
+
export declare const ConversationCreateRequestLockCodeEnum: {
|
|
1279
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
1280
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
1281
|
+
readonly RuntimeError: "runtime_error";
|
|
1282
|
+
readonly ManualMode: "manual_mode";
|
|
1283
|
+
readonly PolicyBlock: "policy_block";
|
|
1284
|
+
};
|
|
1285
|
+
export type ConversationCreateRequestLockCodeEnum = typeof ConversationCreateRequestLockCodeEnum[keyof typeof ConversationCreateRequestLockCodeEnum];
|
|
1286
|
+
export declare const ConversationCreateRequestIngressEnum: {
|
|
1287
|
+
readonly Auto: "auto";
|
|
1288
|
+
readonly Manual: "manual";
|
|
1289
|
+
readonly App: "app";
|
|
1290
|
+
readonly Webhook: "webhook";
|
|
1291
|
+
};
|
|
1292
|
+
export type ConversationCreateRequestIngressEnum = typeof ConversationCreateRequestIngressEnum[keyof typeof ConversationCreateRequestIngressEnum];
|
|
940
1293
|
/**
|
|
941
1294
|
*
|
|
942
1295
|
* @export
|
|
@@ -1012,29 +1365,36 @@ export interface ConversationCreateResponseAllOf {
|
|
|
1012
1365
|
*/
|
|
1013
1366
|
'initiated': string;
|
|
1014
1367
|
}
|
|
1015
|
-
/**
|
|
1016
|
-
* Environment this conversation is in (phone, web, or email) - this determines which device to send messages to
|
|
1017
|
-
* @export
|
|
1018
|
-
* @enum {string}
|
|
1019
|
-
*/
|
|
1020
|
-
export declare const ConversationEnvironment: {
|
|
1021
|
-
readonly Phone: "phone";
|
|
1022
|
-
readonly Web: "web";
|
|
1023
|
-
readonly Email: "email";
|
|
1024
|
-
};
|
|
1025
|
-
export type ConversationEnvironment = typeof ConversationEnvironment[keyof typeof ConversationEnvironment];
|
|
1026
1368
|
/**
|
|
1027
1369
|
*
|
|
1028
1370
|
* @export
|
|
1029
1371
|
* @interface ConversationGetResponse
|
|
1030
1372
|
*/
|
|
1031
1373
|
export interface ConversationGetResponse {
|
|
1374
|
+
/**
|
|
1375
|
+
* The ID of the conversation
|
|
1376
|
+
* @type {string}
|
|
1377
|
+
* @memberof ConversationGetResponse
|
|
1378
|
+
*/
|
|
1379
|
+
'$id': string;
|
|
1380
|
+
/**
|
|
1381
|
+
* Business/organization this conversation belongs to
|
|
1382
|
+
* @type {string}
|
|
1383
|
+
* @memberof ConversationGetResponse
|
|
1384
|
+
*/
|
|
1385
|
+
'$business': string;
|
|
1032
1386
|
/**
|
|
1033
1387
|
* Default agent persona id assigned to the conversation(s)
|
|
1034
1388
|
* @type {string}
|
|
1035
1389
|
* @memberof ConversationGetResponse
|
|
1036
1390
|
*/
|
|
1037
1391
|
'$agent': string;
|
|
1392
|
+
/**
|
|
1393
|
+
* Customer this conversation is with
|
|
1394
|
+
* @type {string}
|
|
1395
|
+
* @memberof ConversationGetResponse
|
|
1396
|
+
*/
|
|
1397
|
+
'$customer': string;
|
|
1038
1398
|
/**
|
|
1039
1399
|
* Initial contexts to load when starting the conversation
|
|
1040
1400
|
* @type {Array<string>}
|
|
@@ -1043,53 +1403,58 @@ export interface ConversationGetResponse {
|
|
|
1043
1403
|
'initialContexts'?: Array<string>;
|
|
1044
1404
|
/**
|
|
1045
1405
|
*
|
|
1046
|
-
* @type {
|
|
1406
|
+
* @type {ConversationChannel}
|
|
1047
1407
|
* @memberof ConversationGetResponse
|
|
1048
1408
|
*/
|
|
1049
|
-
'
|
|
1409
|
+
'channel': ConversationChannel;
|
|
1050
1410
|
/**
|
|
1051
|
-
*
|
|
1052
|
-
* @type {
|
|
1411
|
+
*
|
|
1412
|
+
* @type {ConversationChannelProps}
|
|
1413
|
+
* @memberof ConversationGetResponse
|
|
1414
|
+
*/
|
|
1415
|
+
'channelProps'?: ConversationChannelProps;
|
|
1416
|
+
/**
|
|
1417
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
1418
|
+
* @type {boolean}
|
|
1053
1419
|
* @memberof ConversationGetResponse
|
|
1054
1420
|
*/
|
|
1055
|
-
'
|
|
1421
|
+
'locked'?: boolean | null;
|
|
1056
1422
|
/**
|
|
1057
|
-
*
|
|
1423
|
+
* Machine-readable lock reason.
|
|
1058
1424
|
* @type {string}
|
|
1059
1425
|
* @memberof ConversationGetResponse
|
|
1060
|
-
* @deprecated
|
|
1061
1426
|
*/
|
|
1062
|
-
'
|
|
1427
|
+
'lockCode'?: ConversationGetResponseLockCodeEnum;
|
|
1063
1428
|
/**
|
|
1064
|
-
*
|
|
1065
|
-
* @type {
|
|
1429
|
+
* Human-readable locked reason.
|
|
1430
|
+
* @type {string}
|
|
1066
1431
|
* @memberof ConversationGetResponse
|
|
1067
1432
|
*/
|
|
1068
|
-
'
|
|
1433
|
+
'lockedReason'?: string | null;
|
|
1069
1434
|
/**
|
|
1070
|
-
*
|
|
1071
|
-
* @type {
|
|
1435
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
1436
|
+
* @type {number}
|
|
1072
1437
|
* @memberof ConversationGetResponse
|
|
1073
1438
|
*/
|
|
1074
|
-
'
|
|
1439
|
+
'lockAttempts'?: number | null;
|
|
1075
1440
|
/**
|
|
1076
|
-
*
|
|
1441
|
+
* Contact that received a forward handoff.
|
|
1077
1442
|
* @type {string}
|
|
1078
1443
|
* @memberof ConversationGetResponse
|
|
1079
1444
|
*/
|
|
1080
|
-
'
|
|
1445
|
+
'forwardedTo'?: string | null;
|
|
1081
1446
|
/**
|
|
1082
|
-
*
|
|
1447
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
1083
1448
|
* @type {string}
|
|
1084
1449
|
* @memberof ConversationGetResponse
|
|
1085
1450
|
*/
|
|
1086
|
-
'
|
|
1451
|
+
'forwarded'?: string | null;
|
|
1087
1452
|
/**
|
|
1088
|
-
*
|
|
1453
|
+
* Operator or workflow note attached to the forward.
|
|
1089
1454
|
* @type {string}
|
|
1090
1455
|
* @memberof ConversationGetResponse
|
|
1091
1456
|
*/
|
|
1092
|
-
'
|
|
1457
|
+
'forwardNote'?: string | null;
|
|
1093
1458
|
/**
|
|
1094
1459
|
* ISO 8601 date string of when the conversation was initiated
|
|
1095
1460
|
* @type {string}
|
|
@@ -1097,12 +1462,87 @@ export interface ConversationGetResponse {
|
|
|
1097
1462
|
*/
|
|
1098
1463
|
'initiated': string;
|
|
1099
1464
|
/**
|
|
1100
|
-
*
|
|
1465
|
+
* Detected intent attached at conversation start or first customer message.
|
|
1101
1466
|
* @type {string}
|
|
1102
1467
|
* @memberof ConversationGetResponse
|
|
1103
1468
|
*/
|
|
1104
|
-
'
|
|
1469
|
+
'intent'?: string | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* Confidence score for the detected intent.
|
|
1472
|
+
* @type {number}
|
|
1473
|
+
* @memberof ConversationGetResponse
|
|
1474
|
+
*/
|
|
1475
|
+
'intentScore'?: number | null;
|
|
1476
|
+
/**
|
|
1477
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
1478
|
+
* @type {string}
|
|
1479
|
+
* @memberof ConversationGetResponse
|
|
1480
|
+
*/
|
|
1481
|
+
'read'?: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* Server-assigned conversation metadata.
|
|
1484
|
+
* @type {{ [key: string]: any; }}
|
|
1485
|
+
* @memberof ConversationGetResponse
|
|
1486
|
+
*/
|
|
1487
|
+
'metadata'?: {
|
|
1488
|
+
[key: string]: any;
|
|
1489
|
+
};
|
|
1490
|
+
/**
|
|
1491
|
+
* Metadata for anticipating a preflight response.
|
|
1492
|
+
* @type {{ [key: string]: any; }}
|
|
1493
|
+
* @memberof ConversationGetResponse
|
|
1494
|
+
*/
|
|
1495
|
+
'anticipate'?: {
|
|
1496
|
+
[key: string]: any;
|
|
1497
|
+
};
|
|
1498
|
+
/**
|
|
1499
|
+
* Command-flow configuration attached to this conversation.
|
|
1500
|
+
* @type {{ [key: string]: any; }}
|
|
1501
|
+
* @memberof ConversationGetResponse
|
|
1502
|
+
*/
|
|
1503
|
+
'command'?: {
|
|
1504
|
+
[key: string]: any;
|
|
1505
|
+
};
|
|
1506
|
+
/**
|
|
1507
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
1508
|
+
* @type {string}
|
|
1509
|
+
* @memberof ConversationGetResponse
|
|
1510
|
+
*/
|
|
1511
|
+
'ingress'?: ConversationGetResponseIngressEnum;
|
|
1512
|
+
/**
|
|
1513
|
+
* The client web url of the conversation
|
|
1514
|
+
* @type {string}
|
|
1515
|
+
* @memberof ConversationGetResponse
|
|
1516
|
+
*/
|
|
1517
|
+
'clientWebUrl'?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* The agent web url of the conversation (requires phone two-factor authentication)
|
|
1520
|
+
* @type {string}
|
|
1521
|
+
* @memberof ConversationGetResponse
|
|
1522
|
+
*/
|
|
1523
|
+
'agentWebUrl'?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* The agent test web url of the conversation, used for testing the conversation without notifying the customer
|
|
1526
|
+
* @type {string}
|
|
1527
|
+
* @memberof ConversationGetResponse
|
|
1528
|
+
*/
|
|
1529
|
+
'agentTestWebUrl'?: string;
|
|
1105
1530
|
}
|
|
1531
|
+
export declare const ConversationGetResponseLockCodeEnum: {
|
|
1532
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
1533
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
1534
|
+
readonly RuntimeError: "runtime_error";
|
|
1535
|
+
readonly ManualMode: "manual_mode";
|
|
1536
|
+
readonly PolicyBlock: "policy_block";
|
|
1537
|
+
};
|
|
1538
|
+
export type ConversationGetResponseLockCodeEnum = typeof ConversationGetResponseLockCodeEnum[keyof typeof ConversationGetResponseLockCodeEnum];
|
|
1539
|
+
export declare const ConversationGetResponseIngressEnum: {
|
|
1540
|
+
readonly Auto: "auto";
|
|
1541
|
+
readonly Manual: "manual";
|
|
1542
|
+
readonly App: "app";
|
|
1543
|
+
readonly Webhook: "webhook";
|
|
1544
|
+
};
|
|
1545
|
+
export type ConversationGetResponseIngressEnum = typeof ConversationGetResponseIngressEnum[keyof typeof ConversationGetResponseIngressEnum];
|
|
1106
1546
|
/**
|
|
1107
1547
|
*
|
|
1108
1548
|
* @export
|
|
@@ -1178,12 +1618,30 @@ export interface ConversationScheduleParams {
|
|
|
1178
1618
|
* @interface ConversationUpdateRequest
|
|
1179
1619
|
*/
|
|
1180
1620
|
export interface ConversationUpdateRequest {
|
|
1621
|
+
/**
|
|
1622
|
+
* The ID of the conversation to update
|
|
1623
|
+
* @type {string}
|
|
1624
|
+
* @memberof ConversationUpdateRequest
|
|
1625
|
+
*/
|
|
1626
|
+
'$id': string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Business/organization this conversation belongs to
|
|
1629
|
+
* @type {string}
|
|
1630
|
+
* @memberof ConversationUpdateRequest
|
|
1631
|
+
*/
|
|
1632
|
+
'$business'?: string;
|
|
1181
1633
|
/**
|
|
1182
1634
|
* Default agent persona id assigned to the conversation(s)
|
|
1183
1635
|
* @type {string}
|
|
1184
1636
|
* @memberof ConversationUpdateRequest
|
|
1185
1637
|
*/
|
|
1186
1638
|
'$agent'?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* Customer this conversation is with
|
|
1641
|
+
* @type {string}
|
|
1642
|
+
* @memberof ConversationUpdateRequest
|
|
1643
|
+
*/
|
|
1644
|
+
'$customer'?: string;
|
|
1187
1645
|
/**
|
|
1188
1646
|
* Initial contexts to load when starting the conversation
|
|
1189
1647
|
* @type {Array<string>}
|
|
@@ -1192,17 +1650,128 @@ export interface ConversationUpdateRequest {
|
|
|
1192
1650
|
'initialContexts'?: Array<string>;
|
|
1193
1651
|
/**
|
|
1194
1652
|
*
|
|
1195
|
-
* @type {
|
|
1653
|
+
* @type {ConversationChannel}
|
|
1196
1654
|
* @memberof ConversationUpdateRequest
|
|
1197
1655
|
*/
|
|
1198
|
-
'
|
|
1656
|
+
'channel'?: ConversationChannel;
|
|
1199
1657
|
/**
|
|
1200
|
-
*
|
|
1658
|
+
*
|
|
1659
|
+
* @type {ConversationChannelProps}
|
|
1660
|
+
* @memberof ConversationUpdateRequest
|
|
1661
|
+
*/
|
|
1662
|
+
'channelProps'?: ConversationChannelProps;
|
|
1663
|
+
/**
|
|
1664
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
1665
|
+
* @type {boolean}
|
|
1666
|
+
* @memberof ConversationUpdateRequest
|
|
1667
|
+
*/
|
|
1668
|
+
'locked'?: boolean | null;
|
|
1669
|
+
/**
|
|
1670
|
+
* Machine-readable lock reason.
|
|
1201
1671
|
* @type {string}
|
|
1202
1672
|
* @memberof ConversationUpdateRequest
|
|
1203
1673
|
*/
|
|
1204
|
-
'
|
|
1674
|
+
'lockCode'?: ConversationUpdateRequestLockCodeEnum;
|
|
1675
|
+
/**
|
|
1676
|
+
* Human-readable locked reason.
|
|
1677
|
+
* @type {string}
|
|
1678
|
+
* @memberof ConversationUpdateRequest
|
|
1679
|
+
*/
|
|
1680
|
+
'lockedReason'?: string | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
1683
|
+
* @type {number}
|
|
1684
|
+
* @memberof ConversationUpdateRequest
|
|
1685
|
+
*/
|
|
1686
|
+
'lockAttempts'?: number | null;
|
|
1687
|
+
/**
|
|
1688
|
+
* Contact that received a forward handoff.
|
|
1689
|
+
* @type {string}
|
|
1690
|
+
* @memberof ConversationUpdateRequest
|
|
1691
|
+
*/
|
|
1692
|
+
'forwardedTo'?: string | null;
|
|
1693
|
+
/**
|
|
1694
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
1695
|
+
* @type {string}
|
|
1696
|
+
* @memberof ConversationUpdateRequest
|
|
1697
|
+
*/
|
|
1698
|
+
'forwarded'?: string | null;
|
|
1699
|
+
/**
|
|
1700
|
+
* Operator or workflow note attached to the forward.
|
|
1701
|
+
* @type {string}
|
|
1702
|
+
* @memberof ConversationUpdateRequest
|
|
1703
|
+
*/
|
|
1704
|
+
'forwardNote'?: string | null;
|
|
1705
|
+
/**
|
|
1706
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
1707
|
+
* @type {string}
|
|
1708
|
+
* @memberof ConversationUpdateRequest
|
|
1709
|
+
*/
|
|
1710
|
+
'initiated'?: string;
|
|
1711
|
+
/**
|
|
1712
|
+
* Detected intent attached at conversation start or first customer message.
|
|
1713
|
+
* @type {string}
|
|
1714
|
+
* @memberof ConversationUpdateRequest
|
|
1715
|
+
*/
|
|
1716
|
+
'intent'?: string | null;
|
|
1717
|
+
/**
|
|
1718
|
+
* Confidence score for the detected intent.
|
|
1719
|
+
* @type {number}
|
|
1720
|
+
* @memberof ConversationUpdateRequest
|
|
1721
|
+
*/
|
|
1722
|
+
'intentScore'?: number | null;
|
|
1723
|
+
/**
|
|
1724
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
1725
|
+
* @type {string}
|
|
1726
|
+
* @memberof ConversationUpdateRequest
|
|
1727
|
+
*/
|
|
1728
|
+
'read'?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* Server-assigned conversation metadata.
|
|
1731
|
+
* @type {{ [key: string]: any; }}
|
|
1732
|
+
* @memberof ConversationUpdateRequest
|
|
1733
|
+
*/
|
|
1734
|
+
'metadata'?: {
|
|
1735
|
+
[key: string]: any;
|
|
1736
|
+
};
|
|
1737
|
+
/**
|
|
1738
|
+
* Metadata for anticipating a preflight response.
|
|
1739
|
+
* @type {{ [key: string]: any; }}
|
|
1740
|
+
* @memberof ConversationUpdateRequest
|
|
1741
|
+
*/
|
|
1742
|
+
'anticipate'?: {
|
|
1743
|
+
[key: string]: any;
|
|
1744
|
+
};
|
|
1745
|
+
/**
|
|
1746
|
+
* Command-flow configuration attached to this conversation.
|
|
1747
|
+
* @type {{ [key: string]: any; }}
|
|
1748
|
+
* @memberof ConversationUpdateRequest
|
|
1749
|
+
*/
|
|
1750
|
+
'command'?: {
|
|
1751
|
+
[key: string]: any;
|
|
1752
|
+
};
|
|
1753
|
+
/**
|
|
1754
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
1755
|
+
* @type {string}
|
|
1756
|
+
* @memberof ConversationUpdateRequest
|
|
1757
|
+
*/
|
|
1758
|
+
'ingress'?: ConversationUpdateRequestIngressEnum;
|
|
1205
1759
|
}
|
|
1760
|
+
export declare const ConversationUpdateRequestLockCodeEnum: {
|
|
1761
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
1762
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
1763
|
+
readonly RuntimeError: "runtime_error";
|
|
1764
|
+
readonly ManualMode: "manual_mode";
|
|
1765
|
+
readonly PolicyBlock: "policy_block";
|
|
1766
|
+
};
|
|
1767
|
+
export type ConversationUpdateRequestLockCodeEnum = typeof ConversationUpdateRequestLockCodeEnum[keyof typeof ConversationUpdateRequestLockCodeEnum];
|
|
1768
|
+
export declare const ConversationUpdateRequestIngressEnum: {
|
|
1769
|
+
readonly Auto: "auto";
|
|
1770
|
+
readonly Manual: "manual";
|
|
1771
|
+
readonly App: "app";
|
|
1772
|
+
readonly Webhook: "webhook";
|
|
1773
|
+
};
|
|
1774
|
+
export type ConversationUpdateRequestIngressEnum = typeof ConversationUpdateRequestIngressEnum[keyof typeof ConversationUpdateRequestIngressEnum];
|
|
1206
1775
|
/**
|
|
1207
1776
|
*
|
|
1208
1777
|
* @export
|
|
@@ -1272,12 +1841,30 @@ export interface ConversationUrls {
|
|
|
1272
1841
|
* @interface ConversationWithId
|
|
1273
1842
|
*/
|
|
1274
1843
|
export interface ConversationWithId {
|
|
1844
|
+
/**
|
|
1845
|
+
* The ID of the conversation
|
|
1846
|
+
* @type {string}
|
|
1847
|
+
* @memberof ConversationWithId
|
|
1848
|
+
*/
|
|
1849
|
+
'$id': string;
|
|
1850
|
+
/**
|
|
1851
|
+
* Business/organization this conversation belongs to
|
|
1852
|
+
* @type {string}
|
|
1853
|
+
* @memberof ConversationWithId
|
|
1854
|
+
*/
|
|
1855
|
+
'$business': string;
|
|
1275
1856
|
/**
|
|
1276
1857
|
* Default agent persona id assigned to the conversation(s)
|
|
1277
1858
|
* @type {string}
|
|
1278
1859
|
* @memberof ConversationWithId
|
|
1279
1860
|
*/
|
|
1280
1861
|
'$agent': string;
|
|
1862
|
+
/**
|
|
1863
|
+
* Customer this conversation is with
|
|
1864
|
+
* @type {string}
|
|
1865
|
+
* @memberof ConversationWithId
|
|
1866
|
+
*/
|
|
1867
|
+
'$customer': string;
|
|
1281
1868
|
/**
|
|
1282
1869
|
* Initial contexts to load when starting the conversation
|
|
1283
1870
|
* @type {Array<string>}
|
|
@@ -1286,42 +1873,128 @@ export interface ConversationWithId {
|
|
|
1286
1873
|
'initialContexts'?: Array<string>;
|
|
1287
1874
|
/**
|
|
1288
1875
|
*
|
|
1289
|
-
* @type {
|
|
1876
|
+
* @type {ConversationChannel}
|
|
1877
|
+
* @memberof ConversationWithId
|
|
1878
|
+
*/
|
|
1879
|
+
'channel': ConversationChannel;
|
|
1880
|
+
/**
|
|
1881
|
+
*
|
|
1882
|
+
* @type {ConversationChannelProps}
|
|
1883
|
+
* @memberof ConversationWithId
|
|
1884
|
+
*/
|
|
1885
|
+
'channelProps'?: ConversationChannelProps;
|
|
1886
|
+
/**
|
|
1887
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
1888
|
+
* @type {boolean}
|
|
1290
1889
|
* @memberof ConversationWithId
|
|
1291
1890
|
*/
|
|
1292
|
-
'
|
|
1891
|
+
'locked'?: boolean | null;
|
|
1293
1892
|
/**
|
|
1294
|
-
*
|
|
1893
|
+
* Machine-readable lock reason.
|
|
1295
1894
|
* @type {string}
|
|
1296
1895
|
* @memberof ConversationWithId
|
|
1297
1896
|
*/
|
|
1298
|
-
'
|
|
1897
|
+
'lockCode'?: ConversationWithIdLockCodeEnum;
|
|
1299
1898
|
/**
|
|
1300
|
-
*
|
|
1899
|
+
* Human-readable locked reason.
|
|
1301
1900
|
* @type {string}
|
|
1302
1901
|
* @memberof ConversationWithId
|
|
1303
|
-
* @deprecated
|
|
1304
1902
|
*/
|
|
1305
|
-
'
|
|
1903
|
+
'lockedReason'?: string | null;
|
|
1306
1904
|
/**
|
|
1307
|
-
*
|
|
1308
|
-
* @type {
|
|
1905
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
1906
|
+
* @type {number}
|
|
1309
1907
|
* @memberof ConversationWithId
|
|
1310
1908
|
*/
|
|
1311
|
-
'
|
|
1909
|
+
'lockAttempts'?: number | null;
|
|
1312
1910
|
/**
|
|
1313
|
-
*
|
|
1314
|
-
* @type {
|
|
1911
|
+
* Contact that received a forward handoff.
|
|
1912
|
+
* @type {string}
|
|
1315
1913
|
* @memberof ConversationWithId
|
|
1316
1914
|
*/
|
|
1317
|
-
'
|
|
1915
|
+
'forwardedTo'?: string | null;
|
|
1318
1916
|
/**
|
|
1319
|
-
*
|
|
1917
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
1320
1918
|
* @type {string}
|
|
1321
1919
|
* @memberof ConversationWithId
|
|
1322
1920
|
*/
|
|
1323
|
-
'
|
|
1921
|
+
'forwarded'?: string | null;
|
|
1922
|
+
/**
|
|
1923
|
+
* Operator or workflow note attached to the forward.
|
|
1924
|
+
* @type {string}
|
|
1925
|
+
* @memberof ConversationWithId
|
|
1926
|
+
*/
|
|
1927
|
+
'forwardNote'?: string | null;
|
|
1928
|
+
/**
|
|
1929
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
1930
|
+
* @type {string}
|
|
1931
|
+
* @memberof ConversationWithId
|
|
1932
|
+
*/
|
|
1933
|
+
'initiated'?: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* Detected intent attached at conversation start or first customer message.
|
|
1936
|
+
* @type {string}
|
|
1937
|
+
* @memberof ConversationWithId
|
|
1938
|
+
*/
|
|
1939
|
+
'intent'?: string | null;
|
|
1940
|
+
/**
|
|
1941
|
+
* Confidence score for the detected intent.
|
|
1942
|
+
* @type {number}
|
|
1943
|
+
* @memberof ConversationWithId
|
|
1944
|
+
*/
|
|
1945
|
+
'intentScore'?: number | null;
|
|
1946
|
+
/**
|
|
1947
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
1948
|
+
* @type {string}
|
|
1949
|
+
* @memberof ConversationWithId
|
|
1950
|
+
*/
|
|
1951
|
+
'read'?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Server-assigned conversation metadata.
|
|
1954
|
+
* @type {{ [key: string]: any; }}
|
|
1955
|
+
* @memberof ConversationWithId
|
|
1956
|
+
*/
|
|
1957
|
+
'metadata'?: {
|
|
1958
|
+
[key: string]: any;
|
|
1959
|
+
};
|
|
1960
|
+
/**
|
|
1961
|
+
* Metadata for anticipating a preflight response.
|
|
1962
|
+
* @type {{ [key: string]: any; }}
|
|
1963
|
+
* @memberof ConversationWithId
|
|
1964
|
+
*/
|
|
1965
|
+
'anticipate'?: {
|
|
1966
|
+
[key: string]: any;
|
|
1967
|
+
};
|
|
1968
|
+
/**
|
|
1969
|
+
* Command-flow configuration attached to this conversation.
|
|
1970
|
+
* @type {{ [key: string]: any; }}
|
|
1971
|
+
* @memberof ConversationWithId
|
|
1972
|
+
*/
|
|
1973
|
+
'command'?: {
|
|
1974
|
+
[key: string]: any;
|
|
1975
|
+
};
|
|
1976
|
+
/**
|
|
1977
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
1978
|
+
* @type {string}
|
|
1979
|
+
* @memberof ConversationWithId
|
|
1980
|
+
*/
|
|
1981
|
+
'ingress'?: ConversationWithIdIngressEnum;
|
|
1324
1982
|
}
|
|
1983
|
+
export declare const ConversationWithIdLockCodeEnum: {
|
|
1984
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
1985
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
1986
|
+
readonly RuntimeError: "runtime_error";
|
|
1987
|
+
readonly ManualMode: "manual_mode";
|
|
1988
|
+
readonly PolicyBlock: "policy_block";
|
|
1989
|
+
};
|
|
1990
|
+
export type ConversationWithIdLockCodeEnum = typeof ConversationWithIdLockCodeEnum[keyof typeof ConversationWithIdLockCodeEnum];
|
|
1991
|
+
export declare const ConversationWithIdIngressEnum: {
|
|
1992
|
+
readonly Auto: "auto";
|
|
1993
|
+
readonly Manual: "manual";
|
|
1994
|
+
readonly App: "app";
|
|
1995
|
+
readonly Webhook: "webhook";
|
|
1996
|
+
};
|
|
1997
|
+
export type ConversationWithIdIngressEnum = typeof ConversationWithIdIngressEnum[keyof typeof ConversationWithIdIngressEnum];
|
|
1325
1998
|
/**
|
|
1326
1999
|
*
|
|
1327
2000
|
* @export
|
|
@@ -1898,10 +2571,10 @@ export interface CustomerGroupRecord {
|
|
|
1898
2571
|
'id': string;
|
|
1899
2572
|
/**
|
|
1900
2573
|
*
|
|
1901
|
-
* @type {
|
|
2574
|
+
* @type {ConversationChannel}
|
|
1902
2575
|
* @memberof CustomerGroupRecord
|
|
1903
2576
|
*/
|
|
1904
|
-
'
|
|
2577
|
+
'channel': ConversationChannel;
|
|
1905
2578
|
/**
|
|
1906
2579
|
* Overrides the default $agent for this customer
|
|
1907
2580
|
* @type {string}
|
|
@@ -3280,11 +3953,29 @@ export interface ListApiOperationsResponseInnerAllOf {
|
|
|
3280
3953
|
*/
|
|
3281
3954
|
export interface ListConversationsResponseInner {
|
|
3282
3955
|
/**
|
|
3283
|
-
*
|
|
3956
|
+
* The ID of the conversation
|
|
3284
3957
|
* @type {string}
|
|
3285
3958
|
* @memberof ListConversationsResponseInner
|
|
3286
3959
|
*/
|
|
3287
|
-
'$
|
|
3960
|
+
'$id': string;
|
|
3961
|
+
/**
|
|
3962
|
+
* Business/organization this conversation belongs to
|
|
3963
|
+
* @type {string}
|
|
3964
|
+
* @memberof ListConversationsResponseInner
|
|
3965
|
+
*/
|
|
3966
|
+
'$business': string;
|
|
3967
|
+
/**
|
|
3968
|
+
* Default agent persona id assigned to the conversation(s)
|
|
3969
|
+
* @type {string}
|
|
3970
|
+
* @memberof ListConversationsResponseInner
|
|
3971
|
+
*/
|
|
3972
|
+
'$agent': string;
|
|
3973
|
+
/**
|
|
3974
|
+
* Customer this conversation is with
|
|
3975
|
+
* @type {string}
|
|
3976
|
+
* @memberof ListConversationsResponseInner
|
|
3977
|
+
*/
|
|
3978
|
+
'$customer': string;
|
|
3288
3979
|
/**
|
|
3289
3980
|
* Initial contexts to load when starting the conversation
|
|
3290
3981
|
* @type {Array<string>}
|
|
@@ -3293,53 +3984,58 @@ export interface ListConversationsResponseInner {
|
|
|
3293
3984
|
'initialContexts'?: Array<string>;
|
|
3294
3985
|
/**
|
|
3295
3986
|
*
|
|
3296
|
-
* @type {
|
|
3987
|
+
* @type {ConversationChannel}
|
|
3297
3988
|
* @memberof ListConversationsResponseInner
|
|
3298
3989
|
*/
|
|
3299
|
-
'
|
|
3990
|
+
'channel': ConversationChannel;
|
|
3300
3991
|
/**
|
|
3301
|
-
*
|
|
3302
|
-
* @type {
|
|
3992
|
+
*
|
|
3993
|
+
* @type {ConversationChannelProps}
|
|
3994
|
+
* @memberof ListConversationsResponseInner
|
|
3995
|
+
*/
|
|
3996
|
+
'channelProps'?: ConversationChannelProps;
|
|
3997
|
+
/**
|
|
3998
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
3999
|
+
* @type {boolean}
|
|
3303
4000
|
* @memberof ListConversationsResponseInner
|
|
3304
4001
|
*/
|
|
3305
|
-
'
|
|
4002
|
+
'locked'?: boolean | null;
|
|
3306
4003
|
/**
|
|
3307
|
-
*
|
|
4004
|
+
* Machine-readable lock reason.
|
|
3308
4005
|
* @type {string}
|
|
3309
4006
|
* @memberof ListConversationsResponseInner
|
|
3310
|
-
* @deprecated
|
|
3311
4007
|
*/
|
|
3312
|
-
'
|
|
4008
|
+
'lockCode'?: ListConversationsResponseInnerLockCodeEnum;
|
|
3313
4009
|
/**
|
|
3314
|
-
*
|
|
3315
|
-
* @type {
|
|
4010
|
+
* Human-readable locked reason.
|
|
4011
|
+
* @type {string}
|
|
3316
4012
|
* @memberof ListConversationsResponseInner
|
|
3317
4013
|
*/
|
|
3318
|
-
'
|
|
4014
|
+
'lockedReason'?: string | null;
|
|
3319
4015
|
/**
|
|
3320
|
-
*
|
|
3321
|
-
* @type {
|
|
4016
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
4017
|
+
* @type {number}
|
|
3322
4018
|
* @memberof ListConversationsResponseInner
|
|
3323
4019
|
*/
|
|
3324
|
-
'
|
|
4020
|
+
'lockAttempts'?: number | null;
|
|
3325
4021
|
/**
|
|
3326
|
-
*
|
|
4022
|
+
* Contact that received a forward handoff.
|
|
3327
4023
|
* @type {string}
|
|
3328
4024
|
* @memberof ListConversationsResponseInner
|
|
3329
4025
|
*/
|
|
3330
|
-
'
|
|
4026
|
+
'forwardedTo'?: string | null;
|
|
3331
4027
|
/**
|
|
3332
|
-
*
|
|
4028
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
3333
4029
|
* @type {string}
|
|
3334
4030
|
* @memberof ListConversationsResponseInner
|
|
3335
4031
|
*/
|
|
3336
|
-
'
|
|
4032
|
+
'forwarded'?: string | null;
|
|
3337
4033
|
/**
|
|
3338
|
-
*
|
|
4034
|
+
* Operator or workflow note attached to the forward.
|
|
3339
4035
|
* @type {string}
|
|
3340
4036
|
* @memberof ListConversationsResponseInner
|
|
3341
4037
|
*/
|
|
3342
|
-
'
|
|
4038
|
+
'forwardNote'?: string | null;
|
|
3343
4039
|
/**
|
|
3344
4040
|
* ISO 8601 date string of when the conversation was initiated
|
|
3345
4041
|
* @type {string}
|
|
@@ -3347,12 +4043,87 @@ export interface ListConversationsResponseInner {
|
|
|
3347
4043
|
*/
|
|
3348
4044
|
'initiated': string;
|
|
3349
4045
|
/**
|
|
3350
|
-
*
|
|
4046
|
+
* Detected intent attached at conversation start or first customer message.
|
|
3351
4047
|
* @type {string}
|
|
3352
4048
|
* @memberof ListConversationsResponseInner
|
|
3353
4049
|
*/
|
|
3354
|
-
'
|
|
4050
|
+
'intent'?: string | null;
|
|
4051
|
+
/**
|
|
4052
|
+
* Confidence score for the detected intent.
|
|
4053
|
+
* @type {number}
|
|
4054
|
+
* @memberof ListConversationsResponseInner
|
|
4055
|
+
*/
|
|
4056
|
+
'intentScore'?: number | null;
|
|
4057
|
+
/**
|
|
4058
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
4059
|
+
* @type {string}
|
|
4060
|
+
* @memberof ListConversationsResponseInner
|
|
4061
|
+
*/
|
|
4062
|
+
'read'?: string;
|
|
4063
|
+
/**
|
|
4064
|
+
* Server-assigned conversation metadata.
|
|
4065
|
+
* @type {{ [key: string]: any; }}
|
|
4066
|
+
* @memberof ListConversationsResponseInner
|
|
4067
|
+
*/
|
|
4068
|
+
'metadata'?: {
|
|
4069
|
+
[key: string]: any;
|
|
4070
|
+
};
|
|
4071
|
+
/**
|
|
4072
|
+
* Metadata for anticipating a preflight response.
|
|
4073
|
+
* @type {{ [key: string]: any; }}
|
|
4074
|
+
* @memberof ListConversationsResponseInner
|
|
4075
|
+
*/
|
|
4076
|
+
'anticipate'?: {
|
|
4077
|
+
[key: string]: any;
|
|
4078
|
+
};
|
|
4079
|
+
/**
|
|
4080
|
+
* Command-flow configuration attached to this conversation.
|
|
4081
|
+
* @type {{ [key: string]: any; }}
|
|
4082
|
+
* @memberof ListConversationsResponseInner
|
|
4083
|
+
*/
|
|
4084
|
+
'command'?: {
|
|
4085
|
+
[key: string]: any;
|
|
4086
|
+
};
|
|
4087
|
+
/**
|
|
4088
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
4089
|
+
* @type {string}
|
|
4090
|
+
* @memberof ListConversationsResponseInner
|
|
4091
|
+
*/
|
|
4092
|
+
'ingress'?: ListConversationsResponseInnerIngressEnum;
|
|
4093
|
+
/**
|
|
4094
|
+
* The client web url of the conversation
|
|
4095
|
+
* @type {string}
|
|
4096
|
+
* @memberof ListConversationsResponseInner
|
|
4097
|
+
*/
|
|
4098
|
+
'clientWebUrl'?: string;
|
|
4099
|
+
/**
|
|
4100
|
+
* The agent web url of the conversation (requires phone two-factor authentication)
|
|
4101
|
+
* @type {string}
|
|
4102
|
+
* @memberof ListConversationsResponseInner
|
|
4103
|
+
*/
|
|
4104
|
+
'agentWebUrl'?: string;
|
|
4105
|
+
/**
|
|
4106
|
+
* The agent test web url of the conversation, used for testing the conversation without notifying the customer
|
|
4107
|
+
* @type {string}
|
|
4108
|
+
* @memberof ListConversationsResponseInner
|
|
4109
|
+
*/
|
|
4110
|
+
'agentTestWebUrl'?: string;
|
|
3355
4111
|
}
|
|
4112
|
+
export declare const ListConversationsResponseInnerLockCodeEnum: {
|
|
4113
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
4114
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
4115
|
+
readonly RuntimeError: "runtime_error";
|
|
4116
|
+
readonly ManualMode: "manual_mode";
|
|
4117
|
+
readonly PolicyBlock: "policy_block";
|
|
4118
|
+
};
|
|
4119
|
+
export type ListConversationsResponseInnerLockCodeEnum = typeof ListConversationsResponseInnerLockCodeEnum[keyof typeof ListConversationsResponseInnerLockCodeEnum];
|
|
4120
|
+
export declare const ListConversationsResponseInnerIngressEnum: {
|
|
4121
|
+
readonly Auto: "auto";
|
|
4122
|
+
readonly Manual: "manual";
|
|
4123
|
+
readonly App: "app";
|
|
4124
|
+
readonly Webhook: "webhook";
|
|
4125
|
+
};
|
|
4126
|
+
export type ListConversationsResponseInnerIngressEnum = typeof ListConversationsResponseInnerIngressEnum[keyof typeof ListConversationsResponseInnerIngressEnum];
|
|
3356
4127
|
/**
|
|
3357
4128
|
*
|
|
3358
4129
|
* @export
|
|
@@ -5281,10 +6052,10 @@ export interface MessageCreateRequestConvoOneOf {
|
|
|
5281
6052
|
'agentIdOrPhoneOrEmail'?: string;
|
|
5282
6053
|
/**
|
|
5283
6054
|
*
|
|
5284
|
-
* @type {
|
|
6055
|
+
* @type {ConversationChannel}
|
|
5285
6056
|
* @memberof MessageCreateRequestConvoOneOf
|
|
5286
6057
|
*/
|
|
5287
|
-
'
|
|
6058
|
+
'channel'?: ConversationChannel;
|
|
5288
6059
|
}
|
|
5289
6060
|
/**
|
|
5290
6061
|
*
|
|
@@ -5826,7 +6597,13 @@ export interface PmtTransformResponse {
|
|
|
5826
6597
|
* @type {string}
|
|
5827
6598
|
* @memberof PmtTransformResponse
|
|
5828
6599
|
*/
|
|
5829
|
-
'message'
|
|
6600
|
+
'message'?: string;
|
|
6601
|
+
/**
|
|
6602
|
+
* Formatted persona responses
|
|
6603
|
+
* @type {Array<Message>}
|
|
6604
|
+
* @memberof PmtTransformResponse
|
|
6605
|
+
*/
|
|
6606
|
+
'messages'?: Array<Message>;
|
|
5830
6607
|
/**
|
|
5831
6608
|
* How confident this message meets the persona\'s own words
|
|
5832
6609
|
* @type {number}
|
|
@@ -5964,12 +6741,30 @@ export interface RegexCondition {
|
|
|
5964
6741
|
* @interface ScheduleCreateRequest
|
|
5965
6742
|
*/
|
|
5966
6743
|
export interface ScheduleCreateRequest {
|
|
6744
|
+
/**
|
|
6745
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
6746
|
+
* @type {string}
|
|
6747
|
+
* @memberof ScheduleCreateRequest
|
|
6748
|
+
*/
|
|
6749
|
+
'$id'?: string;
|
|
6750
|
+
/**
|
|
6751
|
+
* Business/organization this conversation belongs to
|
|
6752
|
+
* @type {string}
|
|
6753
|
+
* @memberof ScheduleCreateRequest
|
|
6754
|
+
*/
|
|
6755
|
+
'$business': string;
|
|
5967
6756
|
/**
|
|
5968
6757
|
* Default agent persona id assigned to the conversation(s)
|
|
5969
6758
|
* @type {string}
|
|
5970
6759
|
* @memberof ScheduleCreateRequest
|
|
5971
6760
|
*/
|
|
5972
6761
|
'$agent': string;
|
|
6762
|
+
/**
|
|
6763
|
+
* Customer this conversation is with
|
|
6764
|
+
* @type {string}
|
|
6765
|
+
* @memberof ScheduleCreateRequest
|
|
6766
|
+
*/
|
|
6767
|
+
'$customer': string;
|
|
5973
6768
|
/**
|
|
5974
6769
|
* Initial contexts to load when starting the conversation
|
|
5975
6770
|
* @type {Array<string>}
|
|
@@ -5978,35 +6773,112 @@ export interface ScheduleCreateRequest {
|
|
|
5978
6773
|
'initialContexts'?: Array<string>;
|
|
5979
6774
|
/**
|
|
5980
6775
|
*
|
|
5981
|
-
* @type {
|
|
6776
|
+
* @type {ConversationChannel}
|
|
6777
|
+
* @memberof ScheduleCreateRequest
|
|
6778
|
+
*/
|
|
6779
|
+
'channel': ConversationChannel;
|
|
6780
|
+
/**
|
|
6781
|
+
*
|
|
6782
|
+
* @type {ConversationChannelProps}
|
|
6783
|
+
* @memberof ScheduleCreateRequest
|
|
6784
|
+
*/
|
|
6785
|
+
'channelProps'?: ConversationChannelProps;
|
|
6786
|
+
/**
|
|
6787
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
6788
|
+
* @type {boolean}
|
|
5982
6789
|
* @memberof ScheduleCreateRequest
|
|
5983
6790
|
*/
|
|
5984
|
-
'
|
|
6791
|
+
'locked'?: boolean | null;
|
|
5985
6792
|
/**
|
|
5986
|
-
*
|
|
6793
|
+
* Machine-readable lock reason.
|
|
5987
6794
|
* @type {string}
|
|
5988
6795
|
* @memberof ScheduleCreateRequest
|
|
5989
6796
|
*/
|
|
5990
|
-
'
|
|
6797
|
+
'lockCode'?: ScheduleCreateRequestLockCodeEnum;
|
|
5991
6798
|
/**
|
|
5992
|
-
*
|
|
6799
|
+
* Human-readable locked reason.
|
|
5993
6800
|
* @type {string}
|
|
5994
6801
|
* @memberof ScheduleCreateRequest
|
|
5995
|
-
* @deprecated
|
|
5996
6802
|
*/
|
|
5997
|
-
'
|
|
6803
|
+
'lockedReason'?: string | null;
|
|
5998
6804
|
/**
|
|
5999
|
-
*
|
|
6000
|
-
* @type {
|
|
6805
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
6806
|
+
* @type {number}
|
|
6001
6807
|
* @memberof ScheduleCreateRequest
|
|
6002
6808
|
*/
|
|
6003
|
-
'
|
|
6809
|
+
'lockAttempts'?: number | null;
|
|
6004
6810
|
/**
|
|
6005
|
-
*
|
|
6006
|
-
* @type {
|
|
6811
|
+
* Contact that received a forward handoff.
|
|
6812
|
+
* @type {string}
|
|
6813
|
+
* @memberof ScheduleCreateRequest
|
|
6814
|
+
*/
|
|
6815
|
+
'forwardedTo'?: string | null;
|
|
6816
|
+
/**
|
|
6817
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
6818
|
+
* @type {string}
|
|
6819
|
+
* @memberof ScheduleCreateRequest
|
|
6820
|
+
*/
|
|
6821
|
+
'forwarded'?: string | null;
|
|
6822
|
+
/**
|
|
6823
|
+
* Operator or workflow note attached to the forward.
|
|
6824
|
+
* @type {string}
|
|
6007
6825
|
* @memberof ScheduleCreateRequest
|
|
6008
6826
|
*/
|
|
6009
|
-
'
|
|
6827
|
+
'forwardNote'?: string | null;
|
|
6828
|
+
/**
|
|
6829
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
6830
|
+
* @type {string}
|
|
6831
|
+
* @memberof ScheduleCreateRequest
|
|
6832
|
+
*/
|
|
6833
|
+
'initiated'?: string;
|
|
6834
|
+
/**
|
|
6835
|
+
* Detected intent attached at conversation start or first customer message.
|
|
6836
|
+
* @type {string}
|
|
6837
|
+
* @memberof ScheduleCreateRequest
|
|
6838
|
+
*/
|
|
6839
|
+
'intent'?: string | null;
|
|
6840
|
+
/**
|
|
6841
|
+
* Confidence score for the detected intent.
|
|
6842
|
+
* @type {number}
|
|
6843
|
+
* @memberof ScheduleCreateRequest
|
|
6844
|
+
*/
|
|
6845
|
+
'intentScore'?: number | null;
|
|
6846
|
+
/**
|
|
6847
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
6848
|
+
* @type {string}
|
|
6849
|
+
* @memberof ScheduleCreateRequest
|
|
6850
|
+
*/
|
|
6851
|
+
'read'?: string;
|
|
6852
|
+
/**
|
|
6853
|
+
* Server-assigned conversation metadata.
|
|
6854
|
+
* @type {{ [key: string]: any; }}
|
|
6855
|
+
* @memberof ScheduleCreateRequest
|
|
6856
|
+
*/
|
|
6857
|
+
'metadata'?: {
|
|
6858
|
+
[key: string]: any;
|
|
6859
|
+
};
|
|
6860
|
+
/**
|
|
6861
|
+
* Metadata for anticipating a preflight response.
|
|
6862
|
+
* @type {{ [key: string]: any; }}
|
|
6863
|
+
* @memberof ScheduleCreateRequest
|
|
6864
|
+
*/
|
|
6865
|
+
'anticipate'?: {
|
|
6866
|
+
[key: string]: any;
|
|
6867
|
+
};
|
|
6868
|
+
/**
|
|
6869
|
+
* Command-flow configuration attached to this conversation.
|
|
6870
|
+
* @type {{ [key: string]: any; }}
|
|
6871
|
+
* @memberof ScheduleCreateRequest
|
|
6872
|
+
*/
|
|
6873
|
+
'command'?: {
|
|
6874
|
+
[key: string]: any;
|
|
6875
|
+
};
|
|
6876
|
+
/**
|
|
6877
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
6878
|
+
* @type {string}
|
|
6879
|
+
* @memberof ScheduleCreateRequest
|
|
6880
|
+
*/
|
|
6881
|
+
'ingress'?: ScheduleCreateRequestIngressEnum;
|
|
6010
6882
|
/**
|
|
6011
6883
|
* ISO 8601 datetime string
|
|
6012
6884
|
* @type {string}
|
|
@@ -6032,6 +6904,21 @@ export interface ScheduleCreateRequest {
|
|
|
6032
6904
|
*/
|
|
6033
6905
|
'$group'?: string;
|
|
6034
6906
|
}
|
|
6907
|
+
export declare const ScheduleCreateRequestLockCodeEnum: {
|
|
6908
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
6909
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
6910
|
+
readonly RuntimeError: "runtime_error";
|
|
6911
|
+
readonly ManualMode: "manual_mode";
|
|
6912
|
+
readonly PolicyBlock: "policy_block";
|
|
6913
|
+
};
|
|
6914
|
+
export type ScheduleCreateRequestLockCodeEnum = typeof ScheduleCreateRequestLockCodeEnum[keyof typeof ScheduleCreateRequestLockCodeEnum];
|
|
6915
|
+
export declare const ScheduleCreateRequestIngressEnum: {
|
|
6916
|
+
readonly Auto: "auto";
|
|
6917
|
+
readonly Manual: "manual";
|
|
6918
|
+
readonly App: "app";
|
|
6919
|
+
readonly Webhook: "webhook";
|
|
6920
|
+
};
|
|
6921
|
+
export type ScheduleCreateRequestIngressEnum = typeof ScheduleCreateRequestIngressEnum[keyof typeof ScheduleCreateRequestIngressEnum];
|
|
6035
6922
|
/**
|
|
6036
6923
|
*
|
|
6037
6924
|
* @export
|
|
@@ -6082,12 +6969,30 @@ export interface ScheduleCreateResponseAllOf {
|
|
|
6082
6969
|
* @interface ScheduleGetResponse
|
|
6083
6970
|
*/
|
|
6084
6971
|
export interface ScheduleGetResponse {
|
|
6972
|
+
/**
|
|
6973
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
6974
|
+
* @type {string}
|
|
6975
|
+
* @memberof ScheduleGetResponse
|
|
6976
|
+
*/
|
|
6977
|
+
'$id'?: string;
|
|
6978
|
+
/**
|
|
6979
|
+
* Business/organization this conversation belongs to
|
|
6980
|
+
* @type {string}
|
|
6981
|
+
* @memberof ScheduleGetResponse
|
|
6982
|
+
*/
|
|
6983
|
+
'$business': string;
|
|
6085
6984
|
/**
|
|
6086
6985
|
* Default agent persona id assigned to the conversation(s)
|
|
6087
6986
|
* @type {string}
|
|
6088
6987
|
* @memberof ScheduleGetResponse
|
|
6089
6988
|
*/
|
|
6090
6989
|
'$agent': string;
|
|
6990
|
+
/**
|
|
6991
|
+
* Customer this conversation is with
|
|
6992
|
+
* @type {string}
|
|
6993
|
+
* @memberof ScheduleGetResponse
|
|
6994
|
+
*/
|
|
6995
|
+
'$customer': string;
|
|
6091
6996
|
/**
|
|
6092
6997
|
* Initial contexts to load when starting the conversation
|
|
6093
6998
|
* @type {Array<string>}
|
|
@@ -6096,35 +7001,112 @@ export interface ScheduleGetResponse {
|
|
|
6096
7001
|
'initialContexts'?: Array<string>;
|
|
6097
7002
|
/**
|
|
6098
7003
|
*
|
|
6099
|
-
* @type {
|
|
7004
|
+
* @type {ConversationChannel}
|
|
7005
|
+
* @memberof ScheduleGetResponse
|
|
7006
|
+
*/
|
|
7007
|
+
'channel': ConversationChannel;
|
|
7008
|
+
/**
|
|
7009
|
+
*
|
|
7010
|
+
* @type {ConversationChannelProps}
|
|
7011
|
+
* @memberof ScheduleGetResponse
|
|
7012
|
+
*/
|
|
7013
|
+
'channelProps'?: ConversationChannelProps;
|
|
7014
|
+
/**
|
|
7015
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
7016
|
+
* @type {boolean}
|
|
6100
7017
|
* @memberof ScheduleGetResponse
|
|
6101
7018
|
*/
|
|
6102
|
-
'
|
|
7019
|
+
'locked'?: boolean | null;
|
|
6103
7020
|
/**
|
|
6104
|
-
*
|
|
7021
|
+
* Machine-readable lock reason.
|
|
6105
7022
|
* @type {string}
|
|
6106
7023
|
* @memberof ScheduleGetResponse
|
|
6107
7024
|
*/
|
|
6108
|
-
'
|
|
7025
|
+
'lockCode'?: ScheduleGetResponseLockCodeEnum;
|
|
6109
7026
|
/**
|
|
6110
|
-
*
|
|
7027
|
+
* Human-readable locked reason.
|
|
6111
7028
|
* @type {string}
|
|
6112
7029
|
* @memberof ScheduleGetResponse
|
|
6113
|
-
* @deprecated
|
|
6114
7030
|
*/
|
|
6115
|
-
'
|
|
7031
|
+
'lockedReason'?: string | null;
|
|
6116
7032
|
/**
|
|
6117
|
-
*
|
|
6118
|
-
* @type {
|
|
7033
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
7034
|
+
* @type {number}
|
|
6119
7035
|
* @memberof ScheduleGetResponse
|
|
6120
7036
|
*/
|
|
6121
|
-
'
|
|
7037
|
+
'lockAttempts'?: number | null;
|
|
6122
7038
|
/**
|
|
6123
|
-
*
|
|
6124
|
-
* @type {
|
|
7039
|
+
* Contact that received a forward handoff.
|
|
7040
|
+
* @type {string}
|
|
7041
|
+
* @memberof ScheduleGetResponse
|
|
7042
|
+
*/
|
|
7043
|
+
'forwardedTo'?: string | null;
|
|
7044
|
+
/**
|
|
7045
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
7046
|
+
* @type {string}
|
|
7047
|
+
* @memberof ScheduleGetResponse
|
|
7048
|
+
*/
|
|
7049
|
+
'forwarded'?: string | null;
|
|
7050
|
+
/**
|
|
7051
|
+
* Operator or workflow note attached to the forward.
|
|
7052
|
+
* @type {string}
|
|
7053
|
+
* @memberof ScheduleGetResponse
|
|
7054
|
+
*/
|
|
7055
|
+
'forwardNote'?: string | null;
|
|
7056
|
+
/**
|
|
7057
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
7058
|
+
* @type {string}
|
|
7059
|
+
* @memberof ScheduleGetResponse
|
|
7060
|
+
*/
|
|
7061
|
+
'initiated'?: string;
|
|
7062
|
+
/**
|
|
7063
|
+
* Detected intent attached at conversation start or first customer message.
|
|
7064
|
+
* @type {string}
|
|
7065
|
+
* @memberof ScheduleGetResponse
|
|
7066
|
+
*/
|
|
7067
|
+
'intent'?: string | null;
|
|
7068
|
+
/**
|
|
7069
|
+
* Confidence score for the detected intent.
|
|
7070
|
+
* @type {number}
|
|
7071
|
+
* @memberof ScheduleGetResponse
|
|
7072
|
+
*/
|
|
7073
|
+
'intentScore'?: number | null;
|
|
7074
|
+
/**
|
|
7075
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
7076
|
+
* @type {string}
|
|
7077
|
+
* @memberof ScheduleGetResponse
|
|
7078
|
+
*/
|
|
7079
|
+
'read'?: string;
|
|
7080
|
+
/**
|
|
7081
|
+
* Server-assigned conversation metadata.
|
|
7082
|
+
* @type {{ [key: string]: any; }}
|
|
6125
7083
|
* @memberof ScheduleGetResponse
|
|
6126
7084
|
*/
|
|
6127
|
-
'
|
|
7085
|
+
'metadata'?: {
|
|
7086
|
+
[key: string]: any;
|
|
7087
|
+
};
|
|
7088
|
+
/**
|
|
7089
|
+
* Metadata for anticipating a preflight response.
|
|
7090
|
+
* @type {{ [key: string]: any; }}
|
|
7091
|
+
* @memberof ScheduleGetResponse
|
|
7092
|
+
*/
|
|
7093
|
+
'anticipate'?: {
|
|
7094
|
+
[key: string]: any;
|
|
7095
|
+
};
|
|
7096
|
+
/**
|
|
7097
|
+
* Command-flow configuration attached to this conversation.
|
|
7098
|
+
* @type {{ [key: string]: any; }}
|
|
7099
|
+
* @memberof ScheduleGetResponse
|
|
7100
|
+
*/
|
|
7101
|
+
'command'?: {
|
|
7102
|
+
[key: string]: any;
|
|
7103
|
+
};
|
|
7104
|
+
/**
|
|
7105
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
7106
|
+
* @type {string}
|
|
7107
|
+
* @memberof ScheduleGetResponse
|
|
7108
|
+
*/
|
|
7109
|
+
'ingress'?: ScheduleGetResponseIngressEnum;
|
|
6128
7110
|
/**
|
|
6129
7111
|
* ISO 8601 datetime string
|
|
6130
7112
|
* @type {string}
|
|
@@ -6168,6 +7150,21 @@ export interface ScheduleGetResponse {
|
|
|
6168
7150
|
*/
|
|
6169
7151
|
'agentTestWebUrl'?: string;
|
|
6170
7152
|
}
|
|
7153
|
+
export declare const ScheduleGetResponseLockCodeEnum: {
|
|
7154
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
7155
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
7156
|
+
readonly RuntimeError: "runtime_error";
|
|
7157
|
+
readonly ManualMode: "manual_mode";
|
|
7158
|
+
readonly PolicyBlock: "policy_block";
|
|
7159
|
+
};
|
|
7160
|
+
export type ScheduleGetResponseLockCodeEnum = typeof ScheduleGetResponseLockCodeEnum[keyof typeof ScheduleGetResponseLockCodeEnum];
|
|
7161
|
+
export declare const ScheduleGetResponseIngressEnum: {
|
|
7162
|
+
readonly Auto: "auto";
|
|
7163
|
+
readonly Manual: "manual";
|
|
7164
|
+
readonly App: "app";
|
|
7165
|
+
readonly Webhook: "webhook";
|
|
7166
|
+
};
|
|
7167
|
+
export type ScheduleGetResponseIngressEnum = typeof ScheduleGetResponseIngressEnum[keyof typeof ScheduleGetResponseIngressEnum];
|
|
6171
7168
|
/**
|
|
6172
7169
|
*
|
|
6173
7170
|
* @export
|
|
@@ -6175,23 +7172,143 @@ export interface ScheduleGetResponse {
|
|
|
6175
7172
|
*/
|
|
6176
7173
|
export interface ScheduleGroupCreateRequest {
|
|
6177
7174
|
/**
|
|
6178
|
-
*
|
|
7175
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
6179
7176
|
* @type {string}
|
|
6180
7177
|
* @memberof ScheduleGroupCreateRequest
|
|
6181
7178
|
*/
|
|
6182
|
-
'$
|
|
7179
|
+
'$id'?: string;
|
|
6183
7180
|
/**
|
|
6184
|
-
*
|
|
6185
|
-
* @type {
|
|
7181
|
+
* Business/organization this conversation belongs to
|
|
7182
|
+
* @type {string}
|
|
6186
7183
|
* @memberof ScheduleGroupCreateRequest
|
|
6187
7184
|
*/
|
|
6188
|
-
'
|
|
7185
|
+
'$business'?: string;
|
|
6189
7186
|
/**
|
|
6190
|
-
*
|
|
6191
|
-
* @type {
|
|
7187
|
+
* Default agent persona id assigned to the conversation(s)
|
|
7188
|
+
* @type {string}
|
|
6192
7189
|
* @memberof ScheduleGroupCreateRequest
|
|
6193
7190
|
*/
|
|
6194
|
-
'
|
|
7191
|
+
'$agent'?: string;
|
|
7192
|
+
/**
|
|
7193
|
+
* Customer this conversation is with
|
|
7194
|
+
* @type {string}
|
|
7195
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7196
|
+
*/
|
|
7197
|
+
'$customer'?: string;
|
|
7198
|
+
/**
|
|
7199
|
+
* Initial contexts to load when starting the conversation
|
|
7200
|
+
* @type {Array<string>}
|
|
7201
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7202
|
+
*/
|
|
7203
|
+
'initialContexts'?: Array<string>;
|
|
7204
|
+
/**
|
|
7205
|
+
*
|
|
7206
|
+
* @type {ConversationChannel}
|
|
7207
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7208
|
+
*/
|
|
7209
|
+
'channel'?: ConversationChannel;
|
|
7210
|
+
/**
|
|
7211
|
+
*
|
|
7212
|
+
* @type {ConversationChannelProps}
|
|
7213
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7214
|
+
*/
|
|
7215
|
+
'channelProps'?: ConversationChannelProps;
|
|
7216
|
+
/**
|
|
7217
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
7218
|
+
* @type {boolean}
|
|
7219
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7220
|
+
*/
|
|
7221
|
+
'locked'?: boolean | null;
|
|
7222
|
+
/**
|
|
7223
|
+
* Machine-readable lock reason.
|
|
7224
|
+
* @type {string}
|
|
7225
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7226
|
+
*/
|
|
7227
|
+
'lockCode'?: ScheduleGroupCreateRequestLockCodeEnum;
|
|
7228
|
+
/**
|
|
7229
|
+
* Human-readable locked reason.
|
|
7230
|
+
* @type {string}
|
|
7231
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7232
|
+
*/
|
|
7233
|
+
'lockedReason'?: string | null;
|
|
7234
|
+
/**
|
|
7235
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
7236
|
+
* @type {number}
|
|
7237
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7238
|
+
*/
|
|
7239
|
+
'lockAttempts'?: number | null;
|
|
7240
|
+
/**
|
|
7241
|
+
* Contact that received a forward handoff.
|
|
7242
|
+
* @type {string}
|
|
7243
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7244
|
+
*/
|
|
7245
|
+
'forwardedTo'?: string | null;
|
|
7246
|
+
/**
|
|
7247
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
7248
|
+
* @type {string}
|
|
7249
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7250
|
+
*/
|
|
7251
|
+
'forwarded'?: string | null;
|
|
7252
|
+
/**
|
|
7253
|
+
* Operator or workflow note attached to the forward.
|
|
7254
|
+
* @type {string}
|
|
7255
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7256
|
+
*/
|
|
7257
|
+
'forwardNote'?: string | null;
|
|
7258
|
+
/**
|
|
7259
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
7260
|
+
* @type {string}
|
|
7261
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7262
|
+
*/
|
|
7263
|
+
'initiated'?: string;
|
|
7264
|
+
/**
|
|
7265
|
+
* Detected intent attached at conversation start or first customer message.
|
|
7266
|
+
* @type {string}
|
|
7267
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7268
|
+
*/
|
|
7269
|
+
'intent'?: string | null;
|
|
7270
|
+
/**
|
|
7271
|
+
* Confidence score for the detected intent.
|
|
7272
|
+
* @type {number}
|
|
7273
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7274
|
+
*/
|
|
7275
|
+
'intentScore'?: number | null;
|
|
7276
|
+
/**
|
|
7277
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
7278
|
+
* @type {string}
|
|
7279
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7280
|
+
*/
|
|
7281
|
+
'read'?: string;
|
|
7282
|
+
/**
|
|
7283
|
+
* Server-assigned conversation metadata.
|
|
7284
|
+
* @type {{ [key: string]: any; }}
|
|
7285
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7286
|
+
*/
|
|
7287
|
+
'metadata'?: {
|
|
7288
|
+
[key: string]: any;
|
|
7289
|
+
};
|
|
7290
|
+
/**
|
|
7291
|
+
* Metadata for anticipating a preflight response.
|
|
7292
|
+
* @type {{ [key: string]: any; }}
|
|
7293
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7294
|
+
*/
|
|
7295
|
+
'anticipate'?: {
|
|
7296
|
+
[key: string]: any;
|
|
7297
|
+
};
|
|
7298
|
+
/**
|
|
7299
|
+
* Command-flow configuration attached to this conversation.
|
|
7300
|
+
* @type {{ [key: string]: any; }}
|
|
7301
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7302
|
+
*/
|
|
7303
|
+
'command'?: {
|
|
7304
|
+
[key: string]: any;
|
|
7305
|
+
};
|
|
7306
|
+
/**
|
|
7307
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
7308
|
+
* @type {string}
|
|
7309
|
+
* @memberof ScheduleGroupCreateRequest
|
|
7310
|
+
*/
|
|
7311
|
+
'ingress'?: ScheduleGroupCreateRequestIngressEnum;
|
|
6195
7312
|
/**
|
|
6196
7313
|
* ISO 8601 datetime string
|
|
6197
7314
|
* @type {string}
|
|
@@ -6223,6 +7340,21 @@ export interface ScheduleGroupCreateRequest {
|
|
|
6223
7340
|
*/
|
|
6224
7341
|
'$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
|
|
6225
7342
|
}
|
|
7343
|
+
export declare const ScheduleGroupCreateRequestLockCodeEnum: {
|
|
7344
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
7345
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
7346
|
+
readonly RuntimeError: "runtime_error";
|
|
7347
|
+
readonly ManualMode: "manual_mode";
|
|
7348
|
+
readonly PolicyBlock: "policy_block";
|
|
7349
|
+
};
|
|
7350
|
+
export type ScheduleGroupCreateRequestLockCodeEnum = typeof ScheduleGroupCreateRequestLockCodeEnum[keyof typeof ScheduleGroupCreateRequestLockCodeEnum];
|
|
7351
|
+
export declare const ScheduleGroupCreateRequestIngressEnum: {
|
|
7352
|
+
readonly Auto: "auto";
|
|
7353
|
+
readonly Manual: "manual";
|
|
7354
|
+
readonly App: "app";
|
|
7355
|
+
readonly Webhook: "webhook";
|
|
7356
|
+
};
|
|
7357
|
+
export type ScheduleGroupCreateRequestIngressEnum = typeof ScheduleGroupCreateRequestIngressEnum[keyof typeof ScheduleGroupCreateRequestIngressEnum];
|
|
6226
7358
|
/**
|
|
6227
7359
|
*
|
|
6228
7360
|
* @export
|
|
@@ -6272,12 +7404,30 @@ export interface ScheduleGroupCreateResponse {
|
|
|
6272
7404
|
* @interface ScheduleGroupGetResponse
|
|
6273
7405
|
*/
|
|
6274
7406
|
export interface ScheduleGroupGetResponse {
|
|
7407
|
+
/**
|
|
7408
|
+
* The ID of the scheduled conversation group
|
|
7409
|
+
* @type {string}
|
|
7410
|
+
* @memberof ScheduleGroupGetResponse
|
|
7411
|
+
*/
|
|
7412
|
+
'$id': string;
|
|
7413
|
+
/**
|
|
7414
|
+
* Business/organization this conversation belongs to
|
|
7415
|
+
* @type {string}
|
|
7416
|
+
* @memberof ScheduleGroupGetResponse
|
|
7417
|
+
*/
|
|
7418
|
+
'$business'?: string;
|
|
6275
7419
|
/**
|
|
6276
7420
|
* Default agent persona id assigned to the conversation(s)
|
|
6277
7421
|
* @type {string}
|
|
6278
7422
|
* @memberof ScheduleGroupGetResponse
|
|
6279
7423
|
*/
|
|
6280
7424
|
'$agent'?: string;
|
|
7425
|
+
/**
|
|
7426
|
+
* Customer this conversation is with
|
|
7427
|
+
* @type {string}
|
|
7428
|
+
* @memberof ScheduleGroupGetResponse
|
|
7429
|
+
*/
|
|
7430
|
+
'$customer'?: string;
|
|
6281
7431
|
/**
|
|
6282
7432
|
* Initial contexts to load when starting the conversation
|
|
6283
7433
|
* @type {Array<string>}
|
|
@@ -6286,10 +7436,112 @@ export interface ScheduleGroupGetResponse {
|
|
|
6286
7436
|
'initialContexts'?: Array<string>;
|
|
6287
7437
|
/**
|
|
6288
7438
|
*
|
|
6289
|
-
* @type {
|
|
7439
|
+
* @type {ConversationChannel}
|
|
7440
|
+
* @memberof ScheduleGroupGetResponse
|
|
7441
|
+
*/
|
|
7442
|
+
'channel'?: ConversationChannel;
|
|
7443
|
+
/**
|
|
7444
|
+
*
|
|
7445
|
+
* @type {ConversationChannelProps}
|
|
7446
|
+
* @memberof ScheduleGroupGetResponse
|
|
7447
|
+
*/
|
|
7448
|
+
'channelProps'?: ConversationChannelProps;
|
|
7449
|
+
/**
|
|
7450
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
7451
|
+
* @type {boolean}
|
|
7452
|
+
* @memberof ScheduleGroupGetResponse
|
|
7453
|
+
*/
|
|
7454
|
+
'locked'?: boolean | null;
|
|
7455
|
+
/**
|
|
7456
|
+
* Machine-readable lock reason.
|
|
7457
|
+
* @type {string}
|
|
7458
|
+
* @memberof ScheduleGroupGetResponse
|
|
7459
|
+
*/
|
|
7460
|
+
'lockCode'?: ScheduleGroupGetResponseLockCodeEnum;
|
|
7461
|
+
/**
|
|
7462
|
+
* Human-readable locked reason.
|
|
7463
|
+
* @type {string}
|
|
7464
|
+
* @memberof ScheduleGroupGetResponse
|
|
7465
|
+
*/
|
|
7466
|
+
'lockedReason'?: string | null;
|
|
7467
|
+
/**
|
|
7468
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
7469
|
+
* @type {number}
|
|
7470
|
+
* @memberof ScheduleGroupGetResponse
|
|
7471
|
+
*/
|
|
7472
|
+
'lockAttempts'?: number | null;
|
|
7473
|
+
/**
|
|
7474
|
+
* Contact that received a forward handoff.
|
|
7475
|
+
* @type {string}
|
|
7476
|
+
* @memberof ScheduleGroupGetResponse
|
|
7477
|
+
*/
|
|
7478
|
+
'forwardedTo'?: string | null;
|
|
7479
|
+
/**
|
|
7480
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
7481
|
+
* @type {string}
|
|
7482
|
+
* @memberof ScheduleGroupGetResponse
|
|
7483
|
+
*/
|
|
7484
|
+
'forwarded'?: string | null;
|
|
7485
|
+
/**
|
|
7486
|
+
* Operator or workflow note attached to the forward.
|
|
7487
|
+
* @type {string}
|
|
7488
|
+
* @memberof ScheduleGroupGetResponse
|
|
7489
|
+
*/
|
|
7490
|
+
'forwardNote'?: string | null;
|
|
7491
|
+
/**
|
|
7492
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
7493
|
+
* @type {string}
|
|
7494
|
+
* @memberof ScheduleGroupGetResponse
|
|
7495
|
+
*/
|
|
7496
|
+
'initiated'?: string;
|
|
7497
|
+
/**
|
|
7498
|
+
* Detected intent attached at conversation start or first customer message.
|
|
7499
|
+
* @type {string}
|
|
7500
|
+
* @memberof ScheduleGroupGetResponse
|
|
7501
|
+
*/
|
|
7502
|
+
'intent'?: string | null;
|
|
7503
|
+
/**
|
|
7504
|
+
* Confidence score for the detected intent.
|
|
7505
|
+
* @type {number}
|
|
7506
|
+
* @memberof ScheduleGroupGetResponse
|
|
7507
|
+
*/
|
|
7508
|
+
'intentScore'?: number | null;
|
|
7509
|
+
/**
|
|
7510
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
7511
|
+
* @type {string}
|
|
7512
|
+
* @memberof ScheduleGroupGetResponse
|
|
7513
|
+
*/
|
|
7514
|
+
'read'?: string;
|
|
7515
|
+
/**
|
|
7516
|
+
* Server-assigned conversation metadata.
|
|
7517
|
+
* @type {{ [key: string]: any; }}
|
|
7518
|
+
* @memberof ScheduleGroupGetResponse
|
|
7519
|
+
*/
|
|
7520
|
+
'metadata'?: {
|
|
7521
|
+
[key: string]: any;
|
|
7522
|
+
};
|
|
7523
|
+
/**
|
|
7524
|
+
* Metadata for anticipating a preflight response.
|
|
7525
|
+
* @type {{ [key: string]: any; }}
|
|
7526
|
+
* @memberof ScheduleGroupGetResponse
|
|
7527
|
+
*/
|
|
7528
|
+
'anticipate'?: {
|
|
7529
|
+
[key: string]: any;
|
|
7530
|
+
};
|
|
7531
|
+
/**
|
|
7532
|
+
* Command-flow configuration attached to this conversation.
|
|
7533
|
+
* @type {{ [key: string]: any; }}
|
|
6290
7534
|
* @memberof ScheduleGroupGetResponse
|
|
6291
7535
|
*/
|
|
6292
|
-
'
|
|
7536
|
+
'command'?: {
|
|
7537
|
+
[key: string]: any;
|
|
7538
|
+
};
|
|
7539
|
+
/**
|
|
7540
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
7541
|
+
* @type {string}
|
|
7542
|
+
* @memberof ScheduleGroupGetResponse
|
|
7543
|
+
*/
|
|
7544
|
+
'ingress'?: ScheduleGroupGetResponseIngressEnum;
|
|
6293
7545
|
/**
|
|
6294
7546
|
* ISO 8601 datetime string
|
|
6295
7547
|
* @type {string}
|
|
@@ -6314,12 +7566,6 @@ export interface ScheduleGroupGetResponse {
|
|
|
6314
7566
|
* @memberof ScheduleGroupGetResponse
|
|
6315
7567
|
*/
|
|
6316
7568
|
'delay'?: number;
|
|
6317
|
-
/**
|
|
6318
|
-
* The ID of the scheduled conversation group
|
|
6319
|
-
* @type {string}
|
|
6320
|
-
* @memberof ScheduleGroupGetResponse
|
|
6321
|
-
*/
|
|
6322
|
-
'$id': string;
|
|
6323
7569
|
/**
|
|
6324
7570
|
* ISO Time the initial message has been sent
|
|
6325
7571
|
* @type {boolean}
|
|
@@ -6333,6 +7579,21 @@ export interface ScheduleGroupGetResponse {
|
|
|
6333
7579
|
*/
|
|
6334
7580
|
'$cGroup'?: string;
|
|
6335
7581
|
}
|
|
7582
|
+
export declare const ScheduleGroupGetResponseLockCodeEnum: {
|
|
7583
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
7584
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
7585
|
+
readonly RuntimeError: "runtime_error";
|
|
7586
|
+
readonly ManualMode: "manual_mode";
|
|
7587
|
+
readonly PolicyBlock: "policy_block";
|
|
7588
|
+
};
|
|
7589
|
+
export type ScheduleGroupGetResponseLockCodeEnum = typeof ScheduleGroupGetResponseLockCodeEnum[keyof typeof ScheduleGroupGetResponseLockCodeEnum];
|
|
7590
|
+
export declare const ScheduleGroupGetResponseIngressEnum: {
|
|
7591
|
+
readonly Auto: "auto";
|
|
7592
|
+
readonly Manual: "manual";
|
|
7593
|
+
readonly App: "app";
|
|
7594
|
+
readonly Webhook: "webhook";
|
|
7595
|
+
};
|
|
7596
|
+
export type ScheduleGroupGetResponseIngressEnum = typeof ScheduleGroupGetResponseIngressEnum[keyof typeof ScheduleGroupGetResponseIngressEnum];
|
|
6336
7597
|
/**
|
|
6337
7598
|
*
|
|
6338
7599
|
* @export
|
|
@@ -6389,12 +7650,30 @@ export interface ScheduleGroupRemoveResponse {
|
|
|
6389
7650
|
* @interface ScheduleGroupUpdateRequest
|
|
6390
7651
|
*/
|
|
6391
7652
|
export interface ScheduleGroupUpdateRequest {
|
|
7653
|
+
/**
|
|
7654
|
+
* The ID of the scheduled conversation group to update
|
|
7655
|
+
* @type {string}
|
|
7656
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7657
|
+
*/
|
|
7658
|
+
'$id': string;
|
|
7659
|
+
/**
|
|
7660
|
+
* Business/organization this conversation belongs to
|
|
7661
|
+
* @type {string}
|
|
7662
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7663
|
+
*/
|
|
7664
|
+
'$business'?: string;
|
|
6392
7665
|
/**
|
|
6393
7666
|
* Default agent persona id assigned to the conversation(s)
|
|
6394
7667
|
* @type {string}
|
|
6395
7668
|
* @memberof ScheduleGroupUpdateRequest
|
|
6396
7669
|
*/
|
|
6397
7670
|
'$agent'?: string;
|
|
7671
|
+
/**
|
|
7672
|
+
* Customer this conversation is with
|
|
7673
|
+
* @type {string}
|
|
7674
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7675
|
+
*/
|
|
7676
|
+
'$customer'?: string;
|
|
6398
7677
|
/**
|
|
6399
7678
|
* Initial contexts to load when starting the conversation
|
|
6400
7679
|
* @type {Array<string>}
|
|
@@ -6403,10 +7682,112 @@ export interface ScheduleGroupUpdateRequest {
|
|
|
6403
7682
|
'initialContexts'?: Array<string>;
|
|
6404
7683
|
/**
|
|
6405
7684
|
*
|
|
6406
|
-
* @type {
|
|
7685
|
+
* @type {ConversationChannel}
|
|
7686
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7687
|
+
*/
|
|
7688
|
+
'channel'?: ConversationChannel;
|
|
7689
|
+
/**
|
|
7690
|
+
*
|
|
7691
|
+
* @type {ConversationChannelProps}
|
|
7692
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7693
|
+
*/
|
|
7694
|
+
'channelProps'?: ConversationChannelProps;
|
|
7695
|
+
/**
|
|
7696
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
7697
|
+
* @type {boolean}
|
|
7698
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7699
|
+
*/
|
|
7700
|
+
'locked'?: boolean | null;
|
|
7701
|
+
/**
|
|
7702
|
+
* Machine-readable lock reason.
|
|
7703
|
+
* @type {string}
|
|
7704
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7705
|
+
*/
|
|
7706
|
+
'lockCode'?: ScheduleGroupUpdateRequestLockCodeEnum;
|
|
7707
|
+
/**
|
|
7708
|
+
* Human-readable locked reason.
|
|
7709
|
+
* @type {string}
|
|
7710
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7711
|
+
*/
|
|
7712
|
+
'lockedReason'?: string | null;
|
|
7713
|
+
/**
|
|
7714
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
7715
|
+
* @type {number}
|
|
7716
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7717
|
+
*/
|
|
7718
|
+
'lockAttempts'?: number | null;
|
|
7719
|
+
/**
|
|
7720
|
+
* Contact that received a forward handoff.
|
|
7721
|
+
* @type {string}
|
|
7722
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7723
|
+
*/
|
|
7724
|
+
'forwardedTo'?: string | null;
|
|
7725
|
+
/**
|
|
7726
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
7727
|
+
* @type {string}
|
|
7728
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7729
|
+
*/
|
|
7730
|
+
'forwarded'?: string | null;
|
|
7731
|
+
/**
|
|
7732
|
+
* Operator or workflow note attached to the forward.
|
|
7733
|
+
* @type {string}
|
|
7734
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7735
|
+
*/
|
|
7736
|
+
'forwardNote'?: string | null;
|
|
7737
|
+
/**
|
|
7738
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
7739
|
+
* @type {string}
|
|
7740
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7741
|
+
*/
|
|
7742
|
+
'initiated'?: string;
|
|
7743
|
+
/**
|
|
7744
|
+
* Detected intent attached at conversation start or first customer message.
|
|
7745
|
+
* @type {string}
|
|
7746
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7747
|
+
*/
|
|
7748
|
+
'intent'?: string | null;
|
|
7749
|
+
/**
|
|
7750
|
+
* Confidence score for the detected intent.
|
|
7751
|
+
* @type {number}
|
|
7752
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7753
|
+
*/
|
|
7754
|
+
'intentScore'?: number | null;
|
|
7755
|
+
/**
|
|
7756
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
7757
|
+
* @type {string}
|
|
7758
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7759
|
+
*/
|
|
7760
|
+
'read'?: string;
|
|
7761
|
+
/**
|
|
7762
|
+
* Server-assigned conversation metadata.
|
|
7763
|
+
* @type {{ [key: string]: any; }}
|
|
7764
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7765
|
+
*/
|
|
7766
|
+
'metadata'?: {
|
|
7767
|
+
[key: string]: any;
|
|
7768
|
+
};
|
|
7769
|
+
/**
|
|
7770
|
+
* Metadata for anticipating a preflight response.
|
|
7771
|
+
* @type {{ [key: string]: any; }}
|
|
7772
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7773
|
+
*/
|
|
7774
|
+
'anticipate'?: {
|
|
7775
|
+
[key: string]: any;
|
|
7776
|
+
};
|
|
7777
|
+
/**
|
|
7778
|
+
* Command-flow configuration attached to this conversation.
|
|
7779
|
+
* @type {{ [key: string]: any; }}
|
|
7780
|
+
* @memberof ScheduleGroupUpdateRequest
|
|
7781
|
+
*/
|
|
7782
|
+
'command'?: {
|
|
7783
|
+
[key: string]: any;
|
|
7784
|
+
};
|
|
7785
|
+
/**
|
|
7786
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
7787
|
+
* @type {string}
|
|
6407
7788
|
* @memberof ScheduleGroupUpdateRequest
|
|
6408
7789
|
*/
|
|
6409
|
-
'
|
|
7790
|
+
'ingress'?: ScheduleGroupUpdateRequestIngressEnum;
|
|
6410
7791
|
/**
|
|
6411
7792
|
* ISO 8601 datetime string
|
|
6412
7793
|
* @type {string}
|
|
@@ -6437,13 +7818,22 @@ export interface ScheduleGroupUpdateRequest {
|
|
|
6437
7818
|
* @memberof ScheduleGroupUpdateRequest
|
|
6438
7819
|
*/
|
|
6439
7820
|
'$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
|
|
6440
|
-
/**
|
|
6441
|
-
* The ID of the scheduled conversation group to update
|
|
6442
|
-
* @type {string}
|
|
6443
|
-
* @memberof ScheduleGroupUpdateRequest
|
|
6444
|
-
*/
|
|
6445
|
-
'$id': string;
|
|
6446
7821
|
}
|
|
7822
|
+
export declare const ScheduleGroupUpdateRequestLockCodeEnum: {
|
|
7823
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
7824
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
7825
|
+
readonly RuntimeError: "runtime_error";
|
|
7826
|
+
readonly ManualMode: "manual_mode";
|
|
7827
|
+
readonly PolicyBlock: "policy_block";
|
|
7828
|
+
};
|
|
7829
|
+
export type ScheduleGroupUpdateRequestLockCodeEnum = typeof ScheduleGroupUpdateRequestLockCodeEnum[keyof typeof ScheduleGroupUpdateRequestLockCodeEnum];
|
|
7830
|
+
export declare const ScheduleGroupUpdateRequestIngressEnum: {
|
|
7831
|
+
readonly Auto: "auto";
|
|
7832
|
+
readonly Manual: "manual";
|
|
7833
|
+
readonly App: "app";
|
|
7834
|
+
readonly Webhook: "webhook";
|
|
7835
|
+
};
|
|
7836
|
+
export type ScheduleGroupUpdateRequestIngressEnum = typeof ScheduleGroupUpdateRequestIngressEnum[keyof typeof ScheduleGroupUpdateRequestIngressEnum];
|
|
6447
7837
|
/**
|
|
6448
7838
|
*
|
|
6449
7839
|
* @export
|
|
@@ -6519,12 +7909,30 @@ export interface ScheduleRemoveResponse {
|
|
|
6519
7909
|
* @interface ScheduleUpdateRequest
|
|
6520
7910
|
*/
|
|
6521
7911
|
export interface ScheduleUpdateRequest {
|
|
7912
|
+
/**
|
|
7913
|
+
* The ID of the scheduled conversation to update
|
|
7914
|
+
* @type {string}
|
|
7915
|
+
* @memberof ScheduleUpdateRequest
|
|
7916
|
+
*/
|
|
7917
|
+
'$id'?: string;
|
|
7918
|
+
/**
|
|
7919
|
+
* Business/organization this conversation belongs to
|
|
7920
|
+
* @type {string}
|
|
7921
|
+
* @memberof ScheduleUpdateRequest
|
|
7922
|
+
*/
|
|
7923
|
+
'$business': string;
|
|
6522
7924
|
/**
|
|
6523
7925
|
* Default agent persona id assigned to the conversation(s)
|
|
6524
7926
|
* @type {string}
|
|
6525
7927
|
* @memberof ScheduleUpdateRequest
|
|
6526
7928
|
*/
|
|
6527
7929
|
'$agent': string;
|
|
7930
|
+
/**
|
|
7931
|
+
* Customer this conversation is with
|
|
7932
|
+
* @type {string}
|
|
7933
|
+
* @memberof ScheduleUpdateRequest
|
|
7934
|
+
*/
|
|
7935
|
+
'$customer': string;
|
|
6528
7936
|
/**
|
|
6529
7937
|
* Initial contexts to load when starting the conversation
|
|
6530
7938
|
* @type {Array<string>}
|
|
@@ -6533,35 +7941,112 @@ export interface ScheduleUpdateRequest {
|
|
|
6533
7941
|
'initialContexts'?: Array<string>;
|
|
6534
7942
|
/**
|
|
6535
7943
|
*
|
|
6536
|
-
* @type {
|
|
7944
|
+
* @type {ConversationChannel}
|
|
7945
|
+
* @memberof ScheduleUpdateRequest
|
|
7946
|
+
*/
|
|
7947
|
+
'channel': ConversationChannel;
|
|
7948
|
+
/**
|
|
7949
|
+
*
|
|
7950
|
+
* @type {ConversationChannelProps}
|
|
7951
|
+
* @memberof ScheduleUpdateRequest
|
|
7952
|
+
*/
|
|
7953
|
+
'channelProps'?: ConversationChannelProps;
|
|
7954
|
+
/**
|
|
7955
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
7956
|
+
* @type {boolean}
|
|
6537
7957
|
* @memberof ScheduleUpdateRequest
|
|
6538
7958
|
*/
|
|
6539
|
-
'
|
|
7959
|
+
'locked'?: boolean | null;
|
|
6540
7960
|
/**
|
|
6541
|
-
*
|
|
7961
|
+
* Machine-readable lock reason.
|
|
6542
7962
|
* @type {string}
|
|
6543
7963
|
* @memberof ScheduleUpdateRequest
|
|
6544
7964
|
*/
|
|
6545
|
-
'
|
|
7965
|
+
'lockCode'?: ScheduleUpdateRequestLockCodeEnum;
|
|
6546
7966
|
/**
|
|
6547
|
-
*
|
|
7967
|
+
* Human-readable locked reason.
|
|
6548
7968
|
* @type {string}
|
|
6549
7969
|
* @memberof ScheduleUpdateRequest
|
|
6550
|
-
* @deprecated
|
|
6551
7970
|
*/
|
|
6552
|
-
'
|
|
7971
|
+
'lockedReason'?: string | null;
|
|
6553
7972
|
/**
|
|
6554
|
-
*
|
|
6555
|
-
* @type {
|
|
7973
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
7974
|
+
* @type {number}
|
|
6556
7975
|
* @memberof ScheduleUpdateRequest
|
|
6557
7976
|
*/
|
|
6558
|
-
'
|
|
7977
|
+
'lockAttempts'?: number | null;
|
|
6559
7978
|
/**
|
|
6560
|
-
*
|
|
6561
|
-
* @type {
|
|
7979
|
+
* Contact that received a forward handoff.
|
|
7980
|
+
* @type {string}
|
|
7981
|
+
* @memberof ScheduleUpdateRequest
|
|
7982
|
+
*/
|
|
7983
|
+
'forwardedTo'?: string | null;
|
|
7984
|
+
/**
|
|
7985
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
7986
|
+
* @type {string}
|
|
7987
|
+
* @memberof ScheduleUpdateRequest
|
|
7988
|
+
*/
|
|
7989
|
+
'forwarded'?: string | null;
|
|
7990
|
+
/**
|
|
7991
|
+
* Operator or workflow note attached to the forward.
|
|
7992
|
+
* @type {string}
|
|
7993
|
+
* @memberof ScheduleUpdateRequest
|
|
7994
|
+
*/
|
|
7995
|
+
'forwardNote'?: string | null;
|
|
7996
|
+
/**
|
|
7997
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
7998
|
+
* @type {string}
|
|
7999
|
+
* @memberof ScheduleUpdateRequest
|
|
8000
|
+
*/
|
|
8001
|
+
'initiated'?: string;
|
|
8002
|
+
/**
|
|
8003
|
+
* Detected intent attached at conversation start or first customer message.
|
|
8004
|
+
* @type {string}
|
|
8005
|
+
* @memberof ScheduleUpdateRequest
|
|
8006
|
+
*/
|
|
8007
|
+
'intent'?: string | null;
|
|
8008
|
+
/**
|
|
8009
|
+
* Confidence score for the detected intent.
|
|
8010
|
+
* @type {number}
|
|
8011
|
+
* @memberof ScheduleUpdateRequest
|
|
8012
|
+
*/
|
|
8013
|
+
'intentScore'?: number | null;
|
|
8014
|
+
/**
|
|
8015
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
8016
|
+
* @type {string}
|
|
8017
|
+
* @memberof ScheduleUpdateRequest
|
|
8018
|
+
*/
|
|
8019
|
+
'read'?: string;
|
|
8020
|
+
/**
|
|
8021
|
+
* Server-assigned conversation metadata.
|
|
8022
|
+
* @type {{ [key: string]: any; }}
|
|
8023
|
+
* @memberof ScheduleUpdateRequest
|
|
8024
|
+
*/
|
|
8025
|
+
'metadata'?: {
|
|
8026
|
+
[key: string]: any;
|
|
8027
|
+
};
|
|
8028
|
+
/**
|
|
8029
|
+
* Metadata for anticipating a preflight response.
|
|
8030
|
+
* @type {{ [key: string]: any; }}
|
|
8031
|
+
* @memberof ScheduleUpdateRequest
|
|
8032
|
+
*/
|
|
8033
|
+
'anticipate'?: {
|
|
8034
|
+
[key: string]: any;
|
|
8035
|
+
};
|
|
8036
|
+
/**
|
|
8037
|
+
* Command-flow configuration attached to this conversation.
|
|
8038
|
+
* @type {{ [key: string]: any; }}
|
|
8039
|
+
* @memberof ScheduleUpdateRequest
|
|
8040
|
+
*/
|
|
8041
|
+
'command'?: {
|
|
8042
|
+
[key: string]: any;
|
|
8043
|
+
};
|
|
8044
|
+
/**
|
|
8045
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
8046
|
+
* @type {string}
|
|
6562
8047
|
* @memberof ScheduleUpdateRequest
|
|
6563
8048
|
*/
|
|
6564
|
-
'
|
|
8049
|
+
'ingress'?: ScheduleUpdateRequestIngressEnum;
|
|
6565
8050
|
/**
|
|
6566
8051
|
* ISO 8601 datetime string
|
|
6567
8052
|
* @type {string}
|
|
@@ -6586,13 +8071,22 @@ export interface ScheduleUpdateRequest {
|
|
|
6586
8071
|
* @memberof ScheduleUpdateRequest
|
|
6587
8072
|
*/
|
|
6588
8073
|
'$group'?: string;
|
|
6589
|
-
/**
|
|
6590
|
-
* The ID of the scheduled conversation to update
|
|
6591
|
-
* @type {string}
|
|
6592
|
-
* @memberof ScheduleUpdateRequest
|
|
6593
|
-
*/
|
|
6594
|
-
'$id'?: string;
|
|
6595
8074
|
}
|
|
8075
|
+
export declare const ScheduleUpdateRequestLockCodeEnum: {
|
|
8076
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
8077
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
8078
|
+
readonly RuntimeError: "runtime_error";
|
|
8079
|
+
readonly ManualMode: "manual_mode";
|
|
8080
|
+
readonly PolicyBlock: "policy_block";
|
|
8081
|
+
};
|
|
8082
|
+
export type ScheduleUpdateRequestLockCodeEnum = typeof ScheduleUpdateRequestLockCodeEnum[keyof typeof ScheduleUpdateRequestLockCodeEnum];
|
|
8083
|
+
export declare const ScheduleUpdateRequestIngressEnum: {
|
|
8084
|
+
readonly Auto: "auto";
|
|
8085
|
+
readonly Manual: "manual";
|
|
8086
|
+
readonly App: "app";
|
|
8087
|
+
readonly Webhook: "webhook";
|
|
8088
|
+
};
|
|
8089
|
+
export type ScheduleUpdateRequestIngressEnum = typeof ScheduleUpdateRequestIngressEnum[keyof typeof ScheduleUpdateRequestIngressEnum];
|
|
6596
8090
|
/**
|
|
6597
8091
|
*
|
|
6598
8092
|
* @export
|
|
@@ -6637,12 +8131,30 @@ export interface ScheduleUpdateResponse {
|
|
|
6637
8131
|
* @interface ScheduledConversation
|
|
6638
8132
|
*/
|
|
6639
8133
|
export interface ScheduledConversation {
|
|
8134
|
+
/**
|
|
8135
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
8136
|
+
* @type {string}
|
|
8137
|
+
* @memberof ScheduledConversation
|
|
8138
|
+
*/
|
|
8139
|
+
'$id'?: string;
|
|
8140
|
+
/**
|
|
8141
|
+
* Business/organization this conversation belongs to
|
|
8142
|
+
* @type {string}
|
|
8143
|
+
* @memberof ScheduledConversation
|
|
8144
|
+
*/
|
|
8145
|
+
'$business': string;
|
|
6640
8146
|
/**
|
|
6641
8147
|
* Default agent persona id assigned to the conversation(s)
|
|
6642
8148
|
* @type {string}
|
|
6643
8149
|
* @memberof ScheduledConversation
|
|
6644
8150
|
*/
|
|
6645
8151
|
'$agent': string;
|
|
8152
|
+
/**
|
|
8153
|
+
* Customer this conversation is with
|
|
8154
|
+
* @type {string}
|
|
8155
|
+
* @memberof ScheduledConversation
|
|
8156
|
+
*/
|
|
8157
|
+
'$customer': string;
|
|
6646
8158
|
/**
|
|
6647
8159
|
* Initial contexts to load when starting the conversation
|
|
6648
8160
|
* @type {Array<string>}
|
|
@@ -6651,35 +8163,112 @@ export interface ScheduledConversation {
|
|
|
6651
8163
|
'initialContexts'?: Array<string>;
|
|
6652
8164
|
/**
|
|
6653
8165
|
*
|
|
6654
|
-
* @type {
|
|
8166
|
+
* @type {ConversationChannel}
|
|
8167
|
+
* @memberof ScheduledConversation
|
|
8168
|
+
*/
|
|
8169
|
+
'channel': ConversationChannel;
|
|
8170
|
+
/**
|
|
8171
|
+
*
|
|
8172
|
+
* @type {ConversationChannelProps}
|
|
8173
|
+
* @memberof ScheduledConversation
|
|
8174
|
+
*/
|
|
8175
|
+
'channelProps'?: ConversationChannelProps;
|
|
8176
|
+
/**
|
|
8177
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
8178
|
+
* @type {boolean}
|
|
6655
8179
|
* @memberof ScheduledConversation
|
|
6656
8180
|
*/
|
|
6657
|
-
'
|
|
8181
|
+
'locked'?: boolean | null;
|
|
6658
8182
|
/**
|
|
6659
|
-
*
|
|
8183
|
+
* Machine-readable lock reason.
|
|
6660
8184
|
* @type {string}
|
|
6661
8185
|
* @memberof ScheduledConversation
|
|
6662
8186
|
*/
|
|
6663
|
-
'
|
|
8187
|
+
'lockCode'?: ScheduledConversationLockCodeEnum;
|
|
6664
8188
|
/**
|
|
6665
|
-
*
|
|
8189
|
+
* Human-readable locked reason.
|
|
6666
8190
|
* @type {string}
|
|
6667
8191
|
* @memberof ScheduledConversation
|
|
6668
|
-
* @deprecated
|
|
6669
8192
|
*/
|
|
6670
|
-
'
|
|
8193
|
+
'lockedReason'?: string | null;
|
|
6671
8194
|
/**
|
|
6672
|
-
*
|
|
6673
|
-
* @type {
|
|
8195
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
8196
|
+
* @type {number}
|
|
6674
8197
|
* @memberof ScheduledConversation
|
|
6675
8198
|
*/
|
|
6676
|
-
'
|
|
8199
|
+
'lockAttempts'?: number | null;
|
|
6677
8200
|
/**
|
|
6678
|
-
*
|
|
6679
|
-
* @type {
|
|
8201
|
+
* Contact that received a forward handoff.
|
|
8202
|
+
* @type {string}
|
|
8203
|
+
* @memberof ScheduledConversation
|
|
8204
|
+
*/
|
|
8205
|
+
'forwardedTo'?: string | null;
|
|
8206
|
+
/**
|
|
8207
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
8208
|
+
* @type {string}
|
|
8209
|
+
* @memberof ScheduledConversation
|
|
8210
|
+
*/
|
|
8211
|
+
'forwarded'?: string | null;
|
|
8212
|
+
/**
|
|
8213
|
+
* Operator or workflow note attached to the forward.
|
|
8214
|
+
* @type {string}
|
|
8215
|
+
* @memberof ScheduledConversation
|
|
8216
|
+
*/
|
|
8217
|
+
'forwardNote'?: string | null;
|
|
8218
|
+
/**
|
|
8219
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
8220
|
+
* @type {string}
|
|
8221
|
+
* @memberof ScheduledConversation
|
|
8222
|
+
*/
|
|
8223
|
+
'initiated'?: string;
|
|
8224
|
+
/**
|
|
8225
|
+
* Detected intent attached at conversation start or first customer message.
|
|
8226
|
+
* @type {string}
|
|
8227
|
+
* @memberof ScheduledConversation
|
|
8228
|
+
*/
|
|
8229
|
+
'intent'?: string | null;
|
|
8230
|
+
/**
|
|
8231
|
+
* Confidence score for the detected intent.
|
|
8232
|
+
* @type {number}
|
|
8233
|
+
* @memberof ScheduledConversation
|
|
8234
|
+
*/
|
|
8235
|
+
'intentScore'?: number | null;
|
|
8236
|
+
/**
|
|
8237
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
8238
|
+
* @type {string}
|
|
8239
|
+
* @memberof ScheduledConversation
|
|
8240
|
+
*/
|
|
8241
|
+
'read'?: string;
|
|
8242
|
+
/**
|
|
8243
|
+
* Server-assigned conversation metadata.
|
|
8244
|
+
* @type {{ [key: string]: any; }}
|
|
8245
|
+
* @memberof ScheduledConversation
|
|
8246
|
+
*/
|
|
8247
|
+
'metadata'?: {
|
|
8248
|
+
[key: string]: any;
|
|
8249
|
+
};
|
|
8250
|
+
/**
|
|
8251
|
+
* Metadata for anticipating a preflight response.
|
|
8252
|
+
* @type {{ [key: string]: any; }}
|
|
8253
|
+
* @memberof ScheduledConversation
|
|
8254
|
+
*/
|
|
8255
|
+
'anticipate'?: {
|
|
8256
|
+
[key: string]: any;
|
|
8257
|
+
};
|
|
8258
|
+
/**
|
|
8259
|
+
* Command-flow configuration attached to this conversation.
|
|
8260
|
+
* @type {{ [key: string]: any; }}
|
|
6680
8261
|
* @memberof ScheduledConversation
|
|
6681
8262
|
*/
|
|
6682
|
-
'
|
|
8263
|
+
'command'?: {
|
|
8264
|
+
[key: string]: any;
|
|
8265
|
+
};
|
|
8266
|
+
/**
|
|
8267
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
8268
|
+
* @type {string}
|
|
8269
|
+
* @memberof ScheduledConversation
|
|
8270
|
+
*/
|
|
8271
|
+
'ingress'?: ScheduledConversationIngressEnum;
|
|
6683
8272
|
/**
|
|
6684
8273
|
* ISO 8601 datetime string
|
|
6685
8274
|
* @type {string}
|
|
@@ -6705,6 +8294,21 @@ export interface ScheduledConversation {
|
|
|
6705
8294
|
*/
|
|
6706
8295
|
'$group'?: string;
|
|
6707
8296
|
}
|
|
8297
|
+
export declare const ScheduledConversationLockCodeEnum: {
|
|
8298
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
8299
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
8300
|
+
readonly RuntimeError: "runtime_error";
|
|
8301
|
+
readonly ManualMode: "manual_mode";
|
|
8302
|
+
readonly PolicyBlock: "policy_block";
|
|
8303
|
+
};
|
|
8304
|
+
export type ScheduledConversationLockCodeEnum = typeof ScheduledConversationLockCodeEnum[keyof typeof ScheduledConversationLockCodeEnum];
|
|
8305
|
+
export declare const ScheduledConversationIngressEnum: {
|
|
8306
|
+
readonly Auto: "auto";
|
|
8307
|
+
readonly Manual: "manual";
|
|
8308
|
+
readonly App: "app";
|
|
8309
|
+
readonly Webhook: "webhook";
|
|
8310
|
+
};
|
|
8311
|
+
export type ScheduledConversationIngressEnum = typeof ScheduledConversationIngressEnum[keyof typeof ScheduledConversationIngressEnum];
|
|
6708
8312
|
/**
|
|
6709
8313
|
*
|
|
6710
8314
|
* @export
|
|
@@ -6724,12 +8328,30 @@ export interface ScheduledConversationAllOf {
|
|
|
6724
8328
|
* @interface ScheduledConversationGroup
|
|
6725
8329
|
*/
|
|
6726
8330
|
export interface ScheduledConversationGroup {
|
|
8331
|
+
/**
|
|
8332
|
+
* Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
|
|
8333
|
+
* @type {string}
|
|
8334
|
+
* @memberof ScheduledConversationGroup
|
|
8335
|
+
*/
|
|
8336
|
+
'$id'?: string;
|
|
8337
|
+
/**
|
|
8338
|
+
* Business/organization this conversation belongs to
|
|
8339
|
+
* @type {string}
|
|
8340
|
+
* @memberof ScheduledConversationGroup
|
|
8341
|
+
*/
|
|
8342
|
+
'$business'?: string;
|
|
6727
8343
|
/**
|
|
6728
8344
|
* Default agent persona id assigned to the conversation(s)
|
|
6729
8345
|
* @type {string}
|
|
6730
8346
|
* @memberof ScheduledConversationGroup
|
|
6731
8347
|
*/
|
|
6732
8348
|
'$agent'?: string;
|
|
8349
|
+
/**
|
|
8350
|
+
* Customer this conversation is with
|
|
8351
|
+
* @type {string}
|
|
8352
|
+
* @memberof ScheduledConversationGroup
|
|
8353
|
+
*/
|
|
8354
|
+
'$customer'?: string;
|
|
6733
8355
|
/**
|
|
6734
8356
|
* Initial contexts to load when starting the conversation
|
|
6735
8357
|
* @type {Array<string>}
|
|
@@ -6738,10 +8360,112 @@ export interface ScheduledConversationGroup {
|
|
|
6738
8360
|
'initialContexts'?: Array<string>;
|
|
6739
8361
|
/**
|
|
6740
8362
|
*
|
|
6741
|
-
* @type {
|
|
8363
|
+
* @type {ConversationChannel}
|
|
8364
|
+
* @memberof ScheduledConversationGroup
|
|
8365
|
+
*/
|
|
8366
|
+
'channel'?: ConversationChannel;
|
|
8367
|
+
/**
|
|
8368
|
+
*
|
|
8369
|
+
* @type {ConversationChannelProps}
|
|
8370
|
+
* @memberof ScheduledConversationGroup
|
|
8371
|
+
*/
|
|
8372
|
+
'channelProps'?: ConversationChannelProps;
|
|
8373
|
+
/**
|
|
8374
|
+
* Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
|
|
8375
|
+
* @type {boolean}
|
|
8376
|
+
* @memberof ScheduledConversationGroup
|
|
8377
|
+
*/
|
|
8378
|
+
'locked'?: boolean | null;
|
|
8379
|
+
/**
|
|
8380
|
+
* Machine-readable lock reason.
|
|
8381
|
+
* @type {string}
|
|
8382
|
+
* @memberof ScheduledConversationGroup
|
|
8383
|
+
*/
|
|
8384
|
+
'lockCode'?: ScheduledConversationGroupLockCodeEnum;
|
|
8385
|
+
/**
|
|
8386
|
+
* Human-readable locked reason.
|
|
8387
|
+
* @type {string}
|
|
8388
|
+
* @memberof ScheduledConversationGroup
|
|
8389
|
+
*/
|
|
8390
|
+
'lockedReason'?: string | null;
|
|
8391
|
+
/**
|
|
8392
|
+
* Number of consecutive workflow/context no-progress attempts.
|
|
8393
|
+
* @type {number}
|
|
8394
|
+
* @memberof ScheduledConversationGroup
|
|
8395
|
+
*/
|
|
8396
|
+
'lockAttempts'?: number | null;
|
|
8397
|
+
/**
|
|
8398
|
+
* Contact that received a forward handoff.
|
|
8399
|
+
* @type {string}
|
|
8400
|
+
* @memberof ScheduledConversationGroup
|
|
8401
|
+
*/
|
|
8402
|
+
'forwardedTo'?: string | null;
|
|
8403
|
+
/**
|
|
8404
|
+
* ISO 8601 datetime string for when the conversation was forwarded.
|
|
8405
|
+
* @type {string}
|
|
8406
|
+
* @memberof ScheduledConversationGroup
|
|
8407
|
+
*/
|
|
8408
|
+
'forwarded'?: string | null;
|
|
8409
|
+
/**
|
|
8410
|
+
* Operator or workflow note attached to the forward.
|
|
8411
|
+
* @type {string}
|
|
8412
|
+
* @memberof ScheduledConversationGroup
|
|
8413
|
+
*/
|
|
8414
|
+
'forwardNote'?: string | null;
|
|
8415
|
+
/**
|
|
8416
|
+
* ISO 8601 datetime string for when this conversation was initiated.
|
|
8417
|
+
* @type {string}
|
|
8418
|
+
* @memberof ScheduledConversationGroup
|
|
8419
|
+
*/
|
|
8420
|
+
'initiated'?: string;
|
|
8421
|
+
/**
|
|
8422
|
+
* Detected intent attached at conversation start or first customer message.
|
|
8423
|
+
* @type {string}
|
|
8424
|
+
* @memberof ScheduledConversationGroup
|
|
8425
|
+
*/
|
|
8426
|
+
'intent'?: string | null;
|
|
8427
|
+
/**
|
|
8428
|
+
* Confidence score for the detected intent.
|
|
8429
|
+
* @type {number}
|
|
8430
|
+
* @memberof ScheduledConversationGroup
|
|
8431
|
+
*/
|
|
8432
|
+
'intentScore'?: number | null;
|
|
8433
|
+
/**
|
|
8434
|
+
* ISO 8601 datetime string for when the account user read this conversation in the app.
|
|
8435
|
+
* @type {string}
|
|
8436
|
+
* @memberof ScheduledConversationGroup
|
|
8437
|
+
*/
|
|
8438
|
+
'read'?: string;
|
|
8439
|
+
/**
|
|
8440
|
+
* Server-assigned conversation metadata.
|
|
8441
|
+
* @type {{ [key: string]: any; }}
|
|
8442
|
+
* @memberof ScheduledConversationGroup
|
|
8443
|
+
*/
|
|
8444
|
+
'metadata'?: {
|
|
8445
|
+
[key: string]: any;
|
|
8446
|
+
};
|
|
8447
|
+
/**
|
|
8448
|
+
* Metadata for anticipating a preflight response.
|
|
8449
|
+
* @type {{ [key: string]: any; }}
|
|
8450
|
+
* @memberof ScheduledConversationGroup
|
|
8451
|
+
*/
|
|
8452
|
+
'anticipate'?: {
|
|
8453
|
+
[key: string]: any;
|
|
8454
|
+
};
|
|
8455
|
+
/**
|
|
8456
|
+
* Command-flow configuration attached to this conversation.
|
|
8457
|
+
* @type {{ [key: string]: any; }}
|
|
6742
8458
|
* @memberof ScheduledConversationGroup
|
|
6743
8459
|
*/
|
|
6744
|
-
'
|
|
8460
|
+
'command'?: {
|
|
8461
|
+
[key: string]: any;
|
|
8462
|
+
};
|
|
8463
|
+
/**
|
|
8464
|
+
* Overrides the Persona Model ingress mode for this conversation.
|
|
8465
|
+
* @type {string}
|
|
8466
|
+
* @memberof ScheduledConversationGroup
|
|
8467
|
+
*/
|
|
8468
|
+
'ingress'?: ScheduledConversationGroupIngressEnum;
|
|
6745
8469
|
/**
|
|
6746
8470
|
* ISO 8601 datetime string
|
|
6747
8471
|
* @type {string}
|
|
@@ -6767,6 +8491,21 @@ export interface ScheduledConversationGroup {
|
|
|
6767
8491
|
*/
|
|
6768
8492
|
'delay'?: number;
|
|
6769
8493
|
}
|
|
8494
|
+
export declare const ScheduledConversationGroupLockCodeEnum: {
|
|
8495
|
+
readonly WorkflowStagnation: "workflow_stagnation";
|
|
8496
|
+
readonly MaxLockAttempts: "max_lock_attempts";
|
|
8497
|
+
readonly RuntimeError: "runtime_error";
|
|
8498
|
+
readonly ManualMode: "manual_mode";
|
|
8499
|
+
readonly PolicyBlock: "policy_block";
|
|
8500
|
+
};
|
|
8501
|
+
export type ScheduledConversationGroupLockCodeEnum = typeof ScheduledConversationGroupLockCodeEnum[keyof typeof ScheduledConversationGroupLockCodeEnum];
|
|
8502
|
+
export declare const ScheduledConversationGroupIngressEnum: {
|
|
8503
|
+
readonly Auto: "auto";
|
|
8504
|
+
readonly Manual: "manual";
|
|
8505
|
+
readonly App: "app";
|
|
8506
|
+
readonly Webhook: "webhook";
|
|
8507
|
+
};
|
|
8508
|
+
export type ScheduledConversationGroupIngressEnum = typeof ScheduledConversationGroupIngressEnum[keyof typeof ScheduledConversationGroupIngressEnum];
|
|
6770
8509
|
/**
|
|
6771
8510
|
*
|
|
6772
8511
|
* @export
|