@scout9/admin 1.0.0-alpha.0.0.68 → 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.
Files changed (5) hide show
  1. package/build/api.d.ts +1802 -332
  2. package/build/api.js +195 -15
  3. package/package.json +1 -1
  4. package/src/api.ts +1762 -349
  5. package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts CHANGED
@@ -605,18 +605,42 @@ 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>}
617
635
  * @memberof Conversation
618
636
  */
619
637
  'initialContexts'?: Array<string>;
638
+ /**
639
+ *
640
+ * @type {ConversationChannel}
641
+ * @memberof Conversation
642
+ */
643
+ 'channel': ConversationChannel;
620
644
  /**
621
645
  *
622
646
  * @type {ConversationChannelProps}
@@ -624,102 +648,159 @@ export interface Conversation {
624
648
  */
625
649
  'channelProps'?: ConversationChannelProps;
626
650
  /**
627
- *
628
- * @type {ConversationBaseEnvironmentProps}
651
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
652
+ * @type {boolean}
629
653
  * @memberof Conversation
630
- * @deprecated
631
654
  */
632
- 'environmentProps'?: ConversationBaseEnvironmentProps;
655
+ 'locked'?: boolean | null;
633
656
  /**
634
- * User for this conversation
657
+ * Machine-readable lock reason.
635
658
  * @type {string}
636
659
  * @memberof Conversation
637
660
  */
638
- '$user': string;
661
+ 'lockCode'?: ConversationLockCodeEnum;
639
662
  /**
640
- * Customer this conversation is with (use $user instead)
663
+ * Human-readable locked reason.
641
664
  * @type {string}
642
665
  * @memberof Conversation
643
- * @deprecated
644
666
  */
645
- '$customer'?: string;
667
+ 'lockedReason'?: string | null;
646
668
  /**
647
- *
648
- * @type {ConversationChannel}
669
+ * Number of consecutive workflow/context no-progress attempts.
670
+ * @type {number}
649
671
  * @memberof Conversation
650
672
  */
651
- 'channel': ConversationChannel;
673
+ 'lockAttempts'?: number | null;
652
674
  /**
653
- *
654
- * @type {ConversationEnvironment}
675
+ * Contact that received a forward handoff.
676
+ * @type {string}
655
677
  * @memberof Conversation
656
- * @deprecated
657
678
  */
658
- 'environment'?: ConversationEnvironment;
679
+ 'forwardedTo'?: string | null;
659
680
  /**
660
- * Whether this conversation is a test or not
661
- * @type {boolean}
681
+ * ISO 8601 datetime string for when the conversation was forwarded.
682
+ * @type {string}
662
683
  * @memberof Conversation
663
684
  */
664
- 'test'?: boolean;
665
- }
666
- /**
667
- *
668
- * @export
669
- * @interface ConversationAllOf
670
- */
671
- export interface ConversationAllOf {
685
+ 'forwarded'?: string | null;
672
686
  /**
673
- * User for this conversation
687
+ * Operator or workflow note attached to the forward.
674
688
  * @type {string}
675
- * @memberof ConversationAllOf
689
+ * @memberof Conversation
676
690
  */
677
- '$user': string;
691
+ 'forwardNote'?: string | null;
678
692
  /**
679
- * Customer this conversation is with (use $user instead)
693
+ * ISO 8601 datetime string for when this conversation was initiated.
680
694
  * @type {string}
681
- * @memberof ConversationAllOf
682
- * @deprecated
695
+ * @memberof Conversation
683
696
  */
684
- '$customer'?: string;
697
+ 'initiated'?: string;
685
698
  /**
686
- *
687
- * @type {ConversationChannel}
688
- * @memberof ConversationAllOf
699
+ * Detected intent attached at conversation start or first customer message.
700
+ * @type {string}
701
+ * @memberof Conversation
689
702
  */
690
- 'channel': ConversationChannel;
703
+ 'intent'?: string | null;
691
704
  /**
692
- *
693
- * @type {ConversationEnvironment}
694
- * @memberof ConversationAllOf
695
- * @deprecated
705
+ * Confidence score for the detected intent.
706
+ * @type {number}
707
+ * @memberof Conversation
696
708
  */
697
- 'environment'?: ConversationEnvironment;
709
+ 'intentScore'?: number | null;
698
710
  /**
699
- * Whether this conversation is a test or not
700
- * @type {boolean}
701
- * @memberof ConversationAllOf
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
702
744
  */
703
- 'test'?: boolean;
745
+ 'ingress'?: ConversationIngressEnum;
704
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];
705
762
  /**
706
763
  * Base props all conversation types will have
707
764
  * @export
708
765
  * @interface ConversationBase
709
766
  */
710
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;
711
780
  /**
712
781
  * Default agent persona id assigned to the conversation(s)
713
782
  * @type {string}
714
783
  * @memberof ConversationBase
715
784
  */
716
785
  '$agent'?: string;
786
+ /**
787
+ * Customer this conversation is with
788
+ * @type {string}
789
+ * @memberof ConversationBase
790
+ */
791
+ '$customer'?: string;
717
792
  /**
718
793
  * Initial contexts to load when starting the conversation
719
794
  * @type {Array<string>}
720
795
  * @memberof ConversationBase
721
796
  */
722
797
  'initialContexts'?: Array<string>;
798
+ /**
799
+ *
800
+ * @type {ConversationChannel}
801
+ * @memberof ConversationBase
802
+ */
803
+ 'channel'?: ConversationChannel;
723
804
  /**
724
805
  *
725
806
  * @type {ConversationChannelProps}
@@ -727,50 +808,117 @@ export interface ConversationBase {
727
808
  */
728
809
  'channelProps'?: ConversationChannelProps;
729
810
  /**
730
- *
731
- * @type {ConversationBaseEnvironmentProps}
811
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
812
+ * @type {boolean}
732
813
  * @memberof ConversationBase
733
- * @deprecated
734
814
  */
735
- 'environmentProps'?: ConversationBaseEnvironmentProps;
736
- }
737
- /**
738
- * Deprecated legacy environment properties. Use channelProps.
739
- * @export
740
- * @interface ConversationBaseEnvironmentProps
741
- */
742
- export interface ConversationBaseEnvironmentProps {
815
+ 'locked'?: boolean | null;
743
816
  /**
744
- * Subject line for email-style channels such as Gmail and Outlook.
817
+ * Machine-readable lock reason.
745
818
  * @type {string}
746
- * @memberof ConversationBaseEnvironmentProps
819
+ * @memberof ConversationBase
747
820
  */
748
- 'subject'?: string;
821
+ 'lockCode'?: ConversationBaseLockCodeEnum;
749
822
  /**
750
- * Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
823
+ * Human-readable locked reason.
751
824
  * @type {string}
752
- * @memberof ConversationBaseEnvironmentProps
825
+ * @memberof ConversationBase
753
826
  */
754
- 'platformEmailThreadId'?: string;
827
+ 'lockedReason'?: string | null;
755
828
  /**
756
- * Twilio message sid that initiated this conversation.
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.
757
836
  * @type {string}
758
- * @memberof ConversationBaseEnvironmentProps
837
+ * @memberof ConversationBase
759
838
  */
760
- 'smsMessageSid'?: string;
839
+ 'forwardedTo'?: string | null;
761
840
  /**
762
- * Persisted channel-resolution path used for the current conversation.
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.
763
860
  * @type {string}
764
- * @memberof ConversationBaseEnvironmentProps
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}
903
+ * @memberof ConversationBase
765
904
  */
766
- 'channelResolutionPath'?: ConversationBaseEnvironmentPropsChannelResolutionPathEnum;
905
+ 'ingress'?: ConversationBaseIngressEnum;
767
906
  }
