@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/src/api.ts CHANGED
@@ -348,12 +348,6 @@ export interface Conversation {
348
348
  * @memberof Conversation
349
349
  */
350
350
  '$agent': string;
351
- /**
352
- * Thread this conversation is in - this determines what context to pull when loading the conversation
353
- * @type {string}
354
- * @memberof Conversation
355
- */
356
- '$thread'?: string;
357
351
  /**
358
352
  * Initial contexts to load when starting the conversation
359
353
  * @type {Array<string>}
@@ -414,12 +408,6 @@ export interface ConversationBase {
414
408
  * @memberof ConversationBase
415
409
  */
416
410
  '$agent': string;
417
- /**
418
- * Thread this conversation is in - this determines what context to pull when loading the conversation
419
- * @type {string}
420
- * @memberof ConversationBase
421
- */
422
- '$thread'?: string;
423
411
  /**
424
412
  * Initial contexts to load when starting the conversation
425
413
  * @type {Array<string>}
@@ -559,12 +547,6 @@ export interface ConversationCreateRequest {
559
547
  * @memberof ConversationCreateRequest
560
548
  */
561
549
  '$agent': string;
562
- /**
563
- * Thread this conversation is in - this determines what context to pull when loading the conversation
564
- * @type {string}
565
- * @memberof ConversationCreateRequest
566
- */
567
- '$thread'?: string;
568
550
  /**
569
551
  * Initial contexts to load when starting the conversation
570
552
  * @type {Array<string>}
@@ -589,9 +571,28 @@ export interface ConversationCreateRequest {
589
571
  * @memberof ConversationCreateRequest
590
572
  */
591
573
  'environment': ConversationEnvironment;
574
+ /**
575
+ *
576
+ * @type {ConversationUpdateRequestBaseWorkflow}
577
+ * @memberof ConversationCreateRequest
578
+ */
579
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
592
580
  }
593
581
 
594
582
 
583
+ /**
584
+ *
585
+ * @export
586
+ * @interface ConversationCreateRequestBase
587
+ */
588
+ export interface ConversationCreateRequestBase {
589
+ /**
590
+ *
591
+ * @type {ConversationUpdateRequestBaseWorkflow}
592
+ * @memberof ConversationCreateRequestBase
593
+ */
594
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
595
+ }
595
596
  /**
596
597
  *
597
598
  * @export
@@ -693,12 +694,6 @@ export interface ConversationGetResponse {
693
694
  * @memberof ConversationGetResponse
694
695
  */
695
696
  '$agent': string;
696
- /**
697
- * Thread this conversation is in - this determines what context to pull when loading the conversation
698
- * @type {string}
699
- * @memberof ConversationGetResponse
700
- */
701
- '$thread'?: string;
702
697
  /**
703
698
  * Initial contexts to load when starting the conversation
704
699
  * @type {Array<string>}
@@ -741,6 +736,12 @@ export interface ConversationGetResponse {
741
736
  * @memberof ConversationGetResponse
742
737
  */
743
738
  'agentTestWebUrl'?: string;
739
+ /**
740
+ * The ID of the workflow used for this conversation
741
+ * @type {string}
742
+ * @memberof ConversationGetResponse
743
+ */
744
+ '$workflow': string;
744
745
  /**
745
746
  * ISO 8601 date string of when the conversation was initiated
746
747
  * @type {string}
@@ -775,6 +776,19 @@ export interface ConversationGetResponseAllOf {
775
776
  */
776
777
  '$id': string;
777
778
  }
779
+ /**
780
+ *
781
+ * @export
782
+ * @interface ConversationGetResponseBase
783
+ */
784
+ export interface ConversationGetResponseBase {
785
+ /**
786
+ * The ID of the workflow used for this conversation
787
+ * @type {string}
788
+ * @memberof ConversationGetResponseBase
789
+ */
790
+ '$workflow': string;
791
+ }
778
792
  /**
779
793
  *
780
794
  * @export
@@ -837,12 +851,6 @@ export interface ConversationUpdateRequest {
837
851
  * @memberof ConversationUpdateRequest
838
852
  */
839
853
  '$agent': string;
840
- /**
841
- * Thread this conversation is in - this determines what context to pull when loading the conversation
842
- * @type {string}
843
- * @memberof ConversationUpdateRequest
844
- */
845
- '$thread'?: string;
846
854
  /**
847
855
  * Initial contexts to load when starting the conversation
848
856
  * @type {Array<string>}
@@ -867,6 +875,12 @@ export interface ConversationUpdateRequest {
867
875
  * @memberof ConversationUpdateRequest
868
876
  */
869
877
  'environment': ConversationEnvironment;
878
+ /**
879
+ *
880
+ * @type {ConversationUpdateRequestAllOfWorkflow}
881
+ * @memberof ConversationUpdateRequest
882
+ */
883
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
870
884
  /**
871
885
  * The ID of the conversation to update
872
886
  * @type {string}
@@ -888,7 +902,38 @@ export interface ConversationUpdateRequestAllOf {
888
902
  * @memberof ConversationUpdateRequestAllOf
889
903
  */
890
904
  '$id': string;
905
+ /**
906
+ *
907
+ * @type {ConversationUpdateRequestAllOfWorkflow}
908
+ * @memberof ConversationUpdateRequestAllOf
909
+ */
910
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
911
+ }
912
+ /**
913
+ * @type ConversationUpdateRequestAllOfWorkflow
914
+ * @export
915
+ */
916
+ export type ConversationUpdateRequestAllOfWorkflow = Workflow | string;
917
+
918
+ /**
919
+ *
920
+ * @export
921
+ * @interface ConversationUpdateRequestBase
922
+ */
923
+ export interface ConversationUpdateRequestBase {
924
+ /**
925
+ *
926
+ * @type {ConversationUpdateRequestBaseWorkflow}
927
+ * @memberof ConversationUpdateRequestBase
928
+ */
929
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
891
930
  }
931
+ /**
932
+ * @type ConversationUpdateRequestBaseWorkflow
933
+ * @export
934
+ */
935
+ export type ConversationUpdateRequestBaseWorkflow = Workflow | string;
936
+
892
937
  /**
893
938
  *
894
939
  * @export
@@ -1057,93 +1102,93 @@ export interface CreateAgentResponse {
1057
1102
  export interface CreateAgentsRequest {
1058
1103
  /**
1059
1104
  *
1060
- * @type {Array<CreateAgentsRequestCustomersInner>}
1105
+ * @type {Array<CreateAgentsRequestAgentsInner>}
1061
1106
  * @memberof CreateAgentsRequest
1062
1107
  */
1063
- 'customers'?: Array<CreateAgentsRequestCustomersInner>;
1108
+ 'agents'?: Array<CreateAgentsRequestAgentsInner>;
1064
1109
  }
1065
1110
  /**
1066
1111
  *
1067
1112
  * @export
1068
- * @interface CreateAgentsRequestCustomersInner
1113
+ * @interface CreateAgentsRequestAgentsInner
1069
1114
  */
