@scout9/app 1.0.0-alpha.0.2.1 → 1.0.0-alpha.0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/public.d.ts CHANGED
@@ -2,13 +2,8 @@
2
2
  /**
3
3
  * Scout9 App
4
4
  * Application platform for managing auto reply workflows from personal communication methods
5
- *
6
- *
7
- * NOTE: This file was auto generated 8/17/2024, 8:45:07 AM
8
- * Do not edit the file manually.
9
5
  */
10
6
 
11
-
12
7
  /**
13
8
  * @param {WorkflowEvent} event - every workflow receives an event object
14
9
  * @param {Object} options
@@ -213,6 +208,18 @@ export type EventMacros = {
213
208
  * @return {Promise<boolean>}
214
209
  */
215
210
  export function did(prompt: string): Promise<boolean>;
211
+
212
+ export type ContextExampleWithTrainingData = {
213
+ input: string;
214
+ output: Record<string, any>[];
215
+ }
216
+
217
+
218
+ export type ConversationContext = Record<string, any>;
219
+
220
+ export type ContextExamples = (ContextExampleWithTrainingData | ConversationContext)[];
221
+ export type ContextOutput = Record<string, any>;
222
+
216
223
  /**
217
224
  * @typedef {import('@scout9/admin').MacroContextInputExamples} ContextExamples
218
225
  * @typedef {import('@scout9/admin').MacroContextValue} ContextOutput
@@ -234,67 +241,7 @@ export function did(prompt: string): Promise<boolean>;
234
241
  * @param {ContextExamples} [examples] - Examples to the macro to ensure a consistent data structure.
235
242
  * @return {Promise<ContextOutput>}
236
243
  */
237
- export function context(prompt: string, examples?: any): Promise<any>;
238
- export type ContextExamples = any;
239
- export type ContextOutput = any;
240
-
241
-
242
- export type AgentConfiguration = {
243
- deployed?: {
244
- /** Web URL for agent */
245
- web?: string | undefined;
246
- /** Phone number for agent */
247
- phone?: string | undefined;
248
- /** Email address for agent */
249
- email?: string | undefined;
250
- } | undefined;
251
- img?: (string | null) | undefined;
252
- /** Agent first name */
253
- firstName?: string | undefined;
254
- /** Agent last name */
255
- lastName?: string | undefined;
256
- /** Agent is inactive */
257
- inactive?: boolean | undefined;
258
- /** Programmable phone number */
259
- programmablePhoneNumber?: string | undefined;
260
- /** Programmable phone number SID */
261
- programmablePhoneNumberSid?: string | undefined;
262
- /** Email address from Scout9 gmail subdomain */
263
- programmableEmail?: string | undefined;
264
- /** Email address to forward to */
265
- forwardEmail?: string | undefined;
266
- /** Phone number to forward to */
267
- forwardPhone?: string | undefined;
268
- /** Agent title */
269
- title?: string;
270
- /** Context of the agent */
271
- context?: string;
272
- includedLocations?: string[] | undefined;
273
- excludedLocations?: string[] | undefined;
274
- model?: ("Scout9" | "bard" | "openai");
275
- transcripts?: {
276
- /** Unique ID for the message */
277
- id: string;
278
- role: "agent" | "customer" | "system";
279
- content: string;
280
- /** Datetime ISO 8601 timestamp */
281
- time: string;
282
- name?: string | undefined;
283
- /** Datetime ISO 8601 timestamp */
284
- scheduled?: string | undefined;
285
- /** The context generated from the message */
286
- context?: any | undefined;
287
- /** Detected intent */
288
- intent?: (string | undefined) | null;
289
- /** Confidence score of the assigned intent */
290
- intentScore?: (number | null) | undefined;
291
- /** How long to delay the message manually in seconds */
292
- delayInSeconds?: (number | null) | undefined;
293
- }[][] | undefined;
294
- audios?: any[] | undefined;
295
- /** Unique ID for agent */
296
- id: string;
297
- };
244
+ export function context(prompt: string, examples?: ContextExamples): Promise<ContextOutput>;
298
245
 
