@scout9/admin 1.0.7 → 1.0.8

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
@@ -336,12 +336,6 @@ export interface Conversation {
336
336
  * @memberof Conversation
337
337
  */
338
338
  '$agent': string;
339
- /**
340
- * Thread this conversation is in - this determines what context to pull when loading the conversation
341
- * @type {string}
342
- * @memberof Conversation
343
- */
344
- '$thread'?: string;
345
339
  /**
346
340
  * Initial contexts to load when starting the conversation
347
341
  * @type {Array<string>}
@@ -398,12 +392,6 @@ export interface ConversationBase {
398
392
  * @memberof ConversationBase
399
393
  */
400
394
  '$agent': string;
401
- /**
402
- * Thread this conversation is in - this determines what context to pull when loading the conversation
403
- * @type {string}
404
- * @memberof ConversationBase
405
- */
406
- '$thread'?: string;
407
395
  /**
408
396
  * Initial contexts to load when starting the conversation
409
397
  * @type {Array<string>}
@@ -541,12 +529,6 @@ export interface ConversationCreateRequest {
541
529
  * @memberof ConversationCreateRequest
542
530
  */
543
531
  '$agent': string;
544
- /**
545
- * Thread this conversation is in - this determines what context to pull when loading the conversation
546
- * @type {string}
547
- * @memberof ConversationCreateRequest
548
- */
549
- '$thread'?: string;
550
532
  /**
551
533
  * Initial contexts to load when starting the conversation
552
534
  * @type {Array<string>}
@@ -571,6 +553,25 @@ export interface ConversationCreateRequest {
571
553
  * @memberof ConversationCreateRequest
572
554
  */
573
555
  'environment': ConversationEnvironment;
556
+ /**
557
+ *
558
+ * @type {ConversationUpdateRequestBaseWorkflow}
559
+ * @memberof ConversationCreateRequest
560
+ */
561
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
562
+ }
563
+ /**
564
+ *
565
+ * @export
566
+ * @interface ConversationCreateRequestBase
567
+ */
568
+ export interface ConversationCreateRequestBase {
569
+ /**
570
+ *
571
+ * @type {ConversationUpdateRequestBaseWorkflow}
572
+ * @memberof ConversationCreateRequestBase
573
+ */
574
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
574
575
  }
575
576
  /**
576
577
  *
@@ -669,12 +670,6 @@ export interface ConversationGetResponse {
669
670
  * @memberof ConversationGetResponse
670
671
  */
671
672
  '$agent': string;
672
- /**
673
- * Thread this conversation is in - this determines what context to pull when loading the conversation
674
- * @type {string}
675
- * @memberof ConversationGetResponse
676
- */
677
- '$thread'?: string;
678
673
  /**
679
674
  * Initial contexts to load when starting the conversation
680
675
  * @type {Array<string>}
@@ -717,6 +712,12 @@ export interface ConversationGetResponse {
717
712
  * @memberof ConversationGetResponse
718
713
  */
719
714
  'agentTestWebUrl'?: string;
715
+ /**
716
+ * The ID of the workflow used for this conversation
717
+ * @type {string}
718
+ * @memberof ConversationGetResponse
719
+ */
720
+ '$workflow': string;
720
721
  /**
721
722
  * ISO 8601 date string of when the conversation was initiated
722
723
  * @type {string}
@@ -749,6 +750,19 @@ export interface ConversationGetResponseAllOf {
749
750
  */
750
751
  '$id': string;
751
752
  }
753
+ /**
754
+ *
755
+ * @export
756
+ * @interface ConversationGetResponseBase
757
+ */
758
+ export interface ConversationGetResponseBase {
759
+ /**
760
+ * The ID of the workflow used for this conversation
761
+ * @type {string}
762
+ * @memberof ConversationGetResponseBase
763
+ */
764
+ '$workflow': string;
765
+ }
752
766
  /**
753
767
  *
754
768
  * @export
@@ -811,12 +825,6 @@ export interface ConversationUpdateRequest {
811
825
  * @memberof ConversationUpdateRequest
812
826
  */
813
827
  '$agent': string;
814
- /**
815
- * Thread this conversation is in - this determines what context to pull when loading the conversation
816
- * @type {string}
817
- * @memberof ConversationUpdateRequest
818
- */
819
- '$thread'?: string;
820
828
  /**
821
829
  * Initial contexts to load when starting the conversation
822
830
  * @type {Array<string>}
@@ -841,6 +849,12 @@ export interface ConversationUpdateRequest {
841
849
  * @memberof ConversationUpdateRequest
842
850
  */
843
851
  'environment': ConversationEnvironment;
852
+ /**
853
+ *
854
+ * @type {ConversationUpdateRequestAllOfWorkflow}
855
+ * @memberof ConversationUpdateRequest
856
+ */
857
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
844
858
  /**
845
859
  * The ID of the conversation to update
846
860
  * @type {string}
@@ -860,7 +874,36 @@ export interface ConversationUpdateRequestAllOf {
860
874
  * @memberof ConversationUpdateRequestAllOf
861
875
  */
862
876
  '$id': string;
877
+ /**
878
+ *
879
+ * @type {ConversationUpdateRequestAllOfWorkflow}
880
+ * @memberof ConversationUpdateRequestAllOf
881
+ */
882
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
883
+ }
884
+ /**
885
+ * @type ConversationUpdateRequestAllOfWorkflow
886
+ * @export
887
+ */
888
+ export type ConversationUpdateRequestAllOfWorkflow = Workflow | string;
889
+ /**
890
+ *
891
+ * @export
892
+ * @interface ConversationUpdateRequestBase
893
+ */
894
+ export interface ConversationUpdateRequestBase {
895
+ /**
896
+ *
897
+ * @type {ConversationUpdateRequestBaseWorkflow}
898
+ * @memberof ConversationUpdateRequestBase
899
+ */
900
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
863
901
  }
902
+ /**
903
+ * @type ConversationUpdateRequestBaseWorkflow
904
+ * @export
905
+ */
906
+ export type ConversationUpdateRequestBaseWorkflow = Workflow | string;
864
907
  /**
865
908
  *
866
909
  * @export
@@ -1029,93 +1072,93 @@ export interface CreateAgentResponse {
1029
1072
  export interface CreateAgentsRequest {
1030
1073
  /**
1031
1074
  *
1032
- * @type {Array<CreateAgentsRequestCustomersInner>}
1075
+ * @type {Array<CreateAgentsRequestAgentsInner>}
1033
1076
  * @memberof CreateAgentsRequest
1034
1077
  */
1035
- 'customers'?: Array<CreateAgentsRequestCustomersInner>;
1078
+ 'agents'?: Array<CreateAgentsRequestAgentsInner>;
1036
1079
  }
1037
1080
  /**
1038
1081
  *
1039
1082
  * @export
1040
- * @interface CreateAgentsRequestCustomersInner
1083
+ * @interface CreateAgentsRequestAgentsInner
1041
1084
  */
