@scout9/admin 1.0.0-alpha.0.0.47 → 1.0.0-alpha.0.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/api.d.ts CHANGED
@@ -387,17 +387,11 @@ export interface Config200ResponseAllOf {
387
387
  */
388
388
  export interface Context {
389
389
  /**
390
- * The name of the context
390
+ * The id of the context
391
391
  * @type {string}
392
392
  * @memberof Context
393
393
  */
394
- 'name': string;
395
- /**
396
- * Whether or not the context is modifiable
397
- * @type {boolean}
398
- * @memberof Context
399
- */
400
- 'modifiable'?: boolean;
394
+ 'entity': string;
401
395
  /**
402
396
  * The description of the context
403
397
  * @type {string}
@@ -406,46 +400,47 @@ export interface Context {
406
400
  'description'?: string;
407
401
  /**
408
402
  *
409
- * @type {ContextDetectionParams}
410
- * @memberof Context
411
- */
412
- 'detection'?: ContextDetectionParams;
413
- /**
414
- * The API to use for context detection
415
- * @type {string}
403
+ * @type {Array<ContextDefinitionsInner>}
416
404
  * @memberof Context
417
405
  */
418
- 'detectionApi'?: string;
406
+ 'definitions': Array<ContextDefinitionsInner>;
419
407
  /**
420
- * The ID column of the context
421
- * @type {string}
408
+ *
409
+ * @type {Array<ContextTrainingInner>}
422
410
  * @memberof Context
423
411
  */
424
- 'idColumn'?: string;
412
+ 'training': Array<ContextTrainingInner>;
425
413
  /**
426
- * The columns of the context
414
+ *
427
415
  * @type {Array<string>}
428
416
  * @memberof Context
429
417
  */
430
- 'columns'?: Array<string>;
418
+ 'entities'?: Array<string>;
419
+ }
420
+ /**
421
+ *
422
+ * @export
423
+ * @interface ContextDefinitionsInner
424
+ */
425
+ export interface ContextDefinitionsInner {
431
426
  /**
432
- * The required columns of the context
433
- * @type {Array<string>}
434
- * @memberof Context
427
+ * Utterance category assignment for this definition (if none provided, defaults to entity value)
428
+ * @type {string}
429
+ * @memberof ContextDefinitionsInner
435
430
  */
436
- 'requiredColumns'?: Array<string>;
431
+ 'utterance'?: string;
437
432
  /**
438
- * Whether or not to force NER
439
- * @type {boolean}
440
- * @memberof Context
433
+ * Unique value assigned to this utterance category
434
+ * @type {string}
435
+ * @memberof ContextDefinitionsInner
441
436
  */
442
- 'forceNER'?: boolean;
437
+ 'value': string;
443
438
  /**
444
439
  *
445
- * @type {ContextModel}
446
- * @memberof Context
440
+ * @type {Array<string>}
441
+ * @memberof ContextDefinitionsInner
447
442
  */
448
- 'model'?: ContextModel;
443
+ 'text': Array<string>;
449
444
  }
450
445
  /**
451
446
  *
@@ -503,37 +498,6 @@ export interface ContextDetectionEntity {
503
498
  */
504
499
  'text': Array<string>;
505
500
  }
506
- /**
507
- *
508
- * @export
509
- * @interface ContextDetectionParams
510
- */
511
- export interface ContextDetectionParams {
512
- /**
513
- *
514
- * @type {Array<ContextDetectionEntity>}
515
- * @memberof ContextDetectionParams
516
- */
517
- 'entities': Array<ContextDetectionEntity>;
518
- /**
519
- *
520
- * @type {Array<ContextDetectionDocument>}
521
- * @memberof ContextDetectionParams
522
- */
523
- 'documents': Array<ContextDetectionDocument>;
524
- /**
525
- * The activation intent of the context
526
- * @type {string}
527
- * @memberof ContextDetectionParams
528
- */
529
- 'activationIntent'?: string;
530
- /**
531
- *
532
- * @type {Array<ContextDetectionTest>}
533
- * @memberof ContextDetectionParams
534
- */
535
- 'test'?: Array<ContextDetectionTest>;
536
- }
537
501
  /**
538
502
  *
539
503
  * @export
@@ -578,93 +542,24 @@ export interface ContextDetectionTestExpected {
578
542
  */
579
543
  'entities': Array<ParsedContextEntity>;
580
544
  }
581
- /**
582
- * The model to use for context detection
583
- * @export
584
- * @interface ContextModel
585
- */
586
- export interface ContextModel {
587
- /**
588
- * The last time the model was updated
589
- * @type {string}
590
- * @memberof ContextModel
591
- */
592
- 'lastUpdate': string;
593
- /**
594
- * The reference to the model
595
- * @type {string}
596
- * @memberof ContextModel
597
- */
598
- 'ref': string;
599
- }
600
- /**
601
- * @type ContextRowValue
602
- * @export
603
- */
604
- export type ContextRowValue = boolean | number | string;
605
545
  /**
606
546
  *
607
547
  * @export
608
- * @interface ContextTestRequest
548
+ * @interface ContextTrainingInner
609
549
  */