1070
- export interface CreateAgentsRequestCustomersInner {
1115
+ export interface CreateAgentsRequestAgentsInner {
1071
1116
  /**
1072
1117
  * Agent first name
1073
1118
  * @type {string}
1074
- * @memberof CreateAgentsRequestCustomersInner
1119
+ * @memberof CreateAgentsRequestAgentsInner
1075
1120
  */
1076
1121
  'firstName': string;
1077
1122
  /**
1078
1123
  * Agent last name
1079
1124
  * @type {string}
1080
- * @memberof CreateAgentsRequestCustomersInner
1125
+ * @memberof CreateAgentsRequestAgentsInner
1081
1126
  */
1082
1127
  'lastName': string;
1083
1128
  /**
1084
1129
  * Agent is inactive
1085
1130
  * @type {boolean}
1086
- * @memberof CreateAgentsRequestCustomersInner
1131
+ * @memberof CreateAgentsRequestAgentsInner
1087
1132
  */
1088
1133
  'inactive'?: boolean;
1089
1134
  /**
1090
1135
  * Programmable phone number
1091
1136
  * @type {string}
1092
- * @memberof CreateAgentsRequestCustomersInner
1137
+ * @memberof CreateAgentsRequestAgentsInner
1093
1138
  */
1094
1139
  'programmablePhoneNumber'?: string;
1095
1140
  /**
1096
1141
  * Programmable phone number SID
1097
1142
  * @type {string}
1098
- * @memberof CreateAgentsRequestCustomersInner
1143
+ * @memberof CreateAgentsRequestAgentsInner
1099
1144
  */
1100
1145
  'programmablePhoneNumberSid'?: string;
1101
1146
  /**
1102
1147
  * Email address from Scout9 gmail subdomain
1103
1148
  * @type {string}
1104
- * @memberof CreateAgentsRequestCustomersInner
1149
+ * @memberof CreateAgentsRequestAgentsInner
1105
1150
  */
1106
1151
  'programmableEmail'?: string;
1107
1152
  /**
1108
1153
  * Forward email
1109
1154
  * @type {string}
1110
- * @memberof CreateAgentsRequestCustomersInner
1155
+ * @memberof CreateAgentsRequestAgentsInner
1111
1156
  */
1112
1157
  'forwardEmail'?: string;
1113
1158
  /**
1114
1159
  * Forward phone
1115
1160
  * @type {string}
1116
- * @memberof CreateAgentsRequestCustomersInner
1161
+ * @memberof CreateAgentsRequestAgentsInner
1117
1162
  */
1118
1163
  'forwardPhone': string;
1119
1164
  /**
1120
1165
  * Title of the agent, defaults to \"Agent\"
1121
1166
  * @type {string}
1122
- * @memberof CreateAgentsRequestCustomersInner
1167
+ * @memberof CreateAgentsRequestAgentsInner
1123
1168
  */
1124
1169
  'title'?: string;
1125
1170
  /**
1126
1171
  * Context of the agent, defaults to \"Agent\"
1127
1172
  * @type {string}
1128
- * @memberof CreateAgentsRequestCustomersInner
1173
+ * @memberof CreateAgentsRequestAgentsInner
1129
1174
  */
1130
1175
  'context'?: string;
1131
1176
  /**
1132
1177
  * Locations ids the agent is included in
1133
1178
  * @type {Array<string>}
1134
- * @memberof CreateAgentsRequestCustomersInner
1179
+ * @memberof CreateAgentsRequestAgentsInner
1135
1180
  */
1136
1181
  'includedLocations'?: Array<string>;
1137
1182
  /**
1138
1183
  * Locations id the agent is excluded from
1139
1184
  * @type {Array<string>}
1140
- * @memberof CreateAgentsRequestCustomersInner
1185
+ * @memberof CreateAgentsRequestAgentsInner
1141
1186
  */
1142
1187
  'excludedLocations'?: Array<string>;
1143
1188
  /**
1144
1189
  * Transcript of the agent
1145
1190
  * @type {string}
1146
- * @memberof CreateAgentsRequestCustomersInner
1191
+ * @memberof CreateAgentsRequestAgentsInner
1147
1192
  */
1148
1193
  'transcript'?: string;
1149
1194
  }
@@ -1248,57 +1293,57 @@ export interface CreateContextResponse {
1248
1293
  export interface CreateContextsRequest {
1249
1294
  /**
1250
1295
  *
1251
- * @type {Array<CreateContextsRequestCustomersInner>}
1296
+ * @type {Array<CreateContextsRequestContextsInner>}
1252
1297
  * @memberof CreateContextsRequest
1253
1298
  */
1254
- 'customers'?: Array<CreateContextsRequestCustomersInner>;
1299
+ 'contexts'?: Array<CreateContextsRequestContextsInner>;
1255
1300
  }
1256
1301
  /**
1257
1302
  *
1258
1303
  * @export
1259
- * @interface CreateContextsRequestCustomersInner
1304
+ * @interface CreateContextsRequestContextsInner
1260
1305
  */
1261
- export interface CreateContextsRequestCustomersInner {
1306
+ export interface CreateContextsRequestContextsInner {
1262
1307
  /**
1263
1308
  * The name of the context
1264
1309
  * @type {string}
1265
- * @memberof CreateContextsRequestCustomersInner
1310
+ * @memberof CreateContextsRequestContextsInner
1266
1311
  */
1267
1312
  'name': string;
1268
1313
  /**
1269
1314
  * Whether or not the context is modifiable
1270
1315
  * @type {boolean}
1271
- * @memberof CreateContextsRequestCustomersInner
1316
+ * @memberof CreateContextsRequestContextsInner
1272
1317
  */
1273
1318
  'modifiable': boolean;
1274
1319
  /**
1275
1320
  * The description of the context
1276
1321
  * @type {string}
1277
- * @memberof CreateContextsRequestCustomersInner
1322
+ * @memberof CreateContextsRequestContextsInner
1278
1323
  */
1279
1324
  'description'?: string;
1280
1325
  /**
1281
1326
  *
1282
1327
  * @type {ContextDetectionParams}
1283
- * @memberof CreateContextsRequestCustomersInner
1328
+ * @memberof CreateContextsRequestContextsInner
1284
1329
  */
1285
1330
  'detection'?: ContextDetectionParams;
1286
1331
  /**
1287
1332
  * The ID column of the context
1288
1333
  * @type {string}
1289
- * @memberof CreateContextsRequestCustomersInner
1334
+ * @memberof CreateContextsRequestContextsInner
1290
1335
  */
1291
1336
  'idColumn': string;
1292
1337
  /**
1293
1338
  * The columns of the context
1294
1339
  * @type {Array<string>}
1295
- * @memberof CreateContextsRequestCustomersInner
1340
+ * @memberof CreateContextsRequestContextsInner
1296
1341
  */
1297
1342
  'columns': Array<string>;
1298
1343
  /**
1299
1344
  * The required columns of the context
1300
1345
  * @type {Array<string>}
1301
- * @memberof CreateContextsRequestCustomersInner
1346
+ * @memberof CreateContextsRequestContextsInner
1302
1347
  */
1303
1348
  'requiredColumns'?: Array<string>;
1304
1349
  }
@@ -1321,6 +1366,94 @@ export interface CreateContextsResponse {
1321
1366
  */
1322
1367
  '$operation': string;
1323
1368
  }
1369
+ /**
1370
+ *
1371
+ * @export
1372
+ * @interface CreateCustomerGroupRequest
1373
+ */
1374
+ export interface CreateCustomerGroupRequest {
1375
+ /**
1376
+ * The name of the customer group
1377
+ * @type {string}
1378
+ * @memberof CreateCustomerGroupRequest
1379
+ */
1380
+ 'name': string;
1381
+ /**
1382
+ * The description of the customer group
1383
+ * @type {string}
1384
+ * @memberof CreateCustomerGroupRequest
1385
+ */
1386
+ 'description'?: string;
1387
+ /**
1388
+ *
1389
+ * @type {{ [key: string]: any; }}
1390
+ * @memberof CreateCustomerGroupRequest
1391
+ */
1392
+ 'metadata'?: { [key: string]: any; };
1393
+ /**
1394
+ *
1395
+ * @type {Array<CustomerGroupRecord>}
1396
+ * @memberof CreateCustomerGroupRequest
1397
+ */
1398
+ 'customers': Array<CustomerGroupRecord>;
1399
+ }
1400
+ /**
1401
+ *
1402
+ * @export
1403
+ * @interface CreateCustomerGroupResponse
1404
+ */
1405
+ export interface CreateCustomerGroupResponse {
1406
+ /**
1407
+ *
1408
+ * @type {boolean}
1409
+ * @memberof CreateCustomerGroupResponse
1410
+ */
1411
+ 'success': boolean;
1412
+ /**
1413
+ *
1414
+ * @type {Error}
1415
+ * @memberof CreateCustomerGroupResponse
1416
+ */
1417
+ 'error'?: Error;
1418
+ /**
1419
+ * The id of the document that was created, updated, or deleted
1420
+ * @type {string}
1421
+ * @memberof CreateCustomerGroupResponse
1422
+ */
1423
+ 'id': string;
1424
+ }
1425
+ /**
1426
+ *
1427
+ * @export
1428
+ * @interface CreateCustomerGroupsRequest
1429
+ */
1430
+ export interface CreateCustomerGroupsRequest {
1431
+ /**
1432
+ *
1433
+ * @type {Array<CustomerGroup>}
1434
+ * @memberof CreateCustomerGroupsRequest
1435
+ */
1436
+ 'CustomerGroups': Array<CustomerGroup>;
1437
+ }
1438
+ /**
1439
+ *
1440
+ * @export
1441
+ * @interface CreateCustomerGroupsResponse
1442
+ */
1443
+ export interface CreateCustomerGroupsResponse {
1444
+ /**
1445
+ * ISO 8601 datetime string of when the operation was queued
1446
+ * @type {string}
1447
+ * @memberof CreateCustomerGroupsResponse
1448
+ */
1449
+ 'queued': string;
1450
+ /**
1451
+ * The operation id to view the operation end results
1452
+ * @type {string}
1453
+ * @memberof CreateCustomerGroupsResponse
1454
+ */
1455
+ '$operation': string;
1456
+ }
1324
1457
  /**
1325
1458
  *
1326
1459
  * @export
@@ -1593,63 +1726,63 @@ export interface CreateWorkflowResponse {
1593
1726
  export interface CreateWorkflowsRequest {
1594
1727
  /**
1595
1728
  *
1596
- * @type {Array<CreateWorkflowsRequestCustomersInner>}
1729
+ * @type {Array<CreateWorkflowsRequestWorkflowsInner>}
1597
1730
  * @memberof CreateWorkflowsRequest
1598
1731
  */
1599
- 'customers'?: Array<CreateWorkflowsRequestCustomersInner>;
1732
+ 'workflows'?: Array<CreateWorkflowsRequestWorkflowsInner>;
1600
1733
  }
1601
1734
  /**
1602
1735
  *
1603
1736
  * @export
1604
- * @interface CreateWorkflowsRequestCustomersInner
1737
+ * @interface CreateWorkflowsRequestWorkflowsInner
1605
1738
  */
1606
- export interface CreateWorkflowsRequestCustomersInner {
1739
+ export interface CreateWorkflowsRequestWorkflowsInner {
1607
1740
  /**
1608
1741
  * The name of the workflow
1609
1742
  * @type {string}
1610
- * @memberof CreateWorkflowsRequestCustomersInner
1743
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1611
1744
  */
1612
1745
  'name': string;
1613
1746
  /**
1614
1747
  *
1615
1748
  * @type {ContextDetectionParams}
1616
- * @memberof CreateWorkflowsRequestCustomersInner
1749
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1617
1750
  */
1618
1751
  'initiators': ContextDetectionParams;
1619
1752
  /**
1620
1753
  * The fields of the workflow
1621
1754
  * @type {Array<ConversationContextField>}
1622
- * @memberof CreateWorkflowsRequestCustomersInner
1755
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1623
1756
  */
1624
1757
  'fields': Array<ConversationContextField>;
1625
1758
  /**
1626
1759
  * About this conversation - used as initial context
1627
1760
  * @type {string}
1628
- * @memberof CreateWorkflowsRequestCustomersInner
1761
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1629
1762
  */
1630
1763
  'context': string;
1631
1764
  /**
1632
1765
  * The webhook to call when a workflow is created
1633
1766
  * @type {string}
1634
- * @memberof CreateWorkflowsRequestCustomersInner
1767
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1635
1768
  */
1636
1769
  'onCreated'?: string;
1637
1770
  /**
1638
1771
  * The webhook to call when a workflow is updated
1639
1772
  * @type {string}
1640
- * @memberof CreateWorkflowsRequestCustomersInner
1773
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1641
1774
  */
1642
1775
  'onUpdated'?: string;
1643
1776
  /**
1644
1777
  * The webhook to call when a workflow is deleted
1645
1778
  * @type {string}
1646
- * @memberof CreateWorkflowsRequestCustomersInner
1779
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1647
1780
  */
1648
1781
  'onDeleted'?: string;
1649
1782
  /**
1650
1783
  * The webhook to call when a workflow has an error
1651
1784
  * @type {string}
1652
- * @memberof CreateWorkflowsRequestCustomersInner
1785
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1653
1786
  */
1654
1787
  'onError'?: string;
1655
1788
  }
@@ -1801,6 +1934,64 @@ export interface Customer {
1801
1934
  */
1802
1935
  'stripeDev'?: string | null;
1803
1936
  }
1937
+ /**
1938
+ * A way for a business to group customers to use in scheduling batch conversations
1939
+ * @export
1940
+ * @interface CustomerGroup
1941
+ */
1942
+ export interface CustomerGroup {
1943
+ /**
1944
+ * The name of the customer group
1945
+ * @type {string}
1946
+ * @memberof CustomerGroup
1947
+ */
1948
+ 'name': string;
1949
+ /**
1950
+ * The description of the customer group
1951
+ * @type {string}
1952
+ * @memberof CustomerGroup
1953
+ */
1954
+ 'description'?: string;
1955
+ /**
1956
+ *
1957
+ * @type {{ [key: string]: any; }}
1958
+ * @memberof CustomerGroup
1959
+ */
1960
+ 'metadata'?: { [key: string]: any; };
1961
+ /**
1962
+ *
1963
+ * @type {Array<CustomerGroupRecord>}
1964
+ * @memberof CustomerGroup
1965
+ */
1966
+ 'customers': Array<CustomerGroupRecord>;
1967
+ }
1968
+ /**
1969
+ * A way for a business to group customers to use in scheduling batch conversations
1970
+ * @export
1971
+ * @interface CustomerGroupRecord
1972
+ */
1973
+ export interface CustomerGroupRecord {
1974
+ /**
1975
+ * Customer this conversation is with
1976
+ * @type {string}
1977
+ * @memberof CustomerGroupRecord
1978
+ */
1979
+ 'id': string;
1980
+ /**
1981
+ *
1982
+ * @type {ConversationEnvironment}
1983
+ * @memberof CustomerGroupRecord
1984
+ */
1985
+ 'environment': ConversationEnvironment;
1986
+ /**
1987
+ * Overrides the default $agent for this customer
1988
+ * @type {string}
1989
+ * @memberof CustomerGroupRecord
1990
+ */
1991
+ '$agent'?: string;
1992
+ }
1993
+
1994
+
1804
1995
  /**
1805
1996
  * @type CustomerValue
1806
1997
  * @export
@@ -1895,6 +2086,50 @@ export interface DeleteContextsResponse {
1895
2086
  */
1896
2087
  '$operation': string;
1897
2088
  }
2089
+ /**
2090
+ *
2091
+ * @export
2092
+ * @interface DeleteCustomerGroupResponse
2093
+ */
2094
+ export interface DeleteCustomerGroupResponse {
2095
+ /**
2096
+ *
2097
+ * @type {boolean}
2098
+ * @memberof DeleteCustomerGroupResponse
2099
+ */
2100
+ 'success': boolean;
2101
+ /**
2102
+ *
2103
+ * @type {Error}
2104
+ * @memberof DeleteCustomerGroupResponse
2105
+ */
2106
+ 'error'?: Error;
2107
+ /**
2108
+ * The id of the document that was created, updated, or deleted
2109
+ * @type {string}
2110
+ * @memberof DeleteCustomerGroupResponse
2111
+ */
2112
+ 'id': string;
2113
+ }
2114
+ /**
2115
+ *
2116
+ * @export
2117
+ * @interface DeleteCustomerGroupsResponse
2118
+ */
2119
+ export interface DeleteCustomerGroupsResponse {
2120
+ /**
2121
+ * ISO 8601 datetime string of when the operation was queued
2122
+ * @type {string}
2123
+ * @memberof DeleteCustomerGroupsResponse
2124
+ */
2125
+ 'queued': string;
2126
+ /**
2127
+ * The operation id to view the operation end results
2128
+ * @type {string}
2129
+ * @memberof DeleteCustomerGroupsResponse
2130
+ */
2131
+ '$operation': string;
2132
+ }
1898
2133
  /**
1899
2134
  *
1900
2135
  * @export
@@ -2282,6 +2517,56 @@ export interface GetContextResponseAllOf {
2282
2517
  */
2283
2518
  '$id': string;
2284
2519
  }
2520
+ /**
2521
+ *
2522
+ * @export
2523
+ * @interface GetCustomerGroupResponse
2524
+ */
2525
+ export interface GetCustomerGroupResponse {
2526
+ /**
2527
+ * The name of the customer group
2528
+ * @type {string}
2529
+ * @memberof GetCustomerGroupResponse
2530
+ */
2531
+ 'name': string;
2532
+ /**
2533
+ * The description of the customer group
2534
+ * @type {string}
2535
+ * @memberof GetCustomerGroupResponse
2536
+ */
2537
+ 'description'?: string;
2538
+ /**
2539
+ *
2540
+ * @type {{ [key: string]: any; }}
2541
+ * @memberof GetCustomerGroupResponse
2542
+ */
2543
+ 'metadata'?: { [key: string]: any; };
2544
+ /**
2545
+ *
2546
+ * @type {Array<CustomerGroupRecord>}
2547
+ * @memberof GetCustomerGroupResponse
2548
+ */
2549
+ 'customers': Array<CustomerGroupRecord>;
2550
+ /**
2551
+ * The ID of the CustomerGroup
2552
+ * @type {string}
2553
+ * @memberof GetCustomerGroupResponse
2554
+ */
2555
+ '$id'?: string;
2556
+ }
2557
+ /**
2558
+ *
2559
+ * @export
2560
+ * @interface GetCustomerGroupResponseAllOf
2561
+ */
2562
+ export interface GetCustomerGroupResponseAllOf {
2563
+ /**
2564
+ * The ID of the CustomerGroup
2565
+ * @type {string}
2566
+ * @memberof GetCustomerGroupResponseAllOf
2567
+ */
2568
+ '$id'?: string;
2569
+ }
2285
2570
  /**
2286
2571
  *
2287
2572
  * @export
@@ -2738,30 +3023,80 @@ export interface ListContextsResponseInnerAllOf {
2738
3023
  /**
2739
3024
  *
2740
3025
  * @export
2741
- * @interface ListCustomersResponseInner
3026
+ * @interface ListCustomerGroupsResponseInner
2742
3027
  */
2743
- export interface ListCustomersResponseInner {
3028
+ export interface ListCustomerGroupsResponseInner {
2744
3029
  /**
2745
- * The customers first name
3030
+ * The name of the customer group
2746
3031
  * @type {string}
2747
- * @memberof ListCustomersResponseInner
3032
+ * @memberof ListCustomerGroupsResponseInner
2748
3033
  */
2749
- 'firstName'?: string;
3034
+ 'name': string;
2750
3035
  /**
2751
- * The customers last name
3036
+ * The description of the customer group
2752
3037
  * @type {string}
2753
- * @memberof ListCustomersResponseInner
3038
+ * @memberof ListCustomerGroupsResponseInner
2754
3039
  */
2755
- 'lastName'?: string;
3040
+ 'description'?: string;
2756
3041
  /**
2757
- * The customers full name
2758
- * @type {string}
2759
- * @memberof ListCustomersResponseInner
3042
+ *
3043
+ * @type {{ [key: string]: any; }}
3044
+ * @memberof ListCustomerGroupsResponseInner
2760
3045
  */
2761
- 'name': string;
3046
+ 'metadata'?: { [key: string]: any; };
2762
3047
  /**
2763
- * The customers email address
2764
- * @type {string}
3048
+ *
3049
+ * @type {Array<CustomerGroupRecord>}
3050
+ * @memberof ListCustomerGroupsResponseInner
3051
+ */
3052
+ 'customers': Array<CustomerGroupRecord>;
3053
+ /**
3054
+ * The ID of the CustomerGroup
3055
+ * @type {string}
3056
+ * @memberof ListCustomerGroupsResponseInner
3057
+ */
3058
+ '$id': string;
3059
+ }
3060
+ /**
3061
+ *
3062
+ * @export
3063
+ * @interface ListCustomerGroupsResponseInnerAllOf
3064
+ */
3065
+ export interface ListCustomerGroupsResponseInnerAllOf {
3066
+ /**
3067
+ * The ID of the CustomerGroup
3068
+ * @type {string}
3069
+ * @memberof ListCustomerGroupsResponseInnerAllOf
3070
+ */
3071
+ '$id': string;
3072
+ }
3073
+ /**
3074
+ *
3075
+ * @export
3076
+ * @interface ListCustomersResponseInner
3077
+ */
3078
+ export interface ListCustomersResponseInner {
3079
+ /**
3080
+ * The customers first name
3081
+ * @type {string}
3082
+ * @memberof ListCustomersResponseInner
3083
+ */
3084
+ 'firstName'?: string;
3085
+ /**
3086
+ * The customers last name
3087
+ * @type {string}
3088
+ * @memberof ListCustomersResponseInner
3089
+ */
3090
+ 'lastName'?: string;
3091
+ /**
3092
+ * The customers full name
3093
+ * @type {string}
3094
+ * @memberof ListCustomersResponseInner
3095
+ */
3096
+ 'name': string;
3097
+ /**
3098
+ * The customers email address
3099
+ * @type {string}
2765
3100
  * @memberof ListCustomersResponseInner
2766
3101
  */
2767
3102
  'email'?: string | null;
@@ -3318,12 +3653,6 @@ export interface ScheduleCreateRequest {
3318
3653
  * @memberof ScheduleCreateRequest
3319
3654
  */
3320
3655
  '$agent': string;
3321
- /**
3322
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3323
- * @type {string}
3324
- * @memberof ScheduleCreateRequest
3325
- */
3326
- '$thread'?: string;
3327
3656
  /**
3328
3657
  * Initial contexts to load when starting the conversation
3329
3658
  * @type {Array<string>}
@@ -3372,6 +3701,12 @@ export interface ScheduleCreateRequest {
3372
3701
  * @memberof ScheduleCreateRequest
3373
3702
  */
3374
3703
  '$group'?: string;
3704
+ /**
3705
+ *
3706
+ * @type {ConversationUpdateRequestBaseWorkflow}
3707
+ * @memberof ScheduleCreateRequest
3708
+ */
3709
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
3375
3710
  }
3376
3711
 
3377
3712
 
@@ -3431,12 +3766,6 @@ export interface ScheduleGetResponse {
3431
3766
  * @memberof ScheduleGetResponse
3432
3767
  */
3433
3768
  '$agent': string;
3434
- /**
3435
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3436
- * @type {string}
3437
- * @memberof ScheduleGetResponse
3438
- */
3439
- '$thread'?: string;
3440
3769
  /**
3441
3770
  * Initial contexts to load when starting the conversation
3442
3771
  * @type {Array<string>}
@@ -3485,6 +3814,12 @@ export interface ScheduleGetResponse {
3485
3814
  * @memberof ScheduleGetResponse
3486
3815
  */
3487
3816
  '$group'?: string;
3817
+ /**
3818
+ * The ID of the workflow used for this conversation
3819
+ * @type {string}
3820
+ * @memberof ScheduleGetResponse
3821
+ */
3822
+ '$workflow': string;
3488
3823
  }
3489
3824
 
3490
3825
 
@@ -3495,17 +3830,17 @@ export interface ScheduleGetResponse {
3495
3830
  */
3496
3831
  export interface ScheduleGroupCreateRequest {
3497
3832
  /**
3498
- * Default agent assigned to the conversation(s)
3499
- * @type {string}
3833
+ *
3834
+ * @type {ConversationUpdateRequestBaseWorkflow}
3500
3835
  * @memberof ScheduleGroupCreateRequest
3501
3836
  */
3502
- '$agent': string;
3837
+ '$workflow': ConversationUpdateRequestBaseWorkflow;
3503
3838
  /**
3504
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3839
+ * Default agent assigned to the conversation(s)
3505
3840
  * @type {string}
3506
3841
  * @memberof ScheduleGroupCreateRequest
3507
3842
  */
3508
- '$thread'?: string;
3843
+ '$agent': string;
3509
3844
  /**
3510
3845
  * Initial contexts to load when starting the conversation
3511
3846
  * @type {Array<string>}
@@ -3543,12 +3878,31 @@ export interface ScheduleGroupCreateRequest {
3543
3878
  */
3544
3879
  'delay'?: number;
3545
3880
  /**
3546
- * Customers in this group
3547
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
3881
+ *
3882
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3548
3883
  * @memberof ScheduleGroupCreateRequest
3549
3884
  */
3550
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
3885
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
3551
3886
  }
3887
+ /**
3888
+ *
3889
+ * @export
3890
+ * @interface ScheduleGroupCreateRequestAllOf
3891
+ */
3892
+ export interface ScheduleGroupCreateRequestAllOf {
3893
+ /**
3894
+ *
3895
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3896
+ * @memberof ScheduleGroupCreateRequestAllOf
3897
+ */
3898
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
3899
+ }
3900
+ /**
3901
+ * @type ScheduleGroupCreateRequestAllOfCGroup
3902
+ * @export
3903
+ */
3904
+ export type ScheduleGroupCreateRequestAllOfCGroup = CustomerGroup | string;
3905
+
3552
3906
  /**
3553
3907
  *
3554
3908
  * @export
@@ -3586,12 +3940,6 @@ export interface ScheduleGroupGetResponse {
3586
3940
  * @memberof ScheduleGroupGetResponse
3587
3941
  */
3588
3942
  '$agent': string;
3589
- /**
3590
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3591
- * @type {string}
3592
- * @memberof ScheduleGroupGetResponse
3593
- */
3594
- '$thread'?: string;
3595
3943
  /**
3596
3944
  * Initial contexts to load when starting the conversation
3597
3945
  * @type {Array<string>}
@@ -3629,11 +3977,11 @@ export interface ScheduleGroupGetResponse {
3629
3977
  */
3630
3978
  'delay'?: number;
3631
3979
  /**
3632
- * Customers in this group
3633
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
3980
+ * The ID of the workflow used for this conversation
3981
+ * @type {string}
3634
3982
  * @memberof ScheduleGroupGetResponse
3635
3983
  */
3636
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
3984
+ '$workflow': string;
3637
3985
  /**
3638
3986
  * The ID of the scheduled conversation group
3639
3987
  * @type {string}
@@ -3646,6 +3994,12 @@ export interface ScheduleGroupGetResponse {
3646
3994
  * @memberof ScheduleGroupGetResponse
3647
3995
  */
3648
3996
  'sent'?: boolean;
3997
+ /**
3998
+ * The ID of the group the customers belong to
3999
+ * @type {string}
4000
+ * @memberof ScheduleGroupGetResponse
4001
+ */
4002
+ '$cGroup'?: string;
3649
4003
  }
3650
4004
  /**
3651
4005
  *
@@ -3665,6 +4019,12 @@ export interface ScheduleGroupGetResponseAllOf {
3665
4019
  * @memberof ScheduleGroupGetResponseAllOf
3666
4020
  */
3667
4021
  'sent'?: boolean;
4022
+ /**
4023
+ * The ID of the group the customers belong to
4024
+ * @type {string}
4025
+ * @memberof ScheduleGroupGetResponseAllOf
4026
+ */
4027
+ '$cGroup'?: string;
3668
4028
  }
3669
4029
  /**
3670
4030
  *
@@ -3703,12 +4063,6 @@ export interface ScheduleGroupUpdateRequest {
3703
4063
  * @memberof ScheduleGroupUpdateRequest
3704
4064
  */
3705
4065
  '$agent': string;
3706
- /**
3707
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3708
- * @type {string}
3709
- * @memberof ScheduleGroupUpdateRequest
3710
- */
3711
- '$thread'?: string;
3712
4066
  /**
3713
4067
  * Initial contexts to load when starting the conversation
3714
4068
  * @type {Array<string>}
@@ -3746,11 +4100,17 @@ export interface ScheduleGroupUpdateRequest {
3746
4100
  */
3747
4101
  'delay'?: number;
3748
4102
  /**
3749
- * Customers in this group
3750
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4103
+ *
4104
+ * @type {ConversationUpdateRequestBaseWorkflow}
3751
4105
  * @memberof ScheduleGroupUpdateRequest
3752
4106
  */
3753
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4107
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
4108
+ /**
4109
+ *
4110
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
4111
+ * @memberof ScheduleGroupUpdateRequest
4112
+ */
4113
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3754
4114
  /**
3755
4115
  * The ID of the scheduled conversation group to update
3756
4116
  * @type {string}
@@ -3764,6 +4124,12 @@ export interface ScheduleGroupUpdateRequest {
3764
4124
  * @interface ScheduleGroupUpdateRequestAllOf
3765
4125
  */
3766
4126
  export interface ScheduleGroupUpdateRequestAllOf {
4127
+ /**
4128
+ *
4129
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
4130
+ * @memberof ScheduleGroupUpdateRequestAllOf
4131
+ */
4132
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3767
4133
  /**
3768
4134
  * The ID of the scheduled conversation group to update
3769
4135
  * @type {string}
@@ -3833,12 +4199,6 @@ export interface ScheduleUpdateRequest {
3833
4199
  * @memberof ScheduleUpdateRequest
3834
4200
  */
3835
4201
  '$agent': string;
3836
- /**
3837
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3838
- * @type {string}
3839
- * @memberof ScheduleUpdateRequest
3840
- */
3841
- '$thread'?: string;
3842
4202
  /**
3843
4203
  * Initial contexts to load when starting the conversation
3844
4204
  * @type {Array<string>}
@@ -3887,6 +4247,12 @@ export interface ScheduleUpdateRequest {
3887
4247
  * @memberof ScheduleUpdateRequest
3888
4248
  */
3889
4249
  '$group'?: string;
4250
+ /**
4251
+ *
4252
+ * @type {ConversationUpdateRequestBaseWorkflow}
4253
+ * @memberof ScheduleUpdateRequest
4254
+ */
4255
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3890
4256
  /**
3891
4257
  * The ID of the scheduled conversation to update
3892
4258
  * @type {string}
@@ -3946,12 +4312,6 @@ export interface ScheduledConversation {
3946
4312
  * @memberof ScheduledConversation
3947
4313
  */
3948
4314
  '$agent': string;
3949
- /**
3950
- * Thread this conversation is in - this determines what context to pull when loading the conversation
3951
- * @type {string}
3952
- * @memberof ScheduledConversation
3953
- */
3954
- '$thread'?: string;
3955
4315
  /**
3956
4316
  * Initial contexts to load when starting the conversation
3957
4317
  * @type {Array<string>}
@@ -4028,12 +4388,6 @@ export interface ScheduledConversationGroup {
4028
4388
  * @memberof ScheduledConversationGroup
4029
4389
  */
4030
4390
  '$agent': string;
4031
- /**
4032
- * Thread this conversation is in - this determines what context to pull when loading the conversation
4033
- * @type {string}
4034
- * @memberof ScheduledConversationGroup
4035
- */
4036
- '$thread'?: string;
4037
4391
  /**
4038
4392
  * Initial contexts to load when starting the conversation
4039
4393
  * @type {Array<string>}
@@ -4070,12 +4424,6 @@ export interface ScheduledConversationGroup {
4070
4424
  * @memberof ScheduledConversationGroup
4071
4425
  */
4072
4426
  'delay'?: number;
4073
- /**
4074
- * Customers in this group
4075
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4076
- * @memberof ScheduledConversationGroup
4077
- */
4078
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4079
4427
  }
4080
4428
  /**
4081
4429
  *
@@ -4089,40 +4437,7 @@ export interface ScheduledConversationGroupAllOf {
4089
4437
  * @memberof ScheduledConversationGroupAllOf
4090
4438
  */
4091
4439
  'delay'?: number;
4092
- /**
4093
- * Customers in this group
4094
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4095
- * @memberof ScheduledConversationGroupAllOf
4096
- */
4097
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4098
4440
  }
4099
- /**
4100
- *
4101
- * @export
4102
- * @interface ScheduledConversationGroupAllOfCustomers
4103
- */
4104
- export interface ScheduledConversationGroupAllOfCustomers {
4105
- /**
4106
- *
4107
- * @type {ConversationEnvironment}
4108
- * @memberof ScheduledConversationGroupAllOfCustomers
4109
- */
4110
- 'environment': ConversationEnvironment;
4111
- /**
4112
- * Customer ID
4113
- * @type {string}
4114
- * @memberof ScheduledConversationGroupAllOfCustomers
4115
- */
4116
- 'id': string;
4117
- /**
4118
- * Overrides default $agent for this customer
4119
- * @type {string}
4120
- * @memberof ScheduledConversationGroupAllOfCustomers
4121
- */
4122
- '$agent'?: string;
4123
- }
4124
-
4125
-
4126
4441
  /**
4127
4442
  *
4128
4443
  * @export
@@ -4260,112 +4575,112 @@ export interface UpdateAgentResponse {
4260
4575
  export interface UpdateAgentsRequest {
4261
4576
  /**
4262
4577
  *
4263
- * @type {Array<UpdateAgentsRequestCustomersInner>}
4578
+ * @type {Array<UpdateAgentsRequestAgentsInner>}
4264
4579
  * @memberof UpdateAgentsRequest
4265
4580
  */
4266
- 'customers'?: Array<UpdateAgentsRequestCustomersInner>;
4581
+ 'agents'?: Array<UpdateAgentsRequestAgentsInner>;
4267
4582
  }