1042
- export interface CreateAgentsRequestCustomersInner {
1085
+ export interface CreateAgentsRequestAgentsInner {
1043
1086
  /**
1044
1087
  * Agent first name
1045
1088
  * @type {string}
1046
- * @memberof CreateAgentsRequestCustomersInner
1089
+ * @memberof CreateAgentsRequestAgentsInner
1047
1090
  */
1048
1091
  'firstName': string;
1049
1092
  /**
1050
1093
  * Agent last name
1051
1094
  * @type {string}
1052
- * @memberof CreateAgentsRequestCustomersInner
1095
+ * @memberof CreateAgentsRequestAgentsInner
1053
1096
  */
1054
1097
  'lastName': string;
1055
1098
  /**
1056
1099
  * Agent is inactive
1057
1100
  * @type {boolean}
1058
- * @memberof CreateAgentsRequestCustomersInner
1101
+ * @memberof CreateAgentsRequestAgentsInner
1059
1102
  */
1060
1103
  'inactive'?: boolean;
1061
1104
  /**
1062
1105
  * Programmable phone number
1063
1106
  * @type {string}
1064
- * @memberof CreateAgentsRequestCustomersInner
1107
+ * @memberof CreateAgentsRequestAgentsInner
1065
1108
  */
1066
1109
  'programmablePhoneNumber'?: string;
1067
1110
  /**
1068
1111
  * Programmable phone number SID
1069
1112
  * @type {string}
1070
- * @memberof CreateAgentsRequestCustomersInner
1113
+ * @memberof CreateAgentsRequestAgentsInner
1071
1114
  */
1072
1115
  'programmablePhoneNumberSid'?: string;
1073
1116
  /**
1074
1117
  * Email address from Scout9 gmail subdomain
1075
1118
  * @type {string}
1076
- * @memberof CreateAgentsRequestCustomersInner
1119
+ * @memberof CreateAgentsRequestAgentsInner
1077
1120
  */
1078
1121
  'programmableEmail'?: string;
1079
1122
  /**
1080
1123
  * Forward email
1081
1124
  * @type {string}
1082
- * @memberof CreateAgentsRequestCustomersInner
1125
+ * @memberof CreateAgentsRequestAgentsInner
1083
1126
  */
1084
1127
  'forwardEmail'?: string;
1085
1128
  /**
1086
1129
  * Forward phone
1087
1130
  * @type {string}
1088
- * @memberof CreateAgentsRequestCustomersInner
1131
+ * @memberof CreateAgentsRequestAgentsInner
1089
1132
  */
1090
1133
  'forwardPhone': string;
1091
1134
  /**
1092
1135
  * Title of the agent, defaults to \"Agent\"
1093
1136
  * @type {string}
1094
- * @memberof CreateAgentsRequestCustomersInner
1137
+ * @memberof CreateAgentsRequestAgentsInner
1095
1138
  */
1096
1139
  'title'?: string;
1097
1140
  /**
1098
1141
  * Context of the agent, defaults to \"Agent\"
1099
1142
  * @type {string}
1100
- * @memberof CreateAgentsRequestCustomersInner
1143
+ * @memberof CreateAgentsRequestAgentsInner
1101
1144
  */
1102
1145
  'context'?: string;
1103
1146
  /**
1104
1147
  * Locations ids the agent is included in
1105
1148
  * @type {Array<string>}
1106
- * @memberof CreateAgentsRequestCustomersInner
1149
+ * @memberof CreateAgentsRequestAgentsInner
1107
1150
  */
1108
1151
  'includedLocations'?: Array<string>;
1109
1152
  /**
1110
1153
  * Locations id the agent is excluded from
1111
1154
  * @type {Array<string>}
1112
- * @memberof CreateAgentsRequestCustomersInner
1155
+ * @memberof CreateAgentsRequestAgentsInner
1113
1156
  */
1114
1157
  'excludedLocations'?: Array<string>;
1115
1158
  /**
1116
1159
  * Transcript of the agent
1117
1160
  * @type {string}
1118
- * @memberof CreateAgentsRequestCustomersInner
1161
+ * @memberof CreateAgentsRequestAgentsInner
1119
1162
  */
1120
1163
  'transcript'?: string;
1121
1164
  }
@@ -1220,57 +1263,57 @@ export interface CreateContextResponse {
1220
1263
  export interface CreateContextsRequest {
1221
1264
  /**
1222
1265
  *
1223
- * @type {Array<CreateContextsRequestCustomersInner>}
1266
+ * @type {Array<CreateContextsRequestContextsInner>}
1224
1267
  * @memberof CreateContextsRequest
1225
1268
  */
1226
- 'customers'?: Array<CreateContextsRequestCustomersInner>;
1269
+ 'contexts'?: Array<CreateContextsRequestContextsInner>;
1227
1270
  }
1228
1271
  /**
1229
1272
  *
1230
1273
  * @export
1231
- * @interface CreateContextsRequestCustomersInner
1274
+ * @interface CreateContextsRequestContextsInner
1232
1275
  */
1233
- export interface CreateContextsRequestCustomersInner {
1276
+ export interface CreateContextsRequestContextsInner {
1234
1277
  /**
1235
1278
  * The name of the context
1236
1279
  * @type {string}
1237
- * @memberof CreateContextsRequestCustomersInner
1280
+ * @memberof CreateContextsRequestContextsInner
1238
1281
  */
1239
1282
  'name': string;
1240
1283
  /**
1241
1284
  * Whether or not the context is modifiable
1242
1285
  * @type {boolean}
1243
- * @memberof CreateContextsRequestCustomersInner
1286
+ * @memberof CreateContextsRequestContextsInner
1244
1287
  */
1245
1288
  'modifiable': boolean;
1246
1289
  /**
1247
1290
  * The description of the context
1248
1291
  * @type {string}
1249
- * @memberof CreateContextsRequestCustomersInner
1292
+ * @memberof CreateContextsRequestContextsInner
1250
1293
  */
1251
1294
  'description'?: string;
1252
1295
  /**
1253
1296
  *
1254
1297
  * @type {ContextDetectionParams}
1255
- * @memberof CreateContextsRequestCustomersInner
1298
+ * @memberof CreateContextsRequestContextsInner
1256
1299
  */
1257
1300
  'detection'?: ContextDetectionParams;
1258
1301
  /**
1259
1302
  * The ID column of the context
1260
1303
  * @type {string}
1261
- * @memberof CreateContextsRequestCustomersInner
1304
+ * @memberof CreateContextsRequestContextsInner
1262
1305
  */
1263
1306
  'idColumn': string;
1264
1307
  /**
1265
1308
  * The columns of the context
1266
1309
  * @type {Array<string>}
1267
- * @memberof CreateContextsRequestCustomersInner
1310
+ * @memberof CreateContextsRequestContextsInner
1268
1311
  */
1269
1312
  'columns': Array<string>;
1270
1313
  /**
1271
1314
  * The required columns of the context
1272
1315
  * @type {Array<string>}
1273
- * @memberof CreateContextsRequestCustomersInner
1316
+ * @memberof CreateContextsRequestContextsInner
1274
1317
  */
1275
1318
  'requiredColumns'?: Array<string>;
1276
1319
  }
@@ -1293,6 +1336,96 @@ export interface CreateContextsResponse {
1293
1336
  */
1294
1337
  '$operation': string;
1295
1338
  }
1339
+ /**
1340
+ *
1341
+ * @export
1342
+ * @interface CreateCustomerGroupRequest
1343
+ */
1344
+ export interface CreateCustomerGroupRequest {
1345
+ /**
1346
+ * The name of the customer group
1347
+ * @type {string}
1348
+ * @memberof CreateCustomerGroupRequest
1349
+ */
1350
+ 'name': string;
1351
+ /**
1352
+ * The description of the customer group
1353
+ * @type {string}
1354
+ * @memberof CreateCustomerGroupRequest
1355
+ */
1356
+ 'description'?: string;
1357
+ /**
1358
+ *
1359
+ * @type {{ [key: string]: any; }}
1360
+ * @memberof CreateCustomerGroupRequest
1361
+ */
1362
+ 'metadata'?: {
1363
+ [key: string]: any;
1364
+ };
1365
+ /**
1366
+ *
1367
+ * @type {Array<CustomerGroupRecord>}
1368
+ * @memberof CreateCustomerGroupRequest
1369
+ */
1370
+ 'customers': Array<CustomerGroupRecord>;
1371
+ }
1372
+ /**
1373
+ *
1374
+ * @export
1375
+ * @interface CreateCustomerGroupResponse
1376
+ */
1377
+ export interface CreateCustomerGroupResponse {
1378
+ /**
1379
+ *
1380
+ * @type {boolean}
1381
+ * @memberof CreateCustomerGroupResponse
1382
+ */
1383
+ 'success': boolean;
1384
+ /**
1385
+ *
1386
+ * @type {Error}
1387
+ * @memberof CreateCustomerGroupResponse
1388
+ */
1389
+ 'error'?: Error;
1390
+ /**
1391
+ * The id of the document that was created, updated, or deleted
1392
+ * @type {string}
1393
+ * @memberof CreateCustomerGroupResponse
1394
+ */
1395
+ 'id': string;
1396
+ }
1397
+ /**
1398
+ *
1399
+ * @export
1400
+ * @interface CreateCustomerGroupsRequest
1401
+ */
1402
+ export interface CreateCustomerGroupsRequest {
1403
+ /**
1404
+ *
1405
+ * @type {Array<CustomerGroup>}
1406
+ * @memberof CreateCustomerGroupsRequest
1407
+ */
1408
+ 'CustomerGroups': Array<CustomerGroup>;
1409
+ }
1410
+ /**
1411
+ *
1412
+ * @export
1413
+ * @interface CreateCustomerGroupsResponse
1414
+ */
1415
+ export interface CreateCustomerGroupsResponse {
1416
+ /**
1417
+ * ISO 8601 datetime string of when the operation was queued
1418
+ * @type {string}
1419
+ * @memberof CreateCustomerGroupsResponse
1420
+ */
1421
+ 'queued': string;
1422
+ /**
1423
+ * The operation id to view the operation end results
1424
+ * @type {string}
1425
+ * @memberof CreateCustomerGroupsResponse
1426
+ */
1427
+ '$operation': string;
1428
+ }
1296
1429
  /**
1297
1430
  *
1298
1431
  * @export
@@ -1565,63 +1698,63 @@ export interface CreateWorkflowResponse {
1565
1698
  export interface CreateWorkflowsRequest {
1566
1699
  /**
1567
1700
  *
1568
- * @type {Array<CreateWorkflowsRequestCustomersInner>}
1701
+ * @type {Array<CreateWorkflowsRequestWorkflowsInner>}
1569
1702
  * @memberof CreateWorkflowsRequest
1570
1703
  */
1571
- 'customers'?: Array<CreateWorkflowsRequestCustomersInner>;
1704
+ 'workflows'?: Array<CreateWorkflowsRequestWorkflowsInner>;
1572
1705
  }
1573
1706
  /**
1574
1707
  *
1575
1708
  * @export
1576
- * @interface CreateWorkflowsRequestCustomersInner
1709
+ * @interface CreateWorkflowsRequestWorkflowsInner
1577
1710
  */
1578
- export interface CreateWorkflowsRequestCustomersInner {
1711
+ export interface CreateWorkflowsRequestWorkflowsInner {
1579
1712
  /**
1580
1713
  * The name of the workflow
1581
1714
  * @type {string}
1582
- * @memberof CreateWorkflowsRequestCustomersInner
1715
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1583
1716
  */
1584
1717
  'name': string;
1585
1718
  /**
1586
1719
  *
1587
1720
  * @type {ContextDetectionParams}
1588
- * @memberof CreateWorkflowsRequestCustomersInner
1721
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1589
1722
  */
1590
1723
  'initiators': ContextDetectionParams;
1591
1724
  /**
1592
1725
  * The fields of the workflow
1593
1726
  * @type {Array<ConversationContextField>}
1594
- * @memberof CreateWorkflowsRequestCustomersInner
1727
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1595
1728
  */
1596
1729
  'fields': Array<ConversationContextField>;
1597
1730
  /**
1598
1731
  * About this conversation - used as initial context
1599
1732
  * @type {string}
1600
- * @memberof CreateWorkflowsRequestCustomersInner
1733
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1601
1734
  */
1602
1735
  'context': string;
1603
1736
  /**
1604
1737
  * The webhook to call when a workflow is created
1605
1738
  * @type {string}
1606
- * @memberof CreateWorkflowsRequestCustomersInner
1739
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1607
1740
  */
1608
1741
  'onCreated'?: string;
1609
1742
  /**
1610
1743
  * The webhook to call when a workflow is updated
1611
1744
  * @type {string}
1612
- * @memberof CreateWorkflowsRequestCustomersInner
1745
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1613
1746
  */
1614
1747
  'onUpdated'?: string;
1615
1748
  /**
1616
1749
  * The webhook to call when a workflow is deleted
1617
1750
  * @type {string}
1618
- * @memberof CreateWorkflowsRequestCustomersInner
1751
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1619
1752
  */
1620
1753
  'onDeleted'?: string;
1621
1754
  /**
1622
1755
  * The webhook to call when a workflow has an error
1623
1756
  * @type {string}
1624
- * @memberof CreateWorkflowsRequestCustomersInner
1757
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1625
1758
  */
1626
1759
  'onError'?: string;
1627
1760
  }
@@ -1772,6 +1905,64 @@ export interface Customer {
1772
1905
  */
1773
1906
  'stripeDev'?: string | null;
1774
1907
  }
1908
+ /**
1909
+ * A way for a business to group customers to use in scheduling batch conversations
1910
+ * @export
1911
+ * @interface CustomerGroup
1912
+ */
1913
+ export interface CustomerGroup {
1914
+ /**
1915
+ * The name of the customer group
1916
+ * @type {string}
1917
+ * @memberof CustomerGroup
1918
+ */
1919
+ 'name': string;
1920
+ /**
1921
+ * The description of the customer group
1922
+ * @type {string}
1923
+ * @memberof CustomerGroup
1924
+ */
1925
+ 'description'?: string;
1926
+ /**
1927
+ *
1928
+ * @type {{ [key: string]: any; }}
1929
+ * @memberof CustomerGroup
1930
+ */
1931
+ 'metadata'?: {
1932
+ [key: string]: any;
1933
+ };
1934
+ /**
1935
+ *
1936
+ * @type {Array<CustomerGroupRecord>}
1937
+ * @memberof CustomerGroup
1938
+ */
1939
+ 'customers': Array<CustomerGroupRecord>;
1940
+ }
1941
+ /**
1942
+ * A way for a business to group customers to use in scheduling batch conversations
1943
+ * @export
1944
+ * @interface CustomerGroupRecord
1945
+ */
1946
+ export interface CustomerGroupRecord {
1947
+ /**
1948
+ * Customer this conversation is with
1949
+ * @type {string}
1950
+ * @memberof CustomerGroupRecord
1951
+ */
1952
+ 'id': string;
1953
+ /**
1954
+ *
1955
+ * @type {ConversationEnvironment}
1956
+ * @memberof CustomerGroupRecord
1957
+ */
1958
+ 'environment': ConversationEnvironment;
1959
+ /**
1960
+ * Overrides the default $agent for this customer
1961
+ * @type {string}
1962
+ * @memberof CustomerGroupRecord
1963
+ */
1964
+ '$agent'?: string;
1965
+ }
1775
1966
  /**
1776
1967
  * @type CustomerValue
1777
1968
  * @export
@@ -1865,6 +2056,50 @@ export interface DeleteContextsResponse {
1865
2056
  */
1866
2057
  '$operation': string;
1867
2058
  }
2059
+ /**
2060
+ *
2061
+ * @export
2062
+ * @interface DeleteCustomerGroupResponse
2063
+ */
2064
+ export interface DeleteCustomerGroupResponse {
2065
+ /**
2066
+ *
2067
+ * @type {boolean}
2068
+ * @memberof DeleteCustomerGroupResponse
2069
+ */
2070
+ 'success': boolean;
2071
+ /**
2072
+ *
2073
+ * @type {Error}
2074
+ * @memberof DeleteCustomerGroupResponse
2075
+ */
2076
+ 'error'?: Error;
2077
+ /**
2078
+ * The id of the document that was created, updated, or deleted
2079
+ * @type {string}
2080
+ * @memberof DeleteCustomerGroupResponse
2081
+ */
2082
+ 'id': string;
2083
+ }
2084
+ /**
2085
+ *
2086
+ * @export
2087
+ * @interface DeleteCustomerGroupsResponse
2088
+ */
2089
+ export interface DeleteCustomerGroupsResponse {
2090
+ /**
2091
+ * ISO 8601 datetime string of when the operation was queued
2092
+ * @type {string}
2093
+ * @memberof DeleteCustomerGroupsResponse
2094
+ */
2095
+ 'queued': string;
2096
+ /**
2097
+ * The operation id to view the operation end results
2098
+ * @type {string}
2099
+ * @memberof DeleteCustomerGroupsResponse
2100
+ */
2101
+ '$operation': string;
2102
+ }
1868
2103
  /**
1869
2104
  *
1870
2105
  * @export
@@ -2248,6 +2483,58 @@ export interface GetContextResponseAllOf {
2248
2483
  */
2249
2484
  '$id': string;
2250
2485
  }
2486
+ /**
2487
+ *
2488
+ * @export
2489
+ * @interface GetCustomerGroupResponse
2490
+ */
2491
+ export interface GetCustomerGroupResponse {
2492
+ /**
2493
+ * The name of the customer group
2494
+ * @type {string}
2495
+ * @memberof GetCustomerGroupResponse
2496
+ */
2497
+ 'name': string;
2498
+ /**
2499
+ * The description of the customer group
2500
+ * @type {string}
2501
+ * @memberof GetCustomerGroupResponse
2502
+ */
2503
+ 'description'?: string;
2504
+ /**
2505
+ *
2506
+ * @type {{ [key: string]: any; }}
2507
+ * @memberof GetCustomerGroupResponse
2508
+ */
2509
+ 'metadata'?: {
2510
+ [key: string]: any;
2511
+ };
2512
+ /**
2513
+ *
2514
+ * @type {Array<CustomerGroupRecord>}
2515
+ * @memberof GetCustomerGroupResponse
2516
+ */
2517
+ 'customers': Array<CustomerGroupRecord>;
2518
+ /**
2519
+ * The ID of the CustomerGroup
2520
+ * @type {string}
2521
+ * @memberof GetCustomerGroupResponse
2522
+ */
2523
+ '$id'?: string;
2524
+ }
2525
+ /**
2526
+ *
2527
+ * @export
2528
+ * @interface GetCustomerGroupResponseAllOf
2529
+ */
2530
+ export interface GetCustomerGroupResponseAllOf {
2531
+ /**
2532
+ * The ID of the CustomerGroup
2533
+ * @type {string}
2534
+ * @memberof GetCustomerGroupResponseAllOf
2535
+ */
2536
+ '$id'?: string;
2537
+ }
2251
2538
  /**
2252
2539
  *
2253
2540
  * @export
@@ -2703,27 +2990,79 @@ export interface ListContextsResponseInnerAllOf {
2703
2990
  /**
2704
2991
  *
2705
2992
  * @export
2706
- * @interface ListCustomersResponseInner
2993
+ * @interface ListCustomerGroupsResponseInner
2707
2994
  */
2708
- export interface ListCustomersResponseInner {
2995
+ export interface ListCustomerGroupsResponseInner {
2709
2996
  /**
2710
- * The customers first name
2997
+ * The name of the customer group
2711
2998
  * @type {string}
2712
- * @memberof ListCustomersResponseInner
2999
+ * @memberof ListCustomerGroupsResponseInner
2713
3000
  */
2714
- 'firstName'?: string;
3001
+ 'name': string;
2715
3002
  /**
2716
- * The customers last name
3003
+ * The description of the customer group
2717
3004
  * @type {string}
2718
- * @memberof ListCustomersResponseInner
3005
+ * @memberof ListCustomerGroupsResponseInner
2719
3006
  */
2720
- 'lastName'?: string;
3007
+ 'description'?: string;
2721
3008
  /**
2722
- * The customers full name
2723
- * @type {string}
2724
- * @memberof ListCustomersResponseInner
3009
+ *
3010
+ * @type {{ [key: string]: any; }}
3011
+ * @memberof ListCustomerGroupsResponseInner
2725
3012
  */
2726
- 'name': string;
3013
+ 'metadata'?: {
3014
+ [key: string]: any;
3015
+ };
3016
+ /**
3017
+ *
3018
+ * @type {Array<CustomerGroupRecord>}
3019
+ * @memberof ListCustomerGroupsResponseInner
3020
+ */
3021
+ 'customers': Array<CustomerGroupRecord>;
3022
+ /**
3023
+ * The ID of the CustomerGroup
3024
+ * @type {string}
3025
+ * @memberof ListCustomerGroupsResponseInner
3026
+ */
3027
+ '$id': string;
3028
+ }
3029
+ /**
3030
+ *
3031
+ * @export
3032
+ * @interface ListCustomerGroupsResponseInnerAllOf
3033
+ */
3034
+ export interface ListCustomerGroupsResponseInnerAllOf {
3035
+ /**
3036
+ * The ID of the CustomerGroup
3037
+ * @type {string}
3038
+ * @memberof ListCustomerGroupsResponseInnerAllOf
3039
+ */
3040
+ '$id': string;
3041
+ }
3042
+ /**
3043
+ *
3044
+ * @export
3045
+ * @interface ListCustomersResponseInner
3046
+ */
3047
+ export interface ListCustomersResponseInner {
3048
+ /**
3049
+ * The customers first name
3050
+ * @type {string}
3051
+ * @memberof ListCustomersResponseInner
3052
+ */
3053
+ 'firstName'?: string;
3054
+ /**
3055
+ * The customers last name
3056
+ * @type {string}
3057
+ * @memberof ListCustomersResponseInner
3058
+ */
3059
+ 'lastName'?: string;
3060
+ /**
3061
+ * The customers full name
3062
+ * @type {string}
3063
+ * @memberof ListCustomersResponseInner
3064
+ */
3065
+ 'name': string;
2727
3066
  /**
2728
3067
  * The customers email address
2729
3068
  * @type {string}
@@ -3267,12 +3606,6 @@ export interface ScheduleCreateRequest {
3267
3606
  * @memberof ScheduleCreateRequest
3268
3607
  */
3269
3608
  '$agent': string;
3270
- /**
3271
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3272
- * @type {string}
3273
- * @memberof ScheduleCreateRequest
3274
- */
3275
- '$thread'?: string;
3276
3609
  /**
3277
3610
  * Initial contexts to load when starting the conversation
3278
3611
  * @type {Array<string>}
@@ -3321,6 +3654,12 @@ export interface ScheduleCreateRequest {
3321
3654
  * @memberof ScheduleCreateRequest
3322
3655
  */
3323
3656
  '$group'?: string;
3657
+ /**
3658
+ *
3659
+ * @type {ConversationUpdateRequestBaseWorkflow}
3660
+ * @memberof ScheduleCreateRequest
3661
+ */
3662
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
3324
3663
  }
3325
3664
  /**
3326
3665
  *
@@ -3378,12 +3717,6 @@ export interface ScheduleGetResponse {
3378
3717
  * @memberof ScheduleGetResponse
3379
3718
  */
3380
3719
  '$agent': string;
3381
- /**
3382
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3383
- * @type {string}
3384
- * @memberof ScheduleGetResponse
3385
- */
3386
- '$thread'?: string;
3387
3720
  /**
3388
3721
  * Initial contexts to load when starting the conversation
3389
3722
  * @type {Array<string>}
@@ -3432,6 +3765,12 @@ export interface ScheduleGetResponse {
3432
3765
  * @memberof ScheduleGetResponse
3433
3766
  */
3434
3767
  '$group'?: string;
3768
+ /**
3769
+ * The ID of the workflow used for this conversation
3770
+ * @type {string}
3771
+ * @memberof ScheduleGetResponse
3772
+ */
3773
+ '$workflow': string;
3435
3774
  }
3436
3775
  /**
3437
3776
  *
@@ -3440,17 +3779,17 @@ export interface ScheduleGetResponse {
3440
3779
  */
3441
3780
  export interface ScheduleGroupCreateRequest {
3442
3781
  /**
3443
- * Default agent assigned to the conversation(s)
3444
- * @type {string}
3782
+ *
3783
+ * @type {ConversationUpdateRequestBaseWorkflow}
3445
3784
  * @memberof ScheduleGroupCreateRequest
3446
3785
  */
3447
- '$agent': string;
3786
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
3448
3787
  /**
3449
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3788
+ * Default agent assigned to the conversation(s)
3450
3789
  * @type {string}
3451
3790
  * @memberof ScheduleGroupCreateRequest
3452
3791
  */
3453
- '$thread'?: string;
3792
+ '$agent': string;
3454
3793
  /**
3455
3794
  * Initial contexts to load when starting the conversation
3456
3795
  * @type {Array<string>}
@@ -3488,12 +3827,30 @@ export interface ScheduleGroupCreateRequest {
3488
3827
  */
3489
3828
  'delay'?: number;
3490
3829
  /**
3491
- * Customers in this group
3492
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
3830
+ *
3831
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3493
3832
  * @memberof ScheduleGroupCreateRequest
3494
3833
  */
3495
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
3834
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
3496
3835
  }
3836
+ /**
3837
+ *
3838
+ * @export
3839
+ * @interface ScheduleGroupCreateRequestAllOf
3840
+ */
3841
+ export interface ScheduleGroupCreateRequestAllOf {
3842
+ /**
3843
+ *
3844
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3845
+ * @memberof ScheduleGroupCreateRequestAllOf
3846
+ */
3847
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
3848
+ }
3849
+ /**
3850
+ * @type ScheduleGroupCreateRequestAllOfCGroup
3851
+ * @export
3852
+ */
3853
+ export type ScheduleGroupCreateRequestAllOfCGroup = CustomerGroup | string;
3497
3854
  /**
3498
3855
  *
3499
3856
  * @export
@@ -3531,12 +3888,6 @@ export interface ScheduleGroupGetResponse {
3531
3888
  * @memberof ScheduleGroupGetResponse
3532
3889
  */
3533
3890
  '$agent': string;
3534
- /**
3535
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3536
- * @type {string}
3537
- * @memberof ScheduleGroupGetResponse
3538
- */
3539
- '$thread'?: string;
3540
3891
  /**
3541
3892
  * Initial contexts to load when starting the conversation
3542
3893
  * @type {Array<string>}
@@ -3574,11 +3925,11 @@ export interface ScheduleGroupGetResponse {
3574
3925
  */
3575
3926
  'delay'?: number;
3576
3927
  /**
3577
- * Customers in this group
3578
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
3928
+ * The ID of the workflow used for this conversation
3929
+ * @type {string}
3579
3930
  * @memberof ScheduleGroupGetResponse
3580
3931
  */
3581
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
3932
+ '$workflow': string;
3582
3933
  /**
3583
3934
  * The ID of the scheduled conversation group
3584
3935
  * @type {string}
@@ -3591,6 +3942,12 @@ export interface ScheduleGroupGetResponse {
3591
3942
  * @memberof ScheduleGroupGetResponse
3592
3943
  */
3593
3944
  'sent'?: boolean;
3945
+ /**
3946
+ * The ID of the group the customers belong to
3947
+ * @type {string}
3948
+ * @memberof ScheduleGroupGetResponse
3949
+ */
3950
+ '$cGroup'?: string;
3594
3951
  }