768
- export declare const ConversationBaseEnvironmentPropsChannelResolutionPathEnum: {
769
- readonly Production: "twilio_production";
770
- readonly LegacyPmt: "twilio_legacy_pmt";
771
- readonly FreeBridge: "twilio_free_bridge";
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";
772
920
  };
773
- export type ConversationBaseEnvironmentPropsChannelResolutionPathEnum = typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum[keyof typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum];
921
+ export type ConversationBaseIngressEnum = typeof ConversationBaseIngressEnum[keyof typeof ConversationBaseIngressEnum];
774
922
  /**
775
923
  * Canonical channel that initiated and should continue the customer conversation.
776
924
  * @export
@@ -869,13 +1017,6 @@ export interface ConversationContextField {
869
1017
  * @memberof ConversationContextField
870
1018
  */
871
1019
  'logic'?: Logic;
872
- /**
873
- * The conditions of the conversation
874
- * @type {Array<ConversationContextGroup>}
875
- * @memberof ConversationContextField
876
- * @deprecated
877
- */
878
- 'conditions'?: Array<ConversationContextGroup>;
879
1020
  /**
880
1021
  * The triggers of the conversation
881
1022
  * @type {Array<string>}
@@ -989,18 +1130,42 @@ export type ConversationContextValueOneOfInner = boolean | number | string;
989
1130
  * @interface ConversationCreateRequest
990
1131
  */
991
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;
992
1145
  /**
993
1146
  * Default agent persona id assigned to the conversation(s)
994
1147
  * @type {string}
995
1148
  * @memberof ConversationCreateRequest
996
1149
  */
997
1150
  '$agent': string;
1151
+ /**
1152
+ * Customer this conversation is with
1153
+ * @type {string}
1154
+ * @memberof ConversationCreateRequest
1155
+ */
1156
+ '$customer': string;
998
1157
  /**
999
1158
  * Initial contexts to load when starting the conversation
1000
1159
  * @type {Array<string>}
1001
1160
  * @memberof ConversationCreateRequest
1002
1161
  */
1003
1162
  'initialContexts'?: Array<string>;
1163
+ /**
1164
+ *
1165
+ * @type {ConversationChannel}
1166
+ * @memberof ConversationCreateRequest
1167
+ */
1168
+ 'channel': ConversationChannel;
1004
1169
  /**
1005
1170
  *
1006
1171
  * @type {ConversationChannelProps}
@@ -1008,44 +1173,101 @@ export interface ConversationCreateRequest {
1008
1173
  */
1009
1174
  'channelProps'?: ConversationChannelProps;
1010
1175
  /**
1011
- *
1012
- * @type {ConversationBaseEnvironmentProps}
1176
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
1177
+ * @type {boolean}
1013
1178
  * @memberof ConversationCreateRequest
1014
- * @deprecated
1015
1179
  */
1016
- 'environmentProps'?: ConversationBaseEnvironmentProps;
1180
+ 'locked'?: boolean | null;
1017
1181
  /**
1018
- * User for this conversation
1182
+ * Machine-readable lock reason.
1019
1183
  * @type {string}
1020
1184
  * @memberof ConversationCreateRequest
1021
1185
  */
1022
- '$user': string;
1186
+ 'lockCode'?: ConversationCreateRequestLockCodeEnum;
1023
1187
  /**
1024
- * Customer this conversation is with (use $user instead)
1188
+ * Human-readable locked reason.
1025
1189
  * @type {string}
1026
1190
  * @memberof ConversationCreateRequest
1027
- * @deprecated
1028
1191
  */
1029
- '$customer'?: string;
1192
+ 'lockedReason'?: string | null;
1030
1193
  /**
1031
- *
1032
- * @type {ConversationChannel}
1194
+ * Number of consecutive workflow/context no-progress attempts.
1195
+ * @type {number}
1033
1196
  * @memberof ConversationCreateRequest
1034
1197
  */
1035
- 'channel': ConversationChannel;
1198
+ 'lockAttempts'?: number | null;
1036
1199
  /**
1037
- *
1038
- * @type {ConversationEnvironment}
1200
+ * Contact that received a forward handoff.
1201
+ * @type {string}
1039
1202
  * @memberof ConversationCreateRequest
1040
- * @deprecated
1041
1203
  */
1042
- 'environment'?: ConversationEnvironment;
1204
+ 'forwardedTo'?: string | null;
1043
1205
  /**
1044
- * Whether this conversation is a test or not
1045
- * @type {boolean}
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; }}
1260
+ * @memberof ConversationCreateRequest
1261
+ */
1262
+ 'command'?: {
1263
+ [key: string]: any;
1264
+ };
1265
+ /**
1266
+ * Overrides the Persona Model ingress mode for this conversation.
1267
+ * @type {string}
1046
1268
  * @memberof ConversationCreateRequest
1047
1269
  */
1048
- 'test'?: boolean;
1270
+ 'ingress'?: ConversationCreateRequestIngressEnum;
1049
1271
  /**
1050
1272
  * Appends a prefix to the conversation id, if a conversation id is prefixed with test, or dev, it will mute text messages
1051
1273
  * @type {string}
@@ -1053,6 +1275,21 @@ export interface ConversationCreateRequest {
1053
1275
  */
1054
1276
  'idPrefix'?: string;
1055
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];
1056
1293
  /**
1057
1294
  *
1058
1295
  * @export
@@ -1128,17 +1365,6 @@ export interface ConversationCreateResponseAllOf {
1128
1365
  */
1129
1366
  'initiated': string;
1130
1367
  }
1131
- /**
1132
- * Deprecated broad environment bucket (phone, web, or email). Use ConversationChannel for routing.
1133
- * @export
1134
- * @enum {string}
1135
- */
1136
- export declare const ConversationEnvironment: {
1137
- readonly Phone: "phone";
1138
- readonly Web: "web";
1139
- readonly Email: "email";
1140
- };
1141
- export type ConversationEnvironment = typeof ConversationEnvironment[keyof typeof ConversationEnvironment];
1142
1368
  /**
1143
1369
  *
1144
1370
  * @export
@@ -1146,17 +1372,41 @@ export type ConversationEnvironment = typeof ConversationEnvironment[keyof typeo
1146
1372
  */