4268
4583
  /**
4269
4584
  *
4270
4585
  * @export
4271
- * @interface UpdateAgentsRequestCustomersInner
4586
+ * @interface UpdateAgentsRequestAgentsInner
4272
4587
  */
4273
- export interface UpdateAgentsRequestCustomersInner {
4588
+ export interface UpdateAgentsRequestAgentsInner {
4274
4589
  /**
4275
4590
  * Agent first name
4276
4591
  * @type {string}
4277
- * @memberof UpdateAgentsRequestCustomersInner
4592
+ * @memberof UpdateAgentsRequestAgentsInner
4278
4593
  */
4279
4594
  'firstName': string;
4280
4595
  /**
4281
4596
  * Agent last name
4282
4597
  * @type {string}
4283
- * @memberof UpdateAgentsRequestCustomersInner
4598
+ * @memberof UpdateAgentsRequestAgentsInner
4284
4599
  */
4285
4600
  'lastName': string;
4286
4601
  /**
4287
4602
  * Agent is inactive
4288
4603
  * @type {boolean}
4289
- * @memberof UpdateAgentsRequestCustomersInner
4604
+ * @memberof UpdateAgentsRequestAgentsInner
4290
4605
  */
4291
4606
  'inactive'?: boolean;
4292
4607
  /**
4293
4608
  * Programmable phone number
4294
4609
  * @type {string}
4295
- * @memberof UpdateAgentsRequestCustomersInner
4610
+ * @memberof UpdateAgentsRequestAgentsInner
4296
4611
  */
4297
4612
  'programmablePhoneNumber'?: string;
4298
4613
  /**
4299
4614
  * Programmable phone number SID
4300
4615
  * @type {string}
4301
- * @memberof UpdateAgentsRequestCustomersInner
4616
+ * @memberof UpdateAgentsRequestAgentsInner
4302
4617
  */
4303
4618
  'programmablePhoneNumberSid'?: string;
4304
4619
  /**
4305
4620
  * Email address from Scout9 gmail subdomain
4306
4621
  * @type {string}
4307
- * @memberof UpdateAgentsRequestCustomersInner
4622
+ * @memberof UpdateAgentsRequestAgentsInner
4308
4623
  */
4309
4624
  'programmableEmail'?: string;
4310
4625
  /**
4311
4626
  * Forward email
4312
4627
  * @type {string}
4313
- * @memberof UpdateAgentsRequestCustomersInner
4628
+ * @memberof UpdateAgentsRequestAgentsInner
4314
4629
  */
4315
4630
  'forwardEmail'?: string;
4316
4631
  /**
4317
4632
  * Forward phone
4318
4633
  * @type {string}
4319
- * @memberof UpdateAgentsRequestCustomersInner
4634
+ * @memberof UpdateAgentsRequestAgentsInner
4320
4635
  */
4321
4636
  'forwardPhone': string;
4322
4637
  /**
4323
4638
  * Title of the agent, defaults to \"Agent\"
4324
4639
  * @type {string}
4325
- * @memberof UpdateAgentsRequestCustomersInner
4640
+ * @memberof UpdateAgentsRequestAgentsInner
4326
4641
  */
4327
4642
  'title'?: string;
4328
4643
  /**
4329
4644
  * Context of the agent, defaults to \"Agent\"
4330
4645
  * @type {string}
4331
- * @memberof UpdateAgentsRequestCustomersInner
4646
+ * @memberof UpdateAgentsRequestAgentsInner
4332
4647
  */
4333
4648
  'context'?: string;
4334
4649
  /**
4335
4650
  * Locations ids the agent is included in
4336
4651
  * @type {Array<string>}
4337
- * @memberof UpdateAgentsRequestCustomersInner
4652
+ * @memberof UpdateAgentsRequestAgentsInner
4338
4653
  */
4339
4654
  'includedLocations'?: Array<string>;
4340
4655
  /**
4341
4656
  * Locations id the agent is excluded from
4342
4657
  * @type {Array<string>}
4343
- * @memberof UpdateAgentsRequestCustomersInner
4658
+ * @memberof UpdateAgentsRequestAgentsInner
4344
4659
  */
4345
4660
  'excludedLocations'?: Array<string>;
4346
4661
  /**
4347
4662
  * Transcript of the agent
4348
4663
  * @type {string}
4349
- * @memberof UpdateAgentsRequestCustomersInner
4664
+ * @memberof UpdateAgentsRequestAgentsInner
4350
4665
  */
4351
4666
  'transcript'?: string;
4352
4667
  /**
4353
4668
  * The ID of the agent
4354
4669
  * @type {string}
4355
- * @memberof UpdateAgentsRequestCustomersInner
4670
+ * @memberof UpdateAgentsRequestAgentsInner
4356
4671
  */
4357
4672
  '$id': string;
4358
4673
  }
4359
4674
  /**
4360
4675
  *
4361
4676
  * @export
4362
- * @interface UpdateAgentsRequestCustomersInnerAllOf
4677
+ * @interface UpdateAgentsRequestAgentsInnerAllOf
4363
4678
  */
4364
- export interface UpdateAgentsRequestCustomersInnerAllOf {
4679
+ export interface UpdateAgentsRequestAgentsInnerAllOf {
4365
4680
  /**
4366
4681
  * The ID of the agent
4367
4682
  * @type {string}
4368
- * @memberof UpdateAgentsRequestCustomersInnerAllOf
4683
+ * @memberof UpdateAgentsRequestAgentsInnerAllOf
4369
4684
  */
4370
4685
  '$id': string;
4371
4686
  }
@@ -4492,7 +4807,7 @@ export interface UpdateContextsRequest {
4492
4807
  * @type {Array<ListContextsResponseInner>}
4493
4808
  * @memberof UpdateContextsRequest
4494
4809
  */
4495
- 'customers'?: Array<ListContextsResponseInner>;
4810
+ 'contexts'?: Array<ListContextsResponseInner>;
4496
4811
  }
4497
4812
  /**
4498
4813
  *
@@ -4513,6 +4828,113 @@ export interface UpdateContextsResponse {
4513
4828
  */
4514
4829
  '$operation': string;
4515
4830
  }
4831
+ /**
4832
+ *
4833
+ * @export
4834
+ * @interface UpdateCustomerGroupRequest
4835
+ */
4836
+ export interface UpdateCustomerGroupRequest {
4837
+ /**
4838
+ * The name of the customer group
4839
+ * @type {string}
4840
+ * @memberof UpdateCustomerGroupRequest
4841
+ */
4842
+ 'name': string;
4843
+ /**
4844
+ * The description of the customer group
4845
+ * @type {string}
4846
+ * @memberof UpdateCustomerGroupRequest
4847
+ */
4848
+ 'description'?: string;
4849
+ /**
4850
+ *
4851
+ * @type {{ [key: string]: any; }}
4852
+ * @memberof UpdateCustomerGroupRequest
4853
+ */
4854
+ 'metadata'?: { [key: string]: any; };
4855
+ /**
4856
+ *
4857
+ * @type {Array<CustomerGroupRecord>}
4858
+ * @memberof UpdateCustomerGroupRequest
4859
+ */
4860
+ 'customers': Array<CustomerGroupRecord>;
4861
+ /**
4862
+ * The ID of the CustomerGroup
4863
+ * @type {string}
4864
+ * @memberof UpdateCustomerGroupRequest
4865
+ */
4866
+ '$id': string;
4867
+ }
4868
+ /**
4869
+ *
4870
+ * @export
4871
+ * @interface UpdateCustomerGroupRequestAllOf
4872
+ */
4873
+ export interface UpdateCustomerGroupRequestAllOf {
4874
+ /**
4875
+ * The ID of the CustomerGroup
4876
+ * @type {string}
4877
+ * @memberof UpdateCustomerGroupRequestAllOf
4878
+ */
4879
+ '$id': string;
4880
+ }
4881
+ /**
4882
+ *
4883
+ * @export
4884
+ * @interface UpdateCustomerGroupResponse
4885
+ */
4886
+ export interface UpdateCustomerGroupResponse {
4887
+ /**
4888
+ *
4889
+ * @type {boolean}
4890
+ * @memberof UpdateCustomerGroupResponse
4891
+ */
4892
+ 'success': boolean;
4893
+ /**
4894
+ *
4895
+ * @type {Error}
4896
+ * @memberof UpdateCustomerGroupResponse
4897
+ */
4898
+ 'error'?: Error;
4899
+ /**
4900
+ * The id of the document that was created, updated, or deleted
4901
+ * @type {string}
4902
+ * @memberof UpdateCustomerGroupResponse
4903
+ */
4904
+ 'id': string;
4905
+ }
4906
+ /**
4907
+ *
4908
+ * @export
4909
+ * @interface UpdateCustomerGroupsRequest
4910
+ */
4911
+ export interface UpdateCustomerGroupsRequest {
4912
+ /**
4913
+ *
4914
+ * @type {Array<ListCustomerGroupsResponseInner>}
4915
+ * @memberof UpdateCustomerGroupsRequest
4916
+ */
4917
+ 'CustomerGroups'?: Array<ListCustomerGroupsResponseInner>;
4918
+ }
4919
+ /**
4920
+ *
4921
+ * @export
4922
+ * @interface UpdateCustomerGroupsResponse
4923
+ */
4924
+ export interface UpdateCustomerGroupsResponse {
4925
+ /**
4926
+ * ISO 8601 datetime string of when the operation was queued
4927
+ * @type {string}
4928
+ * @memberof UpdateCustomerGroupsResponse
4929
+ */
4930
+ 'queued': string;
4931
+ /**
4932
+ * The operation id to view the operation end results
4933
+ * @type {string}
4934
+ * @memberof UpdateCustomerGroupsResponse
4935
+ */
4936
+ '$operation': string;
4937
+ }
4516
4938
  /**
4517
4939
  *
4518
4940
  * @export
@@ -4826,7 +5248,7 @@ export interface UpdateWorkflowsRequest {
4826
5248
  * @type {Array<ListWorkflowsResponseInner>}
4827
5249
  * @memberof UpdateWorkflowsRequest
4828
5250
  */
4829
- 'customers'?: Array<ListWorkflowsResponseInner>;
5251
+ 'workflows'?: Array<ListWorkflowsResponseInner>;
4830
5252
  }