3595
3952
  /**
3596
3953
  *
@@ -3610,6 +3967,12 @@ export interface ScheduleGroupGetResponseAllOf {
3610
3967
  * @memberof ScheduleGroupGetResponseAllOf
3611
3968
  */
3612
3969
  'sent'?: boolean;
3970
+ /**
3971
+ * The ID of the group the customers belong to
3972
+ * @type {string}
3973
+ * @memberof ScheduleGroupGetResponseAllOf
3974
+ */
3975
+ '$cGroup'?: string;
3613
3976
  }
3614
3977
  /**
3615
3978
  *
@@ -3648,12 +4011,6 @@ export interface ScheduleGroupUpdateRequest {
3648
4011
  * @memberof ScheduleGroupUpdateRequest
3649
4012
  */
3650
4013
  '$agent': string;
3651
- /**
3652
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3653
- * @type {string}
3654
- * @memberof ScheduleGroupUpdateRequest
3655
- */
3656
- '$thread'?: string;
3657
4014
  /**
3658
4015
  * Initial contexts to load when starting the conversation
3659
4016
  * @type {Array<string>}
@@ -3691,11 +4048,17 @@ export interface ScheduleGroupUpdateRequest {
3691
4048
  */
3692
4049
  'delay'?: number;
3693
4050
  /**
3694
- * Customers in this group
3695
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4051
+ *
4052
+ * @type {ConversationUpdateRequestBaseWorkflow}
4053
+ * @memberof ScheduleGroupUpdateRequest
4054
+ */
4055
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
4056
+ /**
4057
+ *
4058
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3696
4059
  * @memberof ScheduleGroupUpdateRequest
3697
4060
  */