1147
1373
  export interface ConversationGetResponse {
1148
1374
  /**
1149
- * Default agent persona id assigned to the conversation(s)
1375
+ * The ID of the conversation
1150
1376
  * @type {string}
1151
1377
  * @memberof ConversationGetResponse
1152
1378
  */
1153
- '$agent': string;
1379
+ '$id': string;
1154
1380
  /**
1155
- * Initial contexts to load when starting the conversation
1156
- * @type {Array<string>}
1381
+ * Business/organization this conversation belongs to
1382
+ * @type {string}
1383
+ * @memberof ConversationGetResponse
1384
+ */
1385
+ '$business': string;
1386
+ /**
1387
+ * Default agent persona id assigned to the conversation(s)
1388
+ * @type {string}
1389
+ * @memberof ConversationGetResponse
1390
+ */
1391
+ '$agent': string;
1392
+ /**
1393
+ * Customer this conversation is with
1394
+ * @type {string}
1395
+ * @memberof ConversationGetResponse
1396
+ */
1397
+ '$customer': string;
1398
+ /**
1399
+ * Initial contexts to load when starting the conversation
1400
+ * @type {Array<string>}
1157
1401
  * @memberof ConversationGetResponse
1158
1402
  */
1159
1403
  'initialContexts'?: Array<string>;
1404
+ /**
1405
+ *
1406
+ * @type {ConversationChannel}
1407
+ * @memberof ConversationGetResponse
1408
+ */
1409
+ 'channel': ConversationChannel;
1160
1410
  /**
1161
1411
  *
1162
1412
  * @type {ConversationChannelProps}
@@ -1164,75 +1414,135 @@ export interface ConversationGetResponse {
1164
1414
  */
1165
1415
  'channelProps'?: ConversationChannelProps;
1166
1416
  /**
1167
- *
1168
- * @type {ConversationBaseEnvironmentProps}
1417
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
1418
+ * @type {boolean}
1169
1419
  * @memberof ConversationGetResponse
1170
- * @deprecated
1171
1420
  */
1172
- 'environmentProps'?: ConversationBaseEnvironmentProps;
1421
+ 'locked'?: boolean | null;
1173
1422
  /**
1174
- * User for this conversation
1423
+ * Machine-readable lock reason.
1175
1424
  * @type {string}
1176
1425
  * @memberof ConversationGetResponse
1177
1426
  */
1178
- '$user': string;
1427
+ 'lockCode'?: ConversationGetResponseLockCodeEnum;
1179
1428
  /**
1180
- * Customer this conversation is with (use $user instead)
1429
+ * Human-readable locked reason.
1181
1430
  * @type {string}
1182
1431
  * @memberof ConversationGetResponse
1183
- * @deprecated
1184
1432
  */
1185
- '$customer'?: string;
1433
+ 'lockedReason'?: string | null;
1186
1434
  /**
1187
- *
1188
- * @type {ConversationChannel}
1435
+ * Number of consecutive workflow/context no-progress attempts.
1436
+ * @type {number}
1189
1437
  * @memberof ConversationGetResponse
1190
1438
  */
1191
- 'channel': ConversationChannel;
1439
+ 'lockAttempts'?: number | null;
1192
1440
  /**
1193
- *
1194
- * @type {ConversationEnvironment}
1441
+ * Contact that received a forward handoff.
1442
+ * @type {string}
1195
1443
  * @memberof ConversationGetResponse
1196
- * @deprecated
1197
1444
  */
1198
- 'environment'?: ConversationEnvironment;
1445
+ 'forwardedTo'?: string | null;
1199
1446
  /**
1200
- * Whether this conversation is a test or not
1201
- * @type {boolean}
1447
+ * ISO 8601 datetime string for when the conversation was forwarded.
1448
+ * @type {string}
1202
1449
  * @memberof ConversationGetResponse
1203
1450
  */
1204
- 'test'?: boolean;
1451
+ 'forwarded'?: string | null;
1205
1452
  /**
1206
- * The client web url of the conversation
1453
+ * Operator or workflow note attached to the forward.
1207
1454
  * @type {string}
1208
1455
  * @memberof ConversationGetResponse
1209
1456
  */
1210
- 'clientWebUrl'?: string;
1457
+ 'forwardNote'?: string | null;
1211
1458
  /**
1212
- * The agent web url of the conversation (requires phone two-factor authentication)
1459
+ * ISO 8601 date string of when the conversation was initiated
1213
1460
  * @type {string}
1214
1461
  * @memberof ConversationGetResponse
1215
1462
  */
1216
- 'agentWebUrl'?: string;
1463
+ 'initiated': string;
1217
1464
  /**
1218
- * The agent test web url of the conversation, used for testing the conversation without notifying the customer
1465
+ * Detected intent attached at conversation start or first customer message.
1219
1466
  * @type {string}
1220
1467
  * @memberof ConversationGetResponse
1221
1468
  */
1222
- 'agentTestWebUrl'?: string;
1469
+ 'intent'?: string | null;
1223
1470
  /**
1224
- * ISO 8601 date string of when the conversation was initiated
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.
1225
1478
  * @type {string}
1226
1479
  * @memberof ConversationGetResponse
1227
1480
  */
1228
- 'initiated': string;
1481
+ 'read'?: string;
1229
1482
  /**
1230
- * The ID of the conversation
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.
1231
1508
  * @type {string}
1232
1509
  * @memberof ConversationGetResponse
1233
1510
  */
1234
- '$id': string;
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;
1235
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];
1236
1546
  /**
1237
1547
  *
1238
1548
  * @export
@@ -1308,18 +1618,42 @@ export interface ConversationScheduleParams {
1308
1618
  * @interface ConversationUpdateRequest
1309
1619
  */
1310
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;
1311
1633
  /**
1312
1634
  * Default agent persona id assigned to the conversation(s)
1313
1635
  * @type {string}
1314
1636
  * @memberof ConversationUpdateRequest
1315
1637
  */
1316
1638
  '$agent'?: string;
1639
+ /**
1640
+ * Customer this conversation is with
1641
+ * @type {string}
1642
+ * @memberof ConversationUpdateRequest
1643
+ */
1644
+ '$customer'?: string;
1317
1645
  /**
1318
1646
  * Initial contexts to load when starting the conversation
1319
1647
  * @type {Array<string>}
1320
1648
  * @memberof ConversationUpdateRequest
1321
1649
  */
1322
1650
  'initialContexts'?: Array<string>;
1651
+ /**
1652
+ *
1653
+ * @type {ConversationChannel}
1654
+ * @memberof ConversationUpdateRequest
1655
+ */
1656
+ 'channel'?: ConversationChannel;
1323
1657
  /**
1324
1658
  *
1325
1659
  * @type {ConversationChannelProps}
@@ -1327,19 +1661,117 @@ export interface ConversationUpdateRequest {
1327
1661
  */
1328
1662
  'channelProps'?: ConversationChannelProps;
1329
1663
  /**
1330
- *
1331
- * @type {ConversationBaseEnvironmentProps}
1664
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
1665
+ * @type {boolean}
1332
1666
  * @memberof ConversationUpdateRequest
1333
- * @deprecated
1334
1667
  */