299
246
  export type Agent = {
300
247
  deployed?: {
@@ -329,167 +276,17 @@ export type Agent = {
329
276
  includedLocations?: string[] | undefined;
330
277
  excludedLocations?: string[] | undefined;
331
278
  model?: ("Scout9" | "bard" | "openai");
332
- transcripts?: {
333
- /** Unique ID for the message */
334
- id: string;
335
- role: "agent" | "customer" | "system";
336
- content: string;
337
- /** Datetime ISO 8601 timestamp */
338
- time: string;
339
- name?: string | undefined;
340
- /** Datetime ISO 8601 timestamp */
341
- scheduled?: string | undefined;
342
- /** The context generated from the message */
343
- context?: any | undefined;
344
- /** Detected intent */
345
- intent?: (string | undefined) | null;
346
- /** Confidence score of the assigned intent */
347
- intentScore?: (number | null) | undefined;
348
- /** How long to delay the message manually in seconds */
349
- delayInSeconds?: (number | null) | undefined;
350
- }[][] | undefined;
279
+ transcripts?: Message[][] | undefined;
351
280
  audios?: any[] | undefined;
352
281
  };
353
282
 
354
- export type AgentsConfiguration = {
355
- deployed?: {
356
- /** Web URL for agent */
357
- web?: string | undefined;
358
- /** Phone number for agent */
359
- phone?: string | undefined;
360
- /** Email address for agent */
361
- email?: string | undefined;
362
- } | undefined;
363
- img?: (string | null) | undefined;
364
- /** Agent first name */
365
- firstName?: string | undefined;
366
- /** Agent last name */
367
- lastName?: string | undefined;
368
- /** Agent is inactive */
369
- inactive?: boolean | undefined;
370
- /** Programmable phone number */
371
- programmablePhoneNumber?: string | undefined;
372
- /** Programmable phone number SID */
373
- programmablePhoneNumberSid?: string | undefined;
374
- /** Email address from Scout9 gmail subdomain */
375
- programmableEmail?: string | undefined;
376
- /** Email address to forward to */
377
- forwardEmail?: string | undefined;
378
- /** Phone number to forward to */
379
- forwardPhone?: string | undefined;
380
- /** Agent title */
381
- title?: string;
382
- /** Context of the agent */
383
- context?: string;
384
- includedLocations?: string[] | undefined;
385
- excludedLocations?: string[] | undefined;
386
- model?: ("Scout9" | "bard" | "openai");
387
- transcripts?: {
388
- /** Unique ID for the message */
389
- id: string;
390
- role: "agent" | "customer" | "system";
391
- content: string;
392
- /** Datetime ISO 8601 timestamp */
393
- time: string;
394
- name?: string | undefined;
395
- /** Datetime ISO 8601 timestamp */
396
- scheduled?: string | undefined;
397
- /** The context generated from the message */
398
- context?: any | undefined;
399
- /** Detected intent */
400
- intent?: (string | undefined) | null;
401
- /** Confidence score of the assigned intent */
402
- intentScore?: (number | null) | undefined;
403
- /** How long to delay the message manually in seconds */
404
- delayInSeconds?: (number | null) | undefined;
405
- }[][] | undefined;
406
- audios?: any[] | undefined;
407
- /** Unique ID for agent */
408
- id: string;
409
- }[];
410
-
411
- export type Agents = {
412
- deployed?: {
413
- /** Web URL for agent */
414
- web?: string | undefined;
415
- /** Phone number for agent */
416
- phone?: string | undefined;
417
- /** Email address for agent */
418
- email?: string | undefined;
419
- } | undefined;
420
- img?: (string | null) | undefined;
421
- /** Agent first name */
422
- firstName?: string | undefined;
423
- /** Agent last name */
424
- lastName?: string | undefined;
425
- /** Agent is inactive */
426
- inactive?: boolean | undefined;
427
- /** Programmable phone number */
428
- programmablePhoneNumber?: string | undefined;
429
- /** Programmable phone number SID */
430
- programmablePhoneNumberSid?: string | undefined;
431
- /** Email address from Scout9 gmail subdomain */
432
- programmableEmail?: string | undefined;
433
- /** Email address to forward to */
434
- forwardEmail?: string | undefined;
435
- /** Phone number to forward to */
436
- forwardPhone?: string | undefined;
437
- /** Agent title */
438
- title?: string;
439
- /** Context of the agent */
440
- context?: string;
441
- includedLocations?: string[] | undefined;
442
- excludedLocations?: string[] | undefined;
443
- model?: ("Scout9" | "bard" | "openai");
444
- transcripts?: {
445
- /** Unique ID for the message */
446
- id: string;
447
- role: "agent" | "customer" | "system";
448
- content: string;
449
- /** Datetime ISO 8601 timestamp */
450
- time: string;
451
- name?: string | undefined;
452
- /** Datetime ISO 8601 timestamp */
453
- scheduled?: string | undefined;
454
- /** The context generated from the message */
455
- context?: any | undefined;
456
- /** Detected intent */
457
- intent?: (string | undefined) | null;
458
- /** Confidence score of the assigned intent */
459
- intentScore?: (number | null) | undefined;
460
- /** How long to delay the message manually in seconds */
461
- delayInSeconds?: (number | null) | undefined;
462
- }[][] | undefined;
463
- audios?: any[] | undefined;
464
- }[];
465
-
466
- export type Baz = {
467
- boo: {
468
- one: number;
469
- two?: number | undefined;
470
- };
471
- };
283
+ export type AgentConfiguration = Agent & {id: string};
472
284
 
473
- export type Bus = {
474
- foo: string;
475
- bar?: boolean | undefined;
476
- };
285
+ export type AgentsConfiguration = AgentConfiguration[];
477
286
 
478
- export type ContextExample = {
479
- input: string;
480
- output: {
481
- [x: string]: any;
482
- }[];
483
- }[] | {
484
- [x: string]: any;
485
- }[];
287
+ export type Agents = Agent[];
486
288
 
487
- export type ContextExampleWithTrainingData = {
488
- input: string;
489
- output: {
490
- [x: string]: any;
491
- }[];
492
- };
289
+ export type ContextExample = ContextExampleWithTrainingData[] | ConversationContext[];
493
290
 
494
291
  export type ConversationAnticipate = {
495
292
  /** Determines the runtime to address the next response */
@@ -506,9 +303,6 @@ export type ConversationAnticipate = {
506
303
  }[] | undefined;
507
304
  };
508
305
 
509
- export type ConversationContext = {
510
- [x: string]: any;
511
- };
512
306
 
513
307
  export type Conversation = {
514
308
  /** Default agent assigned to the conversation(s) */
@@ -539,22 +333,12 @@ export type Conversation = {
539
333
  intent?: (string | undefined) | null;
540
334
  /** Confidence score of the assigned intent */
541
335
  intentScore?: (number | undefined) | null;
542
- anticipate?: {
543
- /** Determines the runtime to address the next response */
544
- type: "did" | "literal" | "context";
545
- slots: {
546
- [x: string]: any[];
547
- };
548
- /** For type 'did' */
549
- did?: string | undefined;
550
- /** For literal keywords, this map helps point which slot the keyword matches to */
551
- map?: {
552
- slot: string;
553
- keywords: string[];
554
- }[] | undefined;
555
- } | undefined;
336
+ /** Used to handle anticipating outcome */
337
+ anticipate?: ConversationAnticipate | undefined;
556
338
  };
557
339
 
340
+ export type CustomerValue = boolean | number | string;
341
+
558
342
  export type Customer = {
559
343
  firstName?: string | undefined;
560
344
  lastName?: string | undefined;
@@ -573,76 +357,41 @@ export type Customer = {
573
357
  joined?: (string | null) | undefined;
574
358
  stripe?: (string | null) | undefined;
575
359
  stripeDev?: (string | null) | undefined;
360
+ } & {[key: string]: CustomerValue};
361
+
362
+ export type EntityDefinition = {
363
+ /** What entity utterance this represents, if not provided, it will default to the entity id */
364
+ utterance?: string | undefined;
365
+ /** The value of this entity variance */
366
+ value: string;
367
+ /** Text representing the entity variance */
368
+ text: string[];
576
369
  };
577
370
 
578
- export type CustomerValue = boolean | number | string;
371
+ export type EntityTrainingDocument = {
372
+ /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
373
+ intent: string;
374
+ /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
375
+ text: string;
376
+ }
579
377
 
580
- export type EntitiesRootConfiguration = {
581
- /** If not provided, the id will default to the route (folder) name */
582
- id?: string | undefined;
583
- definitions?: {
584
- /** What entity utterance this represents, if not provided, it will default to the entity id */
585
- utterance?: string | undefined;
586
- /** The value of this entity variance */
587
- value: string;
588
- /** Text representing the entity variance */
589
- text: string[];
590
- }[] | undefined;
591
- training?: {
592
- /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
378
+ export type EntityTest = {
379
+ /** Text to test the entity detection */
380
+ text: string;
381
+ expected: {
382
+ /** The expected intent id */
593
383
  intent: string;
594
- /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
595
- text: string;
596
- }[] | undefined;
597
- tests?: {
598
- /** Text to test the entity detection */
599
- text: string;
600
- expected: {
601
- /** The expected intent id */
602
- intent: string;
603
- context?: any;
604
- };
605
- }[] | undefined;
606
- }[];
384
+ context?: any;
385
+ };
386
+ };
607
387
 
608
- export type EntitiesRootProjectConfiguration = {
388
+ export type EntityConfiguration = {
609
389
  /** If not provided, the id will default to the route (folder) name */
610
390
  id?: string | undefined;
611
- definitions?: {
612
- /** What entity utterance this represents, if not provided, it will default to the entity id */
613
- utterance?: string | undefined;
614
- /** The value of this entity variance */
615
- value: string;
616
- /** Text representing the entity variance */
617
- text: string[];
618
- }[] | undefined;
619
- training?: {
620
- /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
621
- intent: string;
622
- /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
623
- text: string;
624
- }[] | undefined;
625
- tests?: {
626
- /** Text to test the entity detection */
627
- text: string;
628
- expected: {
629
- /** The expected intent id */
630
- intent: string;
631
- context?: any;
632
- };
633
- }[] | undefined;
634
- /** Entity id association, used to handle route params */
635
- entities: string[];
636
- entity: string;
637
- api: {
638
- GET?: boolean | undefined;
639
- UPDATE?: boolean | undefined;
640
- QUERY?: boolean | undefined;
641
- PUT?: boolean | undefined;
642
- PATCH?: boolean | undefined;
643
- DELETE?: boolean | undefined;
644
- } | null;
645
- }[];
391
+ definitions?: EntityDefinition[] | undefined;
392
+ training?: EntityTrainingDocument[] | undefined;
393
+ tests?: EntityTest[] | undefined;
394
+ };
646
395
 
647
396
  export type EntityApiConfiguration = {
648
397
  GET?: boolean | undefined;
@@ -651,75 +400,30 @@ export type EntityApiConfiguration = {
651
400
  PUT?: boolean | undefined;
652
401
  PATCH?: boolean | undefined;
653
402
  DELETE?: boolean | undefined;
654
- } | null;
655
-
656
- export type EntityConfiguration = {
657
- /** If not provided, the id will default to the route (folder) name */
658
- id?: string | undefined;
659
- definitions?: {
660
- /** What entity utterance this represents, if not provided, it will default to the entity id */
661
- utterance?: string | undefined;
662
- /** The value of this entity variance */
663
- value: string;
664
- /** Text representing the entity variance */
665
- text: string[];
666
- }[] | undefined;
667
- training?: {
668
- /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
669
- intent: string;
670
- /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
671
- text: string;
672
- }[] | undefined;
673
- tests?: {
674
- /** Text to test the entity detection */
675
- text: string;
676
- expected: {
677
- /** The expected intent id */
678
- intent: string;
679
- context?: any;
680
- };
681
- }[] | undefined;
682
403
  };
683
404
 
684
- export type EntityRootProjectConfiguration = {
685
- /** If not provided, the id will default to the route (folder) name */
686
- id?: string | undefined;
687
- definitions?: {
688
- /** What entity utterance this represents, if not provided, it will default to the entity id */
689
- utterance?: string | undefined;
690
- /** The value of this entity variance */
691
- value: string;
692
- /** Text representing the entity variance */
693
- text: string[];
694
- }[] | undefined;
695
- training?: {
696
- /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
697
- intent: string;
698
- /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
699
- text: string;
700
- }[] | undefined;
701
- tests?: {
702
- /** Text to test the entity detection */
703
- text: string;
704
- expected: {
705
- /** The expected intent id */
706
- intent: string;
707
- context?: any;
708
- };
709
- }[] | undefined;
405
+ export type EntityRootProjectConfiguration = EntityConfiguration & {
710
406
  /** Entity id association, used to handle route params */
711
407
  entities: string[];
712
408
  entity: string;
713
- api: {
714
- GET?: boolean | undefined;
715
- UPDATE?: boolean | undefined;
716
- QUERY?: boolean | undefined;
717
- PUT?: boolean | undefined;
718
- PATCH?: boolean | undefined;
719
- DELETE?: boolean | undefined;
720
- } | null;
409
+ api: EntityApiConfiguration | null;
410
+ };
411
+
412
+ export type EntitiesRootConfiguration = EntityConfiguration[];
413
+
414
+ export type EntitiesRootProjectConfiguration = EntityRootProjectConfiguration[];
415
+
416
+
417
+ export type InstructionObject = {
418
+ /** Unique ID for the instruction, this is used to remove the instruction later */
419
+ id?: string | undefined;
420
+ /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
421
+ persist?: boolean | undefined;
422
+ content: string;
721
423
  };
722
424
 
425
+ export type Instruction = string | InstructionObject;
426
+
723
427
  export type FollowupBase = {
724
428
  scheduled: number;
725
429
  cancelIf?: {
@@ -729,37 +433,15 @@ export type FollowupBase = {
729
433
  overrideLock?: boolean | undefined;
730
434
  };
731
435
 
732
- export type Followup = {
733
- scheduled: number;
734
- cancelIf?: {
735
- [x: string]: any;
736
- } | undefined;
737
- /** This will still run even if the conversation is locked, defaults to false */
738
- overrideLock?: boolean | undefined;
436
+ export type FollowupWithMessage = FollowupBase & {
739
437
  /** Manual message sent to client */
740
438
  message: string;
741
- } | {
742
- scheduled: number;
743
- cancelIf?: {
744
- [x: string]: any;
745
- } | undefined;
746
- /** This will still run even if the conversation is locked, defaults to false */
747
- overrideLock?: boolean | undefined;
748
- instructions: string | {
749
- /** Unique ID for the instruction, this is used to remove the instruction later */
750
- id?: string | undefined;
751
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
752
- persist?: boolean | undefined;
753
- content: string;
754
- } | string[] | {
755
- /** Unique ID for the instruction, this is used to remove the instruction later */
756
- id?: string | undefined;
757
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
758
- persist?: boolean | undefined;
759
- content: string;
760
- }[];
761
439
  };
762
440
 
441
+ export type FollowupWithInstructions = FollowupBase & { instructions: Instruction[]; };
442
+
443
+ export type Followup = FollowupWithMessage | FollowupWithInstructions;
444
+
763
445
  export type Forward = boolean | string | {
764
446
  to?: string | undefined;
765
447
  mode?: ("after-reply" | "immediately") | undefined;
@@ -767,28 +449,6 @@ export type Forward = boolean | string | {
767
449
  note?: string | undefined;
768
450
  };
769
451
 
770
- export type InstructionObject = {
771
- /** Unique ID for the instruction, this is used to remove the instruction later */
772
- id?: string | undefined;
773
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
774
- persist?: boolean | undefined;
775
- content: string;
776
- };
777
-
778
- export type Instruction = string | {
779
- /** Unique ID for the instruction, this is used to remove the instruction later */
780
- id?: string | undefined;
781
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
782
- persist?: boolean | undefined;
783
- content: string;
784
- } | string[] | {
785
- /** Unique ID for the instruction, this is used to remove the instruction later */
786
- id?: string | undefined;
787
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
788
- persist?: boolean | undefined;
789
- content: string;
790
- }[];
791
-
792
452
  export type IntentWorkflowEvent = {
793
453
  current: string | null;
794
454
  flow: string[];
@@ -815,361 +475,21 @@ export type Message = {
815
475
  delayInSeconds?: (number | null) | undefined;
816
476
  };
817
477
 
818
- export type PersonaConfiguration = {
819
- deployed?: {
820
- /** Web URL for agent */
821
- web?: string | undefined;
822
- /** Phone number for agent */
823
- phone?: string | undefined;
824
- /** Email address for agent */
825
- email?: string | undefined;
826
- } | undefined;
827
- img?: (string | null) | undefined;
828
- /** Agent first name */
829
- firstName?: string | undefined;
830
- /** Agent last name */
831
- lastName?: string | undefined;
832
- /** Agent is inactive */
833
- inactive?: boolean | undefined;
834
- /** Programmable phone number */
835
- programmablePhoneNumber?: string | undefined;
836
- /** Programmable phone number SID */
837
- programmablePhoneNumberSid?: string | undefined;
838
- /** Email address from Scout9 gmail subdomain */
839
- programmableEmail?: string | undefined;
840
- /** Email address to forward to */
841
- forwardEmail?: string | undefined;
842
- /** Phone number to forward to */
843
- forwardPhone?: string | undefined;
844
- /** Agent title */
845
- title?: string;
846
- /** Context of the agent */
847
- context?: string;
848
- includedLocations?: string[] | undefined;
849
- excludedLocations?: string[] | undefined;
850
- model?: ("Scout9" | "bard" | "openai");
851
- transcripts?: {
852
- /** Unique ID for the message */
853
- id: string;
854
- role: "agent" | "customer" | "system";
855
- content: string;
856
- /** Datetime ISO 8601 timestamp */
857
- time: string;
858
- name?: string | undefined;
859
- /** Datetime ISO 8601 timestamp */
860
- scheduled?: string | undefined;
861
- /** The context generated from the message */
862
- context?: any | undefined;
863
- /** Detected intent */
864
- intent?: (string | undefined) | null;
865
- /** Confidence score of the assigned intent */
866
- intentScore?: (number | null) | undefined;
867
- /** How long to delay the message manually in seconds */
868
- delayInSeconds?: (number | null) | undefined;
869
- }[][] | undefined;
870
- audios?: any[] | undefined;
871
- /** Unique ID for agent */
872
- id: string;
873
- };
478
+ export type PersonaConfiguration = AgentConfiguration;
874
479
 
875
- export type Persona = {
876
- deployed?: {
877
- /** Web URL for agent */
878
- web?: string | undefined;
879
- /** Phone number for agent */
880
- phone?: string | undefined;
881
- /** Email address for agent */
882
- email?: string | undefined;
883
- } | undefined;
884
- img?: (string | null) | undefined;
885
- /** Agent first name */
886
- firstName?: string | undefined;
887
- /** Agent last name */
888
- lastName?: string | undefined;
889
- /** Agent is inactive */
890
- inactive?: boolean | undefined;
891
- /** Programmable phone number */
892
- programmablePhoneNumber?: string | undefined;
893
- /** Programmable phone number SID */
894
- programmablePhoneNumberSid?: string | undefined;
895
- /** Email address from Scout9 gmail subdomain */
896
- programmableEmail?: string | undefined;
897
- /** Email address to forward to */
898
- forwardEmail?: string | undefined;
899
- /** Phone number to forward to */
900
- forwardPhone?: string | undefined;
901
- /** Agent title */
902
- title?: string;
903
- /** Context of the agent */
904
- context?: string;
905
- includedLocations?: string[] | undefined;
906
- excludedLocations?: string[] | undefined;
907
- model?: ("Scout9" | "bard" | "openai");
908
- transcripts?: {
909
- /** Unique ID for the message */
910
- id: string;
911
- role: "agent" | "customer" | "system";
912
- content: string;
913
- /** Datetime ISO 8601 timestamp */
914
- time: string;
915
- name?: string | undefined;
916
- /** Datetime ISO 8601 timestamp */
917
- scheduled?: string | undefined;
918
- /** The context generated from the message */
919
- context?: any | undefined;
920
- /** Detected intent */
921
- intent?: (string | undefined) | null;
922
- /** Confidence score of the assigned intent */
923
- intentScore?: (number | null) | undefined;
924
- /** How long to delay the message manually in seconds */
925
- delayInSeconds?: (number | null) | undefined;
926
- }[][] | undefined;
927
- audios?: any[] | undefined;
928
- };
480
+ export type Persona = Agent;
929
481
 
930
- export type PersonasConfiguration = {
931
- deployed?: {
932
- /** Web URL for agent */
933
- web?: string | undefined;
934
- /** Phone number for agent */
935
- phone?: string | undefined;
936
- /** Email address for agent */
937
- email?: string | undefined;
938
- } | undefined;
939
- img?: (string | null) | undefined;
940
- /** Agent first name */
941
- firstName?: string | undefined;
942
- /** Agent last name */
943
- lastName?: string | undefined;
944
- /** Agent is inactive */
945
- inactive?: boolean | undefined;
946
- /** Programmable phone number */
947
- programmablePhoneNumber?: string | undefined;
948
- /** Programmable phone number SID */
949
- programmablePhoneNumberSid?: string | undefined;
950
- /** Email address from Scout9 gmail subdomain */
951
- programmableEmail?: string | undefined;
952
- /** Email address to forward to */
953
- forwardEmail?: string | undefined;
954
- /** Phone number to forward to */
955
- forwardPhone?: string | undefined;
956
- /** Agent title */
957
- title?: string;
958
- /** Context of the agent */
959
- context?: string;
960
- includedLocations?: string[] | undefined;
961
- excludedLocations?: string[] | undefined;
962
- model?: ("Scout9" | "bard" | "openai");
963
- transcripts?: {
964
- /** Unique ID for the message */
965
- id: string;
966
- role: "agent" | "customer" | "system";
967
- content: string;
968
- /** Datetime ISO 8601 timestamp */
969
- time: string;
970
- name?: string | undefined;
971
- /** Datetime ISO 8601 timestamp */
972
- scheduled?: string | undefined;
973
- /** The context generated from the message */
974
- context?: any | undefined;
975
- /** Detected intent */
976
- intent?: (string | undefined) | null;
977
- /** Confidence score of the assigned intent */
978
- intentScore?: (number | null) | undefined;
979
- /** How long to delay the message manually in seconds */
980
- delayInSeconds?: (number | null) | undefined;
981
- }[][] | undefined;
982
- audios?: any[] | undefined;
983
- /** Unique ID for agent */
984
- id: string;
985
- }[];
482
+ export type PersonasConfiguration = PersonaConfiguration[];
986
483
 
987
- export type Personas = {
988
- deployed?: {
989
- /** Web URL for agent */
990
- web?: string | undefined;
991
- /** Phone number for agent */
992
- phone?: string | undefined;
993
- /** Email address for agent */
994
- email?: string | undefined;
995
- } | undefined;
996
- img?: (string | null) | undefined;
997
- /** Agent first name */
998
- firstName?: string | undefined;
999
- /** Agent last name */
1000
- lastName?: string | undefined;
1001
- /** Agent is inactive */
1002
- inactive?: boolean | undefined;
1003
- /** Programmable phone number */
1004
- programmablePhoneNumber?: string | undefined;
1005
- /** Programmable phone number SID */
1006
- programmablePhoneNumberSid?: string | undefined;
1007
- /** Email address from Scout9 gmail subdomain */
1008
- programmableEmail?: string | undefined;
1009
- /** Email address to forward to */
1010
- forwardEmail?: string | undefined;
1011
- /** Phone number to forward to */
1012
- forwardPhone?: string | undefined;
1013
- /** Agent title */
1014
- title?: string;
1015
- /** Context of the agent */
1016
- context?: string;
1017
- includedLocations?: string[] | undefined;
1018
- excludedLocations?: string[] | undefined;
1019
- model?: ("Scout9" | "bard" | "openai");
1020
- transcripts?: {
1021
- /** Unique ID for the message */
1022
- id: string;
1023
- role: "agent" | "customer" | "system";
1024
- content: string;
1025
- /** Datetime ISO 8601 timestamp */
1026
- time: string;
1027
- name?: string | undefined;
1028
- /** Datetime ISO 8601 timestamp */
1029
- scheduled?: string | undefined;
1030
- /** The context generated from the message */
1031
- context?: any | undefined;
1032
- /** Detected intent */
1033
- intent?: (string | undefined) | null;
1034
- /** Confidence score of the assigned intent */
1035
- intentScore?: (number | null) | undefined;
1036
- /** How long to delay the message manually in seconds */
1037
- delayInSeconds?: (number | null) | undefined;
1038
- }[][] | undefined;
1039
- audios?: any[] | undefined;
1040
- }[];
484
+ export type Personas = Persona[];
1041
485
 
1042
- export type Scout9ProjectBuildConfig = {
1043
- tag?: string | undefined;
1044
- llm: {
1045
- engine: "openai";
1046
- model: "gpt-4-1106-preview" | "gpt-4-vision-preview" | "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k-0613" | string;
1047
- } | {
1048
- engine: "llama";
1049
- model: string;
1050
- } | {
1051
- engine: "bard";
1052
- model: string;
1053
- };
1054
- /** Configure personal model transformer (PMT) settings to align auto replies the agent's tone */
1055
- pmt: {
1056
- engine: "scout9";
1057
- model: string;
1058
- };
1059
- /** Determines the max auto replies without further conversation progression (defined by new context data gathered), before the conversation is locked and requires manual intervention */
1060
- maxLockAttempts?: number | undefined;
1061
- /** Configure the initial contexts for every conversation */
1062
- initialContext: string[];
1063
- organization?: {
1064
- name: string;
1065
- description: string;
1066
- dashboard?: string | undefined;
1067
- logo?: string | undefined;
1068
- icon?: string | undefined;
1069
- logos?: string | undefined;
1070
- website?: string | undefined;
1071
- email?: string | undefined;
1072
- phone?: string | undefined;
1073
- } | undefined;
1074
- agents: {
1075
- deployed?: {
1076
- /** Web URL for agent */
1077
- web?: string | undefined;
1078
- /** Phone number for agent */
1079
- phone?: string | undefined;
1080
- /** Email address for agent */
1081
- email?: string | undefined;
1082
- } | undefined;
1083
- img?: (string | null) | undefined;
1084
- /** Agent first name */
1085
- firstName?: string | undefined;
1086
- /** Agent last name */
1087
- lastName?: string | undefined;
1088
- /** Agent is inactive */
1089
- inactive?: boolean | undefined;
1090
- /** Programmable phone number */
1091
- programmablePhoneNumber?: string | undefined;
1092
- /** Programmable phone number SID */
1093
- programmablePhoneNumberSid?: string | undefined;
1094
- /** Email address from Scout9 gmail subdomain */
1095
- programmableEmail?: string | undefined;
1096
- /** Email address to forward to */
1097
- forwardEmail?: string | undefined;
1098
- /** Phone number to forward to */
1099
- forwardPhone?: string | undefined;
1100
- /** Agent title */
1101
- title?: string;
1102
- /** Context of the agent */
1103
- context?: string;
1104
- includedLocations?: string[] | undefined;
1105
- excludedLocations?: string[] | undefined;
1106
- model?: ("Scout9" | "bard" | "openai");
1107
- transcripts?: {
1108
- /** Unique ID for the message */
1109
- id: string;
1110
- role: "agent" | "customer" | "system";
1111
- content: string;
1112
- /** Datetime ISO 8601 timestamp */
1113
- time: string;
1114
- name?: string | undefined;
1115
- /** Datetime ISO 8601 timestamp */
1116
- scheduled?: string | undefined;
1117
- /** The context generated from the message */
1118
- context?: any | undefined;
1119
- /** Detected intent */
1120
- intent?: (string | undefined) | null;
1121
- /** Confidence score of the assigned intent */
1122
- intentScore?: (number | null) | undefined;
1123
- /** How long to delay the message manually in seconds */
1124
- delayInSeconds?: (number | null) | undefined;
1125
- }[][] | undefined;
1126
- audios?: any[] | undefined;
1127
- }[];
1128
- entities: {
1129
- /** If not provided, the id will default to the route (folder) name */
1130
- id?: string | undefined;
1131
- definitions?: {
1132
- /** What entity utterance this represents, if not provided, it will default to the entity id */
1133
- utterance?: string | undefined;
1134
- /** The value of this entity variance */
1135
- value: string;
1136
- /** Text representing the entity variance */
1137
- text: string[];
1138
- }[] | undefined;
1139
- training?: {
1140
- /** The assigned intent id of the given text, e.g. "I love %pizza%" could have an intent id "feedback" and "Can I purchase a %pizza%?" could have an intent id "purchase" */
1141
- intent: string;
1142
- /** Text to train the intent field and entities in or entity variances in example sentences or phrase. Ex: "I love %pizza%" and "Can I purchase a %pizza%?" */
1143
- text: string;
1144
- }[] | undefined;
1145
- tests?: {
1146
- /** Text to test the entity detection */
1147
- text: string;
1148
- expected: {
1149
- /** The expected intent id */
1150
- intent: string;
1151
- context?: any;
1152
- };
1153
- }[] | undefined;
1154
- /** Entity id association, used to handle route params */
1155
- entities: string[];
1156
- entity: string;
1157
- api: {
1158
- GET?: boolean | undefined;
1159
- UPDATE?: boolean | undefined;
1160
- QUERY?: boolean | undefined;
1161
- PUT?: boolean | undefined;
1162
- PATCH?: boolean | undefined;
1163
- DELETE?: boolean | undefined;
1164
- } | null;
1165
- }[];
1166
- workflows: {
1167
- /** Workflow id association, used to handle route params */
1168
- entities: string[];
1169
- entity: string;
1170
- }[];
486
+ export type WorkflowConfiguration = {
487
+ /** Workflow id association, used to handle route params */
488
+ entities: string[];
489
+ entity: string;
1171
490
  };
1172
491
 
492
+
1173
493
  export type Scout9ProjectConfig = {
1174
494
  tag?: string | undefined;
1175
495
  llm: {
@@ -1204,1084 +524,43 @@ export type Scout9ProjectConfig = {
1204
524
  } | undefined;
1205
525
  };
1206
526
 
1207
- export type Test = {
1208
- baz: {
1209
- boo: {
1210
- one: number;
1211
- two?: number | undefined;
1212
- };
1213
- };
1214
- bus: {
1215
- foo: string;
1216
- bar?: boolean | undefined;
1217
- };
1218
- };
1219
-
1220
- export type WorkflowConfiguration = {
1221
- /** Workflow id association, used to handle route params */
1222
- entities: string[];
1223
- entity: string;
527
+ export type Scout9ProjectBuildConfig = Scout9ProjectConfig & {
528
+ agents: Agent[];
529
+ entities: EntityRootProjectConfiguration[];
530
+ workflows: WorkflowConfiguration[];
1224
531
  };
1225
532
 
1226
533
  export type WorkflowEvent = {
1227
- messages: {
1228
- /** Unique ID for the message */
1229
- id: string;
1230
- role: "agent" | "customer" | "system";
1231
- content: string;
1232
- /** Datetime ISO 8601 timestamp */
1233
- time: string;
1234
- name?: string | undefined;
1235
- /** Datetime ISO 8601 timestamp */
1236
- scheduled?: string | undefined;
1237
- /** The context generated from the message */
1238
- context?: any | undefined;
1239
- /** Detected intent */
1240
- intent?: (string | undefined) | null;
1241
- /** Confidence score of the assigned intent */
1242
- intentScore?: (number | null) | undefined;
1243
- /** How long to delay the message manually in seconds */
1244
- delayInSeconds?: (number | null) | undefined;
1245
- }[];
1246
- conversation: {
1247
- /** Default agent assigned to the conversation(s) */
1248
- $agent: string;
1249
- /** Customer this conversation is with */
1250
- $customer: string;
1251
- /** Initial contexts to load when starting the conversation */
1252
- initialContexts?: string[] | undefined;
1253
- environment: "phone" | "email" | "web";
1254
- environmentProps?: {
1255
- /** HTML Subject of the conversation */
1256
- subject?: string | undefined;
1257
- /** Used to sync email messages with the conversation */
1258
- platformEmailThreadId?: string | undefined;
1259
- } | undefined;
1260
- /** Whether the conversation is locked or not */
1261
- locked?: (boolean | undefined) | null;
1262
- /** Why this conversation was locked */
1263
- lockedReason?: (string | undefined) | null;
1264
- /** Number attempts made until conversation is locked */
1265
- lockAttempts?: (number | undefined) | null;
1266
- /** What personaId/phone/email was forwarded */
1267
- forwardedTo?: (string | undefined) | null;
1268
- /** Datetime ISO 8601 timestamp when persona was forwarded */
1269
- forwarded?: (string | undefined) | null;
1270
- forwardNote?: (string | undefined) | null;
1271
- /** Detected intent of conversation */
1272
- intent?: (string | undefined) | null;
1273
- /** Confidence score of the assigned intent */
1274
- intentScore?: (number | undefined) | null;
1275
- anticipate?: {
1276
- /** Determines the runtime to address the next response */
1277
- type: "did" | "literal" | "context";
1278
- slots: {
1279
- [x: string]: any[];
1280
- };
1281
- /** For type 'did' */
1282
- did?: string | undefined;
1283
- /** For literal keywords, this map helps point which slot the keyword matches to */
1284
- map?: {
1285
- slot: string;
1286
- keywords: string[];
1287
- }[] | undefined;
1288
- } | undefined;
1289
- };
534
+ messages: Message[];
535
+ conversation: Conversation;
1290
536
  context?: any;
1291
- message: {
1292
- /** Unique ID for the message */
1293
- id: string;
1294
- role: "agent" | "customer" | "system";
1295
- content: string;
1296
- /** Datetime ISO 8601 timestamp */
1297
- time: string;
1298
- name?: string | undefined;
1299
- /** Datetime ISO 8601 timestamp */
1300
- scheduled?: string | undefined;
1301
- /** The context generated from the message */
1302
- context?: any | undefined;
1303
- /** Detected intent */
1304
- intent?: (string | undefined) | null;
1305
- /** Confidence score of the assigned intent */
1306
- intentScore?: (number | null) | undefined;
1307
- /** How long to delay the message manually in seconds */
1308
- delayInSeconds?: (number | null) | undefined;
1309
- };
1310
- agent: {
1311
- deployed?: {
1312
- /** Web URL for agent */
1313
- web?: string | undefined;
1314
- /** Phone number for agent */
1315
- phone?: string | undefined;
1316
- /** Email address for agent */
1317
- email?: string | undefined;
1318
- } | undefined;
1319
- img?: (string | null) | undefined;
1320
- /** Agent first name */
1321
- firstName?: string | undefined;
1322
- /** Agent last name */
1323
- lastName?: string | undefined;
1324
- /** Agent is inactive */
1325
- inactive?: boolean | undefined;
1326
- /** Programmable phone number */
1327
- programmablePhoneNumber?: string | undefined;
1328
- /** Programmable phone number SID */
1329
- programmablePhoneNumberSid?: string | undefined;
1330
- /** Email address from Scout9 gmail subdomain */
1331
- programmableEmail?: string | undefined;
1332
- /** Email address to forward to */
1333
- forwardEmail?: string | undefined;
1334
- /** Phone number to forward to */
1335
- forwardPhone?: string | undefined;
1336
- /** Agent title */
1337
- title?: string;
1338
- /** Unique ID for agent */
1339
- id: string;
1340
- };
1341
- customer: {
1342
- firstName?: string | undefined;
1343
- lastName?: string | undefined;
1344
- name: string;
1345
- email?: (string | null) | undefined;
1346
- phone?: (string | null) | undefined;
1347
- img?: (string | null) | undefined;
1348
- neighborhood?: (string | null) | undefined;
1349
- city?: (string | null) | undefined;
1350
- country?: (string | null) | undefined;
1351
- line1?: (string | null) | undefined;
1352
- line2?: (string | null) | undefined;
1353
- postal_code?: (string | null) | undefined;
1354
- state?: (string | null) | undefined;
1355
- town?: (string | null) | undefined;
1356
- joined?: (string | null) | undefined;
1357
- stripe?: (string | null) | undefined;
1358
- stripeDev?: (string | null) | undefined;
1359
- };
1360
- intent: {
1361
- current: string | null;
1362
- flow: string[];
1363
- initial: string | null;
1364
- };
537
+ message: Message;
538
+ agent: Omit<AgentConfiguration, 'transcripts' | 'audios' | 'includedLocations' | 'excludedLocations' | 'model' | 'context'>;
539
+ customer: Customer;
540
+ intent: IntentWorkflowEvent;
1365
541
  stagnationCount: number;
1366
542
  /** Any developer notes to provide */
1367
543
  note?: string | undefined;
1368
544
  };
1369
545
 
1370
- export type WorkflowFunction = (args_0: {
1371
- messages: {
1372
- /** Unique ID for the message */
1373
- id: string;
1374
- role: "agent" | "customer" | "system";
1375
- content: string;
1376
- /** Datetime ISO 8601 timestamp */
1377
- time: string;
1378
- name?: string | undefined;
1379
- /** Datetime ISO 8601 timestamp */
1380
- scheduled?: string | undefined;
1381
- /** The context generated from the message */
1382
- context?: any | undefined;
1383
- /** Detected intent */
1384
- intent?: (string | undefined) | null;
1385
- /** Confidence score of the assigned intent */
1386
- intentScore?: (number | null) | undefined;
1387
- /** How long to delay the message manually in seconds */
1388
- delayInSeconds?: (number | null) | undefined;
1389
- }[];
1390
- conversation: {
1391
- /** Default agent assigned to the conversation(s) */
1392
- $agent: string;
1393
- /** Customer this conversation is with */
1394
- $customer: string;
1395
- /** Initial contexts to load when starting the conversation */
1396
- initialContexts?: string[] | undefined;
1397
- environment: "phone" | "email" | "web";
1398
- environmentProps?: {
1399
- /** HTML Subject of the conversation */
1400
- subject?: string | undefined;
1401
- /** Used to sync email messages with the conversation */
1402
- platformEmailThreadId?: string | undefined;
1403
- } | undefined;
1404
- /** Whether the conversation is locked or not */
1405
- locked?: (boolean | undefined) | null;
1406
- /** Why this conversation was locked */
1407
- lockedReason?: (string | undefined) | null;
1408
- /** Number attempts made until conversation is locked */
1409
- lockAttempts?: (number | undefined) | null;
1410
- /** What personaId/phone/email was forwarded */
1411
- forwardedTo?: (string | undefined) | null;
1412
- /** Datetime ISO 8601 timestamp when persona was forwarded */
1413
- forwarded?: (string | undefined) | null;
1414
- forwardNote?: (string | undefined) | null;
1415
- /** Detected intent of conversation */
1416
- intent?: (string | undefined) | null;
1417
- /** Confidence score of the assigned intent */
1418
- intentScore?: (number | undefined) | null;
1419
- anticipate?: {
1420
- /** Determines the runtime to address the next response */
1421
- type: "did" | "literal" | "context";
1422
- slots: {
1423
- [x: string]: any[];
1424
- };
1425
- /** For type 'did' */
1426
- did?: string | undefined;
1427
- /** For literal keywords, this map helps point which slot the keyword matches to */
1428
- map?: {
1429
- slot: string;
1430
- keywords: string[];
1431
- }[] | undefined;
1432
- } | undefined;
1433
- };
1434
- context?: any;
1435
- message: {
1436
- /** Unique ID for the message */
1437
- id: string;
1438
- role: "agent" | "customer" | "system";
1439
- content: string;
1440
- /** Datetime ISO 8601 timestamp */
1441
- time: string;
1442
- name?: string | undefined;
1443
- /** Datetime ISO 8601 timestamp */
1444
- scheduled?: string | undefined;
1445
- /** The context generated from the message */
1446
- context?: any | undefined;
1447
- /** Detected intent */
1448
- intent?: (string | undefined) | null;
1449
- /** Confidence score of the assigned intent */
1450
- intentScore?: (number | null) | undefined;
1451
- /** How long to delay the message manually in seconds */
1452
- delayInSeconds?: (number | null) | undefined;
1453
- };
1454
- agent: {
1455
- deployed?: {
1456
- /** Web URL for agent */
1457
- web?: string | undefined;
1458
- /** Phone number for agent */
1459
- phone?: string | undefined;
1460
- /** Email address for agent */
1461
- email?: string | undefined;
1462
- } | undefined;
1463
- img?: (string | null) | undefined;
1464
- /** Agent first name */
1465
- firstName?: string | undefined;
1466
- /** Agent last name */
1467
- lastName?: string | undefined;
1468
- /** Agent is inactive */
1469
- inactive?: boolean | undefined;
1470
- /** Programmable phone number */
1471
- programmablePhoneNumber?: string | undefined;
1472
- /** Programmable phone number SID */
1473
- programmablePhoneNumberSid?: string | undefined;
1474
- /** Email address from Scout9 gmail subdomain */
1475
- programmableEmail?: string | undefined;
1476
- /** Email address to forward to */
1477
- forwardEmail?: string | undefined;
1478
- /** Phone number to forward to */
1479
- forwardPhone?: string | undefined;
1480
- /** Agent title */
1481
- title?: string;
1482
- /** Unique ID for agent */
1483
- id: string;
1484
- };
1485
- customer: {
1486
- firstName?: string | undefined;
1487
- lastName?: string | undefined;
1488
- name: string;
1489
- email?: (string | null) | undefined;
1490
- phone?: (string | null) | undefined;
1491
- img?: (string | null) | undefined;
1492
- neighborhood?: (string | null) | undefined;
1493
- city?: (string | null) | undefined;
1494
- country?: (string | null) | undefined;
1495
- line1?: (string | null) | undefined;
1496
- line2?: (string | null) | undefined;
1497
- postal_code?: (string | null) | undefined;
1498
- state?: (string | null) | undefined;
1499
- town?: (string | null) | undefined;
1500
- joined?: (string | null) | undefined;
1501
- stripe?: (string | null) | undefined;
1502
- stripeDev?: (string | null) | undefined;
1503
- };
1504
- intent: {
1505
- current: string | null;
1506
- flow: string[];
1507
- initial: string | null;
1508
- };
1509
- stagnationCount: number;
1510
- /** Any developer notes to provide */
1511
- note?: string | undefined;
1512
- }, ...args_1: unknown[]) => Promise<{
1513
- /** Forward input information of a conversation */
1514
- forward?: (boolean | string | {
1515
- to?: string | undefined;
1516
- mode?: ("after-reply" | "immediately") | undefined;
1517
- /** Note to provide to the agent */
1518
- note?: string | undefined;
1519
- }) | undefined;
1520
- /** Note to provide to the agent, recommend using forward object api instead */
1521
- forwardNote?: string | undefined;
1522
- instructions?: (string | {
1523
- /** Unique ID for the instruction, this is used to remove the instruction later */
1524
- id?: string | undefined;
1525
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1526
- persist?: boolean | undefined;
1527
- content: string;
1528
- } | string[] | {
1529
- /** Unique ID for the instruction, this is used to remove the instruction later */
1530
- id?: string | undefined;
1531
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1532
- persist?: boolean | undefined;
1533
- content: string;
1534
- }[]) | undefined;
1535
- removeInstructions?: string[] | undefined;
1536
- message?: string | undefined;
1537
- secondsDelay?: number | undefined;
1538
- scheduled?: number | undefined;
1539
- contextUpsert?: {
1540
- [x: string]: any;
1541
- } | undefined;
1542
- resetIntent?: boolean | undefined;
1543
- followup?: ({
1544
- scheduled: number;
1545
- cancelIf?: {
1546
- [x: string]: any;
1547
- } | undefined;
1548
- /** This will still run even if the conversation is locked, defaults to false */
1549
- overrideLock?: boolean | undefined;
1550
- /** Manual message sent to client */
1551
- message: string;
1552
- } | {
1553
- scheduled: number;
1554
- cancelIf?: {
1555
- [x: string]: any;
1556
- } | undefined;
1557
- /** This will still run even if the conversation is locked, defaults to false */
1558
- overrideLock?: boolean | undefined;
1559
- instructions: string | {
1560
- /** Unique ID for the instruction, this is used to remove the instruction later */
1561
- id?: string | undefined;
1562
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1563
- persist?: boolean | undefined;
1564
- content: string;
1565
- } | string[] | {
1566
- /** Unique ID for the instruction, this is used to remove the instruction later */
1567
- id?: string | undefined;
1568
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1569
- persist?: boolean | undefined;
1570
- content: string;
1571
- }[];
1572
- }) | undefined;
1573
- anticipate?: ({
1574
- did: string;
1575
- yes: {
1576
- /** Forward input information of a conversation */
1577
- forward?: (boolean | string | {
1578
- to?: string | undefined;
1579
- mode?: ("after-reply" | "immediately") | undefined;
1580
- /** Note to provide to the agent */
1581
- note?: string | undefined;
1582
- }) | undefined;
1583
- /** Note to provide to the agent, recommend using forward object api instead */
1584
- forwardNote?: string | undefined;
1585
- instructions?: (string | {
1586
- /** Unique ID for the instruction, this is used to remove the instruction later */
1587
- id?: string | undefined;
1588
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1589
- persist?: boolean | undefined;
1590
- content: string;
1591
- } | string[] | {
1592
- /** Unique ID for the instruction, this is used to remove the instruction later */
1593
- id?: string | undefined;
1594
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1595
- persist?: boolean | undefined;
1596
- content: string;
1597
- }[]) | undefined;
1598
- removeInstructions?: string[] | undefined;
1599
- message?: string | undefined;
1600
- secondsDelay?: number | undefined;
1601
- scheduled?: number | undefined;
1602
- contextUpsert?: {
1603
- [x: string]: any;
1604
- } | undefined;
1605
- resetIntent?: boolean | undefined;
1606
- followup?: ({
1607
- scheduled: number;
1608
- cancelIf?: {
1609
- [x: string]: any;
1610
- } | undefined;
1611
- /** This will still run even if the conversation is locked, defaults to false */
1612
- overrideLock?: boolean | undefined;
1613
- /** Manual message sent to client */
1614
- message: string;
1615
- } | {
1616
- scheduled: number;
1617
- cancelIf?: {
1618
- [x: string]: any;
1619
- } | undefined;
1620
- /** This will still run even if the conversation is locked, defaults to false */
1621
- overrideLock?: boolean | undefined;
1622
- instructions: string | {
1623
- /** Unique ID for the instruction, this is used to remove the instruction later */
1624
- id?: string | undefined;
1625
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1626
- persist?: boolean | undefined;
1627
- content: string;
1628
- } | string[] | {
1629
- /** Unique ID for the instruction, this is used to remove the instruction later */
1630
- id?: string | undefined;
1631
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1632
- persist?: boolean | undefined;
1633
- content: string;
1634
- }[];
1635
- }) | undefined;
1636
- };
1637
- no: {
1638
- /** Forward input information of a conversation */
1639
- forward?: (boolean | string | {
1640
- to?: string | undefined;
1641
- mode?: ("after-reply" | "immediately") | undefined;
1642
- /** Note to provide to the agent */
1643
- note?: string | undefined;
1644
- }) | undefined;
1645
- /** Note to provide to the agent, recommend using forward object api instead */
1646
- forwardNote?: string | undefined;
1647
- instructions?: (string | {
1648
- /** Unique ID for the instruction, this is used to remove the instruction later */
1649
- id?: string | undefined;
1650
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1651
- persist?: boolean | undefined;
1652
- content: string;
1653
- } | string[] | {
1654
- /** Unique ID for the instruction, this is used to remove the instruction later */
1655
- id?: string | undefined;
1656
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1657
- persist?: boolean | undefined;
1658
- content: string;
1659
- }[]) | undefined;
1660
- removeInstructions?: string[] | undefined;
1661
- message?: string | undefined;
1662
- secondsDelay?: number | undefined;
1663
- scheduled?: number | undefined;
1664
- contextUpsert?: {
1665
- [x: string]: any;
1666
- } | undefined;
1667
- resetIntent?: boolean | undefined;
1668
- followup?: ({
1669
- scheduled: number;
1670
- cancelIf?: {
1671
- [x: string]: any;
1672
- } | undefined;
1673
- /** This will still run even if the conversation is locked, defaults to false */
1674
- overrideLock?: boolean | undefined;
1675
- /** Manual message sent to client */
1676
- message: string;
1677
- } | {
1678
- scheduled: number;
1679
- cancelIf?: {
1680
- [x: string]: any;
1681
- } | undefined;
1682
- /** This will still run even if the conversation is locked, defaults to false */
1683
- overrideLock?: boolean | undefined;
1684
- instructions: string | {
1685
- /** Unique ID for the instruction, this is used to remove the instruction later */
1686
- id?: string | undefined;
1687
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1688
- persist?: boolean | undefined;
1689
- content: string;
1690
- } | string[] | {
1691
- /** Unique ID for the instruction, this is used to remove the instruction later */
1692
- id?: string | undefined;
1693
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1694
- persist?: boolean | undefined;
1695
- content: string;
1696
- }[];
1697
- }) | undefined;
1698
- };
1699
- } | {
1700
- /** Forward input information of a conversation */
1701
- forward?: (boolean | string | {
1702
- to?: string | undefined;
1703
- mode?: ("after-reply" | "immediately") | undefined;
1704
- /** Note to provide to the agent */
1705
- note?: string | undefined;
1706
- }) | undefined;
1707
- /** Note to provide to the agent, recommend using forward object api instead */
1708
- forwardNote?: string | undefined;
1709
- instructions?: (string | {
1710
- /** Unique ID for the instruction, this is used to remove the instruction later */
1711
- id?: string | undefined;
1712
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1713
- persist?: boolean | undefined;
1714
- content: string;
1715
- } | string[] | {
1716
- /** Unique ID for the instruction, this is used to remove the instruction later */
1717
- id?: string | undefined;
1718
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1719
- persist?: boolean | undefined;
1720
- content: string;
1721
- }[]) | undefined;
1722
- removeInstructions?: string[] | undefined;
1723
- message?: string | undefined;
1724
- secondsDelay?: number | undefined;
1725
- scheduled?: number | undefined;
1726
- contextUpsert?: {
1727
- [x: string]: any;
1728
- } | undefined;
1729
- resetIntent?: boolean | undefined;
1730
- followup?: ({
1731
- scheduled: number;
1732
- cancelIf?: {
1733
- [x: string]: any;
1734
- } | undefined;
1735
- /** This will still run even if the conversation is locked, defaults to false */
1736
- overrideLock?: boolean | undefined;
1737
- /** Manual message sent to client */
1738
- message: string;
1739
- } | {
1740
- scheduled: number;
1741
- cancelIf?: {
1742
- [x: string]: any;
1743
- } | undefined;
1744
- /** This will still run even if the conversation is locked, defaults to false */
1745
- overrideLock?: boolean | undefined;
1746
- instructions: string | {
1747
- /** Unique ID for the instruction, this is used to remove the instruction later */
1748
- id?: string | undefined;
1749
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1750
- persist?: boolean | undefined;
1751
- content: string;
1752
- } | string[] | {
1753
- /** Unique ID for the instruction, this is used to remove the instruction later */
1754
- id?: string | undefined;
1755
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1756
- persist?: boolean | undefined;
1757
- content: string;
1758
- }[];
1759
- }) | undefined;
1760
- keywords: string[];
1761
- }[]) | undefined;
1762
- } | {
1763
- /** Forward input information of a conversation */
1764
- forward?: (boolean | string | {
1765
- to?: string | undefined;
1766
- mode?: ("after-reply" | "immediately") | undefined;
1767
- /** Note to provide to the agent */
1768
- note?: string | undefined;
1769
- }) | undefined;
1770
- /** Note to provide to the agent, recommend using forward object api instead */
1771
- forwardNote?: string | undefined;
1772
- instructions?: (string | {
1773
- /** Unique ID for the instruction, this is used to remove the instruction later */
1774
- id?: string | undefined;
1775
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1776
- persist?: boolean | undefined;
1777
- content: string;
1778
- } | string[] | {
1779
- /** Unique ID for the instruction, this is used to remove the instruction later */
1780
- id?: string | undefined;
1781
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1782
- persist?: boolean | undefined;
1783
- content: string;
1784
- }[]) | undefined;
1785
- removeInstructions?: string[] | undefined;
1786
- message?: string | undefined;
1787
- secondsDelay?: number | undefined;
1788
- scheduled?: number | undefined;
1789
- contextUpsert?: {
1790
- [x: string]: any;
1791
- } | undefined;
1792
- resetIntent?: boolean | undefined;
1793
- followup?: ({
1794
- scheduled: number;
1795
- cancelIf?: {
1796
- [x: string]: any;
1797
- } | undefined;
1798
- /** This will still run even if the conversation is locked, defaults to false */
1799
- overrideLock?: boolean | undefined;
1800
- /** Manual message sent to client */
1801
- message: string;
1802
- } | {
1803
- scheduled: number;
1804
- cancelIf?: {
1805
- [x: string]: any;
1806
- } | undefined;
1807
- /** This will still run even if the conversation is locked, defaults to false */
1808
- overrideLock?: boolean | undefined;
1809
- instructions: string | {
1810
- /** Unique ID for the instruction, this is used to remove the instruction later */
1811
- id?: string | undefined;
1812
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1813
- persist?: boolean | undefined;
1814
- content: string;
1815
- } | string[] | {
1816
- /** Unique ID for the instruction, this is used to remove the instruction later */
1817
- id?: string | undefined;
1818
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1819
- persist?: boolean | undefined;
1820
- content: string;
1821
- }[];
1822
- }) | undefined;
1823
- anticipate?: ({
1824
- did: string;
1825
- yes: {
1826
- /** Forward input information of a conversation */
1827
- forward?: (boolean | string | {
1828
- to?: string | undefined;
1829
- mode?: ("after-reply" | "immediately") | undefined;
1830
- /** Note to provide to the agent */
1831
- note?: string | undefined;
1832
- }) | undefined;
1833
- /** Note to provide to the agent, recommend using forward object api instead */
1834
- forwardNote?: string | undefined;
1835
- instructions?: (string | {
1836
- /** Unique ID for the instruction, this is used to remove the instruction later */
1837
- id?: string | undefined;
1838
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1839
- persist?: boolean | undefined;
1840
- content: string;
1841
- } | string[] | {
1842
- /** Unique ID for the instruction, this is used to remove the instruction later */
1843
- id?: string | undefined;
1844
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1845
- persist?: boolean | undefined;
1846
- content: string;
1847
- }[]) | undefined;
1848
- removeInstructions?: string[] | undefined;
1849
- message?: string | undefined;
1850
- secondsDelay?: number | undefined;
1851
- scheduled?: number | undefined;
1852
- contextUpsert?: {
1853
- [x: string]: any;
1854
- } | undefined;
1855
- resetIntent?: boolean | undefined;
1856
- followup?: ({
1857
- scheduled: number;
1858
- cancelIf?: {
1859
- [x: string]: any;
1860
- } | undefined;
1861
- /** This will still run even if the conversation is locked, defaults to false */
1862
- overrideLock?: boolean | undefined;
1863
- /** Manual message sent to client */
1864
- message: string;
1865
- } | {
1866
- scheduled: number;
1867
- cancelIf?: {
1868
- [x: string]: any;
1869
- } | undefined;
1870
- /** This will still run even if the conversation is locked, defaults to false */
1871
- overrideLock?: boolean | undefined;
1872
- instructions: string | {
1873
- /** Unique ID for the instruction, this is used to remove the instruction later */
1874
- id?: string | undefined;
1875
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1876
- persist?: boolean | undefined;
1877
- content: string;
1878
- } | string[] | {
1879
- /** Unique ID for the instruction, this is used to remove the instruction later */
1880
- id?: string | undefined;
1881
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1882
- persist?: boolean | undefined;
1883
- content: string;
1884
- }[];
1885
- }) | undefined;
1886
- };
1887
- no: {
1888
- /** Forward input information of a conversation */
1889
- forward?: (boolean | string | {
1890
- to?: string | undefined;
1891
- mode?: ("after-reply" | "immediately") | undefined;
1892
- /** Note to provide to the agent */
1893
- note?: string | undefined;
1894
- }) | undefined;
1895
- /** Note to provide to the agent, recommend using forward object api instead */
1896
- forwardNote?: string | undefined;
1897
- instructions?: (string | {
1898
- /** Unique ID for the instruction, this is used to remove the instruction later */
1899
- id?: string | undefined;
1900
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1901
- persist?: boolean | undefined;
1902
- content: string;
1903
- } | string[] | {
1904
- /** Unique ID for the instruction, this is used to remove the instruction later */
1905
- id?: string | undefined;
1906
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1907
- persist?: boolean | undefined;
1908
- content: string;
1909
- }[]) | undefined;
1910
- removeInstructions?: string[] | undefined;
1911
- message?: string | undefined;
1912
- secondsDelay?: number | undefined;
1913
- scheduled?: number | undefined;
1914
- contextUpsert?: {
1915
- [x: string]: any;
1916
- } | undefined;
1917
- resetIntent?: boolean | undefined;
1918
- followup?: ({
1919
- scheduled: number;
1920
- cancelIf?: {
1921
- [x: string]: any;
1922
- } | undefined;
1923
- /** This will still run even if the conversation is locked, defaults to false */
1924
- overrideLock?: boolean | undefined;
1925
- /** Manual message sent to client */
1926
- message: string;
1927
- } | {
1928
- scheduled: number;
1929
- cancelIf?: {
1930
- [x: string]: any;
1931
- } | undefined;
1932
- /** This will still run even if the conversation is locked, defaults to false */
1933
- overrideLock?: boolean | undefined;
1934
- instructions: string | {
1935
- /** Unique ID for the instruction, this is used to remove the instruction later */
1936
- id?: string | undefined;
1937
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1938
- persist?: boolean | undefined;
1939
- content: string;
1940
- } | string[] | {
1941
- /** Unique ID for the instruction, this is used to remove the instruction later */
1942
- id?: string | undefined;
1943
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1944
- persist?: boolean | undefined;
1945
- content: string;
1946
- }[];
1947
- }) | undefined;
1948
- };
1949
- } | {
1950
- /** Forward input information of a conversation */
1951
- forward?: (boolean | string | {
1952
- to?: string | undefined;
1953
- mode?: ("after-reply" | "immediately") | undefined;
1954
- /** Note to provide to the agent */
1955
- note?: string | undefined;
1956
- }) | undefined;
1957
- /** Note to provide to the agent, recommend using forward object api instead */
1958
- forwardNote?: string | undefined;
1959
- instructions?: (string | {
1960
- /** Unique ID for the instruction, this is used to remove the instruction later */
1961
- id?: string | undefined;
1962
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1963
- persist?: boolean | undefined;
1964
- content: string;
1965
- } | string[] | {
1966
- /** Unique ID for the instruction, this is used to remove the instruction later */
1967
- id?: string | undefined;
1968
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
1969
- persist?: boolean | undefined;
1970
- content: string;
1971
- }[]) | undefined;
1972
- removeInstructions?: string[] | undefined;
1973
- message?: string | undefined;
1974
- secondsDelay?: number | undefined;
1975
- scheduled?: number | undefined;
1976
- contextUpsert?: {
1977
- [x: string]: any;
1978
- } | undefined;
1979
- resetIntent?: boolean | undefined;
1980
- followup?: ({
1981
- scheduled: number;
1982
- cancelIf?: {
1983
- [x: string]: any;
1984
- } | undefined;
1985
- /** This will still run even if the conversation is locked, defaults to false */
1986
- overrideLock?: boolean | undefined;
1987
- /** Manual message sent to client */
1988
- message: string;
1989
- } | {
1990
- scheduled: number;
1991
- cancelIf?: {
1992
- [x: string]: any;
1993
- } | undefined;
1994
- /** This will still run even if the conversation is locked, defaults to false */
1995
- overrideLock?: boolean | undefined;
1996
- instructions: string | {
1997
- /** Unique ID for the instruction, this is used to remove the instruction later */
1998
- id?: string | undefined;
1999
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2000
- persist?: boolean | undefined;
2001
- content: string;
2002
- } | string[] | {
2003
- /** Unique ID for the instruction, this is used to remove the instruction later */
2004
- id?: string | undefined;
2005
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2006
- persist?: boolean | undefined;
2007
- content: string;
2008
- }[];
2009
- }) | undefined;
2010
- keywords: string[];
2011
- }[]) | undefined;
2012
- }[]> | ({
2013
- /** Forward input information of a conversation */
2014
- forward?: (boolean | string | {
2015
- to?: string | undefined;
2016
- mode?: ("after-reply" | "immediately") | undefined;
2017
- /** Note to provide to the agent */
2018
- note?: string | undefined;
2019
- }) | undefined;
2020
- /** Note to provide to the agent, recommend using forward object api instead */
2021
- forwardNote?: string | undefined;
2022
- instructions?: (string | {
2023
- /** Unique ID for the instruction, this is used to remove the instruction later */
2024
- id?: string | undefined;
2025
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2026
- persist?: boolean | undefined;
2027
- content: string;
2028
- } | string[] | {
2029
- /** Unique ID for the instruction, this is used to remove the instruction later */
2030
- id?: string | undefined;
2031
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2032
- persist?: boolean | undefined;
2033
- content: string;
2034
- }[]) | undefined;
2035
- removeInstructions?: string[] | undefined;
2036
- message?: string | undefined;
2037
- secondsDelay?: number | undefined;
2038
- scheduled?: number | undefined;
2039
- contextUpsert?: {
2040
- [x: string]: any;
2041
- } | undefined;
2042
- resetIntent?: boolean | undefined;
2043
- followup?: ({
2044
- scheduled: number;
2045
- cancelIf?: {
2046
- [x: string]: any;
2047
- } | undefined;
2048
- /** This will still run even if the conversation is locked, defaults to false */
2049
- overrideLock?: boolean | undefined;
2050
- /** Manual message sent to client */
2051
- message: string;
2052
- } | {
2053
- scheduled: number;
2054
- cancelIf?: {
2055
- [x: string]: any;
2056
- } | undefined;
2057
- /** This will still run even if the conversation is locked, defaults to false */
2058
- overrideLock?: boolean | undefined;
2059
- instructions: string | {
2060
- /** Unique ID for the instruction, this is used to remove the instruction later */
2061
- id?: string | undefined;
2062
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2063
- persist?: boolean | undefined;
2064
- content: string;
2065
- } | string[] | {
2066
- /** Unique ID for the instruction, this is used to remove the instruction later */
2067
- id?: string | undefined;
2068
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2069
- persist?: boolean | undefined;
2070
- content: string;
2071
- }[];
2072
- }) | undefined;
2073
- anticipate?: ({
2074
- did: string;
2075
- yes: {
2076
- /** Forward input information of a conversation */
2077
- forward?: (boolean | string | {
2078
- to?: string | undefined;
2079
- mode?: ("after-reply" | "immediately") | undefined;
2080
- /** Note to provide to the agent */
2081
- note?: string | undefined;
2082
- }) | undefined;
2083
- /** Note to provide to the agent, recommend using forward object api instead */
2084
- forwardNote?: string | undefined;
2085
- instructions?: (string | {
2086
- /** Unique ID for the instruction, this is used to remove the instruction later */
2087
- id?: string | undefined;
2088
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2089
- persist?: boolean | undefined;
2090
- content: string;
2091
- } | string[] | {
2092
- /** Unique ID for the instruction, this is used to remove the instruction later */
2093
- id?: string | undefined;
2094
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2095
- persist?: boolean | undefined;
2096
- content: string;
2097
- }[]) | undefined;
2098
- removeInstructions?: string[] | undefined;
2099
- message?: string | undefined;
2100
- secondsDelay?: number | undefined;
2101
- scheduled?: number | undefined;
2102
- contextUpsert?: {
2103
- [x: string]: any;
2104
- } | undefined;
2105
- resetIntent?: boolean | undefined;
2106
- followup?: ({
2107
- scheduled: number;
2108
- cancelIf?: {
2109
- [x: string]: any;
2110
- } | undefined;
2111
- /** This will still run even if the conversation is locked, defaults to false */
2112
- overrideLock?: boolean | undefined;
2113
- /** Manual message sent to client */
2114
- message: string;
2115
- } | {
2116
- scheduled: number;
2117
- cancelIf?: {
2118
- [x: string]: any;
2119
- } | undefined;
2120
- /** This will still run even if the conversation is locked, defaults to false */
2121
- overrideLock?: boolean | undefined;
2122
- instructions: string | {
2123
- /** Unique ID for the instruction, this is used to remove the instruction later */
2124
- id?: string | undefined;
2125
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2126
- persist?: boolean | undefined;
2127
- content: string;
2128
- } | string[] | {
2129
- /** Unique ID for the instruction, this is used to remove the instruction later */
2130
- id?: string | undefined;
2131
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2132
- persist?: boolean | undefined;
2133
- content: string;
2134
- }[];
2135
- }) | undefined;
2136
- };
2137
- no: {
2138
- /** Forward input information of a conversation */
2139
- forward?: (boolean | string | {
2140
- to?: string | undefined;
2141
- mode?: ("after-reply" | "immediately") | undefined;
2142
- /** Note to provide to the agent */
2143
- note?: string | undefined;
2144
- }) | undefined;
2145
- /** Note to provide to the agent, recommend using forward object api instead */
2146
- forwardNote?: string | undefined;
2147
- instructions?: (string | {
2148
- /** Unique ID for the instruction, this is used to remove the instruction later */
2149
- id?: string | undefined;
2150
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2151
- persist?: boolean | undefined;
2152
- content: string;
2153
- } | string[] | {
2154
- /** Unique ID for the instruction, this is used to remove the instruction later */
2155
- id?: string | undefined;
2156
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2157
- persist?: boolean | undefined;
2158
- content: string;
2159
- }[]) | undefined;
2160
- removeInstructions?: string[] | undefined;
2161
- message?: string | undefined;
2162
- secondsDelay?: number | undefined;
2163
- scheduled?: number | undefined;
2164
- contextUpsert?: {
2165
- [x: string]: any;
2166
- } | undefined;
2167
- resetIntent?: boolean | undefined;
2168
- followup?: ({
2169
- scheduled: number;
2170
- cancelIf?: {
2171
- [x: string]: any;
2172
- } | undefined;
2173
- /** This will still run even if the conversation is locked, defaults to false */
2174
- overrideLock?: boolean | undefined;
2175
- /** Manual message sent to client */
2176
- message: string;
2177
- } | {
2178
- scheduled: number;
2179
- cancelIf?: {
2180
- [x: string]: any;
2181
- } | undefined;
2182
- /** This will still run even if the conversation is locked, defaults to false */
2183
- overrideLock?: boolean | undefined;
2184
- instructions: string | {
2185
- /** Unique ID for the instruction, this is used to remove the instruction later */
2186
- id?: string | undefined;
2187
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2188
- persist?: boolean | undefined;
2189
- content: string;
2190
- } | string[] | {
2191
- /** Unique ID for the instruction, this is used to remove the instruction later */
2192
- id?: string | undefined;
2193
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2194
- persist?: boolean | undefined;
2195
- content: string;
2196
- }[];
2197
- }) | undefined;
2198
- };
2199
- } | {
2200
- /** Forward input information of a conversation */
2201
- forward?: (boolean | string | {
2202
- to?: string | undefined;
2203
- mode?: ("after-reply" | "immediately") | undefined;
2204
- /** Note to provide to the agent */
2205
- note?: string | undefined;
2206
- }) | undefined;
2207
- /** Note to provide to the agent, recommend using forward object api instead */
2208
- forwardNote?: string | undefined;
2209
- instructions?: (string | {
2210
- /** Unique ID for the instruction, this is used to remove the instruction later */
2211
- id?: string | undefined;
2212
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2213
- persist?: boolean | undefined;
2214
- content: string;
2215
- } | string[] | {
2216
- /** Unique ID for the instruction, this is used to remove the instruction later */
2217
- id?: string | undefined;
2218
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2219
- persist?: boolean | undefined;
2220
- content: string;
2221
- }[]) | undefined;
2222
- removeInstructions?: string[] | undefined;
2223
- message?: string | undefined;
2224
- secondsDelay?: number | undefined;
2225
- scheduled?: number | undefined;
2226
- contextUpsert?: {
2227
- [x: string]: any;
2228
- } | undefined;
2229
- resetIntent?: boolean | undefined;
2230
- followup?: ({
2231
- scheduled: number;
2232
- cancelIf?: {
2233
- [x: string]: any;
2234
- } | undefined;
2235
- /** This will still run even if the conversation is locked, defaults to false */
2236
- overrideLock?: boolean | undefined;
2237
- /** Manual message sent to client */
2238
- message: string;
2239
- } | {
2240
- scheduled: number;
2241
- cancelIf?: {
2242
- [x: string]: any;
2243
- } | undefined;
2244
- /** This will still run even if the conversation is locked, defaults to false */
2245
- overrideLock?: boolean | undefined;
2246
- instructions: string | {
2247
- /** Unique ID for the instruction, this is used to remove the instruction later */
2248
- id?: string | undefined;
2249
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2250
- persist?: boolean | undefined;
2251
- content: string;
2252
- } | string[] | {
2253
- /** Unique ID for the instruction, this is used to remove the instruction later */
2254
- id?: string | undefined;
2255
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2256
- persist?: boolean | undefined;
2257
- content: string;
2258
- }[];
2259
- }) | undefined;
2260
- keywords: string[];
2261
- }[]) | undefined;
2262
- } | {
546
+ export type AnticipateDid = {
547
+ did: string;
548
+ yes: WorkflowResponseSlotBase;
549
+ no: WorkflowResponseSlotBase;
550
+ };
551
+
552
+ export type AnticipateKeywords = WorkflowResponseSlotBase & {
553
+ keywords: string[];
554
+ }
555
+
556
+ export type Anticipate = AnticipateDid | AnticipateKeywords[];
557
+
558
+ export type WorkflowResponseSlotBase = {
2263
559
  /** Forward input information of a conversation */
2264
- forward?: (boolean | string | {
2265
- to?: string | undefined;
2266
- mode?: ("after-reply" | "immediately") | undefined;
2267
- /** Note to provide to the agent */
2268
- note?: string | undefined;
2269
- }) | undefined;
560
+ forward?: Forward | undefined;
2270
561
  /** Note to provide to the agent, recommend using forward object api instead */
2271
562
  forwardNote?: string | undefined;
2272
- instructions?: (string | {
2273
- /** Unique ID for the instruction, this is used to remove the instruction later */
2274
- id?: string | undefined;
2275
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2276
- persist?: boolean | undefined;
2277
- content: string;
2278
- } | string[] | {
2279
- /** Unique ID for the instruction, this is used to remove the instruction later */
2280
- id?: string | undefined;
2281
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2282
- persist?: boolean | undefined;
2283
- content: string;
2284
- }[]) | undefined;
563
+ instructions?: Instruction[] | undefined;
2285
564
  removeInstructions?: string[] | undefined;
2286
565
  message?: string | undefined;
2287
566
  secondsDelay?: number | undefined;
@@ -2290,245 +569,26 @@ export type WorkflowFunction = (args_0: {
2290
569
  [x: string]: any;
2291
570
  } | undefined;
2292
571
  resetIntent?: boolean | undefined;
2293
- followup?: ({
2294
- scheduled: number;
2295
- cancelIf?: {
2296
- [x: string]: any;
2297
- } | undefined;
2298
- /** This will still run even if the conversation is locked, defaults to false */
2299
- overrideLock?: boolean | undefined;
2300
- /** Manual message sent to client */
2301
- message: string;
2302
- } | {
2303
- scheduled: number;
2304
- cancelIf?: {
2305
- [x: string]: any;
2306
- } | undefined;
2307
- /** This will still run even if the conversation is locked, defaults to false */
2308
- overrideLock?: boolean | undefined;
2309
- instructions: string | {
2310
- /** Unique ID for the instruction, this is used to remove the instruction later */
2311
- id?: string | undefined;
2312
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2313
- persist?: boolean | undefined;
2314
- content: string;
2315
- } | string[] | {
2316
- /** Unique ID for the instruction, this is used to remove the instruction later */
2317
- id?: string | undefined;
2318
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2319
- persist?: boolean | undefined;
2320
- content: string;
2321
- }[];
2322
- }) | undefined;
2323
- anticipate?: ({
2324
- did: string;
2325
- yes: {
2326
- /** Forward input information of a conversation */
2327
- forward?: (boolean | string | {
2328
- to?: string | undefined;
2329
- mode?: ("after-reply" | "immediately") | undefined;
2330
- /** Note to provide to the agent */
2331
- note?: string | undefined;
2332
- }) | undefined;
2333
- /** Note to provide to the agent, recommend using forward object api instead */
2334
- forwardNote?: string | undefined;
2335
- instructions?: (string | {
2336
- /** Unique ID for the instruction, this is used to remove the instruction later */
2337
- id?: string | undefined;
2338
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2339
- persist?: boolean | undefined;
2340
- content: string;
2341
- } | string[] | {
2342
- /** Unique ID for the instruction, this is used to remove the instruction later */
2343
- id?: string | undefined;
2344
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2345
- persist?: boolean | undefined;
2346
- content: string;
2347
- }[]) | undefined;
2348
- removeInstructions?: string[] | undefined;
2349
- message?: string | undefined;
2350
- secondsDelay?: number | undefined;
2351
- scheduled?: number | undefined;
2352
- contextUpsert?: {
2353
- [x: string]: any;
2354
- } | undefined;
2355
- resetIntent?: boolean | undefined;
2356
- followup?: ({
2357
- scheduled: number;
2358
- cancelIf?: {
2359
- [x: string]: any;
2360
- } | undefined;
2361
- /** This will still run even if the conversation is locked, defaults to false */
2362
- overrideLock?: boolean | undefined;
2363
- /** Manual message sent to client */
2364
- message: string;
2365
- } | {
2366
- scheduled: number;
2367
- cancelIf?: {
2368
- [x: string]: any;
2369
- } | undefined;
2370
- /** This will still run even if the conversation is locked, defaults to false */
2371
- overrideLock?: boolean | undefined;
2372
- instructions: string | {
2373
- /** Unique ID for the instruction, this is used to remove the instruction later */
2374
- id?: string | undefined;
2375
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2376
- persist?: boolean | undefined;
2377
- content: string;
2378
- } | string[] | {
2379
- /** Unique ID for the instruction, this is used to remove the instruction later */
2380
- id?: string | undefined;
2381
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2382
- persist?: boolean | undefined;
2383
- content: string;
2384
- }[];
2385
- }) | undefined;
2386
- };
2387
- no: {
2388
- /** Forward input information of a conversation */
2389
- forward?: (boolean | string | {
2390
- to?: string | undefined;
2391
- mode?: ("after-reply" | "immediately") | undefined;
2392
- /** Note to provide to the agent */
2393
- note?: string | undefined;
2394
- }) | undefined;
2395
- /** Note to provide to the agent, recommend using forward object api instead */
2396
- forwardNote?: string | undefined;
2397
- instructions?: (string | {
2398
- /** Unique ID for the instruction, this is used to remove the instruction later */
2399
- id?: string | undefined;
2400
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2401
- persist?: boolean | undefined;
2402
- content: string;
2403
- } | string[] | {
2404
- /** Unique ID for the instruction, this is used to remove the instruction later */
2405
- id?: string | undefined;
2406
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2407
- persist?: boolean | undefined;
2408
- content: string;
2409
- }[]) | undefined;
2410
- removeInstructions?: string[] | undefined;
2411
- message?: string | undefined;
2412
- secondsDelay?: number | undefined;
2413
- scheduled?: number | undefined;
2414
- contextUpsert?: {
2415
- [x: string]: any;
2416
- } | undefined;
2417
- resetIntent?: boolean | undefined;
2418
- followup?: ({
2419
- scheduled: number;
2420
- cancelIf?: {
2421
- [x: string]: any;
2422
- } | undefined;
2423
- /** This will still run even if the conversation is locked, defaults to false */
2424
- overrideLock?: boolean | undefined;
2425
- /** Manual message sent to client */
2426
- message: string;
2427
- } | {
2428
- scheduled: number;
2429
- cancelIf?: {
2430
- [x: string]: any;
2431
- } | undefined;
2432
- /** This will still run even if the conversation is locked, defaults to false */
2433
- overrideLock?: boolean | undefined;
2434
- instructions: string | {
2435
- /** Unique ID for the instruction, this is used to remove the instruction later */
2436
- id?: string | undefined;
2437
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2438
- persist?: boolean | undefined;
2439
- content: string;
2440
- } | string[] | {
2441
- /** Unique ID for the instruction, this is used to remove the instruction later */
2442
- id?: string | undefined;
2443
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2444
- persist?: boolean | undefined;
2445
- content: string;
2446
- }[];
2447
- }) | undefined;
2448
- };
2449
- } | {
2450
- /** Forward input information of a conversation */
2451
- forward?: (boolean | string | {
2452
- to?: string | undefined;
2453
- mode?: ("after-reply" | "immediately") | undefined;
2454
- /** Note to provide to the agent */
2455
- note?: string | undefined;
2456
- }) | undefined;
2457
- /** Note to provide to the agent, recommend using forward object api instead */
2458
- forwardNote?: string | undefined;
2459
- instructions?: (string | {
2460
- /** Unique ID for the instruction, this is used to remove the instruction later */
2461
- id?: string | undefined;
2462
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2463
- persist?: boolean | undefined;
2464
- content: string;
2465
- } | string[] | {
2466
- /** Unique ID for the instruction, this is used to remove the instruction later */
2467
- id?: string | undefined;
2468
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2469
- persist?: boolean | undefined;
2470
- content: string;
2471
- }[]) | undefined;
2472
- removeInstructions?: string[] | undefined;
2473
- message?: string | undefined;
2474
- secondsDelay?: number | undefined;
2475
- scheduled?: number | undefined;
2476
- contextUpsert?: {
2477
- [x: string]: any;
2478
- } | undefined;
2479
- resetIntent?: boolean | undefined;
2480
- followup?: ({
2481
- scheduled: number;
2482
- cancelIf?: {
2483
- [x: string]: any;
2484
- } | undefined;
2485
- /** This will still run even if the conversation is locked, defaults to false */
2486
- overrideLock?: boolean | undefined;
2487
- /** Manual message sent to client */
2488
- message: string;
2489
- } | {
2490
- scheduled: number;
2491
- cancelIf?: {
2492
- [x: string]: any;
2493
- } | undefined;
2494
- /** This will still run even if the conversation is locked, defaults to false */
2495
- overrideLock?: boolean | undefined;
2496
- instructions: string | {
2497
- /** Unique ID for the instruction, this is used to remove the instruction later */
2498
- id?: string | undefined;
2499
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2500
- persist?: boolean | undefined;
2501
- content: string;
2502
- } | string[] | {
2503
- /** Unique ID for the instruction, this is used to remove the instruction later */
2504
- id?: string | undefined;
2505
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2506
- persist?: boolean | undefined;
2507
- content: string;
2508
- }[];
2509
- }) | undefined;
2510
- keywords: string[];
2511
- }[]) | undefined;
2512
- }[]);
2513
-
2514
- export type WorkflowResponseMessage = string | {
2515
- uri: string;
2516
- data?: any | undefined;
2517
- headers?: {
2518
- [x: string]: string;
2519
- } | undefined;
2520
- method?: ("GET" | "POST" | "PUT") | undefined;
572
+ followup?: Followup | undefined;
2521
573
  };
2522
574
 
575
+ export type WorkflowResponseSlot = WorkflowResponseSlotBase & {
576
+ anticipate?: Anticipate | undefined;
577
+ };
578
+
579
+ export type WorkflowResponse = WorkflowResponseSlot | WorkflowResponseSlot[];
580
+
581
+ export type WorkflowFunction = (event: WorkflowEvent) => WorkflowResponse | Promise<WorkflowResponse>;
582
+
2523
583
  export type WorkflowResponseMessageApiRequest = {
2524
- uri: string;
2525
- data?: any | undefined;
2526
- headers?: {
2527
- [x: string]: string;
2528
- } | undefined;
2529
- method?: ("GET" | "POST" | "PUT") | undefined;
584
+ uri: string;
585
+ data?: any | undefined;
586
+ headers?: Record<string, string> | undefined;
587
+ method?: ("GET" | "POST" | "PUT") | undefined;
2530
588
  };
2531
589
 
590
+ export type WorkflowResponseMessage = string | WorkflowResponseMessageApiRequest;
591
+
2532
592
  export type WorkflowResponseMessageApiResponse = string | {
2533
593
  message: string;
2534
594
  } | {
@@ -2543,822 +603,6 @@ export type WorkflowResponseMessageApiResponse = string | {
2543
603
  };
2544
604
  };
2545
605
 
2546
- export type WorkflowResponse = {
2547
- /** Forward input information of a conversation */
2548
- forward?: (boolean | string | {
2549
- to?: string | undefined;
2550
- mode?: ("after-reply" | "immediately") | undefined;
2551
- /** Note to provide to the agent */
2552
- note?: string | undefined;
2553
- }) | undefined;
2554
- /** Note to provide to the agent, recommend using forward object api instead */
2555
- forwardNote?: string | undefined;
2556
- instructions?: (string | {
2557
- /** Unique ID for the instruction, this is used to remove the instruction later */
2558
- id?: string | undefined;
2559
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2560
- persist?: boolean | undefined;
2561
- content: string;
2562
- } | string[] | {
2563
- /** Unique ID for the instruction, this is used to remove the instruction later */
2564
- id?: string | undefined;
2565
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2566
- persist?: boolean | undefined;
2567
- content: string;
2568
- }[]) | undefined;
2569
- removeInstructions?: string[] | undefined;
2570
- message?: string | undefined;
2571
- secondsDelay?: number | undefined;
2572
- scheduled?: number | undefined;
2573
- contextUpsert?: {
2574
- [x: string]: any;
2575
- } | undefined;
2576
- resetIntent?: boolean | undefined;
2577
- followup?: ({
2578
- scheduled: number;
2579
- cancelIf?: {
2580
- [x: string]: any;
2581
- } | undefined;
2582
- /** This will still run even if the conversation is locked, defaults to false */
2583
- overrideLock?: boolean | undefined;
2584
- /** Manual message sent to client */
2585
- message: string;
2586
- } | {
2587
- scheduled: number;
2588
- cancelIf?: {
2589
- [x: string]: any;
2590
- } | undefined;
2591
- /** This will still run even if the conversation is locked, defaults to false */
2592
- overrideLock?: boolean | undefined;
2593
- instructions: string | {
2594
- /** Unique ID for the instruction, this is used to remove the instruction later */
2595
- id?: string | undefined;
2596
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2597
- persist?: boolean | undefined;
2598
- content: string;
2599
- } | string[] | {
2600
- /** Unique ID for the instruction, this is used to remove the instruction later */
2601
- id?: string | undefined;
2602
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2603
- persist?: boolean | undefined;
2604
- content: string;
2605
- }[];
2606
- }) | undefined;
2607
- anticipate?: ({
2608
- did: string;
2609
- yes: {
2610
- /** Forward input information of a conversation */
2611
- forward?: (boolean | string | {
2612
- to?: string | undefined;
2613
- mode?: ("after-reply" | "immediately") | undefined;
2614
- /** Note to provide to the agent */
2615
- note?: string | undefined;
2616
- }) | undefined;
2617
- /** Note to provide to the agent, recommend using forward object api instead */
2618
- forwardNote?: string | undefined;
2619
- instructions?: (string | {
2620
- /** Unique ID for the instruction, this is used to remove the instruction later */
2621
- id?: string | undefined;
2622
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2623
- persist?: boolean | undefined;
2624
- content: string;
2625
- } | string[] | {
2626
- /** Unique ID for the instruction, this is used to remove the instruction later */
2627
- id?: string | undefined;
2628
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2629
- persist?: boolean | undefined;
2630
- content: string;
2631
- }[]) | undefined;
2632
- removeInstructions?: string[] | undefined;
2633
- message?: string | undefined;
2634
- secondsDelay?: number | undefined;
2635
- scheduled?: number | undefined;
2636
- contextUpsert?: {
2637
- [x: string]: any;
2638
- } | undefined;
2639
- resetIntent?: boolean | undefined;
2640
- followup?: ({
2641
- scheduled: number;
2642
- cancelIf?: {
2643
- [x: string]: any;
2644
- } | undefined;
2645
- /** This will still run even if the conversation is locked, defaults to false */
2646
- overrideLock?: boolean | undefined;
2647
- /** Manual message sent to client */
2648
- message: string;
2649
- } | {
2650
- scheduled: number;
2651
- cancelIf?: {
2652
- [x: string]: any;
2653
- } | undefined;
2654
- /** This will still run even if the conversation is locked, defaults to false */
2655
- overrideLock?: boolean | undefined;
2656
- instructions: string | {
2657
- /** Unique ID for the instruction, this is used to remove the instruction later */
2658
- id?: string | undefined;
2659
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2660
- persist?: boolean | undefined;
2661
- content: string;
2662
- } | string[] | {
2663
- /** Unique ID for the instruction, this is used to remove the instruction later */
2664
- id?: string | undefined;
2665
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2666
- persist?: boolean | undefined;
2667
- content: string;
2668
- }[];
2669
- }) | undefined;
2670
- };
2671
- no: {
2672
- /** Forward input information of a conversation */
2673
- forward?: (boolean | string | {
2674
- to?: string | undefined;
2675
- mode?: ("after-reply" | "immediately") | undefined;
2676
- /** Note to provide to the agent */
2677
- note?: string | undefined;
2678
- }) | undefined;
2679
- /** Note to provide to the agent, recommend using forward object api instead */
2680
- forwardNote?: string | undefined;
2681
- instructions?: (string | {
2682
- /** Unique ID for the instruction, this is used to remove the instruction later */
2683
- id?: string | undefined;
2684
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2685
- persist?: boolean | undefined;
2686
- content: string;
2687
- } | string[] | {
2688
- /** Unique ID for the instruction, this is used to remove the instruction later */
2689
- id?: string | undefined;
2690
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2691
- persist?: boolean | undefined;
2692
- content: string;
2693
- }[]) | undefined;
2694
- removeInstructions?: string[] | undefined;
2695
- message?: string | undefined;
2696
- secondsDelay?: number | undefined;
2697
- scheduled?: number | undefined;
2698
- contextUpsert?: {
2699
- [x: string]: any;
2700
- } | undefined;
2701
- resetIntent?: boolean | undefined;
2702
- followup?: ({
2703
- scheduled: number;
2704
- cancelIf?: {
2705
- [x: string]: any;
2706
- } | undefined;
2707
- /** This will still run even if the conversation is locked, defaults to false */
2708
- overrideLock?: boolean | undefined;
2709
- /** Manual message sent to client */
2710
- message: string;
2711
- } | {
2712
- scheduled: number;
2713
- cancelIf?: {
2714
- [x: string]: any;
2715
- } | undefined;
2716
- /** This will still run even if the conversation is locked, defaults to false */
2717
- overrideLock?: boolean | undefined;
2718
- instructions: string | {
2719
- /** Unique ID for the instruction, this is used to remove the instruction later */
2720
- id?: string | undefined;
2721
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2722
- persist?: boolean | undefined;
2723
- content: string;
2724
- } | string[] | {
2725
- /** Unique ID for the instruction, this is used to remove the instruction later */
2726
- id?: string | undefined;
2727
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2728
- persist?: boolean | undefined;
2729
- content: string;
2730
- }[];
2731
- }) | undefined;
2732
- };
2733
- } | {
2734
- /** Forward input information of a conversation */
2735
- forward?: (boolean | string | {
2736
- to?: string | undefined;
2737
- mode?: ("after-reply" | "immediately") | undefined;
2738
- /** Note to provide to the agent */
2739
- note?: string | undefined;
2740
- }) | undefined;
2741
- /** Note to provide to the agent, recommend using forward object api instead */
2742
- forwardNote?: string | undefined;
2743
- instructions?: (string | {
2744
- /** Unique ID for the instruction, this is used to remove the instruction later */
2745
- id?: string | undefined;
2746
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2747
- persist?: boolean | undefined;
2748
- content: string;
2749
- } | string[] | {
2750
- /** Unique ID for the instruction, this is used to remove the instruction later */
2751
- id?: string | undefined;
2752
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2753
- persist?: boolean | undefined;
2754
- content: string;
2755
- }[]) | undefined;
2756
- removeInstructions?: string[] | undefined;
2757
- message?: string | undefined;
2758
- secondsDelay?: number | undefined;
2759
- scheduled?: number | undefined;
2760
- contextUpsert?: {
2761
- [x: string]: any;
2762
- } | undefined;
2763
- resetIntent?: boolean | undefined;
2764
- followup?: ({
2765
- scheduled: number;
2766
- cancelIf?: {
2767
- [x: string]: any;
2768
- } | undefined;
2769
- /** This will still run even if the conversation is locked, defaults to false */
2770
- overrideLock?: boolean | undefined;
2771
- /** Manual message sent to client */
2772
- message: string;
2773
- } | {
2774
- scheduled: number;
2775
- cancelIf?: {
2776
- [x: string]: any;
2777
- } | undefined;
2778
- /** This will still run even if the conversation is locked, defaults to false */
2779
- overrideLock?: boolean | undefined;
2780
- instructions: string | {
2781
- /** Unique ID for the instruction, this is used to remove the instruction later */
2782
- id?: string | undefined;
2783
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2784
- persist?: boolean | undefined;
2785
- content: string;
2786
- } | string[] | {
2787
- /** Unique ID for the instruction, this is used to remove the instruction later */
2788
- id?: string | undefined;
2789
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2790
- persist?: boolean | undefined;
2791
- content: string;
2792
- }[];
2793
- }) | undefined;
2794
- keywords: string[];
2795
- }[]) | undefined;
2796
- } | {
2797
- /** Forward input information of a conversation */
2798
- forward?: (boolean | string | {
2799
- to?: string | undefined;
2800
- mode?: ("after-reply" | "immediately") | undefined;
2801
- /** Note to provide to the agent */
2802
- note?: string | undefined;
2803
- }) | undefined;
2804
- /** Note to provide to the agent, recommend using forward object api instead */
2805
- forwardNote?: string | undefined;
2806
- instructions?: (string | {
2807
- /** Unique ID for the instruction, this is used to remove the instruction later */
2808
- id?: string | undefined;
2809
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2810
- persist?: boolean | undefined;
2811
- content: string;
2812
- } | string[] | {
2813
- /** Unique ID for the instruction, this is used to remove the instruction later */
2814
- id?: string | undefined;
2815
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2816
- persist?: boolean | undefined;
2817
- content: string;
2818
- }[]) | undefined;
2819
- removeInstructions?: string[] | undefined;
2820
- message?: string | undefined;
2821
- secondsDelay?: number | undefined;
2822
- scheduled?: number | undefined;
2823
- contextUpsert?: {
2824
- [x: string]: any;
2825
- } | undefined;
2826
- resetIntent?: boolean | undefined;
2827
- followup?: ({
2828
- scheduled: number;
2829
- cancelIf?: {
2830
- [x: string]: any;
2831
- } | undefined;
2832
- /** This will still run even if the conversation is locked, defaults to false */
2833
- overrideLock?: boolean | undefined;
2834
- /** Manual message sent to client */
2835
- message: string;
2836
- } | {
2837
- scheduled: number;
2838
- cancelIf?: {
2839
- [x: string]: any;
2840
- } | undefined;
2841
- /** This will still run even if the conversation is locked, defaults to false */
2842
- overrideLock?: boolean | undefined;
2843
- instructions: string | {
2844
- /** Unique ID for the instruction, this is used to remove the instruction later */
2845
- id?: string | undefined;
2846
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2847
- persist?: boolean | undefined;
2848
- content: string;
2849
- } | string[] | {
2850
- /** Unique ID for the instruction, this is used to remove the instruction later */
2851
- id?: string | undefined;
2852
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2853
- persist?: boolean | undefined;
2854
- content: string;
2855
- }[];
2856
- }) | undefined;
2857
- anticipate?: ({
2858
- did: string;
2859
- yes: {
2860
- /** Forward input information of a conversation */
2861
- forward?: (boolean | string | {
2862
- to?: string | undefined;
2863
- mode?: ("after-reply" | "immediately") | undefined;
2864
- /** Note to provide to the agent */
2865
- note?: string | undefined;
2866
- }) | undefined;
2867
- /** Note to provide to the agent, recommend using forward object api instead */
2868
- forwardNote?: string | undefined;
2869
- instructions?: (string | {
2870
- /** Unique ID for the instruction, this is used to remove the instruction later */
2871
- id?: string | undefined;
2872
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2873
- persist?: boolean | undefined;
2874
- content: string;
2875
- } | string[] | {
2876
- /** Unique ID for the instruction, this is used to remove the instruction later */
2877
- id?: string | undefined;
2878
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2879
- persist?: boolean | undefined;
2880
- content: string;
2881
- }[]) | undefined;
2882
- removeInstructions?: string[] | undefined;
2883
- message?: string | undefined;
2884
- secondsDelay?: number | undefined;
2885
- scheduled?: number | undefined;
2886
- contextUpsert?: {
2887
- [x: string]: any;
2888
- } | undefined;
2889
- resetIntent?: boolean | undefined;
2890
- followup?: ({
2891
- scheduled: number;
2892
- cancelIf?: {
2893
- [x: string]: any;
2894
- } | undefined;
2895
- /** This will still run even if the conversation is locked, defaults to false */
2896
- overrideLock?: boolean | undefined;
2897
- /** Manual message sent to client */
2898
- message: string;
2899
- } | {
2900
- scheduled: number;
2901
- cancelIf?: {
2902
- [x: string]: any;
2903
- } | undefined;
2904
- /** This will still run even if the conversation is locked, defaults to false */
2905
- overrideLock?: boolean | undefined;
2906
- instructions: string | {
2907
- /** Unique ID for the instruction, this is used to remove the instruction later */
2908
- id?: string | undefined;
2909
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2910
- persist?: boolean | undefined;
2911
- content: string;
2912
- } | string[] | {
2913
- /** Unique ID for the instruction, this is used to remove the instruction later */
2914
- id?: string | undefined;
2915
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2916
- persist?: boolean | undefined;
2917
- content: string;
2918
- }[];
2919
- }) | undefined;
2920
- };
2921
- no: {
2922
- /** Forward input information of a conversation */
2923
- forward?: (boolean | string | {
2924
- to?: string | undefined;
2925
- mode?: ("after-reply" | "immediately") | undefined;
2926
- /** Note to provide to the agent */
2927
- note?: string | undefined;
2928
- }) | undefined;
2929
- /** Note to provide to the agent, recommend using forward object api instead */
2930
- forwardNote?: string | undefined;
2931
- instructions?: (string | {
2932
- /** Unique ID for the instruction, this is used to remove the instruction later */
2933
- id?: string | undefined;
2934
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2935
- persist?: boolean | undefined;
2936
- content: string;
2937
- } | string[] | {
2938
- /** Unique ID for the instruction, this is used to remove the instruction later */
2939
- id?: string | undefined;
2940
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2941
- persist?: boolean | undefined;
2942
- content: string;
2943
- }[]) | undefined;
2944
- removeInstructions?: string[] | undefined;
2945
- message?: string | undefined;
2946
- secondsDelay?: number | undefined;
2947
- scheduled?: number | undefined;
2948
- contextUpsert?: {
2949
- [x: string]: any;
2950
- } | undefined;
2951
- resetIntent?: boolean | undefined;
2952
- followup?: ({
2953
- scheduled: number;
2954
- cancelIf?: {
2955
- [x: string]: any;
2956
- } | undefined;
2957
- /** This will still run even if the conversation is locked, defaults to false */
2958
- overrideLock?: boolean | undefined;
2959
- /** Manual message sent to client */
2960
- message: string;
2961
- } | {
2962
- scheduled: number;
2963
- cancelIf?: {
2964
- [x: string]: any;
2965
- } | undefined;
2966
- /** This will still run even if the conversation is locked, defaults to false */
2967
- overrideLock?: boolean | undefined;
2968
- instructions: string | {
2969
- /** Unique ID for the instruction, this is used to remove the instruction later */
2970
- id?: string | undefined;
2971
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2972
- persist?: boolean | undefined;
2973
- content: string;
2974
- } | string[] | {
2975
- /** Unique ID for the instruction, this is used to remove the instruction later */
2976
- id?: string | undefined;
2977
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2978
- persist?: boolean | undefined;
2979
- content: string;
2980
- }[];
2981
- }) | undefined;
2982
- };
2983
- } | {
2984
- /** Forward input information of a conversation */
2985
- forward?: (boolean | string | {
2986
- to?: string | undefined;
2987
- mode?: ("after-reply" | "immediately") | undefined;
2988
- /** Note to provide to the agent */
2989
- note?: string | undefined;
2990
- }) | undefined;
2991
- /** Note to provide to the agent, recommend using forward object api instead */
2992
- forwardNote?: string | undefined;
2993
- instructions?: (string | {
2994
- /** Unique ID for the instruction, this is used to remove the instruction later */
2995
- id?: string | undefined;
2996
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
2997
- persist?: boolean | undefined;
2998
- content: string;
2999
- } | string[] | {
3000
- /** Unique ID for the instruction, this is used to remove the instruction later */
3001
- id?: string | undefined;
3002
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3003
- persist?: boolean | undefined;
3004
- content: string;
3005
- }[]) | undefined;
3006
- removeInstructions?: string[] | undefined;
3007
- message?: string | undefined;
3008
- secondsDelay?: number | undefined;
3009
- scheduled?: number | undefined;
3010
- contextUpsert?: {
3011
- [x: string]: any;
3012
- } | undefined;
3013
- resetIntent?: boolean | undefined;
3014
- followup?: ({
3015
- scheduled: number;
3016
- cancelIf?: {
3017
- [x: string]: any;
3018
- } | undefined;
3019
- /** This will still run even if the conversation is locked, defaults to false */
3020
- overrideLock?: boolean | undefined;
3021
- /** Manual message sent to client */
3022
- message: string;
3023
- } | {
3024
- scheduled: number;
3025
- cancelIf?: {
3026
- [x: string]: any;
3027
- } | undefined;
3028
- /** This will still run even if the conversation is locked, defaults to false */
3029
- overrideLock?: boolean | undefined;
3030
- instructions: string | {
3031
- /** Unique ID for the instruction, this is used to remove the instruction later */
3032
- id?: string | undefined;
3033
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3034
- persist?: boolean | undefined;
3035
- content: string;
3036
- } | string[] | {
3037
- /** Unique ID for the instruction, this is used to remove the instruction later */
3038
- id?: string | undefined;
3039
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3040
- persist?: boolean | undefined;
3041
- content: string;
3042
- }[];
3043
- }) | undefined;
3044
- keywords: string[];
3045
- }[]) | undefined;
3046
- }[];
3047
-
3048
- export type WorkflowResponseSlotBase = {
3049
- /** Forward input information of a conversation */
3050
- forward?: (boolean | string | {
3051
- to?: string | undefined;
3052
- mode?: ("after-reply" | "immediately") | undefined;
3053
- /** Note to provide to the agent */
3054
- note?: string | undefined;
3055
- }) | undefined;
3056
- /** Note to provide to the agent, recommend using forward object api instead */
3057
- forwardNote?: string | undefined;
3058
- instructions?: (string | {
3059
- /** Unique ID for the instruction, this is used to remove the instruction later */
3060
- id?: string | undefined;
3061
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3062
- persist?: boolean | undefined;
3063
- content: string;
3064
- } | string[] | {
3065
- /** Unique ID for the instruction, this is used to remove the instruction later */
3066
- id?: string | undefined;
3067
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3068
- persist?: boolean | undefined;
3069
- content: string;
3070
- }[]) | undefined;
3071
- removeInstructions?: string[] | undefined;
3072
- message?: string | undefined;
3073
- secondsDelay?: number | undefined;
3074
- scheduled?: number | undefined;
3075
- contextUpsert?: {
3076
- [x: string]: any;
3077
- } | undefined;
3078
- resetIntent?: boolean | undefined;
3079
- followup?: ({
3080
- scheduled: number;
3081
- cancelIf?: {
3082
- [x: string]: any;
3083
- } | undefined;
3084
- /** This will still run even if the conversation is locked, defaults to false */
3085
- overrideLock?: boolean | undefined;
3086
- /** Manual message sent to client */
3087
- message: string;
3088
- } | {
3089
- scheduled: number;
3090
- cancelIf?: {
3091
- [x: string]: any;
3092
- } | undefined;
3093
- /** This will still run even if the conversation is locked, defaults to false */
3094
- overrideLock?: boolean | undefined;
3095
- instructions: string | {
3096
- /** Unique ID for the instruction, this is used to remove the instruction later */
3097
- id?: string | undefined;
3098
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3099
- persist?: boolean | undefined;
3100
- content: string;
3101
- } | string[] | {
3102
- /** Unique ID for the instruction, this is used to remove the instruction later */
3103
- id?: string | undefined;
3104
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3105
- persist?: boolean | undefined;
3106
- content: string;
3107
- }[];
3108
- }) | undefined;
3109
- };
3110
-
3111
- export type WorkflowResponseSlot = {
3112
- /** Forward input information of a conversation */
3113
- forward?: (boolean | string | {
3114
- to?: string | undefined;
3115
- mode?: ("after-reply" | "immediately") | undefined;
3116
- /** Note to provide to the agent */
3117
- note?: string | undefined;
3118
- }) | undefined;
3119
- /** Note to provide to the agent, recommend using forward object api instead */
3120
- forwardNote?: string | undefined;
3121
- instructions?: (string | {
3122
- /** Unique ID for the instruction, this is used to remove the instruction later */
3123
- id?: string | undefined;
3124
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3125
- persist?: boolean | undefined;
3126
- content: string;
3127
- } | string[] | {
3128
- /** Unique ID for the instruction, this is used to remove the instruction later */
3129
- id?: string | undefined;
3130
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3131
- persist?: boolean | undefined;
3132
- content: string;
3133
- }[]) | undefined;
3134
- removeInstructions?: string[] | undefined;
3135
- message?: string | undefined;
3136
- secondsDelay?: number | undefined;
3137
- scheduled?: number | undefined;
3138
- contextUpsert?: {
3139
- [x: string]: any;
3140
- } | undefined;
3141
- resetIntent?: boolean | undefined;
3142
- followup?: ({
3143
- scheduled: number;
3144
- cancelIf?: {
3145
- [x: string]: any;
3146
- } | undefined;
3147
- /** This will still run even if the conversation is locked, defaults to false */
3148
- overrideLock?: boolean | undefined;
3149
- /** Manual message sent to client */
3150
- message: string;
3151
- } | {
3152
- scheduled: number;
3153
- cancelIf?: {
3154
- [x: string]: any;
3155
- } | undefined;
3156
- /** This will still run even if the conversation is locked, defaults to false */
3157
- overrideLock?: boolean | undefined;
3158
- instructions: string | {
3159
- /** Unique ID for the instruction, this is used to remove the instruction later */
3160
- id?: string | undefined;
3161
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3162
- persist?: boolean | undefined;
3163
- content: string;
3164
- } | string[] | {
3165
- /** Unique ID for the instruction, this is used to remove the instruction later */
3166
- id?: string | undefined;
3167
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3168
- persist?: boolean | undefined;
3169
- content: string;
3170
- }[];
3171
- }) | undefined;
3172
- anticipate?: ({
3173
- did: string;
3174
- yes: {
3175
- /** Forward input information of a conversation */
3176
- forward?: (boolean | string | {
3177
- to?: string | undefined;
3178
- mode?: ("after-reply" | "immediately") | undefined;
3179
- /** Note to provide to the agent */
3180
- note?: string | undefined;
3181
- }) | undefined;
3182
- /** Note to provide to the agent, recommend using forward object api instead */
3183
- forwardNote?: string | undefined;
3184
- instructions?: (string | {
3185
- /** Unique ID for the instruction, this is used to remove the instruction later */
3186
- id?: string | undefined;
3187
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3188
- persist?: boolean | undefined;
3189
- content: string;
3190
- } | string[] | {
3191
- /** Unique ID for the instruction, this is used to remove the instruction later */
3192
- id?: string | undefined;
3193
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3194
- persist?: boolean | undefined;
3195
- content: string;
3196
- }[]) | undefined;
3197
- removeInstructions?: string[] | undefined;
3198
- message?: string | undefined;
3199
- secondsDelay?: number | undefined;
3200
- scheduled?: number | undefined;
3201
- contextUpsert?: {
3202
- [x: string]: any;
3203
- } | undefined;
3204
- resetIntent?: boolean | undefined;
3205
- followup?: ({
3206
- scheduled: number;
3207
- cancelIf?: {
3208
- [x: string]: any;
3209
- } | undefined;
3210
- /** This will still run even if the conversation is locked, defaults to false */
3211
- overrideLock?: boolean | undefined;
3212
- /** Manual message sent to client */
3213
- message: string;
3214
- } | {
3215
- scheduled: number;
3216
- cancelIf?: {
3217
- [x: string]: any;
3218
- } | undefined;
3219
- /** This will still run even if the conversation is locked, defaults to false */
3220
- overrideLock?: boolean | undefined;
3221
- instructions: string | {
3222
- /** Unique ID for the instruction, this is used to remove the instruction later */
3223
- id?: string | undefined;
3224
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3225
- persist?: boolean | undefined;
3226
- content: string;
3227
- } | string[] | {
3228
- /** Unique ID for the instruction, this is used to remove the instruction later */
3229
- id?: string | undefined;
3230
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3231
- persist?: boolean | undefined;
3232
- content: string;
3233
- }[];
3234
- }) | undefined;
3235
- };
3236
- no: {
3237
- /** Forward input information of a conversation */
3238
- forward?: (boolean | string | {
3239
- to?: string | undefined;
3240
- mode?: ("after-reply" | "immediately") | undefined;
3241
- /** Note to provide to the agent */
3242
- note?: string | undefined;
3243
- }) | undefined;
3244
- /** Note to provide to the agent, recommend using forward object api instead */
3245
- forwardNote?: string | undefined;
3246
- instructions?: (string | {
3247
- /** Unique ID for the instruction, this is used to remove the instruction later */
3248
- id?: string | undefined;
3249
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3250
- persist?: boolean | undefined;
3251
- content: string;
3252
- } | string[] | {
3253
- /** Unique ID for the instruction, this is used to remove the instruction later */
3254
- id?: string | undefined;
3255
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3256
- persist?: boolean | undefined;
3257
- content: string;
3258
- }[]) | undefined;
3259
- removeInstructions?: string[] | undefined;
3260
- message?: string | undefined;
3261
- secondsDelay?: number | undefined;
3262
- scheduled?: number | undefined;
3263
- contextUpsert?: {
3264
- [x: string]: any;
3265
- } | undefined;
3266
- resetIntent?: boolean | undefined;
3267
- followup?: ({
3268
- scheduled: number;
3269
- cancelIf?: {
3270
- [x: string]: any;
3271
- } | undefined;
3272
- /** This will still run even if the conversation is locked, defaults to false */
3273
- overrideLock?: boolean | undefined;
3274
- /** Manual message sent to client */
3275
- message: string;
3276
- } | {
3277
- scheduled: number;
3278
- cancelIf?: {
3279
- [x: string]: any;
3280
- } | undefined;
3281
- /** This will still run even if the conversation is locked, defaults to false */
3282
- overrideLock?: boolean | undefined;
3283
- instructions: string | {
3284
- /** Unique ID for the instruction, this is used to remove the instruction later */
3285
- id?: string | undefined;
3286
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3287
- persist?: boolean | undefined;
3288
- content: string;
3289
- } | string[] | {
3290
- /** Unique ID for the instruction, this is used to remove the instruction later */
3291
- id?: string | undefined;
3292
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3293
- persist?: boolean | undefined;
3294
- content: string;
3295
- }[];
3296
- }) | undefined;
3297
- };
3298
- } | {
3299
- /** Forward input information of a conversation */
3300
- forward?: (boolean | string | {
3301
- to?: string | undefined;
3302
- mode?: ("after-reply" | "immediately") | undefined;
3303
- /** Note to provide to the agent */
3304
- note?: string | undefined;
3305
- }) | undefined;
3306
- /** Note to provide to the agent, recommend using forward object api instead */
3307
- forwardNote?: string | undefined;
3308
- instructions?: (string | {
3309
- /** Unique ID for the instruction, this is used to remove the instruction later */
3310
- id?: string | undefined;
3311
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3312
- persist?: boolean | undefined;
3313
- content: string;
3314
- } | string[] | {
3315
- /** Unique ID for the instruction, this is used to remove the instruction later */
3316
- id?: string | undefined;
3317
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3318
- persist?: boolean | undefined;
3319
- content: string;
3320
- }[]) | undefined;
3321
- removeInstructions?: string[] | undefined;
3322
- message?: string | undefined;
3323
- secondsDelay?: number | undefined;
3324
- scheduled?: number | undefined;
3325
- contextUpsert?: {
3326
- [x: string]: any;
3327
- } | undefined;
3328
- resetIntent?: boolean | undefined;
3329
- followup?: ({
3330
- scheduled: number;
3331
- cancelIf?: {
3332
- [x: string]: any;
3333
- } | undefined;
3334
- /** This will still run even if the conversation is locked, defaults to false */
3335
- overrideLock?: boolean | undefined;
3336
- /** Manual message sent to client */
3337
- message: string;
3338
- } | {
3339
- scheduled: number;
3340
- cancelIf?: {
3341
- [x: string]: any;
3342
- } | undefined;
3343
- /** This will still run even if the conversation is locked, defaults to false */
3344
- overrideLock?: boolean | undefined;
3345
- instructions: string | {
3346
- /** Unique ID for the instruction, this is used to remove the instruction later */
3347
- id?: string | undefined;
3348
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3349
- persist?: boolean | undefined;
3350
- content: string;
3351
- } | string[] | {
3352
- /** Unique ID for the instruction, this is used to remove the instruction later */
3353
- id?: string | undefined;
3354
- /** if true, the instruction persists the conversation, if false the instruction will only last for 1 auto reply */
3355
- persist?: boolean | undefined;
3356
- content: string;
3357
- }[];
3358
- }) | undefined;
3359
- keywords: string[];
3360
- }[]) | undefined;
3361
- };
3362
606
 
3363
607
  export type WorkflowsConfiguration = {
3364
608
  /** Workflow id association, used to handle route params */
@@ -3366,14 +610,10 @@ export type WorkflowsConfiguration = {
3366
610
  entity: string;
3367
611
  }[];
3368
612
 
3369
- export type apiFunction = (args_0: {
3370
- searchParams: {
3371
- [x: string]: string | string[];
3372
- };
3373
- params: {
3374
- [x: string]: string;
3375
- };
3376
- }, ...args_1: unknown[]) => Promise<{
613
+ export type apiFunction = (args: {
614
+ searchParams: Record<string, string | string[]>;
615
+ params: Record<string, string>;
616
+ }) => Promise<{
3377
617
  body?: any;
3378
618
  init?: {
3379
619
  status?: number | undefined;
@@ -3382,21 +622,7 @@ export type apiFunction = (args_0: {
3382
622
  } | undefined;
3383
623
  }>;
3384
624
 
3385
- export type deleteApiFunction = (args_0: {
3386
- searchParams: {
3387
- [x: string]: string | string[];
3388
- };
3389
- params: {
3390
- [x: string]: string;
3391
- };
3392
- }, ...args_1: unknown[]) => Promise<{
3393
- body?: any;
3394
- init?: {
3395
- status?: number | undefined;
3396
- statusText?: string | undefined;
3397
- headers?: any | undefined;
3398
- } | undefined;
3399
- }>;
625
+ export type deleteApiFunction = apiFunction;
3400
626
 
3401
627
  export type eventResponse = {
3402
628
  body?: any;
@@ -3407,34 +633,6 @@ export type eventResponse = {
3407
633
  } | undefined;
3408
634
  };
3409
635
 
3410
- export type getApiFunction = (args_0: {
3411
- searchParams: {
3412
- [x: string]: string | string[];
3413
- };
3414
- params: {
3415
- [x: string]: string;
3416
- };
3417
- }, ...args_1: unknown[]) => Promise<{
3418
- body?: any;
3419
- init?: {
3420
- status?: number | undefined;
3421
- statusText?: string | undefined;
3422
- headers?: any | undefined;
3423
- } | undefined;
3424
- }>;
636
+ export type getApiFunction = apiFunction;
3425
637
 
3426
- export type queryApiFunction = (args_0: {
3427
- searchParams: {
3428
- [x: string]: string | string[];
3429
- };
3430
- params: {
3431
- [x: string]: string;
3432
- };
3433
- }, ...args_1: unknown[]) => Promise<{
3434
- body?: any;
3435
- init?: {
3436
- status?: number | undefined;
3437
- statusText?: string | undefined;
3438
- headers?: any | undefined;
3439
- } | undefined;
3440
- }>;
638
+ export type queryApiFunction = apiFunction;