3698
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4061
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3699
4062
  /**
3700
4063
  * The ID of the scheduled conversation group to update
3701
4064
  * @type {string}
@@ -3709,6 +4072,12 @@ export interface ScheduleGroupUpdateRequest {
3709
4072
  * @interface ScheduleGroupUpdateRequestAllOf
3710
4073
  */
3711
4074
  export interface ScheduleGroupUpdateRequestAllOf {
4075
+ /**
4076
+ *
4077
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
4078
+ * @memberof ScheduleGroupUpdateRequestAllOf
4079
+ */
4080
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3712
4081
  /**
3713
4082
  * The ID of the scheduled conversation group to update
3714
4083
  * @type {string}
@@ -3778,12 +4147,6 @@ export interface ScheduleUpdateRequest {
3778
4147
  * @memberof ScheduleUpdateRequest
3779
4148
  */
3780
4149
  '$agent': string;
3781
- /**
3782
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3783
- * @type {string}
3784
- * @memberof ScheduleUpdateRequest
3785
- */
3786
- '$thread'?: string;
3787
4150
  /**
3788
4151
  * Initial contexts to load when starting the conversation
3789
4152
  * @type {Array<string>}
@@ -3832,6 +4195,12 @@ export interface ScheduleUpdateRequest {
3832
4195
  * @memberof ScheduleUpdateRequest
3833
4196
  */
3834
4197
  '$group'?: string;
4198
+ /**
4199
+ *
4200
+ * @type {ConversationUpdateRequestBaseWorkflow}
4201
+ * @memberof ScheduleUpdateRequest
4202
+ */
4203
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3835
4204
  /**
3836
4205
  * The ID of the scheduled conversation to update
3837
4206
  * @type {string}
@@ -3889,12 +4258,6 @@ export interface ScheduledConversation {
3889
4258
  * @memberof ScheduledConversation
3890
4259
  */
3891
4260
  '$agent': string;
3892
- /**
3893
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3894
- * @type {string}
3895
- * @memberof ScheduledConversation
3896
- */
3897
- '$thread'?: string;
3898
4261
  /**
3899
4262
  * Initial contexts to load when starting the conversation
3900
4263
  * @type {Array<string>}
@@ -3969,12 +4332,6 @@ export interface ScheduledConversationGroup {
3969
4332
  * @memberof ScheduledConversationGroup
3970
4333
  */
3971
4334
  '$agent': string;
3972
- /**
3973
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3974
- * @type {string}
3975
- * @memberof ScheduledConversationGroup
3976
- */
3977
- '$thread'?: string;
3978
4335
  /**
3979
4336
  * Initial contexts to load when starting the conversation
3980
4337
  * @type {Array<string>}
@@ -4011,12 +4368,6 @@ export interface ScheduledConversationGroup {
4011
4368
  * @memberof ScheduledConversationGroup
4012
4369
  */
4013
4370
  'delay'?: number;
4014
- /**
4015
- * Customers in this group
4016
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4017
- * @memberof ScheduledConversationGroup
4018
- */
4019
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4020
4371
  }