610
- export interface ContextTestRequest {
611
- /**
612
- * The context id to test
613
- * @type {string}
614
- * @memberof ContextTestRequest
615
- */
616
- 'context': string;
617
- /**
618
- * The text to test the context against
619
- * @type {string}
620
- * @memberof ContextTestRequest
621
- */
622
- 'text'?: string;
550
+ export interface ContextTrainingInner {
623
551
  /**
624
- * The language to test the context against
552
+ * The assigned intent associated with the training text
625
553
  * @type {string}
626
- * @memberof ContextTestRequest
627
- */
628
- 'language'?: string;
629
- /**
630
- *
631
- * @type {Array<ContextDetectionTest>}
632
- * @memberof ContextTestRequest
633
- */
634
- 'data'?: Array<ContextDetectionTest>;
635
- /**
636
- * If true, the context will be saved to the database as an update call
637
- * @type {boolean}
638
- * @memberof ContextTestRequest
554
+ * @memberof ContextTrainingInner
639
555
  */
640
- 'save'?: boolean;
641
- }
642
- /**
643
- *
644
- * @export
645
- * @interface ContextTestResponse
646
- */
647
- export interface ContextTestResponse {
556
+ 'intent': string;
648
557
  /**
649
- * The context id to test
558
+ * The parameterized text to train definition values on
650
559
  * @type {string}
651
- * @memberof ContextTestResponse
560
+ * @memberof ContextTrainingInner
652
561
  */
653
- 'message': string;
654
- /**
655
- * Parsed data results of the text input for the specific context model
656
- * @type {{ [key: string]: any; }}
657
- * @memberof ContextTestResponse
658
- */
659
- 'parsed'?: {
660
- [key: string]: any;
661
- };
662
- /**
663
- * Success percentage of the context detection in decimal format
664
- * @type {number}
665
- * @memberof ContextTestResponse
666
- */
667
- 'success': number;
562
+ 'text': string;
668
563
  }
669
564
  /**
670
565
  *
@@ -691,11 +586,18 @@ export interface Conversation {
691
586
  */
692
587
  'environmentProps'?: ConversationBaseEnvironmentProps;
693
588
  /**
694
- * Customer this conversation is with
589
+ * User for this conversation
590
+ * @type {string}
591
+ * @memberof Conversation
592
+ */
593
+ '$user': string;
594
+ /**
595
+ * Customer this conversation is with (use $user instead)
695
596
  * @type {string}
696
597
  * @memberof Conversation
598
+ * @deprecated
697
599
  */
698
- '$customer': string;
600
+ '$customer'?: string;
699
601
  /**
700
602
  *
701
603
  * @type {ConversationEnvironment}
@@ -710,11 +612,18 @@ export interface Conversation {
710
612
  */
711
613
  export interface ConversationAllOf {
712
614
  /**
713
- * Customer this conversation is with
615
+ * User for this conversation
616
+ * @type {string}
617
+ * @memberof ConversationAllOf
618
+ */
619
+ '$user': string;
620
+ /**
621
+ * Customer this conversation is with (use $user instead)
714
622
  * @type {string}
715
623
  * @memberof ConversationAllOf
624
+ * @deprecated
716
625
  */
717
- '$customer': string;
626
+ '$customer'?: string;
718
627
  /**
719
628
  *
720
629
  * @type {ConversationEnvironment}
@@ -891,6 +800,37 @@ export interface ConversationContextGroup {
891
800
  */
892
801
  'conditions': Array<ConversationContextFieldCondition>;
893
802
  }
803
+ /**
804
+ *
805
+ * @export
806
+ * @interface ConversationContextUpdateRequest
807
+ */
808
+ export interface ConversationContextUpdateRequest {
809
+ /**
810
+ * The conversation id
811
+ * @type {string}
812
+ * @memberof ConversationContextUpdateRequest
813
+ */
814
+ 'convo': string;
815
+ /**
816
+ *
817
+ * @type {{ [key: string]: ConversationContextValue; }}
818
+ * @memberof ConversationContextUpdateRequest
819
+ */
820
+ 'context': {
821
+ [key: string]: ConversationContextValue;
822
+ };
823
+ }
824
+ /**
825
+ * @type ConversationContextValue
826
+ * @export
827
+ */
828
+ export type ConversationContextValue = Array<ConversationContextValueOneOfInner> | boolean | number | string;
829
+ /**
830
+ * @type ConversationContextValueOneOfInner
831
+ * @export
832
+ */
833
+ export type ConversationContextValueOneOfInner = boolean | number | string;
894
834
  /**
895
835
  *
896
836
  * @export
@@ -916,11 +856,18 @@ export interface ConversationCreateRequest {
916
856
  */
917
857
  'environmentProps'?: ConversationBaseEnvironmentProps;
918
858
  /**
919
- * Customer this conversation is with
859
+ * User for this conversation
860
+ * @type {string}
861
+ * @memberof ConversationCreateRequest
862
+ */
863
+ '$user': string;
864
+ /**
865
+ * Customer this conversation is with (use $user instead)
920
866
  * @type {string}
921
867
  * @memberof ConversationCreateRequest
868
+ * @deprecated
922
869
  */
923
- '$customer': string;
870
+ '$customer'?: string;
924
871
  /**
925
872
  *
926
873
  * @type {ConversationEnvironment}
@@ -1045,11 +992,18 @@ export interface ConversationGetResponse {
1045
992
  */
1046
993
  'environmentProps'?: ConversationBaseEnvironmentProps;
1047
994
  /**
1048
- * Customer this conversation is with
995
+ * User for this conversation
1049
996
  * @type {string}
1050
997
  * @memberof ConversationGetResponse
1051
998
  */
1052
- '$customer': string;
999
+ '$user': string;
1000
+ /**
1001
+ * Customer this conversation is with (use $user instead)
1002
+ * @type {string}
1003
+ * @memberof ConversationGetResponse
1004
+ * @deprecated
1005
+ */
1006
+ '$customer'?: string;
1053
1007
  /**
1054
1008
  *
1055
1009
  * @type {ConversationEnvironment}
@@ -1181,11 +1135,18 @@ export interface ConversationUpdateRequest {
1181
1135
  */
1182
1136
  'environmentProps'?: ConversationBaseEnvironmentProps;
1183
1137
  /**
1184
- * Customer this conversation is with
1138
+ * User for this conversation
1139
+ * @type {string}
1140
+ * @memberof ConversationUpdateRequest
1141
+ */
1142
+ '$user': string;
1143
+ /**
1144
+ * Customer this conversation is with (use $user instead)
1185
1145
  * @type {string}
1186
1146
  * @memberof ConversationUpdateRequest
1147
+ * @deprecated
1187
1148
  */
1188
- '$customer': string;
1149
+ '$customer'?: string;
1189
1150
  /**
1190
1151
  *
1191
1152
  * @type {ConversationEnvironment}
@@ -1287,11 +1248,18 @@ export interface ConversationWithId {
1287
1248
  */
1288
1249
  'environmentProps'?: ConversationBaseEnvironmentProps;
1289
1250
  /**
1290
- * Customer this conversation is with
1251
+ * User for this conversation
1252
+ * @type {string}
1253
+ * @memberof ConversationWithId
1254
+ */
1255
+ '$user': string;
1256
+ /**
1257
+ * Customer this conversation is with (use $user instead)
1291
1258
  * @type {string}
1292
1259
  * @memberof ConversationWithId
1260
+ * @deprecated
1293
1261
  */
1294
- '$customer': string;
1262
+ '$customer'?: string;
1295
1263
  /**
1296
1264
  *
1297
1265
  * @type {ConversationEnvironment}
@@ -1512,368 +1480,131 @@ export interface CreateAgentsResponse {
1512
1480
  /**
1513
1481
  *
1514
1482
  * @export
1515
- * @interface CreateContextDataRequest
1483
+ * @interface CreateCustomerGroupRequest
1516
1484
  */
1517
- export interface CreateContextDataRequest {
1485
+ export interface CreateCustomerGroupRequest {
1518
1486
  /**
1519
- * The context id to create data for
1487
+ * The name of the customer group
1520
1488
  * @type {string}
1521
- * @memberof CreateContextDataRequest
1489
+ * @memberof CreateCustomerGroupRequest
1522
1490
  */
1523
- 'context': string;
1491
+ 'name': string;
1492
+ /**
1493
+ * The description of the customer group
1494
+ * @type {string}
1495
+ * @memberof CreateCustomerGroupRequest
1496
+ */
1497
+ 'description'?: string;
1524
1498
  /**
1525
1499
  *
1526
- * @type {Array<{ [key: string]: ContextRowValue; }>}
1527
- * @memberof CreateContextDataRequest
1500
+ * @type {{ [key: string]: any; }}
1501
+ * @memberof CreateCustomerGroupRequest
1528
1502
  */
1529
- 'rows': Array<{
1530
- [key: string]: ContextRowValue;
1531
- }>;
1503
+ 'metadata'?: {
1504
+ [key: string]: any;
1505
+ };
1506
+ /**
1507
+ *
1508
+ * @type {Array<CustomerGroupRecord>}
1509
+ * @memberof CreateCustomerGroupRequest
1510
+ */
1511
+ 'customers': Array<CustomerGroupRecord>;
1532
1512
  }
1533
1513
  /**
1534
1514
  *
1535
1515
  * @export
1536
- * @interface CreateContextDataResponse
1516
+ * @interface CreateCustomerGroupResponse
1537
1517
  */
1538
- export interface CreateContextDataResponse {
1518
+ export interface CreateCustomerGroupResponse {
1539
1519
  /**
1540
1520
  *
1541
1521
  * @type {boolean}
1542
- * @memberof CreateContextDataResponse
1522
+ * @memberof CreateCustomerGroupResponse
1543
1523
  */
1544
1524
  'success': boolean;
1545
1525
  /**
1546
1526
  *
1547
1527
  * @type {Error}
1548
- * @memberof CreateContextDataResponse
1528
+ * @memberof CreateCustomerGroupResponse
1549
1529
  */
1550
1530
  'error'?: Error;
1551
1531
  /**
1552
1532
  * The id of the document that was created, updated, or deleted
1553
1533
  * @type {string}
1554
- * @memberof CreateContextDataResponse
1534
+ * @memberof CreateCustomerGroupResponse
1555
1535
  */
1556
1536
  'id': string;
1557
1537
  }
1558
1538
  /**
1559
1539
  *
1560
1540
  * @export
1561
- * @interface CreateContextRequest
1541
+ * @interface CreateCustomerGroupsRequest
1562
1542
  */
1563
- export interface CreateContextRequest {
1564
- /**
1565
- * The name of the context
1566
- * @type {string}
1567
- * @memberof CreateContextRequest
1568
- */
1569
- 'name': string;
1570
- /**
1571
- * Whether or not the context is modifiable
1572
- * @type {boolean}
1573
- * @memberof CreateContextRequest
1574
- */
1575
- 'modifiable'?: boolean;
1576
- /**
1577
- * The description of the context
1578
- * @type {string}
1579
- * @memberof CreateContextRequest
1580
- */
1581
- 'description'?: string;
1582
- /**
1583
- *
1584
- * @type {ContextDetectionParams}
1585
- * @memberof CreateContextRequest
1586
- */
1587
- 'detection'?: ContextDetectionParams;
1588
- /**
1589
- * The API to use for context detection
1590
- * @type {string}
1591
- * @memberof CreateContextRequest
1592
- */
1593
- 'detectionApi'?: string;
1594
- /**
1595
- * The ID column of the context
1596
- * @type {string}
1597
- * @memberof CreateContextRequest
1598
- */
1599
- 'idColumn'?: string;
1600
- /**
1601
- * The columns of the context
1602
- * @type {Array<string>}
1603
- * @memberof CreateContextRequest
1604
- */
1605
- 'columns'?: Array<string>;
1606
- /**
1607
- * The required columns of the context
1608
- * @type {Array<string>}
1609
- * @memberof CreateContextRequest
1610
- */
1611
- 'requiredColumns'?: Array<string>;
1612
- /**
1613
- * Whether or not to force NER
1614
- * @type {boolean}
1615
- * @memberof CreateContextRequest
1616
- */
1617
- 'forceNER'?: boolean;
1543
+ export interface CreateCustomerGroupsRequest {
1618
1544
  /**
1619
1545
  *
1620
- * @type {ContextModel}
1621
- * @memberof CreateContextRequest
1546
+ * @type {Array<CustomerGroup>}
1547
+ * @memberof CreateCustomerGroupsRequest
1622
1548
  */
1623
- 'model'?: ContextModel;
1549
+ 'CustomerGroups': Array<CustomerGroup>;
1624
1550
  }
1625
1551
  /**
1626
- * The response from creating a context
1552
+ *
1627
1553
  * @export
1628
- * @interface CreateContextResponse
1554
+ * @interface CreateCustomerGroupsResponse
1629
1555
  */
1630
- export interface CreateContextResponse {
1631
- /**
1632
- *
1633
- * @type {boolean}
1634
- * @memberof CreateContextResponse
1635
- */
1636
- 'success': boolean;
1556
+ export interface CreateCustomerGroupsResponse {
1637
1557
  /**
1638
- *
1639
- * @type {Error}
1640
- * @memberof CreateContextResponse
1558
+ * ISO 8601 datetime string of when the operation was queued
1559
+ * @type {string}
1560
+ * @memberof CreateCustomerGroupsResponse
1641
1561
  */
1642
- 'error'?: Error;
1562
+ 'queued': string;
1643
1563
  /**
1644
- * The id of the document that was created, updated, or deleted
1564
+ * The operation id to view the operation end results
1645
1565
  * @type {string}
1646
- * @memberof CreateContextResponse
1566
+ * @memberof CreateCustomerGroupsResponse
1647
1567
  */
1648
- 'id': string;
1568
+ '$operation': string;
1649
1569
  }
1650
1570
  /**
1651
1571
  *
1652
1572
  * @export
1653
- * @interface CreateContextsRequest
1573
+ * @interface CreateCustomersRequest
1654
1574
  */
1655
- export interface CreateContextsRequest {
1575
+ export interface CreateCustomersRequest {
1656
1576
  /**
1657
1577
  *
1658
- * @type {Array<CreateContextsRequestContextsInner>}
1659
- * @memberof CreateContextsRequest
1578
+ * @type {Array<Customer>}
1579
+ * @memberof CreateCustomersRequest
1660
1580
  */
1661
- 'contexts'?: Array<CreateContextsRequestContextsInner>;
1581
+ 'customers': Array<Customer>;
1662
1582
  }
1663
1583
  /**
1664
1584
  *
1665
1585
  * @export
1666
- * @interface CreateContextsRequestContextsInner
1586
+ * @interface CreateCustomersResponse
1667
1587
  */
1668
- export interface CreateContextsRequestContextsInner {
1588
+ export interface CreateCustomersResponse {
1669
1589
  /**
1670
- * The name of the context
1590
+ * ISO 8601 datetime string of when the operation was queued
1671
1591
  * @type {string}
1672
- * @memberof CreateContextsRequestContextsInner
1673
- */
1674
- 'name': string;
1675
- /**
1676
- * Whether or not the context is modifiable
1677
- * @type {boolean}
1678
- * @memberof CreateContextsRequestContextsInner
1592
+ * @memberof CreateCustomersResponse
1679
1593
  */
1680
- 'modifiable'?: boolean;
1594
+ 'queued': string;
1681
1595
  /**
1682
- * The description of the context
1596
+ * The operation id to view the operation end results
1683
1597
  * @type {string}
1684
- * @memberof CreateContextsRequestContextsInner
1598
+ * @memberof CreateCustomersResponse
1685
1599
  */
1686
- 'description'?: string;
1687
- /**
1688
- *
1689
- * @type {ContextDetectionParams}
1690
- * @memberof CreateContextsRequestContextsInner
1691
- */
1692
- 'detection'?: ContextDetectionParams;
1693
- /**
1694
- * The API to use for context detection
1695
- * @type {string}
1696
- * @memberof CreateContextsRequestContextsInner
1697
- */
1698
- 'detectionApi'?: string;
1699
- /**
1700
- * The ID column of the context
1701
- * @type {string}
1702
- * @memberof CreateContextsRequestContextsInner
1703
- */
1704
- 'idColumn'?: string;
1705
- /**
1706
- * The columns of the context
1707
- * @type {Array<string>}
1708
- * @memberof CreateContextsRequestContextsInner
1709
- */
1710
- 'columns'?: Array<string>;
1711
- /**
1712
- * The required columns of the context
1713
- * @type {Array<string>}
1714
- * @memberof CreateContextsRequestContextsInner
1715
- */
1716
- 'requiredColumns'?: Array<string>;
1717
- /**
1718
- * Whether or not to force NER
1719
- * @type {boolean}
1720
- * @memberof CreateContextsRequestContextsInner
1721
- */
1722
- 'forceNER'?: boolean;
1723
- /**
1724
- *
1725
- * @type {ContextModel}
1726
- * @memberof CreateContextsRequestContextsInner
1727
- */
1728
- 'model'?: ContextModel;
1729
- }
1730
- /**
1731
- *
1732
- * @export
1733
- * @interface CreateContextsResponse
1734
- */
1735
- export interface CreateContextsResponse {
1736
- /**
1737
- * ISO 8601 datetime string of when the operation was queued
1738
- * @type {string}
1739
- * @memberof CreateContextsResponse
1740
- */
1741
- 'queued': string;
1742
- /**
1743
- * The operation id to view the operation end results
1744
- * @type {string}
1745
- * @memberof CreateContextsResponse
1746
- */
1747
- '$operation': string;
1748
- }
1749
- /**
1750
- *
1751
- * @export
1752
- * @interface CreateCustomerGroupRequest
1753
- */
1754
- export interface CreateCustomerGroupRequest {
1755
- /**
1756
- * The name of the customer group
1757
- * @type {string}
1758
- * @memberof CreateCustomerGroupRequest
1759
- */
1760
- 'name': string;
1761
- /**
1762
- * The description of the customer group
1763
- * @type {string}
1764
- * @memberof CreateCustomerGroupRequest
1765
- */
1766
- 'description'?: string;
1767
- /**
1768
- *
1769
- * @type {{ [key: string]: any; }}
1770
- * @memberof CreateCustomerGroupRequest
1771
- */
1772
- 'metadata'?: {
1773
- [key: string]: any;
1774
- };
1775
- /**
1776
- *
1777
- * @type {Array<CustomerGroupRecord>}
1778
- * @memberof CreateCustomerGroupRequest
1779
- */
1780
- 'customers': Array<CustomerGroupRecord>;
1781
- }
1782
- /**
1783
- *
1784
- * @export
1785
- * @interface CreateCustomerGroupResponse
1786
- */
1787
- export interface CreateCustomerGroupResponse {
1788
- /**
1789
- *
1790
- * @type {boolean}
1791
- * @memberof CreateCustomerGroupResponse
1792
- */
1793
- 'success': boolean;
1794
- /**
1795
- *
1796
- * @type {Error}
1797
- * @memberof CreateCustomerGroupResponse
1798
- */
1799
- 'error'?: Error;
1800
- /**
1801
- * The id of the document that was created, updated, or deleted
1802
- * @type {string}
1803
- * @memberof CreateCustomerGroupResponse
1804
- */
1805
- 'id': string;
1806
- }
1807
- /**
1808
- *
1809
- * @export
1810
- * @interface CreateCustomerGroupsRequest
1811
- */
1812
- export interface CreateCustomerGroupsRequest {
1813
- /**
1814
- *
1815
- * @type {Array<CustomerGroup>}
1816
- * @memberof CreateCustomerGroupsRequest
1817
- */
1818
- 'CustomerGroups': Array<CustomerGroup>;
1819
- }
1820
- /**
1821
- *
1822
- * @export
1823
- * @interface CreateCustomerGroupsResponse
1824
- */
1825
- export interface CreateCustomerGroupsResponse {
1826
- /**
1827
- * ISO 8601 datetime string of when the operation was queued
1828
- * @type {string}
1829
- * @memberof CreateCustomerGroupsResponse
1830
- */
1831
- 'queued': string;
1832
- /**
1833
- * The operation id to view the operation end results
1834
- * @type {string}
1835
- * @memberof CreateCustomerGroupsResponse
1836
- */
1837
- '$operation': string;
1838
- }
1839
- /**
1840
- *
1841
- * @export
1842
- * @interface CreateCustomersRequest
1843
- */
1844
- export interface CreateCustomersRequest {
1845
- /**
1846
- *
1847
- * @type {Array<Customer>}
1848
- * @memberof CreateCustomersRequest
1849
- */
1850
- 'customers': Array<Customer>;
1851
- }
1852
- /**
1853
- *
1854
- * @export
1855
- * @interface CreateCustomersResponse
1856
- */
1857
- export interface CreateCustomersResponse {
1858
- /**
1859
- * ISO 8601 datetime string of when the operation was queued
1860
- * @type {string}
1861
- * @memberof CreateCustomersResponse
1862
- */
1863
- 'queued': string;
1864
- /**
1865
- * The operation id to view the operation end results
1866
- * @type {string}
1867
- * @memberof CreateCustomersResponse
1868
- */
1869
- '$operation': string;
1870
- }
1871
- /**
1872
- *
1873
- * @export
1874
- * @interface CreateFileRequestWithStringPurpose
1875
- */
1876
- export interface CreateFileRequestWithStringPurpose {
1600
+ '$operation': string;
1601
+ }
1602
+ /**
1603
+ *
1604
+ * @export
1605
+ * @interface CreateFileRequestWithStringPurpose
1606
+ */
1607
+ export interface CreateFileRequestWithStringPurpose {
1877
1608
  /**
1878
1609
  *
1879
1610
  * @type {File}
@@ -1893,197 +1624,6 @@ export interface CreateFileRequestWithStringPurpose {
1893
1624
  */
1894
1625
  'entity': string;
1895
1626
  }
1896
- /**
1897
- *
1898
- * @export
1899
- * @interface CreateWorkflowRequest
1900
- */
1901
- export interface CreateWorkflowRequest {
1902
- /**
1903
- *
1904
- * @type {PurposeEnum}
1905
- * @memberof CreateWorkflowRequest
1906
- */
1907
- 'purpose'?: PurposeEnum;
1908
- /**
1909
- * The name of the workflow
1910
- * @type {string}
1911
- * @memberof CreateWorkflowRequest
1912
- */
1913
- 'name': string;
1914
- /**
1915
- *
1916
- * @type {ContextDetectionParams}
1917
- * @memberof CreateWorkflowRequest
1918
- */
1919
- 'initiators': ContextDetectionParams;
1920
- /**
1921
- * The fields of the workflow
1922
- * @type {Array<ConversationContextField>}
1923
- * @memberof CreateWorkflowRequest
1924
- */
1925
- 'fields': Array<ConversationContextField>;
1926
- /**
1927
- * About this conversation - used as initial context
1928
- * @type {string}
1929
- * @memberof CreateWorkflowRequest
1930
- */
1931
- 'context': string;
1932
- /**
1933
- * The webhook to call when a workflow is created
1934
- * @type {string}
1935
- * @memberof CreateWorkflowRequest
1936
- */
1937
- 'onCreated'?: string;
1938
- /**
1939
- * The webhook to call when a workflow is updated
1940
- * @type {string}
1941
- * @memberof CreateWorkflowRequest
1942
- */
1943
- 'onUpdated'?: string;
1944
- /**
1945
- * The webhook to call when a workflow is deleted
1946
- * @type {string}
1947
- * @memberof CreateWorkflowRequest
1948
- */
1949
- 'onDeleted'?: string;
1950
- /**
1951
- * The webhook to call when a workflow has an error
1952
- * @type {string}
1953
- * @memberof CreateWorkflowRequest
1954
- */
1955
- 'onError'?: string;
1956
- /**
1957
- * The priority of the workflow in relation to other workflows (determines activation order)
1958
- * @type {number}
1959
- * @memberof CreateWorkflowRequest
1960
- */
1961
- 'priority': number;
1962
- }
1963
- /**
1964
- *
1965
- * @export
1966
- * @interface CreateWorkflowResponse
1967
- */
1968
- export interface CreateWorkflowResponse {
1969
- /**
1970
- *
1971
- * @type {boolean}
1972
- * @memberof CreateWorkflowResponse
1973
- */
1974
- 'success': boolean;
1975
- /**
1976
- *
1977
- * @type {Error}
1978
- * @memberof CreateWorkflowResponse
1979
- */
1980
- 'error'?: Error;
1981
- /**
1982
- * The id of the document that was created, updated, or deleted
1983
- * @type {string}
1984
- * @memberof CreateWorkflowResponse
1985
- */
1986
- 'id': string;
1987
- }
1988
- /**
1989
- *
1990
- * @export
1991
- * @interface CreateWorkflowsRequest
1992
- */
1993
- export interface CreateWorkflowsRequest {
1994
- /**
1995
- *
1996
- * @type {Array<CreateWorkflowsRequestWorkflowsInner>}
1997
- * @memberof CreateWorkflowsRequest
1998
- */
1999
- 'workflows'?: Array<CreateWorkflowsRequestWorkflowsInner>;
2000
- }
2001
- /**
2002
- *
2003
- * @export
2004
- * @interface CreateWorkflowsRequestWorkflowsInner
2005
- */
2006
- export interface CreateWorkflowsRequestWorkflowsInner {
2007
- /**
2008
- *
2009
- * @type {PurposeEnum}
2010
- * @memberof CreateWorkflowsRequestWorkflowsInner
2011
- */
2012
- 'purpose'?: PurposeEnum;
2013
- /**
2014
- * The name of the workflow
2015
- * @type {string}
2016
- * @memberof CreateWorkflowsRequestWorkflowsInner
2017
- */
2018
- 'name': string;
2019
- /**
2020
- *
2021
- * @type {ContextDetectionParams}
2022
- * @memberof CreateWorkflowsRequestWorkflowsInner
2023
- */
2024
- 'initiators': ContextDetectionParams;
2025
- /**
2026
- * The fields of the workflow
2027
- * @type {Array<ConversationContextField>}
2028
- * @memberof CreateWorkflowsRequestWorkflowsInner
2029
- */
2030
- 'fields': Array<ConversationContextField>;
2031
- /**
2032
- * About this conversation - used as initial context
2033
- * @type {string}
2034
- * @memberof CreateWorkflowsRequestWorkflowsInner
2035
- */
2036
- 'context': string;
2037
- /**
2038
- * The webhook to call when a workflow is created
2039
- * @type {string}
2040
- * @memberof CreateWorkflowsRequestWorkflowsInner
2041
- */
2042
- 'onCreated'?: string;
2043
- /**
2044
- * The webhook to call when a workflow is updated
2045
- * @type {string}
2046
- * @memberof CreateWorkflowsRequestWorkflowsInner
2047
- */
2048
- 'onUpdated'?: string;
2049
- /**
2050
- * The webhook to call when a workflow is deleted
2051
- * @type {string}
2052
- * @memberof CreateWorkflowsRequestWorkflowsInner
2053
- */
2054
- 'onDeleted'?: string;
2055
- /**
2056
- * The webhook to call when a workflow has an error
2057
- * @type {string}
2058
- * @memberof CreateWorkflowsRequestWorkflowsInner
2059
- */
2060
- 'onError'?: string;
2061
- /**
2062
- * The priority of the workflow in relation to other workflows (determines activation order)
2063
- * @type {number}
2064
- * @memberof CreateWorkflowsRequestWorkflowsInner
2065
- */
2066
- 'priority': number;
2067
- }
2068
- /**
2069
- *
2070
- * @export
2071
- * @interface CreateWorkflowsResponse
2072
- */
2073
- export interface CreateWorkflowsResponse {
2074
- /**
2075
- * ISO 8601 datetime string of when the operation was queued
2076
- * @type {string}
2077
- * @memberof CreateWorkflowsResponse
2078
- */
2079
- 'queued': string;
2080
- /**
2081
- * The operation id to view the operation end results
2082
- * @type {string}
2083
- * @memberof CreateWorkflowsResponse
2084
- */
2085
- '$operation': string;
2086
- }
2087
1627
  /**
2088
1628
  * Represents a customer for your business or organization
2089
1629
  * @export
@@ -2350,75 +1890,6 @@ export interface CustomerUpdateResponse {
2350
1890
  * @export
2351
1891
  */
2352
1892
  export type CustomerValue = boolean | number | string;
2353
- /**
2354
- *
2355
- * @export
2356
- * @interface DeleteContextDataResponse
2357
- */
2358
- export interface DeleteContextDataResponse {
2359
- /**
2360
- *
2361
- * @type {boolean}
2362
- * @memberof DeleteContextDataResponse
2363
- */
2364
- 'success': boolean;
2365
- /**
2366
- *
2367
- * @type {Error}
2368
- * @memberof DeleteContextDataResponse
2369
- */
2370
- 'error'?: Error;
2371
- /**
2372
- * The id of the document that was created, updated, or deleted
2373
- * @type {string}
2374
- * @memberof DeleteContextDataResponse
2375
- */
2376
- 'id': string;
2377
- }
2378
- /**
2379
- *
2380
- * @export
2381
- * @interface DeleteContextResponse
2382
- */
2383
- export interface DeleteContextResponse {
2384
- /**
2385
- *
2386
- * @type {boolean}
2387
- * @memberof DeleteContextResponse
2388
- */
2389
- 'success': boolean;
2390
- /**
2391
- *
2392
- * @type {Error}
2393
- * @memberof DeleteContextResponse
2394
- */
2395
- 'error'?: Error;
2396
- /**
2397
- * The id of the document that was created, updated, or deleted
2398
- * @type {string}
2399
- * @memberof DeleteContextResponse
2400
- */
2401
- 'id': string;
2402
- }
2403
- /**
2404
- *
2405
- * @export
2406
- * @interface DeleteContextsResponse
2407
- */
2408
- export interface DeleteContextsResponse {
2409
- /**
2410
- * ISO 8601 datetime string of when the operation was queued
2411
- * @type {string}
2412
- * @memberof DeleteContextsResponse
2413
- */
2414
- 'queued': string;
2415
- /**
2416
- * The operation id to view the operation end results
2417
- * @type {string}
2418
- * @memberof DeleteContextsResponse
2419
- */
2420
- '$operation': string;
2421
- }
2422
1893
  /**
2423
1894
  *
2424
1895
  * @export
@@ -2507,50 +1978,6 @@ export interface DeleteFileResponse {
2507
1978
  */
2508
1979
  'deleted': boolean;
2509
1980
  }
2510
- /**
2511
- *
2512
- * @export
2513
- * @interface DeleteWorkflowResponse
2514
- */
2515
- export interface DeleteWorkflowResponse {
2516
- /**
2517
- *
2518
- * @type {boolean}
2519
- * @memberof DeleteWorkflowResponse
2520
- */
2521
- 'success': boolean;
2522
- /**
2523
- *
2524
- * @type {Error}
2525
- * @memberof DeleteWorkflowResponse
2526
- */
2527
- 'error'?: Error;
2528
- /**
2529
- * The id of the document that was created, updated, or deleted
2530
- * @type {string}
2531
- * @memberof DeleteWorkflowResponse
2532
- */
2533
- 'id': string;
2534
- }
2535
- /**
2536
- *
2537
- * @export
2538
- * @interface DeleteWorkflowsResponse
2539
- */
2540
- export interface DeleteWorkflowsResponse {
2541
- /**
2542
- * ISO 8601 datetime string of when the operation was queued
2543
- * @type {string}
2544
- * @memberof DeleteWorkflowsResponse
2545
- */
2546
- 'queued': string;
2547
- /**
2548
- * The operation id to view the operation end results
2549
- * @type {string}
2550
- * @memberof DeleteWorkflowsResponse
2551
- */
2552
- '$operation': string;
2553
- }
2554
1981
  /**
2555
1982
  *
2556
1983
  * @export
@@ -3194,170 +2621,71 @@ export interface GetAgentResponse {
3194
2621
  * @export
3195
2622
  * @interface GetAgentResponseAllOf
3196
2623
  */
3197
- export interface GetAgentResponseAllOf {
3198
- /**
3199
- * The ID of the agent
3200
- * @type {string}
3201
- * @memberof GetAgentResponseAllOf
3202
- */
3203
- '$id': string;
3204
- }
3205
- /**
3206
- *
3207
- * @export
3208
- * @interface GetApiOperationResponse
3209
- */
3210
- export interface GetApiOperationResponse {
3211
- /**
3212
- * ISO 8601 datetime string
3213
- * @type {string}
3214
- * @memberof GetApiOperationResponse
3215
- */
3216
- 'time': string;
3217
- /**
3218
- * The model that was created, updated, or deleted
3219
- * @type {string}
3220
- * @memberof GetApiOperationResponse
3221
- */
3222
- 'model': string;
3223
- /**
3224
- * The method that was called
3225
- * @type {string}
3226
- * @memberof GetApiOperationResponse
3227
- */
3228
- 'method': GetApiOperationResponseMethodEnum;
3229
- /**
3230
- *
3231
- * @type {{ [key: string]: any; }}
3232
- * @memberof GetApiOperationResponse
3233
- */
3234
- 'results': {
3235
- [key: string]: any;
3236
- };
3237
- /**
3238
- * The ID of the operation
3239
- * @type {string}
3240
- * @memberof GetApiOperationResponse
3241
- */
3242
- '$id': string;
3243
- }
3244
- export declare const GetApiOperationResponseMethodEnum: {
3245
- readonly Get: "get";
3246
- readonly Post: "post";
3247
- readonly Put: "put";
3248
- readonly Delete: "delete";
3249
- readonly Patch: "patch";
3250
- };
3251
- export type GetApiOperationResponseMethodEnum = typeof GetApiOperationResponseMethodEnum[keyof typeof GetApiOperationResponseMethodEnum];
3252
- /**
3253
- *
3254
- * @export
3255
- * @interface GetApiOperationResponseAllOf
3256
- */
3257
- export interface GetApiOperationResponseAllOf {
3258
- /**
3259
- * The ID of the operation
3260
- * @type {string}
3261
- * @memberof GetApiOperationResponseAllOf
3262
- */
3263
- '$id': string;
3264
- }
3265
- /**
3266
- *
3267
- * @export
3268
- * @interface GetContextDataResponse
3269
- */
3270
- export interface GetContextDataResponse {
2624
+ export interface GetAgentResponseAllOf {
3271
2625
  /**
3272
- * The ID of the context
2626
+ * The ID of the agent
3273
2627
  * @type {string}
3274
- * @memberof GetContextDataResponse
2628
+ * @memberof GetAgentResponseAllOf
3275
2629
  */
3276
2630
  '$id': string;
3277
2631
  }
3278
2632
  /**
3279
2633
  *
3280
2634
  * @export
3281
- * @interface GetContextResponse
2635
+ * @interface GetApiOperationResponse
3282
2636
  */
3283
- export interface GetContextResponse {
3284
- /**
3285
- * The name of the context
3286
- * @type {string}
3287
- * @memberof GetContextResponse
3288
- */
3289
- 'name': string;
3290
- /**
3291
- * Whether or not the context is modifiable
3292
- * @type {boolean}
3293
- * @memberof GetContextResponse
3294
- */
3295
- 'modifiable'?: boolean;
2637
+ export interface GetApiOperationResponse {
3296
2638
  /**
3297
- * The description of the context
2639
+ * ISO 8601 datetime string
3298
2640
  * @type {string}
3299
- * @memberof GetContextResponse
3300
- */
3301
- 'description'?: string;
3302
- /**
3303
- *
3304
- * @type {ContextDetectionParams}
3305
- * @memberof GetContextResponse
2641
+ * @memberof GetApiOperationResponse
3306
2642
  */
3307
- 'detection'?: ContextDetectionParams;
2643
+ 'time': string;
3308
2644
  /**
3309
- * The API to use for context detection
2645
+ * The model that was created, updated, or deleted
3310
2646
  * @type {string}
3311
- * @memberof GetContextResponse
2647
+ * @memberof GetApiOperationResponse
3312
2648
  */
3313
- 'detectionApi'?: string;
2649
+ 'model': string;
3314
2650
  /**
3315
- * The ID column of the context
2651
+ * The method that was called
3316
2652
  * @type {string}
3317
- * @memberof GetContextResponse
3318
- */
3319
- 'idColumn'?: string;
3320
- /**
3321
- * The columns of the context
3322
- * @type {Array<string>}
3323
- * @memberof GetContextResponse
3324
- */
3325
- 'columns'?: Array<string>;
3326
- /**
3327
- * The required columns of the context
3328
- * @type {Array<string>}
3329
- * @memberof GetContextResponse
3330
- */
3331
- 'requiredColumns'?: Array<string>;
3332
- /**
3333
- * Whether or not to force NER
3334
- * @type {boolean}
3335
- * @memberof GetContextResponse
2653
+ * @memberof GetApiOperationResponse
3336
2654
  */
3337
- 'forceNER'?: boolean;
2655
+ 'method': GetApiOperationResponseMethodEnum;
3338
2656
  /**
3339
2657
  *
3340
- * @type {ContextModel}
3341
- * @memberof GetContextResponse
2658
+ * @type {{ [key: string]: any; }}
2659
+ * @memberof GetApiOperationResponse
3342
2660
  */
3343
- 'model'?: ContextModel;
2661
+ 'results': {
2662
+ [key: string]: any;
2663
+ };
3344
2664
  /**
3345
- * The ID of the context
2665
+ * The ID of the operation
3346
2666
  * @type {string}
3347
- * @memberof GetContextResponse
2667
+ * @memberof GetApiOperationResponse
3348
2668
  */
3349
2669
  '$id': string;
3350
2670
  }
2671
+ export declare const GetApiOperationResponseMethodEnum: {
2672
+ readonly Get: "get";
2673
+ readonly Post: "post";
2674
+ readonly Put: "put";
2675
+ readonly Delete: "delete";
2676
+ readonly Patch: "patch";
2677
+ };
2678
+ export type GetApiOperationResponseMethodEnum = typeof GetApiOperationResponseMethodEnum[keyof typeof GetApiOperationResponseMethodEnum];
3351
2679
  /**
3352
2680
  *
3353
2681
  * @export
3354
- * @interface GetContextResponseAllOf
2682
+ * @interface GetApiOperationResponseAllOf
3355
2683
  */
3356
- export interface GetContextResponseAllOf {
2684
+ export interface GetApiOperationResponseAllOf {
3357
2685
  /**
3358
- * The ID of the context
2686
+ * The ID of the operation
3359
2687
  * @type {string}
3360
- * @memberof GetContextResponseAllOf
2688
+ * @memberof GetApiOperationResponseAllOf
3361
2689
  */
3362
2690
  '$id': string;
3363
2691
  }
@@ -3559,92 +2887,6 @@ export interface GetCustomerResponseAllOf {
3559
2887
  */
3560
2888
  '$id'?: string;
3561
2889
  }
3562
- /**
3563
- *
3564
- * @export
3565
- * @interface GetWorkflowResponse
3566
- */
3567
- export interface GetWorkflowResponse {
3568
- /**
3569
- *
3570
- * @type {PurposeEnum}
3571
- * @memberof GetWorkflowResponse
3572
- */
3573
- 'purpose'?: PurposeEnum;
3574
- /**
3575
- * The name of the workflow
3576
- * @type {string}
3577
- * @memberof GetWorkflowResponse
3578
- */
3579
- 'name': string;
3580
- /**
3581
- *
3582
- * @type {ContextDetectionParams}
3583
- * @memberof GetWorkflowResponse
3584
- */
3585
- 'initiators': ContextDetectionParams;
3586
- /**
3587
- * The fields of the workflow
3588
- * @type {Array<ConversationContextField>}
3589
- * @memberof GetWorkflowResponse
3590
- */
3591
- 'fields': Array<ConversationContextField>;
3592
- /**
3593
- * About this conversation - used as initial context
3594
- * @type {string}
3595
- * @memberof GetWorkflowResponse
3596
- */
3597
- 'context': string;
3598
- /**
3599
- * The webhook to call when a workflow is created
3600
- * @type {string}
3601
- * @memberof GetWorkflowResponse
3602
- */
3603
- 'onCreated'?: string;
3604
- /**
3605
- * The webhook to call when a workflow is updated
3606
- * @type {string}
3607
- * @memberof GetWorkflowResponse
3608
- */
3609
- 'onUpdated'?: string;
3610
- /**
3611
- * The webhook to call when a workflow is deleted
3612
- * @type {string}
3613
- * @memberof GetWorkflowResponse
3614
- */
3615
- 'onDeleted'?: string;
3616
- /**
3617
- * The webhook to call when a workflow has an error
3618
- * @type {string}
3619
- * @memberof GetWorkflowResponse
3620
- */
3621
- 'onError'?: string;
3622
- /**
3623
- * The priority of the workflow in relation to other workflows (determines activation order)
3624
- * @type {number}
3625
- * @memberof GetWorkflowResponse
3626
- */
3627
- 'priority': number;
3628
- /**
3629
- * The ID of the workflow
3630
- * @type {string}
3631
- * @memberof GetWorkflowResponse
3632
- */
3633
- '$id': string;
3634
- }
3635
- /**
3636
- *
3637
- * @export
3638
- * @interface GetWorkflowResponseAllOf
3639
- */
3640
- export interface GetWorkflowResponseAllOf {
3641
- /**
3642
- * The ID of the workflow
3643
- * @type {string}
3644
- * @memberof GetWorkflowResponseAllOf
3645
- */
3646
- '$id': string;
3647
- }
3648
2890
  /**
3649
2891
  *
3650
2892
  * @export
@@ -3810,92 +3052,6 @@ export interface ListApiOperationsResponseInnerAllOf {
3810
3052
  */
3811
3053
  '$id': string;
3812
3054
  }
3813
- /**
3814
- *
3815
- * @export
3816
- * @interface ListContextsResponseInner
3817
- */
3818
- export interface ListContextsResponseInner {
3819
- /**
3820
- * The name of the context
3821
- * @type {string}
3822
- * @memberof ListContextsResponseInner
3823
- */
3824
- 'name': string;
3825
- /**
3826
- * Whether or not the context is modifiable
3827
- * @type {boolean}
3828
- * @memberof ListContextsResponseInner
3829
- */
3830
- 'modifiable'?: boolean;
3831
- /**
3832
- * The description of the context
3833
- * @type {string}
3834
- * @memberof ListContextsResponseInner
3835
- */
3836
- 'description'?: string;
3837
- /**
3838
- *
3839
- * @type {ContextDetectionParams}
3840
- * @memberof ListContextsResponseInner
3841
- */
3842
- 'detection'?: ContextDetectionParams;
3843
- /**
3844
- * The API to use for context detection
3845
- * @type {string}
3846
- * @memberof ListContextsResponseInner
3847
- */
3848
- 'detectionApi'?: string;
3849
- /**
3850
- * The ID column of the context
3851
- * @type {string}
3852
- * @memberof ListContextsResponseInner
3853
- */
3854
- 'idColumn'?: string;
3855
- /**
3856
- * The columns of the context
3857
- * @type {Array<string>}
3858
- * @memberof ListContextsResponseInner
3859
- */
3860
- 'columns'?: Array<string>;
3861
- /**
3862
- * The required columns of the context
3863
- * @type {Array<string>}
3864
- * @memberof ListContextsResponseInner
3865
- */
3866
- 'requiredColumns'?: Array<string>;
3867
- /**
3868
- * Whether or not to force NER
3869
- * @type {boolean}
3870
- * @memberof ListContextsResponseInner
3871
- */
3872
- 'forceNER'?: boolean;
3873
- /**
3874
- *
3875
- * @type {ContextModel}
3876
- * @memberof ListContextsResponseInner
3877
- */
3878
- 'model'?: ContextModel;
3879
- /**
3880
- * The ID of the context
3881
- * @type {string}
3882
- * @memberof ListContextsResponseInner
3883
- */
3884
- '$id': string;
3885
- }
3886
- /**
3887
- *
3888
- * @export
3889
- * @interface ListContextsResponseInnerAllOf
3890
- */
3891
- export interface ListContextsResponseInnerAllOf {
3892
- /**
3893
- * The ID of the context
3894
- * @type {string}
3895
- * @memberof ListContextsResponseInnerAllOf
3896
- */
3897
- '$id': string;
3898
- }
3899
3055
  /**
3900
3056
  *
3901
3057
  * @export
@@ -3921,11 +3077,18 @@ export interface ListConversationsResponseInner {
3921
3077
  */
3922
3078
  'environmentProps'?: ConversationBaseEnvironmentProps;
3923
3079
  /**
3924
- * Customer this conversation is with
3080
+ * User for this conversation
3081
+ * @type {string}
3082
+ * @memberof ListConversationsResponseInner
3083
+ */
3084
+ '$user': string;
3085
+ /**
3086
+ * Customer this conversation is with (use $user instead)
3925
3087
  * @type {string}
3926
3088
  * @memberof ListConversationsResponseInner
3089
+ * @deprecated
3927
3090
  */
3928
- '$customer': string;
3091
+ '$customer'?: string;
3929
3092
  /**
3930
3093
  *
3931
3094
  * @type {ConversationEnvironment}
@@ -4248,92 +3411,6 @@ export interface ListQueryOperationsInner {
4248
3411
  */
4249
3412
  'value': AnyValue;
4250
3413
  }
4251
- /**
4252
- *
4253
- * @export
4254
- * @interface ListWorkflowsResponseInner
4255
- */
4256
- export interface ListWorkflowsResponseInner {
4257
- /**
4258
- *
4259
- * @type {PurposeEnum}
4260
- * @memberof ListWorkflowsResponseInner
4261
- */
4262
- 'purpose'?: PurposeEnum;
4263
- /**
4264
- * The name of the workflow
4265
- * @type {string}
4266
- * @memberof ListWorkflowsResponseInner
4267
- */
4268
- 'name': string;
4269
- /**
4270
- *
4271
- * @type {ContextDetectionParams}
4272
- * @memberof ListWorkflowsResponseInner
4273
- */
4274
- 'initiators': ContextDetectionParams;
4275
- /**
4276
- * The fields of the workflow
4277
- * @type {Array<ConversationContextField>}
4278
- * @memberof ListWorkflowsResponseInner
4279
- */
4280
- 'fields': Array<ConversationContextField>;
4281
- /**
4282
- * About this conversation - used as initial context
4283
- * @type {string}
4284
- * @memberof ListWorkflowsResponseInner
4285
- */
4286
- 'context': string;
4287
- /**
4288
- * The webhook to call when a workflow is created
4289
- * @type {string}
4290
- * @memberof ListWorkflowsResponseInner
4291
- */
4292
- 'onCreated'?: string;
4293
- /**
4294
- * The webhook to call when a workflow is updated
4295
- * @type {string}
4296
- * @memberof ListWorkflowsResponseInner
4297
- */
4298
- 'onUpdated'?: string;
4299
- /**
4300
- * The webhook to call when a workflow is deleted
4301
- * @type {string}
4302
- * @memberof ListWorkflowsResponseInner
4303
- */
4304
- 'onDeleted'?: string;
4305
- /**
4306
- * The webhook to call when a workflow has an error
4307
- * @type {string}
4308
- * @memberof ListWorkflowsResponseInner
4309
- */
4310
- 'onError'?: string;
4311
- /**
4312
- * The priority of the workflow in relation to other workflows (determines activation order)
4313
- * @type {number}
4314
- * @memberof ListWorkflowsResponseInner
4315
- */
4316
- 'priority': number;
4317
- /**
4318
- * The ID of the workflow
4319
- * @type {string}
4320
- * @memberof ListWorkflowsResponseInner
4321
- */
4322
- '$id': string;
4323
- }
4324
- /**
4325
- *
4326
- * @export
4327
- * @interface ListWorkflowsResponseInnerAllOf
4328
- */
4329
- export interface ListWorkflowsResponseInnerAllOf {
4330
- /**
4331
- * The ID of the workflow
4332
- * @type {string}
4333
- * @memberof ListWorkflowsResponseInnerAllOf
4334
- */
4335
- '$id': string;
4336
- }
4337
3414
  /**
4338
3415
  * @type LlmConfig
4339
3416
  * @export
@@ -4620,29 +3697,6 @@ export declare const MacroContextResultTypeEnum: {
4620
3697
  readonly Context: "context";
4621
3698
  };
4622
3699
  export type MacroContextResultTypeEnum = typeof MacroContextResultTypeEnum[keyof typeof MacroContextResultTypeEnum];
4623
- /**
4624
- *
4625
- * @export
4626
- * @interface MacroContextResultAllOf
4627
- */
4628
- export interface MacroContextResultAllOf {
4629
- /**
4630
- * Type is hard-coded to \'context\'
4631
- * @type {string}
4632
- * @memberof MacroContextResultAllOf
4633
- */
4634
- 'type'?: MacroContextResultAllOfTypeEnum;
4635
- /**
4636
- *
4637
- * @type {MacroContextValue}
4638
- * @memberof MacroContextResultAllOf
4639
- */
4640
- 'value'?: MacroContextValue;
4641
- }
4642
- export declare const MacroContextResultAllOfTypeEnum: {
4643
- readonly Context: "context";
4644
- };
4645
- export type MacroContextResultAllOfTypeEnum = typeof MacroContextResultAllOfTypeEnum[keyof typeof MacroContextResultAllOfTypeEnum];
4646
3700
  /**
4647
3701
  * @type MacroContextValue
4648
3702
  * @export
@@ -4706,29 +3760,6 @@ export declare const MacroDidResultTypeEnum: {
4706
3760
  readonly Did: "did";
4707
3761
  };
4708
3762
  export type MacroDidResultTypeEnum = typeof MacroDidResultTypeEnum[keyof typeof MacroDidResultTypeEnum];
4709
- /**
4710
- *
4711
- * @export
4712
- * @interface MacroDidResultAllOf
4713
- */
4714
- export interface MacroDidResultAllOf {
4715
- /**
4716
- * Type is hard-coded to \'did\'
4717
- * @type {string}
4718
- * @memberof MacroDidResultAllOf
4719
- */
4720
- 'type'?: MacroDidResultAllOfTypeEnum;
4721
- /**
4722
- * The returned value is of type boolean
4723
- * @type {boolean}
4724
- * @memberof MacroDidResultAllOf
4725
- */
4726
- 'value'?: boolean;
4727
- }
4728
- export declare const MacroDidResultAllOfTypeEnum: {
4729
- readonly Did: "did";
4730
- };
4731
- export type MacroDidResultAllOfTypeEnum = typeof MacroDidResultAllOfTypeEnum[keyof typeof MacroDidResultAllOfTypeEnum];
4732
3763
  /**
4733
3764
  *
4734
3765
  * @export
@@ -5405,11 +4436,18 @@ export interface ScheduleCreateRequest {
5405
4436
  */
5406
4437
  'environmentProps'?: ConversationBaseEnvironmentProps;
5407
4438
  /**
5408
- * Customer this conversation is with
4439
+ * User for this conversation
4440
+ * @type {string}
4441
+ * @memberof ScheduleCreateRequest
4442
+ */
4443
+ '$user': string;
4444
+ /**
4445
+ * Customer this conversation is with (use $user instead)
5409
4446
  * @type {string}
5410
4447
  * @memberof ScheduleCreateRequest
4448
+ * @deprecated
5411
4449
  */
5412
- '$customer': string;
4450
+ '$customer'?: string;
5413
4451
  /**
5414
4452
  *
5415
4453
  * @type {ConversationEnvironment}
@@ -5510,11 +4548,18 @@ export interface ScheduleGetResponse {
5510
4548
  */
5511
4549
  'environmentProps'?: ConversationBaseEnvironmentProps;
5512
4550
  /**
5513
- * Customer this conversation is with
4551
+ * User for this conversation
4552
+ * @type {string}
4553
+ * @memberof ScheduleGetResponse
4554
+ */
4555
+ '$user': string;
4556
+ /**
4557
+ * Customer this conversation is with (use $user instead)
5514
4558
  * @type {string}
5515
4559
  * @memberof ScheduleGetResponse
4560
+ * @deprecated
5516
4561
  */
5517
- '$customer': string;
4562
+ '$customer'?: string;
5518
4563
  /**
5519
4564
  *
5520
4565
  * @type {ConversationEnvironment}
@@ -5934,11 +4979,18 @@ export interface ScheduleUpdateRequest {
5934
4979
  */
5935
4980
  'environmentProps'?: ConversationBaseEnvironmentProps;
5936
4981
  /**
5937
- * Customer this conversation is with
4982
+ * User for this conversation
4983
+ * @type {string}
4984
+ * @memberof ScheduleUpdateRequest
4985
+ */
4986
+ '$user': string;
4987
+ /**
4988
+ * Customer this conversation is with (use $user instead)
5938
4989
  * @type {string}
5939
4990
  * @memberof ScheduleUpdateRequest
4991
+ * @deprecated
5940
4992
  */
5941
- '$customer': string;
4993
+ '$customer'?: string;
5942
4994
  /**
5943
4995
  *
5944
4996
  * @type {ConversationEnvironment}
@@ -6039,11 +5091,18 @@ export interface ScheduledConversation {
6039
5091
  */
6040
5092
  'environmentProps'?: ConversationBaseEnvironmentProps;
6041
5093
  /**
6042
- * Customer this conversation is with
5094
+ * User for this conversation
5095
+ * @type {string}
5096
+ * @memberof ScheduledConversation
5097
+ */
5098
+ '$user': string;
5099
+ /**
5100
+ * Customer this conversation is with (use $user instead)
6043
5101
  * @type {string}
6044
5102
  * @memberof ScheduledConversation
5103
+ * @deprecated
6045
5104
  */
6046
- '$customer': string;
5105
+ '$customer'?: string;
6047
5106
  /**
6048
5107
  *
6049
5108
  * @type {ConversationEnvironment}
@@ -6453,195 +5512,6 @@ export interface UpdateAgentsResponse {
6453
5512
  */
6454
5513
  '$operation': string;
6455
5514
  }
6456
- /**
6457
- *
6458
- * @export
6459
- * @interface UpdateContextDataRequest
6460
- */
6461
- export interface UpdateContextDataRequest {
6462
- /**
6463
- * The context id to create data for
6464
- * @type {string}
6465
- * @memberof UpdateContextDataRequest
6466
- */
6467
- 'context': string;
6468
- /**
6469
- *
6470
- * @type {Array<{ [key: string]: ContextRowValue; }>}
6471
- * @memberof UpdateContextDataRequest
6472
- */
6473
- 'data': Array<{
6474
- [key: string]: ContextRowValue;
6475
- }>;
6476
- }
6477
- /**
6478
- *
6479
- * @export
6480
- * @interface UpdateContextDataResponse
6481
- */
6482
- export interface UpdateContextDataResponse {
6483
- /**
6484
- *
6485
- * @type {boolean}
6486
- * @memberof UpdateContextDataResponse
6487
- */
6488
- 'success': boolean;
6489
- /**
6490
- *
6491
- * @type {Error}
6492
- * @memberof UpdateContextDataResponse
6493
- */
6494
- 'error'?: Error;
6495
- /**
6496
- * The id of the document that was created, updated, or deleted
6497
- * @type {string}
6498
- * @memberof UpdateContextDataResponse
6499
- */
6500
- 'id': string;
6501
- }
6502
- /**
6503
- *
6504
- * @export
6505
- * @interface UpdateContextRequest
6506
- */
6507
- export interface UpdateContextRequest {
6508
- /**
6509
- * The name of the context
6510
- * @type {string}
6511
- * @memberof UpdateContextRequest
6512
- */
6513
- 'name': string;
6514
- /**
6515
- * Whether or not the context is modifiable
6516
- * @type {boolean}
6517
- * @memberof UpdateContextRequest
6518
- */
6519
- 'modifiable'?: boolean;
6520
- /**
6521
- * The description of the context
6522
- * @type {string}
6523
- * @memberof UpdateContextRequest
6524
- */
6525
- 'description'?: string;
6526
- /**
6527
- *
6528
- * @type {ContextDetectionParams}
6529
- * @memberof UpdateContextRequest
6530
- */
6531
- 'detection'?: ContextDetectionParams;
6532
- /**
6533
- * The API to use for context detection
6534
- * @type {string}
6535
- * @memberof UpdateContextRequest
6536
- */
6537
- 'detectionApi'?: string;
6538
- /**
6539
- * The ID column of the context
6540
- * @type {string}
6541
- * @memberof UpdateContextRequest
6542
- */
6543
- 'idColumn'?: string;
6544
- /**
6545
- * The columns of the context
6546
- * @type {Array<string>}
6547
- * @memberof UpdateContextRequest
6548
- */
6549
- 'columns'?: Array<string>;
6550
- /**
6551
- * The required columns of the context
6552
- * @type {Array<string>}
6553
- * @memberof UpdateContextRequest
6554
- */
6555
- 'requiredColumns'?: Array<string>;
6556
- /**
6557
- * Whether or not to force NER
6558
- * @type {boolean}
6559
- * @memberof UpdateContextRequest
6560
- */
6561
- 'forceNER'?: boolean;
6562
- /**
6563
- *
6564
- * @type {ContextModel}
6565
- * @memberof UpdateContextRequest
6566
- */
6567
- 'model'?: ContextModel;
6568
- /**
6569
- * The ID of the context to update
6570
- * @type {string}
6571
- * @memberof UpdateContextRequest
6572
- */
6573
- '$id': string;
6574
- }
6575
- /**
6576
- *
6577
- * @export
6578
- * @interface UpdateContextRequestAllOf
6579
- */
6580
- export interface UpdateContextRequestAllOf {
6581
- /**
6582
- * The ID of the context to update
6583
- * @type {string}
6584
- * @memberof UpdateContextRequestAllOf
6585
- */
6586
- '$id': string;
6587
- }
6588
- /**
6589
- *
6590
- * @export
6591
- * @interface UpdateContextResponse
6592
- */
6593
- export interface UpdateContextResponse {
6594
- /**
6595
- *
6596
- * @type {boolean}
6597
- * @memberof UpdateContextResponse
6598
- */
6599
- 'success': boolean;
6600
- /**
6601
- *
6602
- * @type {Error}
6603
- * @memberof UpdateContextResponse
6604
- */
6605
- 'error'?: Error;
6606
- /**
6607
- * The id of the document that was created, updated, or deleted
6608
- * @type {string}
6609
- * @memberof UpdateContextResponse
6610
- */
6611
- 'id': string;
6612
- }
6613
- /**
6614
- *
6615
- * @export
6616
- * @interface UpdateContextsRequest
6617
- */
6618
- export interface UpdateContextsRequest {
6619
- /**
6620
- *
6621
- * @type {Array<ListContextsResponseInner>}
6622
- * @memberof UpdateContextsRequest
6623
- */
6624
- 'contexts'?: Array<ListContextsResponseInner>;
6625
- }
6626
- /**
6627
- *
6628
- * @export
6629
- * @interface UpdateContextsResponse
6630
- */
6631
- export interface UpdateContextsResponse {
6632
- /**
6633
- * ISO 8601 datetime string of when the operation was queued
6634
- * @type {string}
6635
- * @memberof UpdateContextsResponse
6636
- */
6637
- 'queued': string;
6638
- /**
6639
- * The operation id to view the operation end results
6640
- * @type {string}
6641
- * @memberof UpdateContextsResponse
6642
- */
6643
- '$operation': string;
6644
- }
6645
5515
  /**
6646
5516
  *
6647
5517
  * @export
@@ -6822,323 +5692,113 @@ export interface UpdateCustomerRequest {
6822
5692
  * @type {string}
6823
5693
  * @memberof UpdateCustomerRequest
6824
5694
  */
6825
- 'line2'?: string | null;
6826
- /**
6827
- * The customers postal code
6828
- * @type {string}
6829
- * @memberof UpdateCustomerRequest
6830
- */
6831
- 'postal_code'?: string | null;
6832
- /**
6833
- * The customers state, county, province, or region
6834
- * @type {string}
6835
- * @memberof UpdateCustomerRequest
6836
- */
6837
- 'state'?: string | null;
6838
- /**
6839
- * The customers town (only used in Japan)
6840
- * @type {string}
6841
- * @memberof UpdateCustomerRequest
6842
- */
6843
- 'town'?: string | null;
6844
- /**
6845
- *
6846
- * @type {BlockInfo}
6847
- * @memberof UpdateCustomerRequest
6848
- */
6849
- 'blocked'?: BlockInfo;
6850
- /**
6851
- *
6852
- * @type {BlockInfo}
6853
- * @memberof UpdateCustomerRequest
6854
- */
6855
- 'phoneBlocked'?: BlockInfo;
6856
- /**
6857
- *
6858
- * @type {BlockInfo}
6859
- * @memberof UpdateCustomerRequest
6860
- */
6861
- 'emailBlocked'?: BlockInfo;
6862
- /**
6863
- * The date the customer joined the business
6864
- * @type {string}
6865
- * @memberof UpdateCustomerRequest
6866
- */
6867
- 'joined'?: string | null;
6868
- /**
6869
- * The customers stripe ID
6870
- * @type {string}
6871
- * @memberof UpdateCustomerRequest
6872
- */
6873
- 'stripe'?: string | null;
6874
- /**
6875
- * The customers stripe ID in the dev environment
6876
- * @type {string}
6877
- * @memberof UpdateCustomerRequest
6878
- */
6879
- 'stripeDev'?: string | null;
6880
- /**
6881
- * The ID of the customer
6882
- * @type {string}
6883
- * @memberof UpdateCustomerRequest
6884
- */
6885
- '$id': string;
6886
- }
6887
- /**
6888
- *
6889
- * @export
6890
- * @interface UpdateCustomerRequestAllOf
6891
- */
6892
- export interface UpdateCustomerRequestAllOf {
6893
- /**
6894
- * The ID of the customer
6895
- * @type {string}
6896
- * @memberof UpdateCustomerRequestAllOf
6897
- */
6898
- '$id': string;
6899
- }
6900
- /**
6901
- *
6902
- * @export
6903
- * @interface UpdateCustomersRequest
6904
- */
6905
- export interface UpdateCustomersRequest {
6906
- /**
6907
- *
6908
- * @type {Array<ListCustomersResponseInner>}
6909
- * @memberof UpdateCustomersRequest
6910
- */
6911
- 'customers': Array<ListCustomersResponseInner>;
6912
- }
6913
- /**
6914
- *
6915
- * @export
6916
- * @interface UpdateCustomersResponse
6917
- */
6918
- export interface UpdateCustomersResponse {
6919
- /**
6920
- * ISO 8601 datetime string of when the operation was queued
6921
- * @type {string}
6922
- * @memberof UpdateCustomersResponse
6923
- */
6924
- 'queued': string;
6925
- /**
6926
- * The operation id to view the operation end results
6927
- * @type {string}
6928
- * @memberof UpdateCustomersResponse
6929
- */
6930
- '$operation': string;
6931
- }
6932
- /**
6933
- *
6934
- * @export
6935
- * @interface UpdateWorkflowRequest
6936
- */
6937
- export interface UpdateWorkflowRequest {
5695
+ 'line2'?: string | null;
6938
5696
  /**
6939
- * The ID of the workflow to update
5697
+ * The customers postal code
6940
5698
  * @type {string}
6941
- * @memberof UpdateWorkflowRequest
5699
+ * @memberof UpdateCustomerRequest
6942
5700
  */
6943
- '$id': string;
5701
+ 'postal_code'?: string | null;
6944
5702
  /**
6945
- *
6946
- * @type {PurposeEnum}
6947
- * @memberof UpdateWorkflowRequest
5703
+ * The customers state, county, province, or region
5704
+ * @type {string}
5705
+ * @memberof UpdateCustomerRequest
6948
5706
  */
6949
- 'purpose'?: PurposeEnum;
5707
+ 'state'?: string | null;
6950
5708
  /**
6951
- * The name of the workflow
5709
+ * The customers town (only used in Japan)
6952
5710
  * @type {string}
6953
- * @memberof UpdateWorkflowRequest
5711
+ * @memberof UpdateCustomerRequest
6954
5712
  */
6955
- 'name'?: string;
5713
+ 'town'?: string | null;
6956
5714
  /**
6957
5715
  *
6958
- * @type {ContextDetectionParams}
6959
- * @memberof UpdateWorkflowRequest
6960
- */
6961
- 'initiators'?: ContextDetectionParams;
6962
- /**
6963
- * The fields of the workflow
6964
- * @type {Array<ConversationContextField>}
6965
- * @memberof UpdateWorkflowRequest
5716
+ * @type {BlockInfo}
5717
+ * @memberof UpdateCustomerRequest
6966
5718
  */
6967
- 'fields'?: Array<ConversationContextField>;
5719
+ 'blocked'?: BlockInfo;
6968
5720
  /**
6969
- * About this conversation - used as initial context
6970
- * @type {string}
6971
- * @memberof UpdateWorkflowRequest
5721
+ *
5722
+ * @type {BlockInfo}
5723
+ * @memberof UpdateCustomerRequest
6972
5724
  */
6973
- 'context'?: string;
5725
+ 'phoneBlocked'?: BlockInfo;
6974
5726
  /**
6975
- * The webhook to call when a workflow is created
6976
- * @type {string}
6977
- * @memberof UpdateWorkflowRequest
5727
+ *
5728
+ * @type {BlockInfo}
5729
+ * @memberof UpdateCustomerRequest
6978
5730
  */
6979
- 'onCreated'?: string;
5731
+ 'emailBlocked'?: BlockInfo;
6980
5732
  /**
6981
- * The webhook to call when a workflow is updated
5733
+ * The date the customer joined the business
6982
5734
  * @type {string}
6983
- * @memberof UpdateWorkflowRequest
5735
+ * @memberof UpdateCustomerRequest
6984
5736
  */
6985
- 'onUpdated'?: string;
5737
+ 'joined'?: string | null;
6986
5738
  /**
6987
- * The webhook to call when a workflow is deleted
5739
+ * The customers stripe ID
6988
5740
  * @type {string}
6989
- * @memberof UpdateWorkflowRequest
5741
+ * @memberof UpdateCustomerRequest
6990
5742
  */
6991
- 'onDeleted'?: string;
5743
+ 'stripe'?: string | null;
6992
5744
  /**
6993
- * The webhook to call when a workflow has an error
5745
+ * The customers stripe ID in the dev environment
6994
5746
  * @type {string}
6995
- * @memberof UpdateWorkflowRequest
6996
- */
6997
- 'onError'?: string;
6998
- /**
6999
- * The priority of the workflow in relation to other workflows (determines activation order)
7000
- * @type {number}
7001
- * @memberof UpdateWorkflowRequest
5747
+ * @memberof UpdateCustomerRequest
7002
5748
  */
7003
- 'priority'?: number;
7004
- }
7005
- /**
7006
- *
7007
- * @export
7008
- * @interface UpdateWorkflowRequestAllOf
7009
- */
7010
- export interface UpdateWorkflowRequestAllOf {
5749
+ 'stripeDev'?: string | null;
7011
5750
  /**
7012
- * The ID of the workflow to update
5751
+ * The ID of the customer
7013
5752
  * @type {string}
7014
- * @memberof UpdateWorkflowRequestAllOf
5753
+ * @memberof UpdateCustomerRequest
7015
5754
  */
7016
5755
  '$id': string;
7017
5756
  }
7018
5757
  /**
7019
5758
  *
7020
5759
  * @export
7021
- * @interface UpdateWorkflowResponse
5760
+ * @interface UpdateCustomerRequestAllOf
7022
5761
  */
7023
- export interface UpdateWorkflowResponse {
7024
- /**
7025
- *
7026
- * @type {boolean}
7027
- * @memberof UpdateWorkflowResponse
7028
- */
7029
- 'success': boolean;
7030
- /**
7031
- *
7032
- * @type {Error}
7033
- * @memberof UpdateWorkflowResponse
7034
- */
7035
- 'error'?: Error;
5762
+ export interface UpdateCustomerRequestAllOf {
7036
5763
  /**
7037
- * The id of the document that was created, updated, or deleted
5764
+ * The ID of the customer
7038
5765
  * @type {string}
7039
- * @memberof UpdateWorkflowResponse
5766
+ * @memberof UpdateCustomerRequestAllOf
7040
5767
  */
7041
- 'id': string;
5768
+ '$id': string;
7042
5769
  }
7043
5770
  /**
7044
5771
  *
7045
5772
  * @export
7046
- * @interface UpdateWorkflowsRequest
5773
+ * @interface UpdateCustomersRequest
7047
5774
  */
7048
- export interface UpdateWorkflowsRequest {
5775
+ export interface UpdateCustomersRequest {
7049
5776
  /**
7050
5777
  *
7051
- * @type {Array<ListWorkflowsResponseInner>}
7052
- * @memberof UpdateWorkflowsRequest
5778
+ * @type {Array<ListCustomersResponseInner>}
5779
+ * @memberof UpdateCustomersRequest
7053
5780
  */
7054
- 'workflows'?: Array<ListWorkflowsResponseInner>;
5781
+ 'customers': Array<ListCustomersResponseInner>;
7055
5782
  }
7056
5783
  /**
7057
5784
  *
7058
5785
  * @export
7059
- * @interface UpdateWorkflowsResponse
5786
+ * @interface UpdateCustomersResponse
7060
5787
  */
7061
- export interface UpdateWorkflowsResponse {
5788
+ export interface UpdateCustomersResponse {
7062
5789
  /**
7063
5790
  * ISO 8601 datetime string of when the operation was queued
7064
5791
  * @type {string}
7065
- * @memberof UpdateWorkflowsResponse
5792
+ * @memberof UpdateCustomersResponse
7066
5793
  */
7067
5794
  'queued': string;
7068
5795
  /**
7069
5796
  * The operation id to view the operation end results
7070
5797
  * @type {string}
7071
- * @memberof UpdateWorkflowsResponse
5798
+ * @memberof UpdateCustomersResponse
7072
5799
  */
7073
5800
  '$operation': string;
7074
5801
  }
7075
- /**
7076
- *
7077
- * @export
7078
- * @interface Workflow
7079
- */
7080
- export interface Workflow {
7081
- /**
7082
- *
7083
- * @type {PurposeEnum}
7084
- * @memberof Workflow
7085
- */
7086
- 'purpose'?: PurposeEnum;
7087
- /**
7088
- * The name of the workflow
7089
- * @type {string}
7090
- * @memberof Workflow
7091
- */
7092
- 'name': string;
7093
- /**
7094
- *
7095
- * @type {ContextDetectionParams}
7096
- * @memberof Workflow
7097
- */
7098
- 'initiators': ContextDetectionParams;
7099
- /**
7100
- * The fields of the workflow
7101
- * @type {Array<ConversationContextField>}
7102
- * @memberof Workflow
7103
- */
7104
- 'fields': Array<ConversationContextField>;
7105
- /**
7106
- * About this conversation - used as initial context
7107
- * @type {string}
7108
- * @memberof Workflow
7109
- */
7110
- 'context': string;
7111
- /**
7112
- * The webhook to call when a workflow is created
7113
- * @type {string}
7114
- * @memberof Workflow
7115
- */
7116
- 'onCreated'?: string;
7117
- /**
7118
- * The webhook to call when a workflow is updated
7119
- * @type {string}
7120
- * @memberof Workflow
7121
- */
7122
- 'onUpdated'?: string;
7123
- /**
7124
- * The webhook to call when a workflow is deleted
7125
- * @type {string}
7126
- * @memberof Workflow
7127
- */
7128
- 'onDeleted'?: string;
7129
- /**
7130
- * The webhook to call when a workflow has an error
7131
- * @type {string}
7132
- * @memberof Workflow
7133
- */
7134
- 'onError'?: string;
7135
- /**
7136
- * The priority of the workflow in relation to other workflows (determines activation order)
7137
- * @type {number}
7138
- * @memberof Workflow
7139
- */
7140
- 'priority': number;
7141
- }
7142
5802
  /**
7143
5803
  *
7144
5804
  * @export
@@ -7196,73 +5856,6 @@ export interface WorkflowEvent {
7196
5856
  */
7197
5857
  'stagnationCount': number;
7198
5858
  }
7199
- /**
7200
- *
7201
- * @export
7202
- * @interface WorkflowPartial
7203
- */
7204
- export interface WorkflowPartial {
7205
- /**
7206
- *
7207
- * @type {PurposeEnum}
7208
- * @memberof WorkflowPartial
7209
- */
7210
- 'purpose'?: PurposeEnum;
7211
- /**
7212
- * The name of the workflow
7213
- * @type {string}
7214
- * @memberof WorkflowPartial
7215
- */
7216
- 'name'?: string;
7217
- /**
7218
- *
7219
- * @type {ContextDetectionParams}
7220
- * @memberof WorkflowPartial
7221
- */
7222
- 'initiators'?: ContextDetectionParams;
7223
- /**
7224
- * The fields of the workflow
7225
- * @type {Array<ConversationContextField>}
7226
- * @memberof WorkflowPartial
7227
- */
7228
- 'fields'?: Array<ConversationContextField>;
7229
- /**
7230
- * About this conversation - used as initial context
7231
- * @type {string}
7232
- * @memberof WorkflowPartial
7233
- */
7234
- 'context'?: string;
7235
- /**
7236
- * The webhook to call when a workflow is created
7237
- * @type {string}
7238
- * @memberof WorkflowPartial
7239
- */
7240
- 'onCreated'?: string;
7241
- /**
7242
- * The webhook to call when a workflow is updated
7243
- * @type {string}
7244
- * @memberof WorkflowPartial
7245
- */
7246
- 'onUpdated'?: string;
7247
- /**
7248
- * The webhook to call when a workflow is deleted
7249
- * @type {string}
7250
- * @memberof WorkflowPartial
7251
- */
7252
- 'onDeleted'?: string;
7253
- /**
7254
- * The webhook to call when a workflow has an error
7255
- * @type {string}
7256
- * @memberof WorkflowPartial
7257
- */
7258
- 'onError'?: string;
7259
- /**
7260
- * The priority of the workflow in relation to other workflows (determines activation order)
7261
- * @type {number}
7262
- * @memberof WorkflowPartial
7263
- */
7264
- 'priority'?: number;
7265
- }
7266
5859
  /**
7267
5860
  * @type WorkflowResponse
7268
5861
  * @export
@@ -7357,65 +5950,6 @@ export type WorkflowResponseSlotForwardOneOfModeEnum = typeof WorkflowResponseSl
7357
5950
  * @export
7358
5951
  */
7359
5952
  export type WorkflowResponseSlotInstructions = Array<Instruction> | Array<string> | Instruction | string;
7360
- /**
7361
- * CustomContextApi - axios parameter creator
7362
- * @export
7363
- */
7364
- export declare const CustomContextApiAxiosParamCreator: (configuration?: Configuration) => {
7365
- /**
7366
- *
7367
- * @summary Test a custom context before training
7368
- * @param {ContextTestRequest} contextTestRequest
7369
- * @param {*} [options] Override http request option.
7370
- * @throws {RequiredError}
7371
- */
7372
- contextTest: (contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7373
- };
7374
- /**
7375
- * CustomContextApi - functional programming interface
7376
- * @export
7377
- */
7378
- export declare const CustomContextApiFp: (configuration?: Configuration) => {
7379
- /**
7380
- *
7381
- * @summary Test a custom context before training
7382
- * @param {ContextTestRequest} contextTestRequest
7383
- * @param {*} [options] Override http request option.
7384
- * @throws {RequiredError}
7385
- */
7386
- contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextTestResponse>>;
7387
- };
7388
- /**
7389
- * CustomContextApi - factory interface
7390
- * @export
7391
- */
7392
- export declare const CustomContextApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7393
- /**
7394
- *
7395
- * @summary Test a custom context before training
7396
- * @param {ContextTestRequest} contextTestRequest
7397
- * @param {*} [options] Override http request option.
7398
- * @throws {RequiredError}
7399
- */
7400
- contextTest(contextTestRequest: ContextTestRequest, options?: any): AxiosPromise<ContextTestResponse>;
7401
- };
7402
- /**
7403
- * CustomContextApi - object-oriented interface
7404
- * @export
7405
- * @class CustomContextApi
7406
- * @extends {BaseAPI}
7407
- */
7408
- export declare class CustomContextApi extends BaseAPI {
7409
- /**
7410
- *
7411
- * @summary Test a custom context before training
7412
- * @param {ContextTestRequest} contextTestRequest
7413
- * @param {*} [options] Override http request option.
7414
- * @throws {RequiredError}
7415
- * @memberof CustomContextApi
7416
- */
7417
- contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
7418
- }
7419
5953
  /**
7420
5954
  * Scout9Api - axios parameter creator
7421
5955
  * @export
@@ -7510,128 +6044,31 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
7510
6044
  * @param {*} [options] Override http request option.
7511
6045
  * @throws {RequiredError}
7512
6046
  */
7513
- config: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
7514
- /**
7515
- *
7516
- * @summary Gets a context. Don\'t use, create your context entities within your Scout9 application.
7517
- * @param {string} id id of entity to query
7518
- * @param {*} [options] Override http request option.
7519
- * @deprecated
7520
- * @throws {RequiredError}
7521
- */
7522
- context: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7523
- /**
7524
- *
7525
- * @summary Create a new context. Don\'t use, create your context entities within your Scout9 application.
7526
- * @param {CreateContextRequest} createContextRequest
7527
- * @param {*} [options] Override http request option.
7528
- * @deprecated
7529
- * @throws {RequiredError}
7530
- */
7531
- contextCreate: (createContextRequest: CreateContextRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7532
- /**
7533
- *
7534
- * @summary Gets context data
7535
- * @param {string} id id of entity to query
7536
- * @param {*} [options] Override http request option.
7537
- * @throws {RequiredError}
7538
- */
7539
- contextData: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7540
- /**
7541
- *
7542
- * @summary Create a new context data
7543
- * @param {CreateContextDataRequest} createContextDataRequest
7544
- * @param {*} [options] Override http request option.
7545
- * @throws {RequiredError}
7546
- */
7547
- contextDataCreate: (createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7548
- /**
7549
- *
7550
- * @summary Deletes a schedule
7551
- * @param {string} id id of entity to query
7552
- * @param {*} [options] Override http request option.
7553
- * @throws {RequiredError}
7554
- */
7555
- contextDataDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7556
- /**
7557
- *
7558
- * @summary Update a context data
7559
- * @param {UpdateContextDataRequest} updateContextDataRequest
7560
- * @param {*} [options] Override http request option.
7561
- * @throws {RequiredError}
7562
- */
7563
- contextDataUpdate: (updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7564
- /**
7565
- *
7566
- * @summary Deletes a context entity. Don\'t use, create your context entities within your Scout9 application.
7567
- * @param {string} id id of entity to query
7568
- * @param {*} [options] Override http request option.
7569
- * @deprecated
7570
- * @throws {RequiredError}
7571
- */
7572
- contextDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7573
- /**
7574
- *
7575
- * @summary Test a custom context before training
7576
- * @param {ContextTestRequest} contextTestRequest
7577
- * @param {*} [options] Override http request option.
7578
- * @throws {RequiredError}
7579
- */
7580
- contextTest: (contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7581
- /**
7582
- * Update a context. . Don\'t use, create your context entities within your Scout9 application.
7583
- * @summary Update a context
7584
- * @param {UpdateContextRequest} updateContextRequest
7585
- * @param {*} [options] Override http request option.
7586
- * @deprecated
7587
- * @throws {RequiredError}
7588
- */
7589
- contextUpdate: (updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7590
- /**
7591
- *
7592
- * @summary Gets all or specific set of contexts. Don\'t use, create your context entities within your Scout9 application.
7593
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7594
- * @param {Array<string>} [id] ids for the entities this id belongs to
7595
- * @param {*} [options] Override http request option.
7596
- * @deprecated
7597
- * @throws {RequiredError}
7598
- */
7599
- contexts: (q?: string, id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7600
- /**
7601
- *
7602
- * @summary Creates new contexts. Don\'t use, create your context entities within your Scout9 application.
7603
- * @param {CreateContextsRequest} createContextsRequest
7604
- * @param {*} [options] Override http request option.
7605
- * @deprecated
7606
- * @throws {RequiredError}
7607
- */
7608
- contextsCreate: (createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6047
+ config: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
7609
6048
  /**
7610
6049
  *
7611
- * @summary Deletes multiple contexts. Don\'t use, create your context entities within your Scout9 application.
7612
- * @param {Array<string>} [id] ids for the entities this id belongs to
6050
+ * @summary Gets a conversation
6051
+ * @param {string} id id of entity to query
7613
6052
  * @param {*} [options] Override http request option.
7614
- * @deprecated
7615
6053
  * @throws {RequiredError}
7616
6054
  */
7617
- contextsDelete: (id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6055
+ conversation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7618
6056
  /**
7619
6057
  *
7620
- * @summary Updates multiple contexts. Don\'t use, create your context entities within your Scout9 application.
7621
- * @param {UpdateContextRequest} updateContextRequest
6058
+ * @summary Gets a conversation
6059
+ * @param {string} id id of entity to query
7622
6060
  * @param {*} [options] Override http request option.
7623
- * @deprecated
7624
6061
  * @throws {RequiredError}
7625
6062
  */
7626
- contextsUpdate: (updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6063
+ conversationContext: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7627
6064
  /**
7628
6065
  *
7629
- * @summary Gets a conversation
7630
- * @param {string} id id of entity to query
6066
+ * @summary Update a conversation
6067
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
7631
6068
  * @param {*} [options] Override http request option.
7632
6069
  * @throws {RequiredError}
7633
6070
  */
7634
- conversation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6071
+ conversationContextUpdate: (conversationContextUpdateRequest: ConversationContextUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7635
6072
  /**
7636
6073
  *
7637
6074
  * @summary Create a new conversation
@@ -7668,11 +6105,11 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
7668
6105
  /**
7669
6106
  *
7670
6107
  * @summary Gets a customer
7671
- * @param {string} id id of entity to query
6108
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
7672
6109
  * @param {*} [options] Override http request option.
7673
6110
  * @throws {RequiredError}
7674
6111
  */
7675
- customer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6112
+ customer: (idOrEmailOrPhone: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
7676
6113
  /**
7677
6114
  *
7678
6115
  * @summary Creates a new customer
@@ -8078,125 +6515,30 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
8078
6515
  config(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Config200Response>>;
8079
6516
  /**
8080
6517
  *
8081
- * @summary Gets a context. Don\'t use, create your context entities within your Scout9 application.
8082
- * @param {string} id id of entity to query
8083
- * @param {*} [options] Override http request option.
8084
- * @deprecated
8085
- * @throws {RequiredError}
8086
- */
8087
- context(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContextResponse>>;
8088
- /**
8089
- *
8090
- * @summary Create a new context. Don\'t use, create your context entities within your Scout9 application.
8091
- * @param {CreateContextRequest} createContextRequest
8092
- * @param {*} [options] Override http request option.
8093
- * @deprecated
8094
- * @throws {RequiredError}
8095
- */
8096
- contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateContextResponse>>;
8097
- /**
8098
- *
8099
- * @summary Gets context data
8100
- * @param {string} id id of entity to query
8101
- * @param {*} [options] Override http request option.
8102
- * @throws {RequiredError}
8103
- */
8104
- contextData(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContextDataResponse>>;
8105
- /**
8106
- *
8107
- * @summary Create a new context data
8108
- * @param {CreateContextDataRequest} createContextDataRequest
8109
- * @param {*} [options] Override http request option.
8110
- * @throws {RequiredError}
8111
- */
8112
- contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateContextDataResponse>>;
8113
- /**
8114
- *
8115
- * @summary Deletes a schedule
6518
+ * @summary Gets a conversation
8116
6519
  * @param {string} id id of entity to query
8117
6520
  * @param {*} [options] Override http request option.
8118
6521
  * @throws {RequiredError}
8119
6522
  */
8120
- contextDataDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteContextDataResponse>>;
8121
- /**
8122
- *
8123
- * @summary Update a context data
8124
- * @param {UpdateContextDataRequest} updateContextDataRequest
8125
- * @param {*} [options] Override http request option.
8126
- * @throws {RequiredError}
8127
- */
8128
- contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateContextDataResponse>>;
6523
+ conversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConversationGetResponse>>;
8129
6524
  /**
8130
6525
  *
8131
- * @summary Deletes a context entity. Don\'t use, create your context entities within your Scout9 application.
6526
+ * @summary Gets a conversation
8132
6527
  * @param {string} id id of entity to query
8133
6528
  * @param {*} [options] Override http request option.
8134
- * @deprecated
8135
- * @throws {RequiredError}
8136
- */
8137
- contextDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteContextResponse>>;
8138
- /**
8139
- *
8140
- * @summary Test a custom context before training
8141
- * @param {ContextTestRequest} contextTestRequest
8142
- * @param {*} [options] Override http request option.
8143
- * @throws {RequiredError}
8144
- */
8145
- contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextTestResponse>>;
8146
- /**
8147
- * Update a context. . Don\'t use, create your context entities within your Scout9 application.
8148
- * @summary Update a context
8149
- * @param {UpdateContextRequest} updateContextRequest
8150
- * @param {*} [options] Override http request option.
8151
- * @deprecated
8152
- * @throws {RequiredError}
8153
- */
8154
- contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateContextResponse>>;
8155
- /**
8156
- *
8157
- * @summary Gets all or specific set of contexts. Don\'t use, create your context entities within your Scout9 application.
8158
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8159
- * @param {Array<string>} [id] ids for the entities this id belongs to
8160
- * @param {*} [options] Override http request option.
8161
- * @deprecated
8162
- * @throws {RequiredError}
8163
- */
8164
- contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListContextsResponseInner>>>;
8165
- /**
8166
- *
8167
- * @summary Creates new contexts. Don\'t use, create your context entities within your Scout9 application.
8168
- * @param {CreateContextsRequest} createContextsRequest
8169
- * @param {*} [options] Override http request option.
8170
- * @deprecated
8171
- * @throws {RequiredError}
8172
- */
8173
- contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateContextsResponse>>;
8174
- /**
8175
- *
8176
- * @summary Deletes multiple contexts. Don\'t use, create your context entities within your Scout9 application.
8177
- * @param {Array<string>} [id] ids for the entities this id belongs to
8178
- * @param {*} [options] Override http request option.
8179
- * @deprecated
8180
- * @throws {RequiredError}
8181
- */
8182
- contextsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteContextsResponse>>;
8183
- /**
8184
- *
8185
- * @summary Updates multiple contexts. Don\'t use, create your context entities within your Scout9 application.
8186
- * @param {UpdateContextRequest} updateContextRequest
8187
- * @param {*} [options] Override http request option.
8188
- * @deprecated
8189
6529
  * @throws {RequiredError}
8190
6530
  */
8191
- contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateContextsResponse>>;
6531
+ conversationContext(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
6532
+ [key: string]: ConversationContextValue;
6533
+ }>>;
8192
6534
  /**
8193
6535
  *
8194
- * @summary Gets a conversation
8195
- * @param {string} id id of entity to query
6536
+ * @summary Update a conversation
6537
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
8196
6538
  * @param {*} [options] Override http request option.
8197
6539
  * @throws {RequiredError}
8198
6540
  */
8199
- conversation(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConversationGetResponse>>;
6541
+ conversationContextUpdate(conversationContextUpdateRequest: ConversationContextUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConversationUpdateResponse>>;
8200
6542
  /**
8201
6543
  *
8202
6544
  * @summary Create a new conversation
@@ -8233,11 +6575,11 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
8233
6575
  /**
8234
6576
  *
8235
6577
  * @summary Gets a customer
8236
- * @param {string} id id of entity to query
6578
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
8237
6579
  * @param {*} [options] Override http request option.
8238
6580
  * @throws {RequiredError}
8239
6581
  */
8240
- customer(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponse>>;
6582
+ customer(idOrEmailOrPhone: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponse>>;
8241
6583
  /**
8242
6584
  *
8243
6585
  * @summary Creates a new customer
@@ -8645,125 +6987,30 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
8645
6987
  config(options?: any): AxiosPromise<Config200Response>;
8646
6988
  /**
8647
6989
  *
8648
- * @summary Gets a context. Don\'t use, create your context entities within your Scout9 application.
8649
- * @param {string} id id of entity to query
8650
- * @param {*} [options] Override http request option.
8651
- * @deprecated
8652
- * @throws {RequiredError}
8653
- */
8654
- context(id: string, options?: any): AxiosPromise<GetContextResponse>;
8655
- /**
8656
- *
8657
- * @summary Create a new context. Don\'t use, create your context entities within your Scout9 application.
8658
- * @param {CreateContextRequest} createContextRequest
8659
- * @param {*} [options] Override http request option.
8660
- * @deprecated
8661
- * @throws {RequiredError}
8662
- */
8663
- contextCreate(createContextRequest: CreateContextRequest, options?: any): AxiosPromise<CreateContextResponse>;
8664
- /**
8665
- *
8666
- * @summary Gets context data
8667
- * @param {string} id id of entity to query
8668
- * @param {*} [options] Override http request option.
8669
- * @throws {RequiredError}
8670
- */
8671
- contextData(id: string, options?: any): AxiosPromise<GetContextDataResponse>;
8672
- /**
8673
- *
8674
- * @summary Create a new context data
8675
- * @param {CreateContextDataRequest} createContextDataRequest
8676
- * @param {*} [options] Override http request option.
8677
- * @throws {RequiredError}
8678
- */
8679
- contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: any): AxiosPromise<CreateContextDataResponse>;
8680
- /**
8681
- *
8682
- * @summary Deletes a schedule
6990
+ * @summary Gets a conversation
8683
6991
  * @param {string} id id of entity to query
8684
6992
  * @param {*} [options] Override http request option.
8685
6993
  * @throws {RequiredError}
8686
6994
  */
8687
- contextDataDelete(id: string, options?: any): AxiosPromise<DeleteContextDataResponse>;
8688
- /**
8689
- *
8690
- * @summary Update a context data
8691
- * @param {UpdateContextDataRequest} updateContextDataRequest
8692
- * @param {*} [options] Override http request option.
8693
- * @throws {RequiredError}
8694
- */
8695
- contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: any): AxiosPromise<UpdateContextDataResponse>;
6995
+ conversation(id: string, options?: any): AxiosPromise<ConversationGetResponse>;
8696
6996
  /**
8697
6997
  *
8698
- * @summary Deletes a context entity. Don\'t use, create your context entities within your Scout9 application.
6998
+ * @summary Gets a conversation
8699
6999
  * @param {string} id id of entity to query
8700
7000
  * @param {*} [options] Override http request option.
8701
- * @deprecated
8702
- * @throws {RequiredError}
8703
- */
8704
- contextDelete(id: string, options?: any): AxiosPromise<DeleteContextResponse>;
8705
- /**
8706
- *
8707
- * @summary Test a custom context before training
8708
- * @param {ContextTestRequest} contextTestRequest
8709
- * @param {*} [options] Override http request option.
8710
- * @throws {RequiredError}
8711
- */
8712
- contextTest(contextTestRequest: ContextTestRequest, options?: any): AxiosPromise<ContextTestResponse>;
8713
- /**
8714
- * Update a context. . Don\'t use, create your context entities within your Scout9 application.
8715
- * @summary Update a context
8716
- * @param {UpdateContextRequest} updateContextRequest
8717
- * @param {*} [options] Override http request option.
8718
- * @deprecated
8719
- * @throws {RequiredError}
8720
- */
8721
- contextUpdate(updateContextRequest: UpdateContextRequest, options?: any): AxiosPromise<UpdateContextResponse>;
8722
- /**
8723
- *
8724
- * @summary Gets all or specific set of contexts. Don\'t use, create your context entities within your Scout9 application.
8725
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8726
- * @param {Array<string>} [id] ids for the entities this id belongs to
8727
- * @param {*} [options] Override http request option.
8728
- * @deprecated
8729
- * @throws {RequiredError}
8730
- */
8731
- contexts(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<ListContextsResponseInner>>;
8732
- /**
8733
- *
8734
- * @summary Creates new contexts. Don\'t use, create your context entities within your Scout9 application.
8735
- * @param {CreateContextsRequest} createContextsRequest
8736
- * @param {*} [options] Override http request option.
8737
- * @deprecated
8738
- * @throws {RequiredError}
8739
- */
8740
- contextsCreate(createContextsRequest: CreateContextsRequest, options?: any): AxiosPromise<CreateContextsResponse>;
8741
- /**
8742
- *
8743
- * @summary Deletes multiple contexts. Don\'t use, create your context entities within your Scout9 application.
8744
- * @param {Array<string>} [id] ids for the entities this id belongs to
8745
- * @param {*} [options] Override http request option.
8746
- * @deprecated
8747
- * @throws {RequiredError}
8748
- */
8749
- contextsDelete(id?: Array<string>, options?: any): AxiosPromise<DeleteContextsResponse>;
8750
- /**
8751
- *
8752
- * @summary Updates multiple contexts. Don\'t use, create your context entities within your Scout9 application.
8753
- * @param {UpdateContextRequest} updateContextRequest
8754
- * @param {*} [options] Override http request option.
8755
- * @deprecated
8756
7001
  * @throws {RequiredError}
8757
7002
  */
8758
- contextsUpdate(updateContextRequest: UpdateContextRequest, options?: any): AxiosPromise<UpdateContextsResponse>;
7003
+ conversationContext(id: string, options?: any): AxiosPromise<{
7004
+ [key: string]: ConversationContextValue;
7005
+ }>;
8759
7006
  /**
8760
7007
  *
8761
- * @summary Gets a conversation
8762
- * @param {string} id id of entity to query
7008
+ * @summary Update a conversation
7009
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
8763
7010
  * @param {*} [options] Override http request option.
8764
7011
  * @throws {RequiredError}
8765
7012
  */
8766
- conversation(id: string, options?: any): AxiosPromise<ConversationGetResponse>;
7013
+ conversationContextUpdate(conversationContextUpdateRequest: ConversationContextUpdateRequest, options?: any): AxiosPromise<ConversationUpdateResponse>;
8767
7014
  /**
8768
7015
  *
8769
7016
  * @summary Create a new conversation
@@ -8800,11 +7047,11 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
8800
7047
  /**
8801
7048
  *
8802
7049
  * @summary Gets a customer
8803
- * @param {string} id id of entity to query
7050
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
8804
7051
  * @param {*} [options] Override http request option.
8805
7052
  * @throws {RequiredError}
8806
7053
  */
8807
- customer(id: string, options?: any): AxiosPromise<GetCustomerResponse>;
7054
+ customer(idOrEmailOrPhone: string, options?: any): AxiosPromise<GetCustomerResponse>;
8808
7055
  /**
8809
7056
  *
8810
7057
  * @summary Creates a new customer
@@ -9225,139 +7472,33 @@ export declare class Scout9ApiGenerated extends BaseAPI {
9225
7472
  config(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Config200Response, any>>;
9226
7473
  /**
9227
7474
  *
9228
- * @summary Gets a context. Don\'t use, create your context entities within your Scout9 application.
9229
- * @param {string} id id of entity to query
9230
- * @param {*} [options] Override http request option.
9231
- * @deprecated
9232
- * @throws {RequiredError}
9233
- * @memberof Scout9Api
9234
- */
9235
- context(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextResponse, any>>;
9236
- /**
9237
- *
9238
- * @summary Create a new context. Don\'t use, create your context entities within your Scout9 application.
9239
- * @param {CreateContextRequest} createContextRequest
9240
- * @param {*} [options] Override http request option.
9241
- * @deprecated
9242
- * @throws {RequiredError}
9243
- * @memberof Scout9Api
9244
- */
9245
- contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextResponse, any>>;
9246
- /**
9247
- *
9248
- * @summary Gets context data
9249
- * @param {string} id id of entity to query
9250
- * @param {*} [options] Override http request option.
9251
- * @throws {RequiredError}
9252
- * @memberof Scout9Api
9253
- */
9254
- contextData(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextDataResponse, any>>;
9255
- /**
9256
- *
9257
- * @summary Create a new context data
9258
- * @param {CreateContextDataRequest} createContextDataRequest
9259
- * @param {*} [options] Override http request option.
9260
- * @throws {RequiredError}
9261
- * @memberof Scout9Api
9262
- */
9263
- contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextDataResponse, any>>;
9264
- /**
9265
- *
9266
- * @summary Deletes a schedule
7475
+ * @summary Gets a conversation
9267
7476
  * @param {string} id id of entity to query
9268
7477
  * @param {*} [options] Override http request option.
9269
7478
  * @throws {RequiredError}
9270
7479
  * @memberof Scout9Api
9271
7480
  */
9272
- contextDataDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextDataResponse, any>>;
9273
- /**
9274
- *
9275
- * @summary Update a context data
9276
- * @param {UpdateContextDataRequest} updateContextDataRequest
9277
- * @param {*} [options] Override http request option.
9278
- * @throws {RequiredError}
9279
- * @memberof Scout9Api
9280
- */
9281
- contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextDataResponse, any>>;
7481
+ conversation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationGetResponse, any>>;
9282
7482
  /**
9283
7483
  *
9284
- * @summary Deletes a context entity. Don\'t use, create your context entities within your Scout9 application.
7484
+ * @summary Gets a conversation
9285
7485
  * @param {string} id id of entity to query
9286
7486
  * @param {*} [options] Override http request option.
9287
- * @deprecated
9288
- * @throws {RequiredError}
9289
- * @memberof Scout9Api
9290
- */
9291
- contextDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextResponse, any>>;
9292
- /**
9293
- *
9294
- * @summary Test a custom context before training
9295
- * @param {ContextTestRequest} contextTestRequest
9296
- * @param {*} [options] Override http request option.
9297
- * @throws {RequiredError}
9298
- * @memberof Scout9Api
9299
- */
9300
- contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
9301
- /**
9302
- * Update a context. . Don\'t use, create your context entities within your Scout9 application.
9303
- * @summary Update a context
9304
- * @param {UpdateContextRequest} updateContextRequest
9305
- * @param {*} [options] Override http request option.
9306
- * @deprecated
9307
- * @throws {RequiredError}
9308
- * @memberof Scout9Api
9309
- */
9310
- contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextResponse, any>>;
9311
- /**
9312
- *
9313
- * @summary Gets all or specific set of contexts. Don\'t use, create your context entities within your Scout9 application.
9314
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
9315
- * @param {Array<string>} [id] ids for the entities this id belongs to
9316
- * @param {*} [options] Override http request option.
9317
- * @deprecated
9318
- * @throws {RequiredError}
9319
- * @memberof Scout9Api
9320
- */
9321
- contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListContextsResponseInner[], any>>;
9322
- /**
9323
- *
9324
- * @summary Creates new contexts. Don\'t use, create your context entities within your Scout9 application.
9325
- * @param {CreateContextsRequest} createContextsRequest
9326
- * @param {*} [options] Override http request option.
9327
- * @deprecated
9328
- * @throws {RequiredError}
9329
- * @memberof Scout9Api
9330
- */
9331
- contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextsResponse, any>>;
9332
- /**
9333
- *
9334
- * @summary Deletes multiple contexts. Don\'t use, create your context entities within your Scout9 application.
9335
- * @param {Array<string>} [id] ids for the entities this id belongs to
9336
- * @param {*} [options] Override http request option.
9337
- * @deprecated
9338
- * @throws {RequiredError}
9339
- * @memberof Scout9Api
9340
- */
9341
- contextsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextsResponse, any>>;
9342
- /**
9343
- *
9344
- * @summary Updates multiple contexts. Don\'t use, create your context entities within your Scout9 application.
9345
- * @param {UpdateContextRequest} updateContextRequest
9346
- * @param {*} [options] Override http request option.
9347
- * @deprecated
9348
7487
  * @throws {RequiredError}
9349
7488
  * @memberof Scout9Api
9350
7489
  */
9351
- contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextsResponse, any>>;
7490
+ conversationContext(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
7491
+ [key: string]: ConversationContextValue;
7492
+ }, any>>;
9352
7493
  /**
9353
7494
  *
9354
- * @summary Gets a conversation
9355
- * @param {string} id id of entity to query
7495
+ * @summary Update a conversation
7496
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
9356
7497
  * @param {*} [options] Override http request option.
9357
7498
  * @throws {RequiredError}
9358
7499
  * @memberof Scout9Api
9359
7500
  */
9360
- conversation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationGetResponse, any>>;
7501
+ conversationContextUpdate(conversationContextUpdateRequest: ConversationContextUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationUpdateResponse, any>>;
9361
7502
  /**
9362
7503
  *
9363
7504
  * @summary Create a new conversation
@@ -9398,12 +7539,12 @@ export declare class Scout9ApiGenerated extends BaseAPI {
9398
7539
  /**
9399
7540
  *
9400
7541
  * @summary Gets a customer
9401
- * @param {string} id id of entity to query
7542
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
9402
7543
  * @param {*} [options] Override http request option.
9403
7544
  * @throws {RequiredError}
9404
7545
  * @memberof Scout9Api
9405
7546
  */
9406
- customer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponse, any>>;
7547
+ customer(idOrEmailOrPhone: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponse, any>>;
9407
7548
  /**
9408
7549
  *
9409
7550
  * @summary Creates a new customer