4831
5253
  /**
4832
5254
  *
@@ -5561,7 +5983,263 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5561
5983
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5562
5984
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5563
5985
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
5564
- localVarRequestOptions.data = serializeDataIfNeeded(conversationCreateRequest, localVarRequestOptions, configuration)
5986
+ localVarRequestOptions.data = serializeDataIfNeeded(conversationCreateRequest, localVarRequestOptions, configuration)
5987
+
5988
+ return {
5989
+ url: toPathString(localVarUrlObj),
5990
+ options: localVarRequestOptions,
5991
+ };
5992
+ },
5993
+ /**
5994
+ *
5995
+ * @summary Deletes a schedule
5996
+ * @param {string} id
5997
+ * @param {*} [options] Override http request option.
5998
+ * @throws {RequiredError}
5999
+ */
6000
+ conversationDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6001
+ // verify required parameter 'id' is not null or undefined
6002
+ assertParamExists('conversationDelete', 'id', id)
6003
+ const localVarPath = `/v1-conversation`;
6004
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6005
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6006
+ let baseOptions;
6007
+ if (configuration) {
6008
+ baseOptions = configuration.baseOptions;
6009
+ }
6010
+
6011
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
6012
+ const localVarHeaderParameter = {} as any;
6013
+ const localVarQueryParameter = {} as any;
6014
+
6015
+ if (id !== undefined) {
6016
+ localVarQueryParameter['id'] = id;
6017
+ }
6018
+
6019
+
6020
+
6021
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6022
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6023
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6024
+
6025
+ return {
6026
+ url: toPathString(localVarUrlObj),
6027
+ options: localVarRequestOptions,
6028
+ };
6029
+ },
6030
+ /**
6031
+ *
6032
+ * @summary Update a conversation
6033
+ * @param {ConversationUpdateRequest} conversationUpdateRequest
6034
+ * @param {*} [options] Override http request option.
6035
+ * @throws {RequiredError}
6036
+ */
6037
+ conversationUpdate: async (conversationUpdateRequest: ConversationUpdateRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6038
+ // verify required parameter 'conversationUpdateRequest' is not null or undefined
6039
+ assertParamExists('conversationUpdate', 'conversationUpdateRequest', conversationUpdateRequest)
6040
+ const localVarPath = `/v1-conversation`;
6041
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6042
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6043
+ let baseOptions;
6044
+ if (configuration) {
6045
+ baseOptions = configuration.baseOptions;
6046
+ }
6047
+
6048
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
6049
+ const localVarHeaderParameter = {} as any;
6050
+ const localVarQueryParameter = {} as any;
6051
+
6052
+
6053
+
6054
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6055
+
6056
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6057
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6058
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6059
+ localVarRequestOptions.data = serializeDataIfNeeded(conversationUpdateRequest, localVarRequestOptions, configuration)
6060
+
6061
+ return {
6062
+ url: toPathString(localVarUrlObj),
6063
+ options: localVarRequestOptions,
6064
+ };
6065
+ },
6066
+ /**
6067
+ *
6068
+ * @summary Gets a customer
6069
+ * @param {string} id
6070
+ * @param {*} [options] Override http request option.
6071
+ * @throws {RequiredError}
6072
+ */
6073
+ customer: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6074
+ // verify required parameter 'id' is not null or undefined
6075
+ assertParamExists('customer', 'id', id)
6076
+ const localVarPath = `/v1-customer`;
6077
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6078
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6079
+ let baseOptions;
6080
+ if (configuration) {
6081
+ baseOptions = configuration.baseOptions;
6082
+ }
6083
+
6084
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6085
+ const localVarHeaderParameter = {} as any;
6086
+ const localVarQueryParameter = {} as any;
6087
+
6088
+ if (id !== undefined) {
6089
+ localVarQueryParameter['id'] = id;
6090
+ }
6091
+
6092
+
6093
+
6094
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6095
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6096
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6097
+
6098
+ return {
6099
+ url: toPathString(localVarUrlObj),
6100
+ options: localVarRequestOptions,
6101
+ };
6102
+ },
6103
+ /**
6104
+ *
6105
+ * @summary Creates a new customer
6106
+ * @param {CreateCustomerRequest} createCustomerRequest
6107
+ * @param {*} [options] Override http request option.
6108
+ * @throws {RequiredError}
6109
+ */
6110
+ customerCreate: async (createCustomerRequest: CreateCustomerRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6111
+ // verify required parameter 'createCustomerRequest' is not null or undefined
6112
+ assertParamExists('customerCreate', 'createCustomerRequest', createCustomerRequest)
6113
+ const localVarPath = `/v1-customer`;
6114
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6115
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6116
+ let baseOptions;
6117
+ if (configuration) {
6118
+ baseOptions = configuration.baseOptions;
6119
+ }
6120
+
6121
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
6122
+ const localVarHeaderParameter = {} as any;
6123
+ const localVarQueryParameter = {} as any;
6124
+
6125
+
6126
+
6127
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6128
+
6129
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6130
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6131
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6132
+ localVarRequestOptions.data = serializeDataIfNeeded(createCustomerRequest, localVarRequestOptions, configuration)
6133
+
6134
+ return {
6135
+ url: toPathString(localVarUrlObj),
6136
+ options: localVarRequestOptions,
6137
+ };
6138
+ },
6139
+ /**
6140
+ *
6141
+ * @summary Deletes a customer
6142
+ * @param {string} id
6143
+ * @param {*} [options] Override http request option.
6144
+ * @throws {RequiredError}
6145
+ */
6146
+ customerDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6147
+ // verify required parameter 'id' is not null or undefined
6148
+ assertParamExists('customerDelete', 'id', id)
6149
+ const localVarPath = `/v1-customer`;
6150
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6151
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6152
+ let baseOptions;
6153
+ if (configuration) {
6154
+ baseOptions = configuration.baseOptions;
6155
+ }
6156
+
6157
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
6158
+ const localVarHeaderParameter = {} as any;
6159
+ const localVarQueryParameter = {} as any;
6160
+
6161
+ if (id !== undefined) {
6162
+ localVarQueryParameter['id'] = id;
6163
+ }
6164
+
6165
+
6166
+
6167
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6168
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6169
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6170
+
6171
+ return {
6172
+ url: toPathString(localVarUrlObj),
6173
+ options: localVarRequestOptions,
6174
+ };
6175
+ },
6176
+ /**
6177
+ *
6178
+ * @summary Gets a customer group
6179
+ * @param {string} id
6180
+ * @param {*} [options] Override http request option.
6181
+ * @throws {RequiredError}
6182
+ */
6183
+ customerGroup: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6184
+ // verify required parameter 'id' is not null or undefined
6185
+ assertParamExists('customerGroup', 'id', id)
6186
+ const localVarPath = `/v1-customerGroup`;
6187
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6188
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6189
+ let baseOptions;
6190
+ if (configuration) {
6191
+ baseOptions = configuration.baseOptions;
6192
+ }
6193
+
6194
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
6195
+ const localVarHeaderParameter = {} as any;
6196
+ const localVarQueryParameter = {} as any;
6197
+
6198
+ if (id !== undefined) {
6199
+ localVarQueryParameter['id'] = id;
6200
+ }
6201
+
6202
+
6203
+
6204
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6205
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6206
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6207
+
6208
+ return {
6209
+ url: toPathString(localVarUrlObj),
6210
+ options: localVarRequestOptions,
6211
+ };
6212
+ },
6213
+ /**
6214
+ *
6215
+ * @summary Creates a new customer group
6216
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
6217
+ * @param {*} [options] Override http request option.
6218
+ * @throws {RequiredError}
6219
+ */
6220
+ customerGroupCreate: async (createCustomerGroupRequest: CreateCustomerGroupRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6221
+ // verify required parameter 'createCustomerGroupRequest' is not null or undefined
6222
+ assertParamExists('customerGroupCreate', 'createCustomerGroupRequest', createCustomerGroupRequest)
6223
+ const localVarPath = `/v1-customerGroup`;
6224
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6225
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6226
+ let baseOptions;
6227
+ if (configuration) {
6228
+ baseOptions = configuration.baseOptions;
6229
+ }
6230
+
6231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
6232
+ const localVarHeaderParameter = {} as any;
6233
+ const localVarQueryParameter = {} as any;
6234
+
6235
+
6236
+
6237
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6238
+
6239
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6240
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6241
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6242
+ localVarRequestOptions.data = serializeDataIfNeeded(createCustomerGroupRequest, localVarRequestOptions, configuration)
5565
6243
 
5566
6244
  return {
5567
6245
  url: toPathString(localVarUrlObj),
@@ -5570,15 +6248,15 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5570
6248
  },
5571
6249
  /**
5572
6250
  *
5573
- * @summary Deletes a schedule
6251
+ * @summary Deletes a customer group
5574
6252
  * @param {string} id
5575
6253
  * @param {*} [options] Override http request option.
5576
6254
  * @throws {RequiredError}
5577
6255
  */
5578
- conversationDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6256
+ customerGroupDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5579
6257
  // verify required parameter 'id' is not null or undefined
5580
- assertParamExists('conversationDelete', 'id', id)
5581
- const localVarPath = `/v1-conversation`;
6258
+ assertParamExists('customerGroupDelete', 'id', id)
6259
+ const localVarPath = `/v1-customerGroup`;
5582
6260
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5583
6261
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5584
6262
  let baseOptions;
@@ -5607,15 +6285,15 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5607
6285
  },