4021
4372
  /**
4022
4373
  *
@@ -4030,37 +4381,6 @@ export interface ScheduledConversationGroupAllOf {
4030
4381
  * @memberof ScheduledConversationGroupAllOf
4031
4382
  */
4032
4383
  'delay'?: number;
4033
- /**
4034
- * Customers in this group
4035
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4036
- * @memberof ScheduledConversationGroupAllOf
4037
- */
4038
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4039
- }
4040
- /**
4041
- *
4042
- * @export
4043
- * @interface ScheduledConversationGroupAllOfCustomers
4044
- */
4045
- export interface ScheduledConversationGroupAllOfCustomers {
4046
- /**
4047
- *
4048
- * @type {ConversationEnvironment}
4049
- * @memberof ScheduledConversationGroupAllOfCustomers
4050
- */
4051
- 'environment': ConversationEnvironment;
4052
- /**
4053
- * Customer ID
4054
- * @type {string}
4055
- * @memberof ScheduledConversationGroupAllOfCustomers
4056
- */
4057
- 'id': string;
4058
- /**
4059
- * Overrides default $agent for this customer
4060
- * @type {string}
4061
- * @memberof ScheduledConversationGroupAllOfCustomers
4062
- */
4063
- '$agent'?: string;
4064
4384
  }