1335
- 'environmentProps'?: ConversationBaseEnvironmentProps;
1668
+ 'locked'?: boolean | null;
1336
1669
  /**
1337
- * The ID of the conversation to update
1670
+ * Machine-readable lock reason.
1338
1671
  * @type {string}
1339
1672
  * @memberof ConversationUpdateRequest
1340
1673
  */
1341
- '$id': string;
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;
1342
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];
1343
1775
  /**
1344
1776
  *
1345
1777
  * @export
@@ -1409,18 +1841,42 @@ export interface ConversationUrls {
1409
1841
  * @interface ConversationWithId
1410
1842
  */
1411
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;
1412
1856
  /**
1413
1857
  * Default agent persona id assigned to the conversation(s)
1414
1858
  * @type {string}
1415
1859
  * @memberof ConversationWithId
1416
1860
  */
1417
1861
  '$agent': string;
1862
+ /**
1863
+ * Customer this conversation is with
1864
+ * @type {string}
1865
+ * @memberof ConversationWithId
1866
+ */
1867
+ '$customer': string;
1418
1868
  /**
1419
1869
  * Initial contexts to load when starting the conversation
1420
1870
  * @type {Array<string>}
1421
1871
  * @memberof ConversationWithId
1422
1872
  */
1423
1873
  'initialContexts'?: Array<string>;
1874
+ /**
1875
+ *
1876
+ * @type {ConversationChannel}
1877
+ * @memberof ConversationWithId
1878
+ */
1879
+ 'channel': ConversationChannel;
1424
1880
  /**
1425
1881
  *
1426
1882
  * @type {ConversationChannelProps}
@@ -1428,51 +1884,117 @@ export interface ConversationWithId {
1428
1884
  */
1429
1885
  'channelProps'?: ConversationChannelProps;
1430
1886
  /**
1431
- *
1432
- * @type {ConversationBaseEnvironmentProps}
1887
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
1888
+ * @type {boolean}
1433
1889
  * @memberof ConversationWithId
1434
- * @deprecated
1435
1890
  */
1436
- 'environmentProps'?: ConversationBaseEnvironmentProps;
1891
+ 'locked'?: boolean | null;
1437
1892
  /**
1438
- * User for this conversation
1893
+ * Machine-readable lock reason.
1439
1894
  * @type {string}
1440
1895
  * @memberof ConversationWithId
1441
1896
  */
1442
- '$user': string;
1897
+ 'lockCode'?: ConversationWithIdLockCodeEnum;
1443
1898
  /**
1444
- * Customer this conversation is with (use $user instead)
1899
+ * Human-readable locked reason.
1445
1900
  * @type {string}
1446
1901
  * @memberof ConversationWithId
1447
- * @deprecated
1448
1902
  */
1449
- '$customer'?: string;
1903
+ 'lockedReason'?: string | null;
1450
1904
  /**
1451
- *
1452
- * @type {ConversationChannel}
1905
+ * Number of consecutive workflow/context no-progress attempts.
1906
+ * @type {number}
1453
1907
  * @memberof ConversationWithId
1454
1908
  */
1455
- 'channel': ConversationChannel;
1909
+ 'lockAttempts'?: number | null;
1456
1910
  /**
1457
- *
1458
- * @type {ConversationEnvironment}
1911
+ * Contact that received a forward handoff.
1912
+ * @type {string}
1459
1913
  * @memberof ConversationWithId
1460
- * @deprecated
1461
1914
  */
1462
- 'environment'?: ConversationEnvironment;
1915
+ 'forwardedTo'?: string | null;
1463
1916
  /**
1464
- * Whether this conversation is a test or not
1465
- * @type {boolean}
1917
+ * ISO 8601 datetime string for when the conversation was forwarded.
1918
+ * @type {string}
1466
1919
  * @memberof ConversationWithId
1467
1920
  */
1468
- 'test'?: boolean;
1921
+ 'forwarded'?: string | null;
1469
1922
  /**
1470
- * The ID of the conversation
1923
+ * Operator or workflow note attached to the forward.
1471
1924
  * @type {string}
1472
1925
  * @memberof ConversationWithId
1473
1926
  */
1474
- '$id': string;
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;
1475
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];
1476
1998
  /**
1477
1999
  *
1478
2000
  * @export
@@ -2053,13 +2575,6 @@ export interface CustomerGroupRecord {
2053
2575
  * @memberof CustomerGroupRecord
2054
2576
  */
2055
2577
  'channel': ConversationChannel;
2056
- /**
2057
- *
2058
- * @type {ConversationEnvironment}
2059
- * @memberof CustomerGroupRecord
2060
- * @deprecated
2061
- */
2062
- 'environment'?: ConversationEnvironment;
2063
2578
  /**
2064
2579
  * Overrides the default $agent for this customer
2065
2580
  * @type {string}
@@ -3438,17 +3953,41 @@ export interface ListApiOperationsResponseInnerAllOf {
3438
3953
  */
3439
3954
  export interface ListConversationsResponseInner {
3440
3955
  /**
3441
- * Default agent persona id assigned to the conversation(s)
3956
+ * The ID of the conversation
3957
+ * @type {string}
3958
+ * @memberof ListConversationsResponseInner
3959
+ */
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)
3442
3969
  * @type {string}
3443
3970
  * @memberof ListConversationsResponseInner
3444
3971
  */
3445
3972
  '$agent': string;
3973
+ /**
3974
+ * Customer this conversation is with
3975
+ * @type {string}
3976
+ * @memberof ListConversationsResponseInner
3977
+ */
3978
+ '$customer': string;
3446
3979
  /**
3447
3980
  * Initial contexts to load when starting the conversation
3448
3981
  * @type {Array<string>}
3449
3982
  * @memberof ListConversationsResponseInner
3450
3983
  */
3451
3984
  'initialContexts'?: Array<string>;
3985
+ /**
3986
+ *
3987
+ * @type {ConversationChannel}
3988
+ * @memberof ListConversationsResponseInner
3989
+ */
3990
+ 'channel': ConversationChannel;
3452
3991
  /**
3453
3992
  *
3454
3993
  * @type {ConversationChannelProps}
@@ -3456,75 +3995,135 @@ export interface ListConversationsResponseInner {
3456
3995
  */
3457
3996
  'channelProps'?: ConversationChannelProps;
3458
3997
  /**
3459
- *
3460
- * @type {ConversationBaseEnvironmentProps}
3998
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
3999
+ * @type {boolean}
3461
4000
  * @memberof ListConversationsResponseInner
3462
- * @deprecated
3463
4001
  */
3464
- 'environmentProps'?: ConversationBaseEnvironmentProps;
4002
+ 'locked'?: boolean | null;
3465
4003
  /**
3466
- * User for this conversation
4004
+ * Machine-readable lock reason.
3467
4005
  * @type {string}
3468
4006
  * @memberof ListConversationsResponseInner
3469
4007
  */
3470
- '$user': string;
4008
+ 'lockCode'?: ListConversationsResponseInnerLockCodeEnum;
3471
4009
  /**
3472
- * Customer this conversation is with (use $user instead)
4010
+ * Human-readable locked reason.
3473
4011
  * @type {string}
3474
4012
  * @memberof ListConversationsResponseInner
3475
- * @deprecated
3476
4013
  */