5608
6286
  /**
5609
6287
  *
5610
- * @summary Update a conversation
5611
- * @param {ConversationUpdateRequest} conversationUpdateRequest
6288
+ * @summary Updates a customer group
6289
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
5612
6290
  * @param {*} [options] Override http request option.
5613
6291
  * @throws {RequiredError}
5614
6292
  */
5615
- conversationUpdate: async (conversationUpdateRequest: ConversationUpdateRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5616
- // verify required parameter 'conversationUpdateRequest' is not null or undefined
5617
- assertParamExists('conversationUpdate', 'conversationUpdateRequest', conversationUpdateRequest)
5618
- const localVarPath = `/v1-conversation`;
6293
+ customerGroupUpdate: async (updateCustomerGroupRequest: UpdateCustomerGroupRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6294
+ // verify required parameter 'updateCustomerGroupRequest' is not null or undefined
6295
+ assertParamExists('customerGroupUpdate', 'updateCustomerGroupRequest', updateCustomerGroupRequest)
6296
+ const localVarPath = `/v1-customerGroup`;
5619
6297
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5620
6298
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5621
6299
  let baseOptions;
@@ -5634,7 +6312,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5634
6312
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5635
6313
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5636
6314
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
5637
- localVarRequestOptions.data = serializeDataIfNeeded(conversationUpdateRequest, localVarRequestOptions, configuration)
6315
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerGroupRequest, localVarRequestOptions, configuration)
5638
6316
 
5639
6317
  return {
5640
6318
  url: toPathString(localVarUrlObj),
@@ -5643,15 +6321,14 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5643
6321
  },
5644
6322
  /**
5645
6323
  *
5646
- * @summary Gets a customer
5647
- * @param {string} id
6324
+ * @summary Gets all or specific set of customer groups
6325
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6326
+ * @param {Array<string>} [id]
5648
6327
  * @param {*} [options] Override http request option.
5649
6328
  * @throws {RequiredError}
5650
6329
  */
5651
- customer: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5652
- // verify required parameter 'id' is not null or undefined
5653
- assertParamExists('customer', 'id', id)
5654
- const localVarPath = `/v1-customer`;
6330
+ customerGroups: async (q?: string, id?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6331
+ const localVarPath = `/v1-customerGroups`;
5655
6332
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5656
6333
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5657
6334
  let baseOptions;
@@ -5663,7 +6340,11 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5663
6340
  const localVarHeaderParameter = {} as any;
5664
6341
  const localVarQueryParameter = {} as any;
5665
6342
 
5666
- if (id !== undefined) {
6343
+ if (q !== undefined) {
6344
+ localVarQueryParameter['q'] = q;
6345
+ }
6346
+
6347
+ if (id) {
5667
6348
  localVarQueryParameter['id'] = id;
5668
6349
  }
5669
6350
 
@@ -5680,15 +6361,15 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5680
6361
  },
5681
6362
  /**
5682
6363
  *
5683
- * @summary Creates a new customer
5684
- * @param {CreateCustomerRequest} createCustomerRequest
6364
+ * @summary Creates new customer groups
6365
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
5685
6366
  * @param {*} [options] Override http request option.
5686
6367
  * @throws {RequiredError}
5687
6368
  */
5688
- customerCreate: async (createCustomerRequest: CreateCustomerRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5689
- // verify required parameter 'createCustomerRequest' is not null or undefined
5690
- assertParamExists('customerCreate', 'createCustomerRequest', createCustomerRequest)
5691
- const localVarPath = `/v1-customer`;
6369
+ customerGroupsCreate: async (createCustomerGroupsRequest: CreateCustomerGroupsRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6370
+ // verify required parameter 'createCustomerGroupsRequest' is not null or undefined
6371
+ assertParamExists('customerGroupsCreate', 'createCustomerGroupsRequest', createCustomerGroupsRequest)
6372
+ const localVarPath = `/v1-customerGroups`;
5692
6373
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5693
6374
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5694
6375
  let baseOptions;
@@ -5707,7 +6388,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5707
6388
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5708
6389
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5709
6390
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
5710
- localVarRequestOptions.data = serializeDataIfNeeded(createCustomerRequest, localVarRequestOptions, configuration)
6391
+ localVarRequestOptions.data = serializeDataIfNeeded(createCustomerGroupsRequest, localVarRequestOptions, configuration)
5711
6392
 
5712
6393
  return {
5713
6394
  url: toPathString(localVarUrlObj),
@@ -5716,15 +6397,13 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5716
6397
  },
5717
6398
  /**
5718
6399
  *
5719
- * @summary Deletes a customer
5720
- * @param {string} id
6400
+ * @summary Deletes multiple customer groups
6401
+ * @param {Array<string>} [id]
5721
6402
  * @param {*} [options] Override http request option.
5722
6403
  * @throws {RequiredError}
5723
6404
  */
5724
- customerDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5725
- // verify required parameter 'id' is not null or undefined
5726
- assertParamExists('customerDelete', 'id', id)
5727
- const localVarPath = `/v1-customer`;
6405
+ customerGroupsDelete: async (id?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6406
+ const localVarPath = `/v1-customerGroups`;
5728
6407
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5729
6408
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5730
6409
  let baseOptions;
@@ -5736,7 +6415,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5736
6415
  const localVarHeaderParameter = {} as any;
5737
6416
  const localVarQueryParameter = {} as any;
5738
6417
 
5739
- if (id !== undefined) {
6418
+ if (id) {
5740
6419
  localVarQueryParameter['id'] = id;
5741
6420
  }
5742
6421
 
@@ -5751,6 +6430,42 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5751
6430
  options: localVarRequestOptions,
5752
6431
  };
5753
6432
  },
6433
+ /**
6434
+ *
6435
+ * @summary Updates multiple customer groups
6436
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
6437
+ * @param {*} [options] Override http request option.
6438
+ * @throws {RequiredError}
6439
+ */
6440
+ customerGroupsUpdate: async (updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6441
+ // verify required parameter 'updateCustomerGroupsRequest' is not null or undefined
6442
+ assertParamExists('customerGroupsUpdate', 'updateCustomerGroupsRequest', updateCustomerGroupsRequest)
6443
+ const localVarPath = `/v1-customerGroups`;
6444
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6445
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6446
+ let baseOptions;
6447
+ if (configuration) {
6448
+ baseOptions = configuration.baseOptions;
6449
+ }
6450
+
6451
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
6452
+ const localVarHeaderParameter = {} as any;
6453
+ const localVarQueryParameter = {} as any;
6454
+
6455
+
6456
+
6457
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6458
+
6459
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6460
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6461
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
6462
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerGroupsRequest, localVarRequestOptions, configuration)
6463
+
6464
+ return {
6465
+ url: toPathString(localVarUrlObj),
6466
+ options: localVarRequestOptions,
6467
+ };
6468
+ },
5754
6469
  /**
5755
6470
  *
5756
6471
  * @summary Updates a customer
@@ -6973,6 +7688,95 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
6973
7688
  const localVarAxiosArgs = await localVarAxiosParamCreator.customerDelete(id, options);
6974
7689
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
6975
7690
  },
7691
+ /**
7692
+ *
7693
+ * @summary Gets a customer group
7694
+ * @param {string} id
7695
+ * @param {*} [options] Override http request option.
7696
+ * @throws {RequiredError}
7697
+ */
7698
+ async customerGroup(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerGroupResponse>> {
7699
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroup(id, options);
7700
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7701
+ },
7702
+ /**
7703
+ *
7704
+ * @summary Creates a new customer group
7705
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
7706
+ * @param {*} [options] Override http request option.
7707
+ * @throws {RequiredError}
7708
+ */
7709
+ async customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupResponse>> {
7710
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupCreate(createCustomerGroupRequest, options);
7711
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7712
+ },
7713
+ /**
7714
+ *
7715
+ * @summary Deletes a customer group
7716
+ * @param {string} id
7717
+ * @param {*} [options] Override http request option.
7718
+ * @throws {RequiredError}
7719
+ */
7720
+ async customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupResponse>> {
7721
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupDelete(id, options);
7722
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7723
+ },
7724
+ /**
7725
+ *
7726
+ * @summary Updates a customer group
7727
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
7728
+ * @param {*} [options] Override http request option.
7729
+ * @throws {RequiredError}
7730
+ */
7731
+ async customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupResponse>> {
7732
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupUpdate(updateCustomerGroupRequest, options);
7733
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7734
+ },
7735
+ /**
7736
+ *
7737
+ * @summary Gets all or specific set of customer groups
7738
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7739
+ * @param {Array<string>} [id]
7740
+ * @param {*} [options] Override http request option.
7741
+ * @throws {RequiredError}
7742
+ */
7743
+ async customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListCustomerGroupsResponseInner>>> {
7744
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroups(q, id, options);
7745
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7746
+ },
7747
+ /**
7748
+ *
7749
+ * @summary Creates new customer groups
7750
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
7751
+ * @param {*} [options] Override http request option.
7752
+ * @throws {RequiredError}
7753
+ */
7754
+ async customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupsResponse>> {
7755
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupsCreate(createCustomerGroupsRequest, options);
7756
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7757
+ },
7758
+ /**
7759
+ *
7760
+ * @summary Deletes multiple customer groups
7761
+ * @param {Array<string>} [id]
7762
+ * @param {*} [options] Override http request option.
7763
+ * @throws {RequiredError}
7764
+ */
7765
+ async customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupsResponse>> {
7766
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupsDelete(id, options);
7767
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7768
+ },
7769
+ /**
7770
+ *
7771
+ * @summary Updates multiple customer groups
7772
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
7773
+ * @param {*} [options] Override http request option.
7774
+ * @throws {RequiredError}
7775
+ */
7776
+ async customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupsResponse>> {
7777
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerGroupsUpdate(updateCustomerGroupsRequest, options);
7778
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7779
+ },
6976
7780
  /**
6977
7781
  *
6978
7782
  * @summary Updates a customer
@@ -7505,6 +8309,87 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
7505
8309
  customerDelete(id: string, options?: any): AxiosPromise<DeleteCustomerResponse> {
7506
8310
  return localVarFp.customerDelete(id, options).then((request) => request(axios, basePath));
7507
8311
  },
8312
+ /**
8313
+ *
8314
+ * @summary Gets a customer group
8315
+ * @param {string} id
8316
+ * @param {*} [options] Override http request option.
8317
+ * @throws {RequiredError}
8318
+ */
8319
+ customerGroup(id: string, options?: any): AxiosPromise<GetCustomerGroupResponse> {
8320
+ return localVarFp.customerGroup(id, options).then((request) => request(axios, basePath));
8321
+ },
8322
+ /**
8323
+ *
8324
+ * @summary Creates a new customer group
8325
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
8326
+ * @param {*} [options] Override http request option.
8327
+ * @throws {RequiredError}
8328
+ */
8329
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: any): AxiosPromise<CreateCustomerGroupResponse> {
8330
+ return localVarFp.customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(axios, basePath));
8331
+ },
8332
+ /**
8333
+ *
8334
+ * @summary Deletes a customer group
8335
+ * @param {string} id
8336
+ * @param {*} [options] Override http request option.
8337
+ * @throws {RequiredError}
8338
+ */
8339
+ customerGroupDelete(id: string, options?: any): AxiosPromise<DeleteCustomerGroupResponse> {
8340
+ return localVarFp.customerGroupDelete(id, options).then((request) => request(axios, basePath));
8341
+ },
8342
+ /**
8343
+ *
8344
+ * @summary Updates a customer group
8345
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
8346
+ * @param {*} [options] Override http request option.
8347
+ * @throws {RequiredError}
8348
+ */
8349
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: any): AxiosPromise<UpdateCustomerGroupResponse> {
8350
+ return localVarFp.customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(axios, basePath));
8351
+ },
8352
+ /**
8353
+ *
8354
+ * @summary Gets all or specific set of customer groups
8355
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8356
+ * @param {Array<string>} [id]
8357
+ * @param {*} [options] Override http request option.
8358
+ * @throws {RequiredError}
8359
+ */
8360
+ customerGroups(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<ListCustomerGroupsResponseInner>> {
8361
+ return localVarFp.customerGroups(q, id, options).then((request) => request(axios, basePath));
8362
+ },
8363
+ /**
8364
+ *
8365
+ * @summary Creates new customer groups
8366
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
8367
+ * @param {*} [options] Override http request option.
8368
+ * @throws {RequiredError}
8369
+ */
8370
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: any): AxiosPromise<CreateCustomerGroupsResponse> {
8371
+ return localVarFp.customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(axios, basePath));
8372
+ },
8373
+ /**
8374
+ *
8375
+ * @summary Deletes multiple customer groups
8376
+ * @param {Array<string>} [id]
8377
+ * @param {*} [options] Override http request option.
8378
+ * @throws {RequiredError}
8379
+ */
8380
+ customerGroupsDelete(id?: Array<string>, options?: any): AxiosPromise<DeleteCustomerGroupsResponse> {
8381
+ return localVarFp.customerGroupsDelete(id, options).then((request) => request(axios, basePath));
8382
+ },
8383
+ /**
8384
+ *
8385
+ * @summary Updates multiple customer groups
8386
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
8387
+ * @param {*} [options] Override http request option.
8388
+ * @throws {RequiredError}
8389
+ */
8390
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: any): AxiosPromise<UpdateCustomerGroupsResponse> {
8391
+ return localVarFp.customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(axios, basePath));
8392
+ },
7508
8393
  /**
7509
8394
  *
7510
8395
  * @summary Updates a customer
@@ -8057,6 +8942,103 @@ export class Scout9Api extends BaseAPI {
8057
8942
  return Scout9ApiFp(this.configuration).customerDelete(id, options).then((request) => request(this.axios, this.basePath));
8058
8943
  }
8059
8944
 
8945
+ /**
8946
+ *
8947
+ * @summary Gets a customer group
8948
+ * @param {string} id
8949
+ * @param {*} [options] Override http request option.
8950
+ * @throws {RequiredError}
8951
+ * @memberof Scout9Api
8952
+ */
8953
+ public customerGroup(id: string, options?: AxiosRequestConfig) {
8954
+ return Scout9ApiFp(this.configuration).customerGroup(id, options).then((request) => request(this.axios, this.basePath));
8955
+ }
8956
+
8957
+ /**
8958
+ *
8959
+ * @summary Creates a new customer group
8960
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
8961
+ * @param {*} [options] Override http request option.
8962
+ * @throws {RequiredError}
8963
+ * @memberof Scout9Api
8964
+ */
8965
+ public customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig) {
8966
+ return Scout9ApiFp(this.configuration).customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
8967
+ }
8968
+
8969
+ /**
8970
+ *
8971
+ * @summary Deletes a customer group
8972
+ * @param {string} id
8973
+ * @param {*} [options] Override http request option.
8974
+ * @throws {RequiredError}
8975
+ * @memberof Scout9Api
8976
+ */
8977
+ public customerGroupDelete(id: string, options?: AxiosRequestConfig) {
8978
+ return Scout9ApiFp(this.configuration).customerGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
8979
+ }
8980
+
8981
+ /**
8982
+ *
8983
+ * @summary Updates a customer group
8984
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
8985
+ * @param {*} [options] Override http request option.
8986
+ * @throws {RequiredError}
8987
+ * @memberof Scout9Api
8988
+ */
8989
+ public customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig) {
8990
+ return Scout9ApiFp(this.configuration).customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
8991
+ }
8992
+
8993
+ /**
8994
+ *
8995
+ * @summary Gets all or specific set of customer groups
8996
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8997
+ * @param {Array<string>} [id]
8998
+ * @param {*} [options] Override http request option.
8999
+ * @throws {RequiredError}
9000
+ * @memberof Scout9Api
9001
+ */
9002
+ public customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9003
+ return Scout9ApiFp(this.configuration).customerGroups(q, id, options).then((request) => request(this.axios, this.basePath));
9004
+ }
9005
+
9006
+ /**
9007
+ *
9008
+ * @summary Creates new customer groups
9009
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
9010
+ * @param {*} [options] Override http request option.
9011
+ * @throws {RequiredError}
9012
+ * @memberof Scout9Api
9013
+ */
9014
+ public customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig) {
9015
+ return Scout9ApiFp(this.configuration).customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9016
+ }
9017
+
9018
+ /**
9019
+ *
9020
+ * @summary Deletes multiple customer groups
9021
+ * @param {Array<string>} [id]
9022
+ * @param {*} [options] Override http request option.
9023
+ * @throws {RequiredError}
9024
+ * @memberof Scout9Api
9025
+ */
9026
+ public customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig) {
9027
+ return Scout9ApiFp(this.configuration).customerGroupsDelete(id, options).then((request) => request(this.axios, this.basePath));
9028
+ }
9029
+
9030
+ /**
9031
+ *
9032
+ * @summary Updates multiple customer groups
9033
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
9034
+ * @param {*} [options] Override http request option.
9035
+ * @throws {RequiredError}
9036
+ * @memberof Scout9Api
9037
+ */
9038
+ public customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig) {
9039
+ return Scout9ApiFp(this.configuration).customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9040
+ }
9041
+
8060
9042
  /**
8061
9043
  *
8062
9044
  * @summary Updates a customer