4065
4385
  /**
4066
4386
  *
@@ -4199,112 +4519,112 @@ export interface UpdateAgentResponse {
4199
4519
  export interface UpdateAgentsRequest {
4200
4520
  /**
4201
4521
  *
4202
- * @type {Array<UpdateAgentsRequestCustomersInner>}
4522
+ * @type {Array<UpdateAgentsRequestAgentsInner>}
4203
4523
  * @memberof UpdateAgentsRequest
4204
4524
  */
4205
- 'customers'?: Array<UpdateAgentsRequestCustomersInner>;
4525
+ 'agents'?: Array<UpdateAgentsRequestAgentsInner>;
4206
4526
  }
4207
4527
  /**
4208
4528
  *
4209
4529
  * @export
4210
- * @interface UpdateAgentsRequestCustomersInner
4530
+ * @interface UpdateAgentsRequestAgentsInner
4211
4531
  */
4212
- export interface UpdateAgentsRequestCustomersInner {
4532
+ export interface UpdateAgentsRequestAgentsInner {
4213
4533
  /**
4214
4534
  * Agent first name
4215
4535
  * @type {string}
4216
- * @memberof UpdateAgentsRequestCustomersInner
4536
+ * @memberof UpdateAgentsRequestAgentsInner
4217
4537
  */
4218
4538
  'firstName': string;
4219
4539
  /**
4220
4540
  * Agent last name
4221
4541
  * @type {string}
4222
- * @memberof UpdateAgentsRequestCustomersInner
4542
+ * @memberof UpdateAgentsRequestAgentsInner
4223
4543
  */
4224
4544
  'lastName': string;
4225
4545
  /**
4226
4546
  * Agent is inactive
4227
4547
  * @type {boolean}
4228
- * @memberof UpdateAgentsRequestCustomersInner
4548
+ * @memberof UpdateAgentsRequestAgentsInner
4229
4549
  */
4230
4550
  'inactive'?: boolean;
4231
4551
  /**
4232
4552
  * Programmable phone number
4233
4553
  * @type {string}
4234
- * @memberof UpdateAgentsRequestCustomersInner
4554
+ * @memberof UpdateAgentsRequestAgentsInner
4235
4555
  */
4236
4556
  'programmablePhoneNumber'?: string;
4237
4557
  /**
4238
4558
  * Programmable phone number SID
4239
4559
  * @type {string}
4240
- * @memberof UpdateAgentsRequestCustomersInner
4560
+ * @memberof UpdateAgentsRequestAgentsInner
4241
4561
  */
4242
4562
  'programmablePhoneNumberSid'?: string;
4243
4563
  /**
4244
4564
  * Email address from Scout9 gmail subdomain
4245
4565
  * @type {string}
4246
- * @memberof UpdateAgentsRequestCustomersInner
4566
+ * @memberof UpdateAgentsRequestAgentsInner
4247
4567
  */
4248
4568
  'programmableEmail'?: string;
4249
4569
  /**
4250
4570
  * Forward email
4251
4571
  * @type {string}
4252
- * @memberof UpdateAgentsRequestCustomersInner
4572
+ * @memberof UpdateAgentsRequestAgentsInner
4253
4573
  */
4254
4574
  'forwardEmail'?: string;
4255
4575
  /**
4256
4576
  * Forward phone
4257
4577
  * @type {string}
4258
- * @memberof UpdateAgentsRequestCustomersInner
4578
+ * @memberof UpdateAgentsRequestAgentsInner
4259
4579
  */
4260
4580
  'forwardPhone': string;
4261
4581
  /**
4262
4582
  * Title of the agent, defaults to \"Agent\"
4263
4583
  * @type {string}
4264
- * @memberof UpdateAgentsRequestCustomersInner
4584
+ * @memberof UpdateAgentsRequestAgentsInner
4265
4585
  */
4266
4586
  'title'?: string;
4267
4587
  /**
4268
4588
  * Context of the agent, defaults to \"Agent\"
4269
4589
  * @type {string}
4270
- * @memberof UpdateAgentsRequestCustomersInner
4590
+ * @memberof UpdateAgentsRequestAgentsInner
4271
4591
  */
4272
4592
  'context'?: string;
4273
4593
  /**
4274
4594
  * Locations ids the agent is included in
4275
4595
  * @type {Array<string>}
4276
- * @memberof UpdateAgentsRequestCustomersInner
4596
+ * @memberof UpdateAgentsRequestAgentsInner
4277
4597
  */
4278
4598
  'includedLocations'?: Array<string>;
4279
4599
  /**
4280
4600
  * Locations id the agent is excluded from
4281
4601
  * @type {Array<string>}
4282
- * @memberof UpdateAgentsRequestCustomersInner
4602
+ * @memberof UpdateAgentsRequestAgentsInner
4283
4603
  */
4284
4604
  'excludedLocations'?: Array<string>;
4285
4605
  /**
4286
4606
  * Transcript of the agent
4287
4607
  * @type {string}
4288
- * @memberof UpdateAgentsRequestCustomersInner
4608
+ * @memberof UpdateAgentsRequestAgentsInner
4289
4609
  */
4290
4610
  'transcript'?: string;
4291
4611
  /**
4292
4612
  * The ID of the agent
4293
4613
  * @type {string}
4294
- * @memberof UpdateAgentsRequestCustomersInner
4614
+ * @memberof UpdateAgentsRequestAgentsInner
4295
4615
  */
4296
4616
  '$id': string;
4297
4617
  }
4298
4618
  /**
4299
4619
  *
4300
4620
  * @export
4301
- * @interface UpdateAgentsRequestCustomersInnerAllOf
4621
+ * @interface UpdateAgentsRequestAgentsInnerAllOf
4302
4622
  */
4303
- export interface UpdateAgentsRequestCustomersInnerAllOf {
4623
+ export interface UpdateAgentsRequestAgentsInnerAllOf {
4304
4624
  /**
4305
4625
  * The ID of the agent
4306
4626
  * @type {string}
4307
- * @memberof UpdateAgentsRequestCustomersInnerAllOf
4627
+ * @memberof UpdateAgentsRequestAgentsInnerAllOf
4308
4628
  */
4309
4629
  '$id': string;
4310
4630
  }
@@ -4431,7 +4751,7 @@ export interface UpdateContextsRequest {
4431
4751
  * @type {Array<ListContextsResponseInner>}
4432
4752
  * @memberof UpdateContextsRequest
4433
4753
  */
4434
- 'customers'?: Array<ListContextsResponseInner>;
4754
+ 'contexts'?: Array<ListContextsResponseInner>;
4435
4755
  }
4436
4756
  /**
4437
4757
  *
@@ -4452,6 +4772,115 @@ export interface UpdateContextsResponse {
4452
4772
  */
4453
4773
  '$operation': string;
4454
4774
  }
4775
+ /**
4776
+ *
4777
+ * @export
4778
+ * @interface UpdateCustomerGroupRequest
4779
+ */
4780
+ export interface UpdateCustomerGroupRequest {
4781
+ /**
4782
+ * The name of the customer group
4783
+ * @type {string}
4784
+ * @memberof UpdateCustomerGroupRequest
4785
+ */
4786
+ 'name': string;
4787
+ /**
4788
+ * The description of the customer group
4789
+ * @type {string}
4790
+ * @memberof UpdateCustomerGroupRequest
4791
+ */
4792
+ 'description'?: string;
4793
+ /**
4794
+ *
4795
+ * @type {{ [key: string]: any; }}
4796
+ * @memberof UpdateCustomerGroupRequest
4797
+ */
4798
+ 'metadata'?: {
4799
+ [key: string]: any;
4800
+ };
4801
+ /**
4802
+ *
4803
+ * @type {Array<CustomerGroupRecord>}
4804
+ * @memberof UpdateCustomerGroupRequest
4805
+ */
4806
+ 'customers': Array<CustomerGroupRecord>;
4807
+ /**
4808
+ * The ID of the CustomerGroup
4809
+ * @type {string}
4810
+ * @memberof UpdateCustomerGroupRequest
4811
+ */
4812
+ '$id': string;
4813
+ }
4814
+ /**
4815
+ *
4816
+ * @export
4817
+ * @interface UpdateCustomerGroupRequestAllOf
4818
+ */
4819
+ export interface UpdateCustomerGroupRequestAllOf {
4820
+ /**
4821
+ * The ID of the CustomerGroup
4822
+ * @type {string}
4823
+ * @memberof UpdateCustomerGroupRequestAllOf
4824
+ */
4825
+ '$id': string;
4826
+ }
4827
+ /**
4828
+ *
4829
+ * @export
4830
+ * @interface UpdateCustomerGroupResponse
4831
+ */
4832
+ export interface UpdateCustomerGroupResponse {
4833
+ /**
4834
+ *
4835
+ * @type {boolean}
4836
+ * @memberof UpdateCustomerGroupResponse
4837
+ */
4838
+ 'success': boolean;
4839
+ /**
4840
+ *
4841
+ * @type {Error}
4842
+ * @memberof UpdateCustomerGroupResponse
4843
+ */
4844
+ 'error'?: Error;
4845
+ /**
4846
+ * The id of the document that was created, updated, or deleted
4847
+ * @type {string}
4848
+ * @memberof UpdateCustomerGroupResponse
4849
+ */
4850
+ 'id': string;
4851
+ }
4852
+ /**
4853
+ *
4854
+ * @export
4855
+ * @interface UpdateCustomerGroupsRequest
4856
+ */
4857
+ export interface UpdateCustomerGroupsRequest {
4858
+ /**
4859
+ *
4860
+ * @type {Array<ListCustomerGroupsResponseInner>}
4861
+ * @memberof UpdateCustomerGroupsRequest
4862
+ */
4863
+ 'CustomerGroups'?: Array<ListCustomerGroupsResponseInner>;
4864
+ }
4865
+ /**
4866
+ *
4867
+ * @export
4868
+ * @interface UpdateCustomerGroupsResponse
4869
+ */
4870
+ export interface UpdateCustomerGroupsResponse {
4871
+ /**
4872
+ * ISO 8601 datetime string of when the operation was queued
4873
+ * @type {string}
4874
+ * @memberof UpdateCustomerGroupsResponse
4875
+ */
4876
+ 'queued': string;
4877
+ /**
4878
+ * The operation id to view the operation end results
4879
+ * @type {string}
4880
+ * @memberof UpdateCustomerGroupsResponse
4881
+ */
4882
+ '$operation': string;
4883
+ }
4455
4884
  /**
4456
4885
  *
4457
4886
  * @export
@@ -4765,7 +5194,7 @@ export interface UpdateWorkflowsRequest {
4765
5194
  * @type {Array<ListWorkflowsResponseInner>}
4766
5195
  * @memberof UpdateWorkflowsRequest
4767
5196
  */
4768
- 'customers'?: Array<ListWorkflowsResponseInner>;
5197
+ 'workflows'?: Array<ListWorkflowsResponseInner>;
4769
5198
  }