3477
- '$customer'?: string;
4014
+ 'lockedReason'?: string | null;
3478
4015
  /**
3479
- *
3480
- * @type {ConversationChannel}
4016
+ * Number of consecutive workflow/context no-progress attempts.
4017
+ * @type {number}
3481
4018
  * @memberof ListConversationsResponseInner
3482
4019
  */
3483
- 'channel': ConversationChannel;
4020
+ 'lockAttempts'?: number | null;
3484
4021
  /**
3485
- *
3486
- * @type {ConversationEnvironment}
4022
+ * Contact that received a forward handoff.
4023
+ * @type {string}
3487
4024
  * @memberof ListConversationsResponseInner
3488
- * @deprecated
3489
4025
  */
3490
- 'environment'?: ConversationEnvironment;
4026
+ 'forwardedTo'?: string | null;
3491
4027
  /**
3492
- * Whether this conversation is a test or not
3493
- * @type {boolean}
4028
+ * ISO 8601 datetime string for when the conversation was forwarded.
4029
+ * @type {string}
3494
4030
  * @memberof ListConversationsResponseInner
3495
4031
  */
3496
- 'test'?: boolean;
4032
+ 'forwarded'?: string | null;
3497
4033
  /**
3498
- * The client web url of the conversation
4034
+ * Operator or workflow note attached to the forward.
3499
4035
  * @type {string}
3500
4036
  * @memberof ListConversationsResponseInner
3501
4037
  */
3502
- 'clientWebUrl'?: string;
4038
+ 'forwardNote'?: string | null;
3503
4039
  /**
3504
- * The agent web url of the conversation (requires phone two-factor authentication)
4040
+ * ISO 8601 date string of when the conversation was initiated
3505
4041
  * @type {string}
3506
4042
  * @memberof ListConversationsResponseInner
3507
4043
  */
3508
- 'agentWebUrl'?: string;
4044
+ 'initiated': string;
3509
4045
  /**
3510
- * The agent test web url of the conversation, used for testing the conversation without notifying the customer
4046
+ * Detected intent attached at conversation start or first customer message.
3511
4047
  * @type {string}
3512
4048
  * @memberof ListConversationsResponseInner
3513
4049
  */
3514
- 'agentTestWebUrl'?: string;
4050
+ 'intent'?: string | null;
3515
4051
  /**
3516
- * ISO 8601 date string of when the conversation was initiated
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.
3517
4059
  * @type {string}
3518
4060
  * @memberof ListConversationsResponseInner
3519
4061
  */
3520
- 'initiated': string;
4062
+ 'read'?: string;
3521
4063
  /**
3522
- * The ID of the conversation
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.
3523
4089
  * @type {string}
3524
4090
  * @memberof ListConversationsResponseInner
3525
4091
  */
3526
- '$id': string;
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;
3527
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];
3528
4127
  /**
3529
4128
  *
3530
4129
  * @export
@@ -5457,13 +6056,6 @@ export interface MessageCreateRequestConvoOneOf {
5457
6056
  * @memberof MessageCreateRequestConvoOneOf
5458
6057
  */
5459
6058
  'channel'?: ConversationChannel;
5460
- /**
5461
- *
5462
- * @type {ConversationEnvironment}
5463
- * @memberof MessageCreateRequestConvoOneOf
5464
- * @deprecated
5465
- */
5466
- 'environment'?: ConversationEnvironment;
5467
6059
  }
5468
6060
  /**
5469
6061
  *
@@ -6149,18 +6741,42 @@ export interface RegexCondition {
6149
6741
  * @interface ScheduleCreateRequest
6150
6742
  */
6151
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;
6152
6756
  /**
6153
6757
  * Default agent persona id assigned to the conversation(s)
6154
6758
  * @type {string}
6155
6759
  * @memberof ScheduleCreateRequest
6156
6760
  */
6157
6761
  '$agent': string;
6762
+ /**
6763
+ * Customer this conversation is with
6764
+ * @type {string}
6765
+ * @memberof ScheduleCreateRequest
6766
+ */
6767
+ '$customer': string;
6158
6768
  /**
6159
6769
  * Initial contexts to load when starting the conversation
6160
6770
  * @type {Array<string>}
6161
6771
  * @memberof ScheduleCreateRequest
6162
6772
  */
6163
6773
  'initialContexts'?: Array<string>;
6774
+ /**
6775
+ *
6776
+ * @type {ConversationChannel}
6777
+ * @memberof ScheduleCreateRequest
6778
+ */
6779
+ 'channel': ConversationChannel;
6164
6780
  /**
6165
6781
  *
6166
6782
  * @type {ConversationChannelProps}
@@ -6168,44 +6784,101 @@ export interface ScheduleCreateRequest {
6168
6784
  */
6169
6785
  'channelProps'?: ConversationChannelProps;
6170
6786
  /**
6171
- *
6172
- * @type {ConversationBaseEnvironmentProps}
6787
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
6788
+ * @type {boolean}
6173
6789
  * @memberof ScheduleCreateRequest
6174
- * @deprecated
6175
6790
  */
6176
- 'environmentProps'?: ConversationBaseEnvironmentProps;
6791
+ 'locked'?: boolean | null;
6177
6792
  /**
6178
- * User for this conversation
6793
+ * Machine-readable lock reason.
6179
6794
  * @type {string}
6180
6795
  * @memberof ScheduleCreateRequest
6181
6796
  */
6182
- '$user': string;
6797
+ 'lockCode'?: ScheduleCreateRequestLockCodeEnum;
6183
6798
  /**
6184
- * Customer this conversation is with (use $user instead)
6799
+ * Human-readable locked reason.
6185
6800
  * @type {string}
6186
6801
  * @memberof ScheduleCreateRequest
6187
- * @deprecated
6188
6802
  */
6189
- '$customer'?: string;
6803
+ 'lockedReason'?: string | null;
6190
6804
  /**
6191
- *
6192
- * @type {ConversationChannel}
6805
+ * Number of consecutive workflow/context no-progress attempts.
6806
+ * @type {number}
6193
6807
  * @memberof ScheduleCreateRequest
6194
6808
  */
6195
- 'channel': ConversationChannel;
6809
+ 'lockAttempts'?: number | null;
6196
6810
  /**
6197
- *
6198
- * @type {ConversationEnvironment}
6811
+ * Contact that received a forward handoff.
6812
+ * @type {string}
6199
6813
  * @memberof ScheduleCreateRequest
6200
- * @deprecated
6201
6814
  */
6202
- 'environment'?: ConversationEnvironment;
6815
+ 'forwardedTo'?: string | null;
6203
6816
  /**
6204
- * Whether this conversation is a test or not
6205
- * @type {boolean}
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}
6825
+ * @memberof ScheduleCreateRequest
6826
+ */
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; }}
6206
6871
  * @memberof ScheduleCreateRequest
6207
6872
  */
6208
- 'test'?: boolean;
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;
6209
6882
  /**
6210
6883
  * ISO 8601 datetime string
6211
6884
  * @type {string}
@@ -6231,6 +6904,21 @@ export interface ScheduleCreateRequest {
6231
6904
  */
6232
6905
  '$group'?: string;
6233
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];
6234
6922
  /**
6235
6923
  *
6236
6924
  * @export
@@ -6281,18 +6969,42 @@ export interface ScheduleCreateResponseAllOf {
6281
6969
  * @interface ScheduleGetResponse
6282
6970
  */
6283
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;
6284
6984
  /**
6285
6985
  * Default agent persona id assigned to the conversation(s)
6286
6986
  * @type {string}
6287
6987
  * @memberof ScheduleGetResponse
6288
6988
  */
6289
6989
  '$agent': string;
6990
+ /**
6991
+ * Customer this conversation is with
6992
+ * @type {string}
6993
+ * @memberof ScheduleGetResponse
6994
+ */
6995
+ '$customer': string;
6290
6996
  /**
6291
6997
  * Initial contexts to load when starting the conversation
6292
6998
  * @type {Array<string>}
6293
6999
  * @memberof ScheduleGetResponse
6294
7000
  */
6295
7001
  'initialContexts'?: Array<string>;
7002
+ /**
7003
+ *
7004
+ * @type {ConversationChannel}
7005
+ * @memberof ScheduleGetResponse
7006
+ */
7007
+ 'channel': ConversationChannel;
6296
7008
  /**
6297
7009
  *
6298
7010
  * @type {ConversationChannelProps}
@@ -6300,44 +7012,101 @@ export interface ScheduleGetResponse {
6300
7012
  */
6301
7013
  'channelProps'?: ConversationChannelProps;
6302
7014
  /**
6303
- *
6304
- * @type {ConversationBaseEnvironmentProps}
7015
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
7016
+ * @type {boolean}
6305
7017
  * @memberof ScheduleGetResponse
6306
- * @deprecated
6307
7018
  */
6308
- 'environmentProps'?: ConversationBaseEnvironmentProps;
7019
+ 'locked'?: boolean | null;
6309
7020
  /**
6310
- * User for this conversation
7021
+ * Machine-readable lock reason.
6311
7022
  * @type {string}
6312
7023
  * @memberof ScheduleGetResponse
6313
7024
  */
6314
- '$user': string;
7025
+ 'lockCode'?: ScheduleGetResponseLockCodeEnum;
6315
7026
  /**
6316
- * Customer this conversation is with (use $user instead)
7027
+ * Human-readable locked reason.
6317
7028
  * @type {string}
6318
7029
  * @memberof ScheduleGetResponse
6319
- * @deprecated
6320
7030
  */
6321
- '$customer'?: string;
7031
+ 'lockedReason'?: string | null;
6322
7032
  /**
6323
- *
6324
- * @type {ConversationChannel}
7033
+ * Number of consecutive workflow/context no-progress attempts.
7034
+ * @type {number}
6325
7035
  * @memberof ScheduleGetResponse
6326
7036
  */
6327
- 'channel': ConversationChannel;
7037
+ 'lockAttempts'?: number | null;
6328
7038
  /**
6329
- *
6330
- * @type {ConversationEnvironment}
7039
+ * Contact that received a forward handoff.
7040
+ * @type {string}
6331
7041
  * @memberof ScheduleGetResponse
6332
- * @deprecated
6333
7042
  */
6334
- 'environment'?: ConversationEnvironment;
7043
+ 'forwardedTo'?: string | null;
6335
7044
  /**
6336
- * Whether this conversation is a test or not
6337
- * @type {boolean}
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; }}
7083
+ * @memberof ScheduleGetResponse
7084
+ */
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}
6338
7107
  * @memberof ScheduleGetResponse
6339
7108
  */
6340
- 'test'?: boolean;
7109
+ 'ingress'?: ScheduleGetResponseIngressEnum;
6341
7110
  /**
6342
7111
  * ISO 8601 datetime string
6343
7112
  * @type {string}
@@ -6381,6 +7150,21 @@ export interface ScheduleGetResponse {
6381
7150
  */
6382
7151
  'agentTestWebUrl'?: string;
6383
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];
6384
7168
  /**
6385
7169
  *
6386
7170
  * @export
@@ -6388,30 +7172,143 @@ export interface ScheduleGetResponse {
6388
7172
  */
6389
7173
  export interface ScheduleGroupCreateRequest {
6390
7174
  /**
6391
- * Default agent persona id assigned to the conversation(s)
7175
+ * Conversation document id. Public/admin clients may receive this field; middleware does not store it inside the Firestore document body.
6392
7176
  * @type {string}
6393
7177
  * @memberof ScheduleGroupCreateRequest
6394
7178
  */
6395
- '$agent'?: string;
7179
+ '$id'?: string;
6396
7180
  /**
6397
- * Initial contexts to load when starting the conversation
6398
- * @type {Array<string>}
7181
+ * Business/organization this conversation belongs to
7182
+ * @type {string}
6399
7183
  * @memberof ScheduleGroupCreateRequest
6400
7184
  */
6401
- 'initialContexts'?: Array<string>;
7185
+ '$business'?: string;
6402
7186
  /**
6403
- *
6404
- * @type {ConversationChannelProps}
7187
+ * Default agent persona id assigned to the conversation(s)
7188
+ * @type {string}
6405
7189
  * @memberof ScheduleGroupCreateRequest
6406
7190
  */
6407
- 'channelProps'?: ConversationChannelProps;
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;
6408
7210
  /**
6409
7211
  *
6410
- * @type {ConversationBaseEnvironmentProps}
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}
6411
7309
  * @memberof ScheduleGroupCreateRequest
6412
- * @deprecated
6413
7310
  */
6414
- 'environmentProps'?: ConversationBaseEnvironmentProps;
7311
+ 'ingress'?: ScheduleGroupCreateRequestIngressEnum;
6415
7312
  /**
6416
7313
  * ISO 8601 datetime string
6417
7314
  * @type {string}
@@ -6443,6 +7340,21 @@ export interface ScheduleGroupCreateRequest {
6443
7340
  */
6444
7341
  '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
6445
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];
6446
7358
  /**
6447
7359
  *
6448
7360
  * @export
@@ -6492,18 +7404,42 @@ export interface ScheduleGroupCreateResponse {
6492
7404
  * @interface ScheduleGroupGetResponse
6493
7405
  */
6494
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;
6495
7419
  /**
6496
7420
  * Default agent persona id assigned to the conversation(s)
6497
7421
  * @type {string}
6498
7422
  * @memberof ScheduleGroupGetResponse
6499
7423
  */
6500
7424
  '$agent'?: string;
7425
+ /**
7426
+ * Customer this conversation is with
7427
+ * @type {string}
7428
+ * @memberof ScheduleGroupGetResponse
7429
+ */
7430
+ '$customer'?: string;
6501
7431
  /**
6502
7432
  * Initial contexts to load when starting the conversation
6503
7433
  * @type {Array<string>}
6504
7434
  * @memberof ScheduleGroupGetResponse
6505
7435
  */
6506
7436
  'initialContexts'?: Array<string>;