4770
5199
  /**
4771
5200
  *
@@ -5032,6 +5461,71 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5032
5461
  * @throws {RequiredError}
5033
5462
  */
5034
5463
  customerDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5464
+ /**
5465
+ *
5466
+ * @summary Gets a customer group
5467
+ * @param {string} id
5468
+ * @param {*} [options] Override http request option.
5469
+ * @throws {RequiredError}
5470
+ */
5471
+ customerGroup: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5472
+ /**
5473
+ *
5474
+ * @summary Creates a new customer group
5475
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
5476
+ * @param {*} [options] Override http request option.
5477
+ * @throws {RequiredError}
5478
+ */
5479
+ customerGroupCreate: (createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5480
+ /**
5481
+ *
5482
+ * @summary Deletes a customer group
5483
+ * @param {string} id
5484
+ * @param {*} [options] Override http request option.
5485
+ * @throws {RequiredError}
5486
+ */
5487
+ customerGroupDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5488
+ /**
5489
+ *
5490
+ * @summary Updates a customer group
5491
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
5492
+ * @param {*} [options] Override http request option.
5493
+ * @throws {RequiredError}
5494
+ */
5495
+ customerGroupUpdate: (updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5496
+ /**
5497
+ *
5498
+ * @summary Gets all or specific set of customer groups
5499
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5500
+ * @param {Array<string>} [id]
5501
+ * @param {*} [options] Override http request option.
5502
+ * @throws {RequiredError}
5503
+ */
5504
+ customerGroups: (q?: string, id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5505
+ /**
5506
+ *
5507
+ * @summary Creates new customer groups
5508
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
5509
+ * @param {*} [options] Override http request option.
5510
+ * @throws {RequiredError}
5511
+ */
5512
+ customerGroupsCreate: (createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5513
+ /**
5514
+ *
5515
+ * @summary Deletes multiple customer groups
5516
+ * @param {Array<string>} [id]
5517
+ * @param {*} [options] Override http request option.
5518
+ * @throws {RequiredError}
5519
+ */
5520
+ customerGroupsDelete: (id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5521
+ /**
5522
+ *
5523
+ * @summary Updates multiple customer groups
5524
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
5525
+ * @param {*} [options] Override http request option.
5526
+ * @throws {RequiredError}
5527
+ */
5528
+ customerGroupsUpdate: (updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5035
5529
  /**
5036
5530
  *
5037
5531
  * @summary Updates a customer
@@ -5436,6 +5930,71 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5436
5930
  * @throws {RequiredError}
5437
5931
  */
5438
5932
  customerDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerResponse>>;
5933
+ /**
5934
+ *
5935
+ * @summary Gets a customer group
5936
+ * @param {string} id
5937
+ * @param {*} [options] Override http request option.
5938
+ * @throws {RequiredError}
5939
+ */
5940
+ customerGroup(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerGroupResponse>>;
5941
+ /**
5942
+ *
5943
+ * @summary Creates a new customer group
5944
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
5945
+ * @param {*} [options] Override http request option.
5946
+ * @throws {RequiredError}
5947
+ */
5948
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupResponse>>;
5949
+ /**
5950
+ *
5951
+ * @summary Deletes a customer group
5952
+ * @param {string} id
5953
+ * @param {*} [options] Override http request option.
5954
+ * @throws {RequiredError}
5955
+ */
5956
+ customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupResponse>>;
5957
+ /**
5958
+ *
5959
+ * @summary Updates a customer group
5960
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
5961
+ * @param {*} [options] Override http request option.
5962
+ * @throws {RequiredError}
5963
+ */
5964
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupResponse>>;
5965
+ /**
5966
+ *
5967
+ * @summary Gets all or specific set of customer groups
5968
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5969
+ * @param {Array<string>} [id]
5970
+ * @param {*} [options] Override http request option.
5971
+ * @throws {RequiredError}
5972
+ */
5973
+ customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListCustomerGroupsResponseInner>>>;
5974
+ /**
5975
+ *
5976
+ * @summary Creates new customer groups
5977
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
5978
+ * @param {*} [options] Override http request option.
5979
+ * @throws {RequiredError}
5980
+ */
5981
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupsResponse>>;
5982
+ /**
5983
+ *
5984
+ * @summary Deletes multiple customer groups
5985
+ * @param {Array<string>} [id]
5986
+ * @param {*} [options] Override http request option.
5987
+ * @throws {RequiredError}
5988
+ */
5989
+ customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupsResponse>>;
5990
+ /**
5991
+ *
5992
+ * @summary Updates multiple customer groups
5993
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
5994
+ * @param {*} [options] Override http request option.
5995
+ * @throws {RequiredError}
5996
+ */
5997
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupsResponse>>;
5439
5998
  /**
5440
5999
  *
5441
6000
  * @summary Updates a customer
@@ -5840,6 +6399,71 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5840
6399
  * @throws {RequiredError}
5841
6400
  */
5842
6401
  customerDelete(id: string, options?: any): AxiosPromise<DeleteCustomerResponse>;
6402
+ /**
6403
+ *
6404
+ * @summary Gets a customer group
6405
+ * @param {string} id
6406
+ * @param {*} [options] Override http request option.
6407
+ * @throws {RequiredError}
6408
+ */
6409
+ customerGroup(id: string, options?: any): AxiosPromise<GetCustomerGroupResponse>;
6410
+ /**
6411
+ *
6412
+ * @summary Creates a new customer group
6413
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
6414
+ * @param {*} [options] Override http request option.
6415
+ * @throws {RequiredError}
6416
+ */
6417
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: any): AxiosPromise<CreateCustomerGroupResponse>;
6418
+ /**
6419
+ *
6420
+ * @summary Deletes a customer group
6421
+ * @param {string} id
6422
+ * @param {*} [options] Override http request option.
6423
+ * @throws {RequiredError}
6424
+ */
6425
+ customerGroupDelete(id: string, options?: any): AxiosPromise<DeleteCustomerGroupResponse>;
6426
+ /**
6427
+ *
6428
+ * @summary Updates a customer group
6429
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
6430
+ * @param {*} [options] Override http request option.
6431
+ * @throws {RequiredError}
6432
+ */
6433
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: any): AxiosPromise<UpdateCustomerGroupResponse>;
6434
+ /**
6435
+ *
6436
+ * @summary Gets all or specific set of customer groups
6437
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6438
+ * @param {Array<string>} [id]
6439
+ * @param {*} [options] Override http request option.
6440
+ * @throws {RequiredError}
6441
+ */
6442
+ customerGroups(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<ListCustomerGroupsResponseInner>>;
6443
+ /**
6444
+ *
6445
+ * @summary Creates new customer groups
6446
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
6447
+ * @param {*} [options] Override http request option.
6448
+ * @throws {RequiredError}
6449
+ */
6450
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: any): AxiosPromise<CreateCustomerGroupsResponse>;
6451
+ /**
6452
+ *
6453
+ * @summary Deletes multiple customer groups
6454
+ * @param {Array<string>} [id]
6455
+ * @param {*} [options] Override http request option.
6456
+ * @throws {RequiredError}
6457
+ */
6458
+ customerGroupsDelete(id?: Array<string>, options?: any): AxiosPromise<DeleteCustomerGroupsResponse>;
6459
+ /**
6460
+ *
6461
+ * @summary Updates multiple customer groups
6462
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
6463
+ * @param {*} [options] Override http request option.
6464
+ * @throws {RequiredError}
6465
+ */
6466
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: any): AxiosPromise<UpdateCustomerGroupsResponse>;
5843
6467
  /**
5844
6468
  *
5845
6469
  * @summary Updates a customer
@@ -6269,6 +6893,79 @@ export declare class Scout9Api extends BaseAPI {
6269
6893
  * @memberof Scout9Api
6270
6894
  */
6271
6895
  customerDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerResponse, any>>;
6896
+ /**
6897
+ *
6898
+ * @summary Gets a customer group
6899
+ * @param {string} id
6900
+ * @param {*} [options] Override http request option.
6901
+ * @throws {RequiredError}
6902
+ * @memberof Scout9Api
6903
+ */
6904
+ customerGroup(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerGroupResponse, any>>;
6905
+ /**
6906
+ *
6907
+ * @summary Creates a new customer group
6908
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
6909
+ * @param {*} [options] Override http request option.
6910
+ * @throws {RequiredError}
6911
+ * @memberof Scout9Api
6912
+ */
6913
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupResponse, any>>;
6914
+ /**
6915
+ *
6916
+ * @summary Deletes a customer group
6917
+ * @param {string} id
6918
+ * @param {*} [options] Override http request option.
6919
+ * @throws {RequiredError}
6920
+ * @memberof Scout9Api
6921
+ */
6922
+ customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupResponse, any>>;
6923
+ /**
6924
+ *
6925
+ * @summary Updates a customer group
6926
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
6927
+ * @param {*} [options] Override http request option.
6928
+ * @throws {RequiredError}
6929
+ * @memberof Scout9Api
6930
+ */
6931
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupResponse, any>>;
6932
+ /**
6933
+ *
6934
+ * @summary Gets all or specific set of customer groups
6935
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6936
+ * @param {Array<string>} [id]
6937
+ * @param {*} [options] Override http request option.
6938
+ * @throws {RequiredError}
6939
+ * @memberof Scout9Api
6940
+ */
6941
+ customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerGroupsResponseInner[], any>>;
6942
+ /**
6943
+ *
6944
+ * @summary Creates new customer groups
6945
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
6946
+ * @param {*} [options] Override http request option.
6947
+ * @throws {RequiredError}
6948
+ * @memberof Scout9Api
6949
+ */
6950
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupsResponse, any>>;
6951
+ /**
6952
+ *
6953
+ * @summary Deletes multiple customer groups
6954
+ * @param {Array<string>} [id]
6955
+ * @param {*} [options] Override http request option.
6956
+ * @throws {RequiredError}
6957
+ * @memberof Scout9Api
6958
+ */
6959
+ customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupsResponse, any>>;
6960
+ /**
6961
+ *
6962
+ * @summary Updates multiple customer groups
6963
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
6964
+ * @param {*} [options] Override http request option.
6965
+ * @throws {RequiredError}
6966
+ * @memberof Scout9Api
6967
+ */
6968
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupsResponse, any>>;
6272
6969
  /**
6273
6970
  *
6274
6971
  * @summary Updates a customer