7437
+ /**
7438
+ *
7439
+ * @type {ConversationChannel}
7440
+ * @memberof ScheduleGroupGetResponse
7441
+ */
7442
+ 'channel'?: ConversationChannel;
6507
7443
  /**
6508
7444
  *
6509
7445
  * @type {ConversationChannelProps}
@@ -6511,12 +7447,101 @@ export interface ScheduleGroupGetResponse {
6511
7447
  */
6512
7448
  'channelProps'?: ConversationChannelProps;
6513
7449
  /**
6514
- *
6515
- * @type {ConversationBaseEnvironmentProps}
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}
6516
7464
  * @memberof ScheduleGroupGetResponse
6517
- * @deprecated
6518
7465
  */
6519
- 'environmentProps'?: ConversationBaseEnvironmentProps;
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; }}
7534
+ * @memberof ScheduleGroupGetResponse
7535
+ */
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;
6520
7545
  /**
6521
7546
  * ISO 8601 datetime string
6522
7547
  * @type {string}
@@ -6541,12 +7566,6 @@ export interface ScheduleGroupGetResponse {
6541
7566
  * @memberof ScheduleGroupGetResponse
6542
7567
  */
6543
7568
  'delay'?: number;
6544
- /**
6545
- * The ID of the scheduled conversation group
6546
- * @type {string}
6547
- * @memberof ScheduleGroupGetResponse
6548
- */
6549
- '$id': string;
6550
7569
  /**
6551
7570
  * ISO Time the initial message has been sent
6552
7571
  * @type {boolean}
@@ -6560,6 +7579,21 @@ export interface ScheduleGroupGetResponse {
6560
7579
  */
6561
7580
  '$cGroup'?: string;
6562
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];
6563
7597
  /**
6564
7598
  *
6565
7599
  * @export
@@ -6616,18 +7650,42 @@ export interface ScheduleGroupRemoveResponse {
6616
7650
  * @interface ScheduleGroupUpdateRequest
6617
7651
  */
6618
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;
6619
7665
  /**
6620
7666
  * Default agent persona id assigned to the conversation(s)
6621
7667
  * @type {string}
6622
7668
  * @memberof ScheduleGroupUpdateRequest
6623
7669
  */
6624
7670
  '$agent'?: string;
7671
+ /**
7672
+ * Customer this conversation is with
7673
+ * @type {string}
7674
+ * @memberof ScheduleGroupUpdateRequest
7675
+ */
7676
+ '$customer'?: string;
6625
7677
  /**
6626
7678
  * Initial contexts to load when starting the conversation
6627
7679
  * @type {Array<string>}
6628
7680
  * @memberof ScheduleGroupUpdateRequest
6629
7681
  */
6630
7682
  'initialContexts'?: Array<string>;
7683
+ /**
7684
+ *
7685
+ * @type {ConversationChannel}
7686
+ * @memberof ScheduleGroupUpdateRequest
7687
+ */
7688
+ 'channel'?: ConversationChannel;
6631
7689
  /**
6632
7690
  *
6633
7691
  * @type {ConversationChannelProps}
@@ -6635,12 +7693,101 @@ export interface ScheduleGroupUpdateRequest {
6635
7693
  */
6636
7694
  'channelProps'?: ConversationChannelProps;
6637
7695
  /**
6638
- *
6639
- * @type {ConversationBaseEnvironmentProps}
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}
6640
7788
  * @memberof ScheduleGroupUpdateRequest
6641
- * @deprecated
6642
7789
  */
6643
- 'environmentProps'?: ConversationBaseEnvironmentProps;
7790
+ 'ingress'?: ScheduleGroupUpdateRequestIngressEnum;
6644
7791
  /**
6645
7792
  * ISO 8601 datetime string
6646
7793
  * @type {string}
@@ -6671,13 +7818,22 @@ export interface ScheduleGroupUpdateRequest {
6671
7818
  * @memberof ScheduleGroupUpdateRequest
6672
7819
  */
6673
7820
  '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
6674
- /**
6675
- * The ID of the scheduled conversation group to update
6676
- * @type {string}
6677
- * @memberof ScheduleGroupUpdateRequest
6678
- */
6679
- '$id': string;
6680
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];
6681
7837
  /**
6682
7838
  *
6683
7839
  * @export
@@ -6753,18 +7909,42 @@ export interface ScheduleRemoveResponse {
6753
7909
  * @interface ScheduleUpdateRequest
6754
7910
  */
6755
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;
6756
7924
  /**
6757
7925
  * Default agent persona id assigned to the conversation(s)
6758
7926
  * @type {string}
6759
7927
  * @memberof ScheduleUpdateRequest
6760
7928
  */
6761
7929
  '$agent': string;
7930
+ /**
7931
+ * Customer this conversation is with
7932
+ * @type {string}
7933
+ * @memberof ScheduleUpdateRequest
7934
+ */
7935
+ '$customer': string;
6762
7936
  /**
6763
7937
  * Initial contexts to load when starting the conversation
6764
7938
  * @type {Array<string>}
6765
7939
  * @memberof ScheduleUpdateRequest
6766
7940
  */
6767
7941
  'initialContexts'?: Array<string>;
7942
+ /**
7943
+ *
7944
+ * @type {ConversationChannel}
7945
+ * @memberof ScheduleUpdateRequest
7946
+ */
7947
+ 'channel': ConversationChannel;
6768
7948
  /**
6769
7949
  *
6770
7950
  * @type {ConversationChannelProps}
@@ -6772,44 +7952,101 @@ export interface ScheduleUpdateRequest {
6772
7952
  */
6773
7953
  'channelProps'?: ConversationChannelProps;
6774
7954
  /**
6775
- *
6776
- * @type {ConversationBaseEnvironmentProps}
7955
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
7956
+ * @type {boolean}
6777
7957
  * @memberof ScheduleUpdateRequest
6778
- * @deprecated
6779
7958
  */
6780
- 'environmentProps'?: ConversationBaseEnvironmentProps;
7959
+ 'locked'?: boolean | null;
6781
7960
  /**
6782
- * User for this conversation
7961
+ * Machine-readable lock reason.
6783
7962
  * @type {string}
6784
7963
  * @memberof ScheduleUpdateRequest
6785
7964
  */
6786
- '$user': string;
7965
+ 'lockCode'?: ScheduleUpdateRequestLockCodeEnum;
6787
7966
  /**
6788
- * Customer this conversation is with (use $user instead)
7967
+ * Human-readable locked reason.
6789
7968
  * @type {string}
6790
7969
  * @memberof ScheduleUpdateRequest
6791
- * @deprecated
6792
7970
  */
6793
- '$customer'?: string;
7971
+ 'lockedReason'?: string | null;
6794
7972
  /**
6795
- *
6796
- * @type {ConversationChannel}
7973
+ * Number of consecutive workflow/context no-progress attempts.
7974
+ * @type {number}
6797
7975
  * @memberof ScheduleUpdateRequest
6798
7976
  */
6799
- 'channel': ConversationChannel;
7977
+ 'lockAttempts'?: number | null;
6800
7978
  /**
6801
- *
6802
- * @type {ConversationEnvironment}
7979
+ * Contact that received a forward handoff.
7980
+ * @type {string}
6803
7981
  * @memberof ScheduleUpdateRequest
6804
- * @deprecated
6805
7982
  */
6806
- 'environment'?: ConversationEnvironment;
7983
+ 'forwardedTo'?: string | null;
6807
7984
  /**
6808
- * Whether this conversation is a test or not
6809
- * @type {boolean}
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}
6810
8047
  * @memberof ScheduleUpdateRequest
6811
8048
  */
6812
- 'test'?: boolean;
8049
+ 'ingress'?: ScheduleUpdateRequestIngressEnum;
6813
8050
  /**
6814
8051
  * ISO 8601 datetime string
6815
8052
  * @type {string}
@@ -6834,13 +8071,22 @@ export interface ScheduleUpdateRequest {
6834
8071
  * @memberof ScheduleUpdateRequest
6835
8072
  */
6836
8073
  '$group'?: string;
6837
- /**
6838
- * The ID of the scheduled conversation to update
6839
- * @type {string}
6840
- * @memberof ScheduleUpdateRequest
6841
- */
6842
- '$id'?: string;
6843
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];
6844
8090
  /**
6845
8091
  *
6846
8092
  * @export
@@ -6885,18 +8131,42 @@ export interface ScheduleUpdateResponse {
6885
8131
  * @interface ScheduledConversation
6886
8132
  */
6887
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;
6888
8146
  /**
6889
8147
  * Default agent persona id assigned to the conversation(s)
6890
8148
  * @type {string}
6891
8149
  * @memberof ScheduledConversation
6892
8150
  */
6893
8151
  '$agent': string;
8152
+ /**
8153
+ * Customer this conversation is with
8154
+ * @type {string}
8155
+ * @memberof ScheduledConversation
8156
+ */
8157
+ '$customer': string;
6894
8158
  /**
6895
8159
  * Initial contexts to load when starting the conversation
6896
8160
  * @type {Array<string>}
6897
8161
  * @memberof ScheduledConversation
6898
8162
  */
6899
8163
  'initialContexts'?: Array<string>;
8164
+ /**
8165
+ *
8166
+ * @type {ConversationChannel}
8167
+ * @memberof ScheduledConversation
8168
+ */
8169
+ 'channel': ConversationChannel;
6900
8170
  /**
6901
8171
  *
6902
8172
  * @type {ConversationChannelProps}
@@ -6904,44 +8174,101 @@ export interface ScheduledConversation {
6904
8174
  */
6905
8175
  'channelProps'?: ConversationChannelProps;
6906
8176
  /**
6907
- *
6908
- * @type {ConversationBaseEnvironmentProps}
8177
+ * Whether automated replies are locked and the conversation requires a policy outcome or manual intervention.
8178
+ * @type {boolean}
6909
8179
  * @memberof ScheduledConversation
6910
- * @deprecated
6911
8180
  */
6912
- 'environmentProps'?: ConversationBaseEnvironmentProps;
8181
+ 'locked'?: boolean | null;
6913
8182
  /**
6914
- * User for this conversation
8183
+ * Machine-readable lock reason.
6915
8184
  * @type {string}
6916
8185
  * @memberof ScheduledConversation
6917
8186
  */
6918
- '$user': string;
8187
+ 'lockCode'?: ScheduledConversationLockCodeEnum;
6919
8188
  /**
6920
- * Customer this conversation is with (use $user instead)
8189
+ * Human-readable locked reason.
6921
8190
  * @type {string}
6922
8191
  * @memberof ScheduledConversation
6923
- * @deprecated
6924
8192
  */
6925
- '$customer'?: string;
8193
+ 'lockedReason'?: string | null;
6926
8194
  /**
6927
- *
6928
- * @type {ConversationChannel}
8195
+ * Number of consecutive workflow/context no-progress attempts.
8196
+ * @type {number}
6929
8197
  * @memberof ScheduledConversation
6930
8198
  */
6931
- 'channel': ConversationChannel;
8199
+ 'lockAttempts'?: number | null;
6932
8200
  /**
6933
- *
6934
- * @type {ConversationEnvironment}
8201
+ * Contact that received a forward handoff.
8202
+ * @type {string}
6935
8203
  * @memberof ScheduledConversation
6936
- * @deprecated
6937
8204
  */
6938
- 'environment'?: ConversationEnvironment;
8205
+ 'forwardedTo'?: string | null;
6939
8206
  /**
6940
- * Whether this conversation is a test or not
6941
- * @type {boolean}
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; }}
6942
8261
  * @memberof ScheduledConversation
6943
8262
  */
6944
- 'test'?: boolean;
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;
6945
8272
  /**
6946
8273
  * ISO 8601 datetime string
6947
8274
  * @type {string}
@@ -6967,6 +8294,21 @@ export interface ScheduledConversation {
6967
8294
  */
6968
8295
  '$group'?: string;
6969
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];
6970
8312
  /**
6971
8313
  *
6972
8314
  * @export
@@ -6986,18 +8328,42 @@ export interface ScheduledConversationAllOf {
6986
8328
  * @interface ScheduledConversationGroup
6987
8329
  */
6988
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;
6989
8343
  /**
6990
8344
  * Default agent persona id assigned to the conversation(s)
6991
8345
  * @type {string}
6992
8346
  * @memberof ScheduledConversationGroup
6993
8347
  */
6994
8348
  '$agent'?: string;
8349
+ /**
8350
+ * Customer this conversation is with
8351
+ * @type {string}
8352
+ * @memberof ScheduledConversationGroup
8353
+ */
8354
+ '$customer'?: string;
6995
8355
  /**
6996
8356
  * Initial contexts to load when starting the conversation
6997
8357
  * @type {Array<string>}
6998
8358
  * @memberof ScheduledConversationGroup
6999
8359
  */
7000
8360
  'initialContexts'?: Array<string>;
8361
+ /**
8362
+ *
8363
+ * @type {ConversationChannel}
8364
+ * @memberof ScheduledConversationGroup
8365
+ */
8366
+ 'channel'?: ConversationChannel;
7001
8367
  /**
7002
8368
  *
7003
8369
  * @type {ConversationChannelProps}
@@ -7005,12 +8371,101 @@ export interface ScheduledConversationGroup {
7005
8371
  */
7006
8372
  'channelProps'?: ConversationChannelProps;
7007
8373
  /**
7008
- *
7009
- * @type {ConversationBaseEnvironmentProps}
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; }}
7010
8458
  * @memberof ScheduledConversationGroup
7011
- * @deprecated
7012
8459
  */
7013
- 'environmentProps'?: ConversationBaseEnvironmentProps;
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;
7014
8469
  /**
7015
8470
  * ISO 8601 datetime string
7016
8471
  * @type {string}
@@ -7036,6 +8491,21 @@ export interface ScheduledConversationGroup {
7036
8491
  */
7037
8492
  'delay'?: number;
7038
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];
7039
8509
  /**
7040
8510
  *
7041
8511
  * @export