@scout9/admin 1.0.7 → 1.0.9

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
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Scout9 Pocket Scout API
2
+ * Scout9\'s Pocket Scout API
3
3
  * Pocket Scout APIs for managing Scout9 users and conversations with your Pocket Scout agents
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /// <reference types="node" />
12
13
  import type { Configuration } from './configuration';
13
14
  import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
15
  import type { RequestArgs } from './base';
@@ -24,13 +25,13 @@ export interface Agent {
24
25
  * @type {string}
25
26
  * @memberof Agent
26
27
  */
27
- 'firstName': string;
28
+ 'firstName'?: string;
28
29
  /**
29
30
  * Agent last name
30
31
  * @type {string}
31
32
  * @memberof Agent
32
33
  */
33
- 'lastName': string;
34
+ 'lastName'?: string;
34
35
  /**
35
36
  * Agent is inactive
36
37
  * @type {boolean}
@@ -66,7 +67,7 @@ export interface Agent {
66
67
  * @type {string}
67
68
  * @memberof Agent
68
69
  */
69
- 'forwardPhone': string;
70
+ 'forwardPhone'?: string;
70
71
  /**
71
72
  * Title of the agent, defaults to \"Agent\"
72
73
  * @type {string}
@@ -86,18 +87,24 @@ export interface Agent {
86
87
  */
87
88
  'includedLocations'?: Array<string>;
88
89
  /**
89
- * Locations id the agent is excluded from
90
- * @type {Array<string>}
90
+ * AI Model
91
+ * @type {string}
91
92
  * @memberof Agent
92
93
  */
93
- 'excludedLocations'?: Array<string>;
94
+ 'model'?: AgentModelEnum;
94
95
  /**
95
- * Transcript of the agent
96
- * @type {string}
96
+ * Locations id the agent is excluded from
97
+ * @type {Array<string>}
97
98
  * @memberof Agent
98
99
  */
99
- 'transcript'?: string;
100
+ 'excludedLocations'?: Array<string>;
100
101
  }
102
+ export declare const AgentModelEnum: {
103
+ readonly PocketScout: "Pocket Scout";
104
+ readonly Bard: "bard";
105
+ readonly Null: "null";
106
+ };
107
+ export type AgentModelEnum = typeof AgentModelEnum[keyof typeof AgentModelEnum];
101
108
  /**
102
109
  * @type AnyValue
103
110
  * @export
@@ -336,12 +343,6 @@ export interface Conversation {
336
343
  * @memberof Conversation
337
344
  */
338
345
  '$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
346
  /**
346
347
  * Initial contexts to load when starting the conversation
347
348
  * @type {Array<string>}
@@ -398,12 +399,6 @@ export interface ConversationBase {
398
399
  * @memberof ConversationBase
399
400
  */
400
401
  '$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
402
  /**
408
403
  * Initial contexts to load when starting the conversation
409
404
  * @type {Array<string>}
@@ -498,11 +493,11 @@ export interface ConversationContextFieldCondition {
498
493
  */
499
494
  'key': string;
500
495
  /**
501
- *
502
- * @type {Operator}
496
+ * The operator of the condition or query
497
+ * @type {string}
503
498
  * @memberof ConversationContextFieldCondition
504
499
  */
505
- 'operator': Operator;
500
+ 'operator': ConversationContextFieldConditionOperatorEnum;
506
501
  /**
507
502
  * The regex of the condition
508
503
  * @type {string}
@@ -516,6 +511,31 @@ export interface ConversationContextFieldCondition {
516
511
  */
517
512
  'value': AnyValue;
518
513
  }
514
+ export declare const ConversationContextFieldConditionOperatorEnum: {
515
+ readonly Eq: "eq";
516
+ readonly Equal: "equal";
517
+ readonly Ne: "ne";
518
+ readonly NotEquals: "not-equals";
519
+ readonly Gt: "gt";
520
+ readonly GreaterThan: "greater-than";
521
+ readonly Gte: "gte";
522
+ readonly GreaterThanEquals: "greater-than-equals";
523
+ readonly Lt: "lt";
524
+ readonly LessThan: "less-than";
525
+ readonly Lte: "lte";
526
+ readonly LessThanEquals: "less-than-equals";
527
+ readonly ArrayContains: "array-contains";
528
+ readonly In: "in";
529
+ readonly ArrayContainsAny: "array-contains-any";
530
+ readonly NotIn: "not-in";
531
+ readonly Exists: "exists";
532
+ readonly NotExists: "notExists";
533
+ readonly Contains: "contains";
534
+ readonly NotContains: "notContains";
535
+ readonly StartsWith: "startsWith";
536
+ readonly EndsWith: "endsWith";
537
+ };
538
+ export type ConversationContextFieldConditionOperatorEnum = typeof ConversationContextFieldConditionOperatorEnum[keyof typeof ConversationContextFieldConditionOperatorEnum];
519
539
  /**
520
540
  *
521
541
  * @export
@@ -541,12 +561,6 @@ export interface ConversationCreateRequest {
541
561
  * @memberof ConversationCreateRequest
542
562
  */
543
563
  '$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
564
  /**
551
565
  * Initial contexts to load when starting the conversation
552
566
  * @type {Array<string>}
@@ -571,6 +585,25 @@ export interface ConversationCreateRequest {
571
585
  * @memberof ConversationCreateRequest
572
586
  */
573
587
  'environment': ConversationEnvironment;
588
+ /**
589
+ *
590
+ * @type {ConversationUpdateRequestBaseWorkflow}
591
+ * @memberof ConversationCreateRequest
592
+ */
593
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
594
+ }
595
+ /**
596
+ *
597
+ * @export
598
+ * @interface ConversationCreateRequestBase
599
+ */
600
+ export interface ConversationCreateRequestBase {
601
+ /**
602
+ *
603
+ * @type {ConversationUpdateRequestBaseWorkflow}
604
+ * @memberof ConversationCreateRequestBase
605
+ */
606
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
574
607
  }
575
608
  /**
576
609
  *
@@ -669,12 +702,6 @@ export interface ConversationGetResponse {
669
702
  * @memberof ConversationGetResponse
670
703
  */
671
704
  '$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
705
  /**
679
706
  * Initial contexts to load when starting the conversation
680
707
  * @type {Array<string>}
@@ -717,6 +744,12 @@ export interface ConversationGetResponse {
717
744
  * @memberof ConversationGetResponse
718
745
  */
719
746
  'agentTestWebUrl'?: string;
747
+ /**
748
+ * The ID of the workflow used for this conversation
749
+ * @type {string}
750
+ * @memberof ConversationGetResponse
751
+ */
752
+ '$workflow': string;
720
753
  /**
721
754
  * ISO 8601 date string of when the conversation was initiated
722
755
  * @type {string}
@@ -749,6 +782,19 @@ export interface ConversationGetResponseAllOf {
749
782
  */
750
783
  '$id': string;
751
784
  }
785
+ /**
786
+ *
787
+ * @export
788
+ * @interface ConversationGetResponseBase
789
+ */
790
+ export interface ConversationGetResponseBase {
791
+ /**
792
+ * The ID of the workflow used for this conversation
793
+ * @type {string}
794
+ * @memberof ConversationGetResponseBase
795
+ */
796
+ '$workflow': string;
797
+ }
752
798
  /**
753
799
  *
754
800
  * @export
@@ -811,12 +857,6 @@ export interface ConversationUpdateRequest {
811
857
  * @memberof ConversationUpdateRequest
812
858
  */
813
859
  '$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
860
  /**
821
861
  * Initial contexts to load when starting the conversation
822
862
  * @type {Array<string>}
@@ -841,6 +881,12 @@ export interface ConversationUpdateRequest {
841
881
  * @memberof ConversationUpdateRequest
842
882
  */
843
883
  'environment': ConversationEnvironment;
884
+ /**
885
+ *
886
+ * @type {ConversationUpdateRequestAllOfWorkflow}
887
+ * @memberof ConversationUpdateRequest
888
+ */
889
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
844
890
  /**
845
891
  * The ID of the conversation to update
846
892
  * @type {string}
@@ -860,7 +906,36 @@ export interface ConversationUpdateRequestAllOf {
860
906
  * @memberof ConversationUpdateRequestAllOf
861
907
  */
862
908
  '$id': string;
909
+ /**
910
+ *
911
+ * @type {ConversationUpdateRequestAllOfWorkflow}
912
+ * @memberof ConversationUpdateRequestAllOf
913
+ */
914
+ '$workflow'?: ConversationUpdateRequestAllOfWorkflow;
915
+ }
916
+ /**
917
+ * @type ConversationUpdateRequestAllOfWorkflow
918
+ * @export
919
+ */
920
+ export type ConversationUpdateRequestAllOfWorkflow = Workflow | string;
921
+ /**
922
+ *
923
+ * @export
924
+ * @interface ConversationUpdateRequestBase
925
+ */
926
+ export interface ConversationUpdateRequestBase {
927
+ /**
928
+ *
929
+ * @type {ConversationUpdateRequestBaseWorkflow}
930
+ * @memberof ConversationUpdateRequestBase
931
+ */
932
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
863
933
  }
934
+ /**
935
+ * @type ConversationUpdateRequestBaseWorkflow
936
+ * @export
937
+ */
938
+ export type ConversationUpdateRequestBaseWorkflow = Workflow | string;
864
939
  /**
865
940
  *
866
941
  * @export
@@ -958,7 +1033,7 @@ export interface CreateAgentRequest {
958
1033
  * @type {string}
959
1034
  * @memberof CreateAgentRequest
960
1035
  */
961
- 'forwardEmail'?: string;
1036
+ 'forwardEmail': string;
962
1037
  /**
963
1038
  * Forward phone
964
1039
  * @type {string}
@@ -983,6 +1058,12 @@ export interface CreateAgentRequest {
983
1058
  * @memberof CreateAgentRequest
984
1059
  */
985
1060
  'includedLocations'?: Array<string>;
1061
+ /**
1062
+ * AI Model
1063
+ * @type {string}
1064
+ * @memberof CreateAgentRequest
1065
+ */
1066
+ 'model'?: CreateAgentRequestModelEnum;
986
1067
  /**
987
1068
  * Locations id the agent is excluded from
988
1069
  * @type {Array<string>}
@@ -990,11 +1071,91 @@ export interface CreateAgentRequest {
990
1071
  */
991
1072
  'excludedLocations'?: Array<string>;
992
1073
  /**
993
- * Transcript of the agent
994
- * @type {string}
1074
+ * Sample conversations that help build out your agent to mimic your responses
1075
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
1076
+ * @memberof CreateAgentRequest
1077
+ */
1078
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
1079
+ /**
1080
+ * Sample audio files that help build out your agent to mimic your voice
1081
+ * @type {Array<string>}
995
1082
  * @memberof CreateAgentRequest
996
1083
  */
997
- 'transcript'?: string;
1084
+ 'audio'?: Array<string>;
1085
+ }
1086
+ export declare const CreateAgentRequestModelEnum: {
1087
+ readonly PocketScout: "Pocket Scout";
1088
+ readonly Bard: "bard";
1089
+ readonly Null: "null";
1090
+ };
1091
+ export type CreateAgentRequestModelEnum = typeof CreateAgentRequestModelEnum[keyof typeof CreateAgentRequestModelEnum];
1092
+ /**
1093
+ *
1094
+ * @export
1095
+ * @interface CreateAgentRequestAllOf
1096
+ */
1097
+ export interface CreateAgentRequestAllOf {
1098
+ /**
1099
+ * Sample conversations that help build out your agent to mimic your responses
1100
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
1101
+ * @memberof CreateAgentRequestAllOf
1102
+ */
1103
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
1104
+ /**
1105
+ * Sample audio files that help build out your agent to mimic your voice
1106
+ * @type {Array<string>}
1107
+ * @memberof CreateAgentRequestAllOf
1108
+ */
1109
+ 'audio'?: Array<string>;
1110
+ }
1111
+ /**
1112
+ * @type CreateAgentRequestAllOfConversationsInner
1113
+ * @export
1114
+ */
1115
+ export type CreateAgentRequestAllOfConversationsInner = CreateAgentRequestAllOfConversationsInnerOneOf | string;
1116
+ /**
1117
+ * Conversation sample
1118
+ * @export
1119
+ * @interface CreateAgentRequestAllOfConversationsInnerOneOf
1120
+ */
1121
+ export interface CreateAgentRequestAllOfConversationsInnerOneOf {
1122
+ /**
1123
+ * The type or category of the conversation (this helps with associating work flows)
1124
+ * @type {string}
1125
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1126
+ */
1127
+ 'type': string;
1128
+ /**
1129
+ * The context of the conversation, this helps with associating work flows, or any caveats to the conversation
1130
+ * @type {string}
1131
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1132
+ */
1133
+ 'context'?: string;
1134
+ /**
1135
+ * Conversation
1136
+ * @type {Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>}
1137
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1138
+ */
1139
+ 'conversation': Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>;
1140
+ }
1141
+ /**
1142
+ *
1143
+ * @export
1144
+ * @interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1145
+ */
1146
+ export interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner {
1147
+ /**
1148
+ * The speaker of the message, if this from the agent then this must have \"agent\" or match the agent\'s first or full name
1149
+ * @type {string}
1150
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1151
+ */
1152
+ 'speaker': string;
1153
+ /**
1154
+ * The message content
1155
+ * @type {string}
1156
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1157
+ */
1158
+ 'message': string;
998
1159
  }
999
1160
  /**
1000
1161
  *
@@ -1029,96 +1190,102 @@ export interface CreateAgentResponse {
1029
1190
  export interface CreateAgentsRequest {
1030
1191
  /**
1031
1192
  *
1032
- * @type {Array<CreateAgentsRequestCustomersInner>}
1193
+ * @type {Array<CreateAgentsRequestAgentsInner>}
1033
1194
  * @memberof CreateAgentsRequest
1034
1195
  */
1035
- 'customers'?: Array<CreateAgentsRequestCustomersInner>;
1196
+ 'agents'?: Array<CreateAgentsRequestAgentsInner>;
1036
1197
  }
1037
1198
  /**
1038
1199
  *
1039
1200
  * @export
1040
- * @interface CreateAgentsRequestCustomersInner
1201
+ * @interface CreateAgentsRequestAgentsInner
1041
1202
  */
1042
- export interface CreateAgentsRequestCustomersInner {
1203
+ export interface CreateAgentsRequestAgentsInner {
1043
1204
  /**
1044
1205
  * Agent first name
1045
1206
  * @type {string}
1046
- * @memberof CreateAgentsRequestCustomersInner
1207
+ * @memberof CreateAgentsRequestAgentsInner
1047
1208
  */
1048
1209
  'firstName': string;
1049
1210
  /**
1050
1211
  * Agent last name
1051
1212
  * @type {string}
1052
- * @memberof CreateAgentsRequestCustomersInner
1213
+ * @memberof CreateAgentsRequestAgentsInner
1053
1214
  */
1054
1215
  'lastName': string;
1055
1216
  /**
1056
1217
  * Agent is inactive
1057
1218
  * @type {boolean}
1058
- * @memberof CreateAgentsRequestCustomersInner
1219
+ * @memberof CreateAgentsRequestAgentsInner
1059
1220
  */
1060
1221
  'inactive'?: boolean;
1061
1222
  /**
1062
1223
  * Programmable phone number
1063
1224
  * @type {string}
1064
- * @memberof CreateAgentsRequestCustomersInner
1225
+ * @memberof CreateAgentsRequestAgentsInner
1065
1226
  */
1066
1227
  'programmablePhoneNumber'?: string;
1067
1228
  /**
1068
1229
  * Programmable phone number SID
1069
1230
  * @type {string}
1070
- * @memberof CreateAgentsRequestCustomersInner
1231
+ * @memberof CreateAgentsRequestAgentsInner
1071
1232
  */
1072
1233
  'programmablePhoneNumberSid'?: string;
1073
1234
  /**
1074
1235
  * Email address from Scout9 gmail subdomain
1075
1236
  * @type {string}
1076
- * @memberof CreateAgentsRequestCustomersInner
1237
+ * @memberof CreateAgentsRequestAgentsInner
1077
1238
  */
1078
1239
  'programmableEmail'?: string;
1079
1240
  /**
1080
1241
  * Forward email
1081
1242
  * @type {string}
1082
- * @memberof CreateAgentsRequestCustomersInner
1243
+ * @memberof CreateAgentsRequestAgentsInner
1083
1244
  */
1084
1245
  'forwardEmail'?: string;
1085
1246
  /**
1086
1247
  * Forward phone
1087
1248
  * @type {string}
1088
- * @memberof CreateAgentsRequestCustomersInner
1249
+ * @memberof CreateAgentsRequestAgentsInner
1089
1250
  */
1090
- 'forwardPhone': string;
1251
+ 'forwardPhone'?: string;
1091
1252
  /**
1092
1253
  * Title of the agent, defaults to \"Agent\"
1093
1254
  * @type {string}
1094
- * @memberof CreateAgentsRequestCustomersInner
1255
+ * @memberof CreateAgentsRequestAgentsInner
1095
1256
  */
1096
1257
  'title'?: string;
1097
1258
  /**
1098
1259
  * Context of the agent, defaults to \"Agent\"
1099
1260
  * @type {string}
1100
- * @memberof CreateAgentsRequestCustomersInner
1261
+ * @memberof CreateAgentsRequestAgentsInner
1101
1262
  */
1102
1263
  'context'?: string;
1103
1264
  /**
1104
1265
  * Locations ids the agent is included in
1105
1266
  * @type {Array<string>}
1106
- * @memberof CreateAgentsRequestCustomersInner
1267
+ * @memberof CreateAgentsRequestAgentsInner
1107
1268
  */
1108
1269
  'includedLocations'?: Array<string>;
1270
+ /**
1271
+ * AI Model
1272
+ * @type {string}
1273
+ * @memberof CreateAgentsRequestAgentsInner
1274
+ */
1275
+ 'model'?: CreateAgentsRequestAgentsInnerModelEnum;
1109
1276
  /**
1110
1277
  * Locations id the agent is excluded from
1111
1278
  * @type {Array<string>}
1112
- * @memberof CreateAgentsRequestCustomersInner
1279
+ * @memberof CreateAgentsRequestAgentsInner
1113
1280
  */
1114
1281
  'excludedLocations'?: Array<string>;
1115
- /**
1116
- * Transcript of the agent
1117
- * @type {string}
1118
- * @memberof CreateAgentsRequestCustomersInner
1119
- */
1120
- 'transcript'?: string;
1121
1282
  }
1283
+ export declare const CreateAgentsRequestAgentsInnerModelEnum: {
1284
+ readonly PocketScout: "Pocket Scout";
1285
+ readonly Bard: "bard";
1286
+ readonly Null: "null";
1287
+ };
1288
+ export type CreateAgentsRequestAgentsInnerModelEnum = typeof CreateAgentsRequestAgentsInnerModelEnum[keyof typeof CreateAgentsRequestAgentsInnerModelEnum];
1122
1289
  /**
1123
1290
  *
1124
1291
  * @export
@@ -1220,57 +1387,57 @@ export interface CreateContextResponse {
1220
1387
  export interface CreateContextsRequest {
1221
1388
  /**
1222
1389
  *
1223
- * @type {Array<CreateContextsRequestCustomersInner>}
1390
+ * @type {Array<CreateContextsRequestContextsInner>}
1224
1391
  * @memberof CreateContextsRequest
1225
1392
  */
1226
- 'customers'?: Array<CreateContextsRequestCustomersInner>;
1393
+ 'contexts'?: Array<CreateContextsRequestContextsInner>;
1227
1394
  }
1228
1395
  /**
1229
1396
  *
1230
1397
  * @export
1231
- * @interface CreateContextsRequestCustomersInner
1398
+ * @interface CreateContextsRequestContextsInner
1232
1399
  */
1233
- export interface CreateContextsRequestCustomersInner {
1400
+ export interface CreateContextsRequestContextsInner {
1234
1401
  /**
1235
1402
  * The name of the context
1236
1403
  * @type {string}
1237
- * @memberof CreateContextsRequestCustomersInner
1404
+ * @memberof CreateContextsRequestContextsInner
1238
1405
  */
1239
1406
  'name': string;
1240
1407
  /**
1241
1408
  * Whether or not the context is modifiable
1242
1409
  * @type {boolean}
1243
- * @memberof CreateContextsRequestCustomersInner
1410
+ * @memberof CreateContextsRequestContextsInner
1244
1411
  */
1245
1412
  'modifiable': boolean;
1246
1413
  /**
1247
1414
  * The description of the context
1248
1415
  * @type {string}
1249
- * @memberof CreateContextsRequestCustomersInner
1416
+ * @memberof CreateContextsRequestContextsInner
1250
1417
  */
1251
1418
  'description'?: string;
1252
1419
  /**
1253
1420
  *
1254
1421
  * @type {ContextDetectionParams}
1255
- * @memberof CreateContextsRequestCustomersInner
1422
+ * @memberof CreateContextsRequestContextsInner
1256
1423
  */
1257
1424
  'detection'?: ContextDetectionParams;
1258
1425
  /**
1259
1426
  * The ID column of the context
1260
1427
  * @type {string}
1261
- * @memberof CreateContextsRequestCustomersInner
1428
+ * @memberof CreateContextsRequestContextsInner
1262
1429
  */
1263
1430
  'idColumn': string;
1264
1431
  /**
1265
1432
  * The columns of the context
1266
1433
  * @type {Array<string>}
1267
- * @memberof CreateContextsRequestCustomersInner
1434
+ * @memberof CreateContextsRequestContextsInner
1268
1435
  */
1269
1436
  'columns': Array<string>;
1270
1437
  /**
1271
1438
  * The required columns of the context
1272
1439
  * @type {Array<string>}
1273
- * @memberof CreateContextsRequestCustomersInner
1440
+ * @memberof CreateContextsRequestContextsInner
1274
1441
  */
1275
1442
  'requiredColumns'?: Array<string>;
1276
1443
  }
@@ -1293,6 +1460,96 @@ export interface CreateContextsResponse {
1293
1460
  */
1294
1461
  '$operation': string;
1295
1462
  }
1463
+ /**
1464
+ *
1465
+ * @export
1466
+ * @interface CreateCustomerGroupRequest
1467
+ */
1468
+ export interface CreateCustomerGroupRequest {
1469
+ /**
1470
+ * The name of the customer group
1471
+ * @type {string}
1472
+ * @memberof CreateCustomerGroupRequest
1473
+ */
1474
+ 'name': string;
1475
+ /**
1476
+ * The description of the customer group
1477
+ * @type {string}
1478
+ * @memberof CreateCustomerGroupRequest
1479
+ */
1480
+ 'description'?: string;
1481
+ /**
1482
+ *
1483
+ * @type {{ [key: string]: any; }}
1484
+ * @memberof CreateCustomerGroupRequest
1485
+ */
1486
+ 'metadata'?: {
1487
+ [key: string]: any;
1488
+ };
1489
+ /**
1490
+ *
1491
+ * @type {Array<CustomerGroupRecord>}
1492
+ * @memberof CreateCustomerGroupRequest
1493
+ */
1494
+ 'customers': Array<CustomerGroupRecord>;
1495
+ }
1496
+ /**
1497
+ *
1498
+ * @export
1499
+ * @interface CreateCustomerGroupResponse
1500
+ */
1501
+ export interface CreateCustomerGroupResponse {
1502
+ /**
1503
+ *
1504
+ * @type {boolean}
1505
+ * @memberof CreateCustomerGroupResponse
1506
+ */
1507
+ 'success': boolean;
1508
+ /**
1509
+ *
1510
+ * @type {Error}
1511
+ * @memberof CreateCustomerGroupResponse
1512
+ */
1513
+ 'error'?: Error;
1514
+ /**
1515
+ * The id of the document that was created, updated, or deleted
1516
+ * @type {string}
1517
+ * @memberof CreateCustomerGroupResponse
1518
+ */
1519
+ 'id': string;
1520
+ }
1521
+ /**
1522
+ *
1523
+ * @export
1524
+ * @interface CreateCustomerGroupsRequest
1525
+ */
1526
+ export interface CreateCustomerGroupsRequest {
1527
+ /**
1528
+ *
1529
+ * @type {Array<CustomerGroup>}
1530
+ * @memberof CreateCustomerGroupsRequest
1531
+ */
1532
+ 'CustomerGroups': Array<CustomerGroup>;
1533
+ }
1534
+ /**
1535
+ *
1536
+ * @export
1537
+ * @interface CreateCustomerGroupsResponse
1538
+ */
1539
+ export interface CreateCustomerGroupsResponse {
1540
+ /**
1541
+ * ISO 8601 datetime string of when the operation was queued
1542
+ * @type {string}
1543
+ * @memberof CreateCustomerGroupsResponse
1544
+ */
1545
+ 'queued': string;
1546
+ /**
1547
+ * The operation id to view the operation end results
1548
+ * @type {string}
1549
+ * @memberof CreateCustomerGroupsResponse
1550
+ */
1551
+ '$operation': string;
1552
+ }
1296
1553
  /**
1297
1554
  *
1298
1555
  * @export
@@ -1565,63 +1822,63 @@ export interface CreateWorkflowResponse {
1565
1822
  export interface CreateWorkflowsRequest {
1566
1823
  /**
1567
1824
  *
1568
- * @type {Array<CreateWorkflowsRequestCustomersInner>}
1825
+ * @type {Array<CreateWorkflowsRequestWorkflowsInner>}
1569
1826
  * @memberof CreateWorkflowsRequest
1570
1827
  */
1571
- 'customers'?: Array<CreateWorkflowsRequestCustomersInner>;
1828
+ 'workflows'?: Array<CreateWorkflowsRequestWorkflowsInner>;
1572
1829
  }
1573
1830
  /**
1574
1831
  *
1575
1832
  * @export
1576
- * @interface CreateWorkflowsRequestCustomersInner
1833
+ * @interface CreateWorkflowsRequestWorkflowsInner
1577
1834
  */
1578
- export interface CreateWorkflowsRequestCustomersInner {
1835
+ export interface CreateWorkflowsRequestWorkflowsInner {
1579
1836
  /**
1580
1837
  * The name of the workflow
1581
1838
  * @type {string}
1582
- * @memberof CreateWorkflowsRequestCustomersInner
1839
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1583
1840
  */
1584
1841
  'name': string;
1585
1842
  /**
1586
1843
  *
1587
1844
  * @type {ContextDetectionParams}
1588
- * @memberof CreateWorkflowsRequestCustomersInner
1845
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1589
1846
  */
1590
1847
  'initiators': ContextDetectionParams;
1591
1848
  /**
1592
1849
  * The fields of the workflow
1593
1850
  * @type {Array<ConversationContextField>}
1594
- * @memberof CreateWorkflowsRequestCustomersInner
1851
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1595
1852
  */
1596
1853
  'fields': Array<ConversationContextField>;
1597
1854
  /**
1598
1855
  * About this conversation - used as initial context
1599
1856
  * @type {string}
1600
- * @memberof CreateWorkflowsRequestCustomersInner
1857
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1601
1858
  */
1602
1859
  'context': string;
1603
1860
  /**
1604
1861
  * The webhook to call when a workflow is created
1605
1862
  * @type {string}
1606
- * @memberof CreateWorkflowsRequestCustomersInner
1863
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1607
1864
  */
1608
1865
  'onCreated'?: string;
1609
1866
  /**
1610
1867
  * The webhook to call when a workflow is updated
1611
1868
  * @type {string}
1612
- * @memberof CreateWorkflowsRequestCustomersInner
1869
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1613
1870
  */
1614
1871
  'onUpdated'?: string;
1615
1872
  /**
1616
1873
  * The webhook to call when a workflow is deleted
1617
1874
  * @type {string}
1618
- * @memberof CreateWorkflowsRequestCustomersInner
1875
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1619
1876
  */
1620
1877
  'onDeleted'?: string;
1621
1878
  /**
1622
1879
  * The webhook to call when a workflow has an error
1623
1880
  * @type {string}
1624
- * @memberof CreateWorkflowsRequestCustomersInner
1881
+ * @memberof CreateWorkflowsRequestWorkflowsInner
1625
1882
  */
1626
1883
  'onError'?: string;
1627
1884
  }
@@ -1773,41 +2030,99 @@ export interface Customer {
1773
2030
  'stripeDev'?: string | null;
1774
2031
  }
1775
2032
  /**
1776
- * @type CustomerValue
1777
- * @export
1778
- */
1779
- export type CustomerValue = boolean | number | string;
1780
- /**
1781
- *
2033
+ * A way for a business to group customers to use in scheduling batch conversations
1782
2034
  * @export
1783
- * @interface DeleteAgentResponse
2035
+ * @interface CustomerGroup
1784
2036
  */
1785
- export interface DeleteAgentResponse {
2037
+ export interface CustomerGroup {
1786
2038
  /**
1787
- *
1788
- * @type {boolean}
1789
- * @memberof DeleteAgentResponse
2039
+ * The name of the customer group
2040
+ * @type {string}
2041
+ * @memberof CustomerGroup
1790
2042
  */
1791
- 'success': boolean;
2043
+ 'name': string;
2044
+ /**
2045
+ * The description of the customer group
2046
+ * @type {string}
2047
+ * @memberof CustomerGroup
2048
+ */
2049
+ 'description'?: string;
1792
2050
  /**
1793
2051
  *
1794
- * @type {Error}
1795
- * @memberof DeleteAgentResponse
2052
+ * @type {{ [key: string]: any; }}
2053
+ * @memberof CustomerGroup
1796
2054
  */
1797
- 'error'?: Error;
2055
+ 'metadata'?: {
2056
+ [key: string]: any;
2057
+ };
1798
2058
  /**
1799
- * The id of the document that was created, updated, or deleted
1800
- * @type {string}
1801
- * @memberof DeleteAgentResponse
2059
+ *
2060
+ * @type {Array<CustomerGroupRecord>}
2061
+ * @memberof CustomerGroup
1802
2062
  */
1803
- 'id': string;
2063
+ 'customers': Array<CustomerGroupRecord>;
1804
2064
  }
1805
2065
  /**
1806
- *
2066
+ * A way for a business to group customers to use in scheduling batch conversations
1807
2067
  * @export
1808
- * @interface DeleteAgentsResponse
2068
+ * @interface CustomerGroupRecord
1809
2069
  */
1810
- export interface DeleteAgentsResponse {
2070
+ export interface CustomerGroupRecord {
2071
+ /**
2072
+ * Customer this conversation is with
2073
+ * @type {string}
2074
+ * @memberof CustomerGroupRecord
2075
+ */
2076
+ 'id': string;
2077
+ /**
2078
+ *
2079
+ * @type {ConversationEnvironment}
2080
+ * @memberof CustomerGroupRecord
2081
+ */
2082
+ 'environment': ConversationEnvironment;
2083
+ /**
2084
+ * Overrides the default $agent for this customer
2085
+ * @type {string}
2086
+ * @memberof CustomerGroupRecord
2087
+ */
2088
+ '$agent'?: string;
2089
+ }
2090
+ /**
2091
+ * @type CustomerValue
2092
+ * @export
2093
+ */
2094
+ export type CustomerValue = boolean | number | string;
2095
+ /**
2096
+ *
2097
+ * @export
2098
+ * @interface DeleteAgentResponse
2099
+ */
2100
+ export interface DeleteAgentResponse {
2101
+ /**
2102
+ *
2103
+ * @type {boolean}
2104
+ * @memberof DeleteAgentResponse
2105
+ */
2106
+ 'success': boolean;
2107
+ /**
2108
+ *
2109
+ * @type {Error}
2110
+ * @memberof DeleteAgentResponse
2111
+ */
2112
+ 'error'?: Error;
2113
+ /**
2114
+ * The id of the document that was created, updated, or deleted
2115
+ * @type {string}
2116
+ * @memberof DeleteAgentResponse
2117
+ */
2118
+ 'id': string;
2119
+ }
2120
+ /**
2121
+ *
2122
+ * @export
2123
+ * @interface DeleteAgentsResponse
2124
+ */
2125
+ export interface DeleteAgentsResponse {
1811
2126
  /**
1812
2127
  * ISO 8601 datetime string of when the operation was queued
1813
2128
  * @type {string}
@@ -1865,6 +2180,50 @@ export interface DeleteContextsResponse {
1865
2180
  */
1866
2181
  '$operation': string;
1867
2182
  }
2183
+ /**
2184
+ *
2185
+ * @export
2186
+ * @interface DeleteCustomerGroupResponse
2187
+ */
2188
+ export interface DeleteCustomerGroupResponse {
2189
+ /**
2190
+ *
2191
+ * @type {boolean}
2192
+ * @memberof DeleteCustomerGroupResponse
2193
+ */
2194
+ 'success': boolean;
2195
+ /**
2196
+ *
2197
+ * @type {Error}
2198
+ * @memberof DeleteCustomerGroupResponse
2199
+ */
2200
+ 'error'?: Error;
2201
+ /**
2202
+ * The id of the document that was created, updated, or deleted
2203
+ * @type {string}
2204
+ * @memberof DeleteCustomerGroupResponse
2205
+ */
2206
+ 'id': string;
2207
+ }
2208
+ /**
2209
+ *
2210
+ * @export
2211
+ * @interface DeleteCustomerGroupsResponse
2212
+ */
2213
+ export interface DeleteCustomerGroupsResponse {
2214
+ /**
2215
+ * ISO 8601 datetime string of when the operation was queued
2216
+ * @type {string}
2217
+ * @memberof DeleteCustomerGroupsResponse
2218
+ */
2219
+ 'queued': string;
2220
+ /**
2221
+ * The operation id to view the operation end results
2222
+ * @type {string}
2223
+ * @memberof DeleteCustomerGroupsResponse
2224
+ */
2225
+ '$operation': string;
2226
+ }
1868
2227
  /**
1869
2228
  *
1870
2229
  * @export
@@ -1909,6 +2268,31 @@ export interface DeleteCustomersResponse {
1909
2268
  */
1910
2269
  '$operation': string;
1911
2270
  }
2271
+ /**
2272
+ *
2273
+ * @export
2274
+ * @interface DeleteFileResponse
2275
+ */
2276
+ export interface DeleteFileResponse {
2277
+ /**
2278
+ *
2279
+ * @type {string}
2280
+ * @memberof DeleteFileResponse
2281
+ */
2282
+ 'id': string;
2283
+ /**
2284
+ *
2285
+ * @type {string}
2286
+ * @memberof DeleteFileResponse
2287
+ */
2288
+ 'object': string;
2289
+ /**
2290
+ *
2291
+ * @type {boolean}
2292
+ * @memberof DeleteFileResponse
2293
+ */
2294
+ 'deleted': boolean;
2295
+ }
1912
2296
  /**
1913
2297
  *
1914
2298
  * @export
@@ -1973,11 +2357,50 @@ export interface ErrorResponse {
1973
2357
  */
1974
2358
  export interface GenerateRequest {
1975
2359
  /**
1976
- * Conversation ID to generate message from
1977
- * @type {string}
2360
+ *
2361
+ * @type {GenerateRequestConvo}
1978
2362
  * @memberof GenerateRequest
1979
2363
  */
1980
- 'convo': string;
2364
+ 'convo': GenerateRequestConvo;
2365
+ /**
2366
+ *
2367
+ * @type {GenerateRequestMocks}
2368
+ * @memberof GenerateRequest
2369
+ */
2370
+ 'mocks'?: GenerateRequestMocks;
2371
+ }
2372
+ /**
2373
+ * @type GenerateRequestConvo
2374
+ * The conversation to generate a message from
2375
+ * @export
2376
+ */
2377
+ export type GenerateRequestConvo = ConversationCreateRequest | string;
2378
+ /**
2379
+ * If any mocks are provided, the response will be mocked and conversation will not be created. Requires .convo to be a Conversation object
2380
+ * @export
2381
+ * @interface GenerateRequestMocks
2382
+ */
2383
+ export interface GenerateRequestMocks {
2384
+ /**
2385
+ * Any key,value information about the conversation, customr, or offer goes here
2386
+ * @type {{ [key: string]: any; }}
2387
+ * @memberof GenerateRequestMocks
2388
+ */
2389
+ 'info'?: {
2390
+ [key: string]: any;
2391
+ };
2392
+ /**
2393
+ * Conversation Context fields to mock, use this to test out conversation logic
2394
+ * @type {Array<ConversationContextField>}
2395
+ * @memberof GenerateRequestMocks
2396
+ */
2397
+ 'context'?: Array<ConversationContextField>;
2398
+ /**
2399
+ * Conversation Messages to mock, use this to test out anticipated responses
2400
+ * @type {Array<MessageBase>}
2401
+ * @memberof GenerateRequestMocks
2402
+ */
2403
+ 'messages'?: Array<MessageBase>;
1981
2404
  }
1982
2405
  /**
1983
2406
  *
@@ -2009,13 +2432,48 @@ export interface GenerateResponse {
2009
2432
  * @memberof GenerateResponse
2010
2433
  */
2011
2434
  'time': string;
2435
+ /**
2436
+ * Any key,value information about the conversation, customr, or offer goes here
2437
+ * @type {{ [key: string]: any; }}
2438
+ * @memberof GenerateResponse
2439
+ */
2440
+ 'info': {
2441
+ [key: string]: any;
2442
+ };
2443
+ /**
2444
+ * Conversation Context fields to mock, use this to test out conversation logic
2445
+ * @type {Array<ConversationContextField>}
2446
+ * @memberof GenerateResponse
2447
+ */
2448
+ 'included': Array<ConversationContextField>;
2012
2449
  }
2013
2450
  export declare const GenerateResponseRoleEnum: {
2014
- readonly User: "user";
2015
- readonly Assistant: "assistant";
2016
- readonly System: "system";
2451
+ readonly Customer: "customer";
2452
+ readonly Agent: "agent";
2453
+ readonly Context: "context";
2017
2454
  };
2018
2455
  export type GenerateResponseRoleEnum = typeof GenerateResponseRoleEnum[keyof typeof GenerateResponseRoleEnum];
2456
+ /**
2457
+ *
2458
+ * @export
2459
+ * @interface GenerateResponseAllOf
2460
+ */
2461
+ export interface GenerateResponseAllOf {
2462
+ /**
2463
+ * Any key,value information about the conversation, customr, or offer goes here
2464
+ * @type {{ [key: string]: any; }}
2465
+ * @memberof GenerateResponseAllOf
2466
+ */
2467
+ 'info': {
2468
+ [key: string]: any;
2469
+ };
2470
+ /**
2471
+ * Conversation Context fields to mock, use this to test out conversation logic
2472
+ * @type {Array<ConversationContextField>}
2473
+ * @memberof GenerateResponseAllOf
2474
+ */
2475
+ 'included': Array<ConversationContextField>;
2476
+ }
2019
2477
  /**
2020
2478
  *
2021
2479
  * @export
@@ -2069,7 +2527,7 @@ export interface GetAgentResponse {
2069
2527
  * @type {string}
2070
2528
  * @memberof GetAgentResponse
2071
2529
  */
2072
- 'forwardPhone': string;
2530
+ 'forwardPhone'?: string;
2073
2531
  /**
2074
2532
  * Title of the agent, defaults to \"Agent\"
2075
2533
  * @type {string}
@@ -2089,17 +2547,17 @@ export interface GetAgentResponse {
2089
2547
  */
2090
2548
  'includedLocations'?: Array<string>;
2091
2549
  /**
2092
- * Locations id the agent is excluded from
2093
- * @type {Array<string>}
2550
+ * AI Model
2551
+ * @type {string}
2094
2552
  * @memberof GetAgentResponse
2095
2553
  */
2096
- 'excludedLocations'?: Array<string>;
2554
+ 'model'?: GetAgentResponseModelEnum;
2097
2555
  /**
2098
- * Transcript of the agent
2099
- * @type {string}
2556
+ * Locations id the agent is excluded from
2557
+ * @type {Array<string>}
2100
2558
  * @memberof GetAgentResponse
2101
2559
  */
2102
- 'transcript'?: string;
2560
+ 'excludedLocations'?: Array<string>;
2103
2561
  /**
2104
2562
  * The ID of the agent
2105
2563
  * @type {string}
@@ -2107,6 +2565,12 @@ export interface GetAgentResponse {
2107
2565
  */
2108
2566
  '$id': string;
2109
2567
  }
2568
+ export declare const GetAgentResponseModelEnum: {
2569
+ readonly PocketScout: "Pocket Scout";
2570
+ readonly Bard: "bard";
2571
+ readonly Null: "null";
2572
+ };
2573
+ export type GetAgentResponseModelEnum = typeof GetAgentResponseModelEnum[keyof typeof GetAgentResponseModelEnum];
2110
2574
  /**
2111
2575
  *
2112
2576
  * @export
@@ -2248,6 +2712,58 @@ export interface GetContextResponseAllOf {
2248
2712
  */
2249
2713
  '$id': string;
2250
2714
  }
2715
+ /**
2716
+ *
2717
+ * @export
2718
+ * @interface GetCustomerGroupResponse
2719
+ */
2720
+ export interface GetCustomerGroupResponse {
2721
+ /**
2722
+ * The name of the customer group
2723
+ * @type {string}
2724
+ * @memberof GetCustomerGroupResponse
2725
+ */
2726
+ 'name': string;
2727
+ /**
2728
+ * The description of the customer group
2729
+ * @type {string}
2730
+ * @memberof GetCustomerGroupResponse
2731
+ */
2732
+ 'description'?: string;
2733
+ /**
2734
+ *
2735
+ * @type {{ [key: string]: any; }}
2736
+ * @memberof GetCustomerGroupResponse
2737
+ */
2738
+ 'metadata'?: {
2739
+ [key: string]: any;
2740
+ };
2741
+ /**
2742
+ *
2743
+ * @type {Array<CustomerGroupRecord>}
2744
+ * @memberof GetCustomerGroupResponse
2745
+ */
2746
+ 'customers': Array<CustomerGroupRecord>;
2747
+ /**
2748
+ * The ID of the CustomerGroup
2749
+ * @type {string}
2750
+ * @memberof GetCustomerGroupResponse
2751
+ */
2752
+ '$id'?: string;
2753
+ }
2754
+ /**
2755
+ *
2756
+ * @export
2757
+ * @interface GetCustomerGroupResponseAllOf
2758
+ */
2759
+ export interface GetCustomerGroupResponseAllOf {
2760
+ /**
2761
+ * The ID of the CustomerGroup
2762
+ * @type {string}
2763
+ * @memberof GetCustomerGroupResponseAllOf
2764
+ */
2765
+ '$id'?: string;
2766
+ }
2251
2767
  /**
2252
2768
  *
2253
2769
  * @export
@@ -2479,13 +2995,13 @@ export interface ListAgentsResponseInner {
2479
2995
  * @type {string}
2480
2996
  * @memberof ListAgentsResponseInner
2481
2997
  */
2482
- 'firstName': string;
2998
+ 'firstName'?: string;
2483
2999
  /**
2484
3000
  * Agent last name
2485
3001
  * @type {string}
2486
3002
  * @memberof ListAgentsResponseInner
2487
3003
  */
2488
- 'lastName': string;
3004
+ 'lastName'?: string;
2489
3005
  /**
2490
3006
  * Agent is inactive
2491
3007
  * @type {boolean}
@@ -2521,7 +3037,7 @@ export interface ListAgentsResponseInner {
2521
3037
  * @type {string}
2522
3038
  * @memberof ListAgentsResponseInner
2523
3039
  */
2524
- 'forwardPhone': string;
3040
+ 'forwardPhone'?: string;
2525
3041
  /**
2526
3042
  * Title of the agent, defaults to \"Agent\"
2527
3043
  * @type {string}
@@ -2541,17 +3057,17 @@ export interface ListAgentsResponseInner {
2541
3057
  */
2542
3058
  'includedLocations'?: Array<string>;
2543
3059
  /**
2544
- * Locations id the agent is excluded from
2545
- * @type {Array<string>}
3060
+ * AI Model
3061
+ * @type {string}
2546
3062
  * @memberof ListAgentsResponseInner
2547
3063
  */
2548
- 'excludedLocations'?: Array<string>;
3064
+ 'model'?: ListAgentsResponseInnerModelEnum;
2549
3065
  /**
2550
- * Transcript of the agent
2551
- * @type {string}
3066
+ * Locations id the agent is excluded from
3067
+ * @type {Array<string>}
2552
3068
  * @memberof ListAgentsResponseInner
2553
3069
  */
2554
- 'transcript'?: string;
3070
+ 'excludedLocations'?: Array<string>;
2555
3071
  /**
2556
3072
  * The ID of the agent
2557
3073
  * @type {string}
@@ -2559,6 +3075,12 @@ export interface ListAgentsResponseInner {
2559
3075
  */
2560
3076
  '$id': string;
2561
3077
  }
3078
+ export declare const ListAgentsResponseInnerModelEnum: {
3079
+ readonly PocketScout: "Pocket Scout";
3080
+ readonly Bard: "bard";
3081
+ readonly Null: "null";
3082
+ };
3083
+ export type ListAgentsResponseInnerModelEnum = typeof ListAgentsResponseInnerModelEnum[keyof typeof ListAgentsResponseInnerModelEnum];
2562
3084
  /**
2563
3085
  *
2564
3086
  * @export
@@ -2700,6 +3222,58 @@ export interface ListContextsResponseInnerAllOf {
2700
3222
  */
2701
3223
  '$id': string;
2702
3224
  }
3225
+ /**
3226
+ *
3227
+ * @export
3228
+ * @interface ListCustomerGroupsResponseInner
3229
+ */
3230
+ export interface ListCustomerGroupsResponseInner {
3231
+ /**
3232
+ * The name of the customer group
3233
+ * @type {string}
3234
+ * @memberof ListCustomerGroupsResponseInner
3235
+ */
3236
+ 'name': string;
3237
+ /**
3238
+ * The description of the customer group
3239
+ * @type {string}
3240
+ * @memberof ListCustomerGroupsResponseInner
3241
+ */
3242
+ 'description'?: string;
3243
+ /**
3244
+ *
3245
+ * @type {{ [key: string]: any; }}
3246
+ * @memberof ListCustomerGroupsResponseInner
3247
+ */
3248
+ 'metadata'?: {
3249
+ [key: string]: any;
3250
+ };
3251
+ /**
3252
+ *
3253
+ * @type {Array<CustomerGroupRecord>}
3254
+ * @memberof ListCustomerGroupsResponseInner
3255
+ */
3256
+ 'customers': Array<CustomerGroupRecord>;
3257
+ /**
3258
+ * The ID of the CustomerGroup
3259
+ * @type {string}
3260
+ * @memberof ListCustomerGroupsResponseInner
3261
+ */
3262
+ '$id': string;
3263
+ }
3264
+ /**
3265
+ *
3266
+ * @export
3267
+ * @interface ListCustomerGroupsResponseInnerAllOf
3268
+ */
3269
+ export interface ListCustomerGroupsResponseInnerAllOf {
3270
+ /**
3271
+ * The ID of the CustomerGroup
3272
+ * @type {string}
3273
+ * @memberof ListCustomerGroupsResponseInnerAllOf
3274
+ */
3275
+ '$id': string;
3276
+ }
2703
3277
  /**
2704
3278
  *
2705
3279
  * @export
@@ -2846,6 +3420,25 @@ export interface ListCustomersResponseInnerAllOf {
2846
3420
  */
2847
3421
  '$id': string;
2848
3422
  }
3423
+ /**
3424
+ *
3425
+ * @export
3426
+ * @interface ListFilesResponse
3427
+ */
3428
+ export interface ListFilesResponse {
3429
+ /**
3430
+ *
3431
+ * @type {string}
3432
+ * @memberof ListFilesResponse
3433
+ */
3434
+ 'object': string;
3435
+ /**
3436
+ *
3437
+ * @type {Array<Scout9File>}
3438
+ * @memberof ListFilesResponse
3439
+ */
3440
+ 'data': Array<Scout9File>;
3441
+ }
2849
3442
  /**
2850
3443
  *
2851
3444
  * @export
@@ -3001,11 +3594,55 @@ export interface Message {
3001
3594
  'time': string;
3002
3595
  }
3003
3596
  export declare const MessageRoleEnum: {
3004
- readonly User: "user";
3005
- readonly Assistant: "assistant";
3006
- readonly System: "system";
3597
+ readonly Customer: "customer";
3598
+ readonly Agent: "agent";
3599
+ readonly Context: "context";
3007
3600
  };
3008
3601
  export type MessageRoleEnum = typeof MessageRoleEnum[keyof typeof MessageRoleEnum];
3602
+ /**
3603
+ *
3604
+ * @export
3605
+ * @interface MessageAllOf
3606
+ */
3607
+ export interface MessageAllOf {
3608
+ /**
3609
+ * The time the message was sent
3610
+ * @type {string}
3611
+ * @memberof MessageAllOf
3612
+ */
3613
+ 'time': string;
3614
+ }
3615
+ /**
3616
+ *
3617
+ * @export
3618
+ * @interface MessageBase
3619
+ */
3620
+ export interface MessageBase {
3621
+ /**
3622
+ * The role of the message (customer, agent, or business)
3623
+ * @type {string}
3624
+ * @memberof MessageBase
3625
+ */
3626
+ 'role': MessageBaseRoleEnum;
3627
+ /**
3628
+ * The content of the message
3629
+ * @type {string}
3630
+ * @memberof MessageBase
3631
+ */
3632
+ 'content': string;
3633
+ /**
3634
+ * The name of the sender
3635
+ * @type {string}
3636
+ * @memberof MessageBase
3637
+ */
3638
+ 'name'?: string;
3639
+ }
3640
+ export declare const MessageBaseRoleEnum: {
3641
+ readonly Customer: "customer";
3642
+ readonly Agent: "agent";
3643
+ readonly Context: "context";
3644
+ };
3645
+ export type MessageBaseRoleEnum = typeof MessageBaseRoleEnum[keyof typeof MessageBaseRoleEnum];
3009
3646
  /**
3010
3647
  *
3011
3648
  * @export
@@ -3106,9 +3743,9 @@ export interface MessageGetResponseInner {
3106
3743
  '$id': string;
3107
3744
  }
3108
3745
  export declare const MessageGetResponseInnerRoleEnum: {
3109
- readonly User: "user";
3110
- readonly Assistant: "assistant";
3111
- readonly System: "system";
3746
+ readonly Customer: "customer";
3747
+ readonly Agent: "agent";
3748
+ readonly Context: "context";
3112
3749
  };
3113
3750
  export type MessageGetResponseInnerRoleEnum = typeof MessageGetResponseInnerRoleEnum[keyof typeof MessageGetResponseInnerRoleEnum];
3114
3751
  /**
@@ -3267,12 +3904,6 @@ export interface ScheduleCreateRequest {
3267
3904
  * @memberof ScheduleCreateRequest
3268
3905
  */
3269
3906
  '$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
3907
  /**
3277
3908
  * Initial contexts to load when starting the conversation
3278
3909
  * @type {Array<string>}
@@ -3321,6 +3952,12 @@ export interface ScheduleCreateRequest {
3321
3952
  * @memberof ScheduleCreateRequest
3322
3953
  */
3323
3954
  '$group'?: string;
3955
+ /**
3956
+ *
3957
+ * @type {ConversationUpdateRequestBaseWorkflow}
3958
+ * @memberof ScheduleCreateRequest
3959
+ */
3960
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3324
3961
  }
3325
3962
  /**
3326
3963
  *
@@ -3378,12 +4015,6 @@ export interface ScheduleGetResponse {
3378
4015
  * @memberof ScheduleGetResponse
3379
4016
  */
3380
4017
  '$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
4018
  /**
3388
4019
  * Initial contexts to load when starting the conversation
3389
4020
  * @type {Array<string>}
@@ -3432,6 +4063,30 @@ export interface ScheduleGetResponse {
3432
4063
  * @memberof ScheduleGetResponse
3433
4064
  */
3434
4065
  '$group'?: string;
4066
+ /**
4067
+ * The ID of the workflow used for this conversation
4068
+ * @type {string}
4069
+ * @memberof ScheduleGetResponse
4070
+ */
4071
+ '$workflow': string;
4072
+ /**
4073
+ * The client web url of the conversation
4074
+ * @type {string}
4075
+ * @memberof ScheduleGetResponse
4076
+ */
4077
+ 'clientWebUrl'?: string;
4078
+ /**
4079
+ * The agent web url of the conversation (requires phone two-factor authentication)
4080
+ * @type {string}
4081
+ * @memberof ScheduleGetResponse
4082
+ */
4083
+ 'agentWebUrl'?: string;
4084
+ /**
4085
+ * The agent test web url of the conversation, used for testing the conversation without notifying the customer
4086
+ * @type {string}
4087
+ * @memberof ScheduleGetResponse
4088
+ */
4089
+ 'agentTestWebUrl'?: string;
3435
4090
  }
3436
4091
  /**
3437
4092
  *
@@ -3440,17 +4095,17 @@ export interface ScheduleGetResponse {
3440
4095
  */
3441
4096
  export interface ScheduleGroupCreateRequest {
3442
4097
  /**
3443
- * Default agent assigned to the conversation(s)
3444
- * @type {string}
4098
+ *
4099
+ * @type {ConversationUpdateRequestBaseWorkflow}
3445
4100
  * @memberof ScheduleGroupCreateRequest
3446
4101
  */
3447
- '$agent': string;
4102
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3448
4103
  /**
3449
- * Thread this conversation is in - this determines what context to pull when loading the conversation
4104
+ * Default agent assigned to the conversation(s)
3450
4105
  * @type {string}
3451
4106
  * @memberof ScheduleGroupCreateRequest
3452
4107
  */
3453
- '$thread'?: string;
4108
+ '$agent': string;
3454
4109
  /**
3455
4110
  * Initial contexts to load when starting the conversation
3456
4111
  * @type {Array<string>}
@@ -3488,12 +4143,30 @@ export interface ScheduleGroupCreateRequest {
3488
4143
  */
3489
4144
  'delay'?: number;
3490
4145
  /**
3491
- * Customers in this group
3492
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4146
+ *
4147
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3493
4148
  * @memberof ScheduleGroupCreateRequest
3494
4149
  */
3495
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4150
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
4151
+ }
4152
+ /**
4153
+ *
4154
+ * @export
4155
+ * @interface ScheduleGroupCreateRequestAllOf
4156
+ */
4157
+ export interface ScheduleGroupCreateRequestAllOf {
4158
+ /**
4159
+ *
4160
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
4161
+ * @memberof ScheduleGroupCreateRequestAllOf
4162
+ */
4163
+ '$cGroup': ScheduleGroupCreateRequestAllOfCGroup;
3496
4164
  }
4165
+ /**
4166
+ * @type ScheduleGroupCreateRequestAllOfCGroup
4167
+ * @export
4168
+ */
4169
+ export type ScheduleGroupCreateRequestAllOfCGroup = CustomerGroup | string;
3497
4170
  /**
3498
4171
  *
3499
4172
  * @export
@@ -3531,12 +4204,6 @@ export interface ScheduleGroupGetResponse {
3531
4204
  * @memberof ScheduleGroupGetResponse
3532
4205
  */
3533
4206
  '$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
4207
  /**
3541
4208
  * Initial contexts to load when starting the conversation
3542
4209
  * @type {Array<string>}
@@ -3574,11 +4241,11 @@ export interface ScheduleGroupGetResponse {
3574
4241
  */
3575
4242
  'delay'?: number;
3576
4243
  /**
3577
- * Customers in this group
3578
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4244
+ * The ID of the workflow used for this conversation
4245
+ * @type {string}
3579
4246
  * @memberof ScheduleGroupGetResponse
3580
4247
  */
3581
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4248
+ '$workflow': string;
3582
4249
  /**
3583
4250
  * The ID of the scheduled conversation group
3584
4251
  * @type {string}
@@ -3591,6 +4258,12 @@ export interface ScheduleGroupGetResponse {
3591
4258
  * @memberof ScheduleGroupGetResponse
3592
4259
  */
3593
4260
  'sent'?: boolean;
4261
+ /**
4262
+ * The ID of the group the customers belong to
4263
+ * @type {string}
4264
+ * @memberof ScheduleGroupGetResponse
4265
+ */
4266
+ '$cGroup'?: string;
3594
4267
  }
3595
4268
  /**
3596
4269
  *
@@ -3610,6 +4283,12 @@ export interface ScheduleGroupGetResponseAllOf {
3610
4283
  * @memberof ScheduleGroupGetResponseAllOf
3611
4284
  */
3612
4285
  'sent'?: boolean;
4286
+ /**
4287
+ * The ID of the group the customers belong to
4288
+ * @type {string}
4289
+ * @memberof ScheduleGroupGetResponseAllOf
4290
+ */
4291
+ '$cGroup'?: string;
3613
4292
  }
3614
4293
  /**
3615
4294
  *
@@ -3648,12 +4327,6 @@ export interface ScheduleGroupUpdateRequest {
3648
4327
  * @memberof ScheduleGroupUpdateRequest
3649
4328
  */
3650
4329
  '$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
4330
  /**
3658
4331
  * Initial contexts to load when starting the conversation
3659
4332
  * @type {Array<string>}
@@ -3691,11 +4364,17 @@ export interface ScheduleGroupUpdateRequest {
3691
4364
  */
3692
4365
  'delay'?: number;
3693
4366
  /**
3694
- * Customers in this group
3695
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4367
+ *
4368
+ * @type {ConversationUpdateRequestBaseWorkflow}
4369
+ * @memberof ScheduleGroupUpdateRequest
4370
+ */
4371
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
4372
+ /**
4373
+ *
4374
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
3696
4375
  * @memberof ScheduleGroupUpdateRequest
3697
4376
  */
3698
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4377
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3699
4378
  /**
3700
4379
  * The ID of the scheduled conversation group to update
3701
4380
  * @type {string}
@@ -3709,6 +4388,12 @@ export interface ScheduleGroupUpdateRequest {
3709
4388
  * @interface ScheduleGroupUpdateRequestAllOf
3710
4389
  */
3711
4390
  export interface ScheduleGroupUpdateRequestAllOf {
4391
+ /**
4392
+ *
4393
+ * @type {ScheduleGroupCreateRequestAllOfCGroup}
4394
+ * @memberof ScheduleGroupUpdateRequestAllOf
4395
+ */
4396
+ '$cGroup'?: ScheduleGroupCreateRequestAllOfCGroup;
3712
4397
  /**
3713
4398
  * The ID of the scheduled conversation group to update
3714
4399
  * @type {string}
@@ -3778,12 +4463,6 @@ export interface ScheduleUpdateRequest {
3778
4463
  * @memberof ScheduleUpdateRequest
3779
4464
  */
3780
4465
  '$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
4466
  /**
3788
4467
  * Initial contexts to load when starting the conversation
3789
4468
  * @type {Array<string>}
@@ -3832,6 +4511,12 @@ export interface ScheduleUpdateRequest {
3832
4511
  * @memberof ScheduleUpdateRequest
3833
4512
  */
3834
4513
  '$group'?: string;
4514
+ /**
4515
+ *
4516
+ * @type {ConversationUpdateRequestBaseWorkflow}
4517
+ * @memberof ScheduleUpdateRequest
4518
+ */
4519
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3835
4520
  /**
3836
4521
  * The ID of the scheduled conversation to update
3837
4522
  * @type {string}
@@ -3889,12 +4574,6 @@ export interface ScheduledConversation {
3889
4574
  * @memberof ScheduledConversation
3890
4575
  */
3891
4576
  '$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
4577
  /**
3899
4578
  * Initial contexts to load when starting the conversation
3900
4579
  * @type {Array<string>}
@@ -3969,12 +4648,6 @@ export interface ScheduledConversationGroup {
3969
4648
  * @memberof ScheduledConversationGroup
3970
4649
  */
3971
4650
  '$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
4651
  /**
3979
4652
  * Initial contexts to load when starting the conversation
3980
4653
  * @type {Array<string>}
@@ -4011,12 +4684,6 @@ export interface ScheduledConversationGroup {
4011
4684
  * @memberof ScheduledConversationGroup
4012
4685
  */
4013
4686
  'delay'?: number;
4014
- /**
4015
- * Customers in this group
4016
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4017
- * @memberof ScheduledConversationGroup
4018
- */
4019
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4020
4687
  }
4021
4688
  /**
4022
4689
  *
@@ -4030,37 +4697,61 @@ export interface ScheduledConversationGroupAllOf {
4030
4697
  * @memberof ScheduledConversationGroupAllOf
4031
4698
  */
4032
4699
  'delay'?: number;
4033
- /**
4034
- * Customers in this group
4035
- * @type {Array<ScheduledConversationGroupAllOfCustomers>}
4036
- * @memberof ScheduledConversationGroupAllOf
4037
- */
4038
- 'customers': Array<ScheduledConversationGroupAllOfCustomers>;
4039
4700
  }
4040
4701
  /**
4041
- *
4702
+ * The `File` object represents a document that has been uploaded to Scout9.
4042
4703
  * @export
4043
- * @interface ScheduledConversationGroupAllOfCustomers
4704
+ * @interface Scout9File
4044
4705
  */
4045
- export interface ScheduledConversationGroupAllOfCustomers {
4706
+ export interface Scout9File {
4046
4707
  /**
4047
- *
4048
- * @type {ConversationEnvironment}
4049
- * @memberof ScheduledConversationGroupAllOfCustomers
4708
+ * The file identifier, which can be referenced in the API endpoints.
4709
+ * @type {string}
4710
+ * @memberof Scout9File
4050
4711
  */
4051
- 'environment': ConversationEnvironment;
4712
+ 'id': string;
4052
4713
  /**
4053
- * Customer ID
4714
+ * The object type, which is always \"file\".
4054
4715
  * @type {string}
4055
- * @memberof ScheduledConversationGroupAllOfCustomers
4716
+ * @memberof Scout9File
4056
4717
  */
4057
- 'id': string;
4718
+ 'object': string;
4719
+ /**
4720
+ * The size of the file in bytes.
4721
+ * @type {number}
4722
+ * @memberof Scout9File
4723
+ */
4724
+ 'bytes': number;
4725
+ /**
4726
+ * The unix timestamp for when the file was created.
4727
+ * @type {number}
4728
+ * @memberof Scout9File
4729
+ */
4730
+ 'created_at': number;
4058
4731
  /**
4059
- * Overrides default $agent for this customer
4732
+ * The name of the file.
4060
4733
  * @type {string}
4061
- * @memberof ScheduledConversationGroupAllOfCustomers
4734
+ * @memberof Scout9File
4062
4735
  */
4063
- '$agent'?: string;
4736
+ 'filename': string;
4737
+ /**
4738
+ * The intended purpose of the file. Currently, only \"fine-tune\" is supported.
4739
+ * @type {string}
4740
+ * @memberof Scout9File
4741
+ */
4742
+ 'purpose': string;
4743
+ /**
4744
+ * The current status of the file, which can be either `uploaded`, `processed`, `pending`, `error`, `deleting` or `deleted`.
4745
+ * @type {string}
4746
+ * @memberof Scout9File
4747
+ */
4748
+ 'status'?: string;
4749
+ /**
4750
+ * Additional details about the status of the file. If the file is in the `error` state, this will include a message describing the error.
4751
+ * @type {string}
4752
+ * @memberof Scout9File
4753
+ */
4754
+ 'status_details'?: string | null;
4064
4755
  }
4065
4756
  /**
4066
4757
  *
@@ -4068,18 +4759,36 @@ export interface ScheduledConversationGroupAllOfCustomers {
4068
4759
  * @interface UpdateAgentRequest
4069
4760
  */
4070
4761
  export interface UpdateAgentRequest {
4762
+ /**
4763
+ * The ID of the agent to update
4764
+ * @type {string}
4765
+ * @memberof UpdateAgentRequest
4766
+ */
4767
+ '$id': string;
4768
+ /**
4769
+ * Sample conversations that help build out your agent to mimic your responses
4770
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
4771
+ * @memberof UpdateAgentRequest
4772
+ */
4773
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
4774
+ /**
4775
+ * Sample audio files that help build out your agent to mimic your voice
4776
+ * @type {Array<string>}
4777
+ * @memberof UpdateAgentRequest
4778
+ */
4779
+ 'audio'?: Array<string>;
4071
4780
  /**
4072
4781
  * Agent first name
4073
4782
  * @type {string}
4074
4783
  * @memberof UpdateAgentRequest
4075
4784
  */
4076
- 'firstName': string;
4785
+ 'firstName'?: string;
4077
4786
  /**
4078
4787
  * Agent last name
4079
4788
  * @type {string}
4080
4789
  * @memberof UpdateAgentRequest
4081
4790
  */
4082
- 'lastName': string;
4791
+ 'lastName'?: string;
4083
4792
  /**
4084
4793
  * Agent is inactive
4085
4794
  * @type {boolean}
@@ -4115,7 +4824,7 @@ export interface UpdateAgentRequest {
4115
4824
  * @type {string}
4116
4825
  * @memberof UpdateAgentRequest
4117
4826
  */
4118
- 'forwardPhone': string;
4827
+ 'forwardPhone'?: string;
4119
4828
  /**
4120
4829
  * Title of the agent, defaults to \"Agent\"
4121
4830
  * @type {string}
@@ -4135,24 +4844,24 @@ export interface UpdateAgentRequest {
4135
4844
  */
4136
4845
  'includedLocations'?: Array<string>;
4137
4846
  /**
4138
- * Locations id the agent is excluded from
4139
- * @type {Array<string>}
4140
- * @memberof UpdateAgentRequest
4141
- */
4142
- 'excludedLocations'?: Array<string>;
4143
- /**
4144
- * Transcript of the agent
4847
+ * AI Model
4145
4848
  * @type {string}
4146
4849
  * @memberof UpdateAgentRequest
4147
4850
  */
4148
- 'transcript'?: string;
4851
+ 'model'?: UpdateAgentRequestModelEnum;
4149
4852
  /**
4150
- * The ID of the agent to update
4151
- * @type {string}
4853
+ * Locations id the agent is excluded from
4854
+ * @type {Array<string>}
4152
4855
  * @memberof UpdateAgentRequest
4153
4856
  */
4154
- '$id': string;
4857
+ 'excludedLocations'?: Array<string>;
4155
4858
  }
4859
+ export declare const UpdateAgentRequestModelEnum: {
4860
+ readonly PocketScout: "Pocket Scout";
4861
+ readonly Bard: "bard";
4862
+ readonly Null: "null";
4863
+ };
4864
+ export type UpdateAgentRequestModelEnum = typeof UpdateAgentRequestModelEnum[keyof typeof UpdateAgentRequestModelEnum];
4156
4865
  /**
4157
4866
  *
4158
4867
  * @export
@@ -4165,6 +4874,18 @@ export interface UpdateAgentRequestAllOf {
4165
4874
  * @memberof UpdateAgentRequestAllOf
4166
4875
  */
4167
4876
  '$id': string;
4877
+ /**
4878
+ * Sample conversations that help build out your agent to mimic your responses
4879
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
4880
+ * @memberof UpdateAgentRequestAllOf
4881
+ */
4882
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
4883
+ /**
4884
+ * Sample audio files that help build out your agent to mimic your voice
4885
+ * @type {Array<string>}
4886
+ * @memberof UpdateAgentRequestAllOf
4887
+ */
4888
+ 'audio'?: Array<string>;
4168
4889
  }
4169
4890
  /**
4170
4891
  *
@@ -4199,112 +4920,118 @@ export interface UpdateAgentResponse {
4199
4920
  export interface UpdateAgentsRequest {
4200
4921
  /**
4201
4922
  *
4202
- * @type {Array<UpdateAgentsRequestCustomersInner>}
4923
+ * @type {Array<UpdateAgentsRequestAgentsInner>}
4203
4924
  * @memberof UpdateAgentsRequest
4204
4925
  */
4205
- 'customers'?: Array<UpdateAgentsRequestCustomersInner>;
4926
+ 'agents'?: Array<UpdateAgentsRequestAgentsInner>;
4206
4927
  }
4207
4928
  /**
4208
4929
  *
4209
4930
  * @export
4210
- * @interface UpdateAgentsRequestCustomersInner
4931
+ * @interface UpdateAgentsRequestAgentsInner
4211
4932
  */
4212
- export interface UpdateAgentsRequestCustomersInner {
4933
+ export interface UpdateAgentsRequestAgentsInner {
4213
4934
  /**
4214
4935
  * Agent first name
4215
4936
  * @type {string}
4216
- * @memberof UpdateAgentsRequestCustomersInner
4937
+ * @memberof UpdateAgentsRequestAgentsInner
4217
4938
  */
4218
4939
  'firstName': string;
4219
4940
  /**
4220
4941
  * Agent last name
4221
4942
  * @type {string}
4222
- * @memberof UpdateAgentsRequestCustomersInner
4943
+ * @memberof UpdateAgentsRequestAgentsInner
4223
4944
  */
4224
4945
  'lastName': string;
4225
4946
  /**
4226
4947
  * Agent is inactive
4227
4948
  * @type {boolean}
4228
- * @memberof UpdateAgentsRequestCustomersInner
4949
+ * @memberof UpdateAgentsRequestAgentsInner
4229
4950
  */
4230
4951
  'inactive'?: boolean;
4231
4952
  /**
4232
4953
  * Programmable phone number
4233
4954
  * @type {string}
4234
- * @memberof UpdateAgentsRequestCustomersInner
4955
+ * @memberof UpdateAgentsRequestAgentsInner
4235
4956
  */
4236
4957
  'programmablePhoneNumber'?: string;
4237
4958
  /**
4238
4959
  * Programmable phone number SID
4239
4960
  * @type {string}
4240
- * @memberof UpdateAgentsRequestCustomersInner
4961
+ * @memberof UpdateAgentsRequestAgentsInner
4241
4962
  */
4242
4963
  'programmablePhoneNumberSid'?: string;
4243
4964
  /**
4244
4965
  * Email address from Scout9 gmail subdomain
4245
4966
  * @type {string}
4246
- * @memberof UpdateAgentsRequestCustomersInner
4967
+ * @memberof UpdateAgentsRequestAgentsInner
4247
4968
  */
4248
4969
  'programmableEmail'?: string;
4249
4970
  /**
4250
4971
  * Forward email
4251
4972
  * @type {string}
4252
- * @memberof UpdateAgentsRequestCustomersInner
4973
+ * @memberof UpdateAgentsRequestAgentsInner
4253
4974
  */
4254
4975
  'forwardEmail'?: string;
4255
4976
  /**
4256
4977
  * Forward phone
4257
4978
  * @type {string}
4258
- * @memberof UpdateAgentsRequestCustomersInner
4979
+ * @memberof UpdateAgentsRequestAgentsInner
4259
4980
  */
4260
- 'forwardPhone': string;
4981
+ 'forwardPhone'?: string;
4261
4982
  /**
4262
4983
  * Title of the agent, defaults to \"Agent\"
4263
4984
  * @type {string}
4264
- * @memberof UpdateAgentsRequestCustomersInner
4985
+ * @memberof UpdateAgentsRequestAgentsInner
4265
4986
  */
4266
4987
  'title'?: string;
4267
4988
  /**
4268
4989
  * Context of the agent, defaults to \"Agent\"
4269
4990
  * @type {string}
4270
- * @memberof UpdateAgentsRequestCustomersInner
4991
+ * @memberof UpdateAgentsRequestAgentsInner
4271
4992
  */
4272
4993
  'context'?: string;
4273
4994
  /**
4274
4995
  * Locations ids the agent is included in
4275
4996
  * @type {Array<string>}
4276
- * @memberof UpdateAgentsRequestCustomersInner
4997
+ * @memberof UpdateAgentsRequestAgentsInner
4277
4998
  */
4278
4999
  'includedLocations'?: Array<string>;
5000
+ /**
5001
+ * AI Model
5002
+ * @type {string}
5003
+ * @memberof UpdateAgentsRequestAgentsInner
5004
+ */
5005
+ 'model'?: UpdateAgentsRequestAgentsInnerModelEnum;
4279
5006
  /**
4280
5007
  * Locations id the agent is excluded from
4281
5008
  * @type {Array<string>}
4282
- * @memberof UpdateAgentsRequestCustomersInner
5009
+ * @memberof UpdateAgentsRequestAgentsInner
4283
5010
  */
4284
5011
  'excludedLocations'?: Array<string>;
4285
- /**
4286
- * Transcript of the agent
4287
- * @type {string}
4288
- * @memberof UpdateAgentsRequestCustomersInner
4289
- */
4290
- 'transcript'?: string;
4291
5012
  /**
4292
5013
  * The ID of the agent
4293
5014
  * @type {string}
4294
- * @memberof UpdateAgentsRequestCustomersInner
5015
+ * @memberof UpdateAgentsRequestAgentsInner
4295
5016
  */
4296
5017
  '$id': string;
4297
5018
  }
5019
+ export declare const UpdateAgentsRequestAgentsInnerModelEnum: {
5020
+ readonly PocketScout: "Pocket Scout";
5021
+ readonly Bard: "bard";
5022
+ readonly Null: "null";
5023
+ };
5024
+ export type UpdateAgentsRequestAgentsInnerModelEnum = typeof UpdateAgentsRequestAgentsInnerModelEnum[keyof typeof UpdateAgentsRequestAgentsInnerModelEnum];
4298
5025
  /**
4299
5026
  *
4300
5027
  * @export
4301
- * @interface UpdateAgentsRequestCustomersInnerAllOf
5028
+ * @interface UpdateAgentsRequestAgentsInnerAllOf
4302
5029
  */
4303
- export interface UpdateAgentsRequestCustomersInnerAllOf {
5030
+ export interface UpdateAgentsRequestAgentsInnerAllOf {
4304
5031
  /**
4305
5032
  * The ID of the agent
4306
5033
  * @type {string}
4307
- * @memberof UpdateAgentsRequestCustomersInnerAllOf
5034
+ * @memberof UpdateAgentsRequestAgentsInnerAllOf
4308
5035
  */
4309
5036
  '$id': string;
4310
5037
  }
@@ -4431,7 +5158,7 @@ export interface UpdateContextsRequest {
4431
5158
  * @type {Array<ListContextsResponseInner>}
4432
5159
  * @memberof UpdateContextsRequest
4433
5160
  */
4434
- 'customers'?: Array<ListContextsResponseInner>;
5161
+ 'contexts'?: Array<ListContextsResponseInner>;
4435
5162
  }
4436
5163
  /**
4437
5164
  *
@@ -4452,6 +5179,115 @@ export interface UpdateContextsResponse {
4452
5179
  */
4453
5180
  '$operation': string;
4454
5181
  }
5182
+ /**
5183
+ *
5184
+ * @export
5185
+ * @interface UpdateCustomerGroupRequest
5186
+ */
5187
+ export interface UpdateCustomerGroupRequest {
5188
+ /**
5189
+ * The name of the customer group
5190
+ * @type {string}
5191
+ * @memberof UpdateCustomerGroupRequest
5192
+ */
5193
+ 'name': string;
5194
+ /**
5195
+ * The description of the customer group
5196
+ * @type {string}
5197
+ * @memberof UpdateCustomerGroupRequest
5198
+ */
5199
+ 'description'?: string;
5200
+ /**
5201
+ *
5202
+ * @type {{ [key: string]: any; }}
5203
+ * @memberof UpdateCustomerGroupRequest
5204
+ */
5205
+ 'metadata'?: {
5206
+ [key: string]: any;
5207
+ };
5208
+ /**
5209
+ *
5210
+ * @type {Array<CustomerGroupRecord>}
5211
+ * @memberof UpdateCustomerGroupRequest
5212
+ */
5213
+ 'customers': Array<CustomerGroupRecord>;
5214
+ /**
5215
+ * The ID of the CustomerGroup
5216
+ * @type {string}
5217
+ * @memberof UpdateCustomerGroupRequest
5218
+ */
5219
+ '$id': string;
5220
+ }
5221
+ /**
5222
+ *
5223
+ * @export
5224
+ * @interface UpdateCustomerGroupRequestAllOf
5225
+ */
5226
+ export interface UpdateCustomerGroupRequestAllOf {
5227
+ /**
5228
+ * The ID of the CustomerGroup
5229
+ * @type {string}
5230
+ * @memberof UpdateCustomerGroupRequestAllOf
5231
+ */
5232
+ '$id': string;
5233
+ }
5234
+ /**
5235
+ *
5236
+ * @export
5237
+ * @interface UpdateCustomerGroupResponse
5238
+ */
5239
+ export interface UpdateCustomerGroupResponse {
5240
+ /**
5241
+ *
5242
+ * @type {boolean}
5243
+ * @memberof UpdateCustomerGroupResponse
5244
+ */
5245
+ 'success': boolean;
5246
+ /**
5247
+ *
5248
+ * @type {Error}
5249
+ * @memberof UpdateCustomerGroupResponse
5250
+ */
5251
+ 'error'?: Error;
5252
+ /**
5253
+ * The id of the document that was created, updated, or deleted
5254
+ * @type {string}
5255
+ * @memberof UpdateCustomerGroupResponse
5256
+ */
5257
+ 'id': string;
5258
+ }
5259
+ /**
5260
+ *
5261
+ * @export
5262
+ * @interface UpdateCustomerGroupsRequest
5263
+ */
5264
+ export interface UpdateCustomerGroupsRequest {
5265
+ /**
5266
+ *
5267
+ * @type {Array<ListCustomerGroupsResponseInner>}
5268
+ * @memberof UpdateCustomerGroupsRequest
5269
+ */
5270
+ 'CustomerGroups'?: Array<ListCustomerGroupsResponseInner>;
5271
+ }
5272
+ /**
5273
+ *
5274
+ * @export
5275
+ * @interface UpdateCustomerGroupsResponse
5276
+ */
5277
+ export interface UpdateCustomerGroupsResponse {
5278
+ /**
5279
+ * ISO 8601 datetime string of when the operation was queued
5280
+ * @type {string}
5281
+ * @memberof UpdateCustomerGroupsResponse
5282
+ */
5283
+ 'queued': string;
5284
+ /**
5285
+ * The operation id to view the operation end results
5286
+ * @type {string}
5287
+ * @memberof UpdateCustomerGroupsResponse
5288
+ */
5289
+ '$operation': string;
5290
+ }
4455
5291
  /**
4456
5292
  *
4457
5293
  * @export
@@ -4765,7 +5601,7 @@ export interface UpdateWorkflowsRequest {
4765
5601
  * @type {Array<ListWorkflowsResponseInner>}
4766
5602
  * @memberof UpdateWorkflowsRequest
4767
5603
  */
4768
- 'customers'?: Array<ListWorkflowsResponseInner>;
5604
+ 'workflows'?: Array<ListWorkflowsResponseInner>;
4769
5605
  }
4770
5606
  /**
4771
5607
  *
@@ -4842,34 +5678,34 @@ export interface Workflow {
4842
5678
  'onError'?: string;
4843
5679
  }
4844
5680
  /**
4845
- * Scout9Api - axios parameter creator
5681
+ * PocketScoutApi - axios parameter creator
4846
5682
  * @export
4847
5683
  */
4848
- export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
5684
+ export declare const PocketScoutApiAxiosParamCreator: (configuration?: Configuration) => {
4849
5685
  /**
4850
5686
  *
4851
5687
  * @summary Gets a agent
4852
- * @param {string} id
5688
+ * @param {string} id id of entity to query
4853
5689
  * @param {*} [options] Override http request option.
4854
5690
  * @throws {RequiredError}
4855
5691
  */
4856
5692
  agent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4857
5693
  /**
4858
5694
  *
4859
- * @summary Create a new agent
4860
- * @param {CreateAgentRequest} createAgentRequest
5695
+ * @summary Deletes a agent
5696
+ * @param {string} id id of entity to query
4861
5697
  * @param {*} [options] Override http request option.
4862
5698
  * @throws {RequiredError}
4863
5699
  */
4864
- agentCreate: (createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5700
+ agentDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4865
5701
  /**
4866
5702
  *
4867
- * @summary Deletes a agent
4868
- * @param {string} id
5703
+ * @summary Registers a new agent
5704
+ * @param {CreateAgentRequest} createAgentRequest
4869
5705
  * @param {*} [options] Override http request option.
4870
5706
  * @throws {RequiredError}
4871
5707
  */
4872
- agentDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5708
+ agentRegister: (createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4873
5709
  /**
4874
5710
  *
4875
5711
  * @summary Update a agent
@@ -4882,7 +5718,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4882
5718
  *
4883
5719
  * @summary Gets all or specific set of agents
4884
5720
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4885
- * @param {Array<string>} [id]
5721
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4886
5722
  * @param {*} [options] Override http request option.
4887
5723
  * @throws {RequiredError}
4888
5724
  */
@@ -4898,7 +5734,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4898
5734
  /**
4899
5735
  *
4900
5736
  * @summary Deletes multiple agents
4901
- * @param {Array<string>} [id]
5737
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4902
5738
  * @param {*} [options] Override http request option.
4903
5739
  * @throws {RequiredError}
4904
5740
  */
@@ -4914,7 +5750,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4914
5750
  /**
4915
5751
  *
4916
5752
  * @summary Gets a context
4917
- * @param {string} id
5753
+ * @param {string} id id of entity to query
4918
5754
  * @param {*} [options] Override http request option.
4919
5755
  * @throws {RequiredError}
4920
5756
  */
@@ -4930,7 +5766,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4930
5766
  /**
4931
5767
  *
4932
5768
  * @summary Deletes a schedule
4933
- * @param {string} id
5769
+ * @param {string} id id of entity to query
4934
5770
  * @param {*} [options] Override http request option.
4935
5771
  * @throws {RequiredError}
4936
5772
  */
@@ -4947,7 +5783,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4947
5783
  *
4948
5784
  * @summary Gets all or specific set of contexts
4949
5785
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4950
- * @param {Array<string>} [id]
5786
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4951
5787
  * @param {*} [options] Override http request option.
4952
5788
  * @throws {RequiredError}
4953
5789
  */
@@ -4963,7 +5799,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4963
5799
  /**
4964
5800
  *
4965
5801
  * @summary Deletes multiple contexts
4966
- * @param {Array<string>} [id]
5802
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4967
5803
  * @param {*} [options] Override http request option.
4968
5804
  * @throws {RequiredError}
4969
5805
  */
@@ -4979,7 +5815,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4979
5815
  /**
4980
5816
  *
4981
5817
  * @summary Gets a conversation
4982
- * @param {string} id
5818
+ * @param {string} id id of entity to query
4983
5819
  * @param {*} [options] Override http request option.
4984
5820
  * @throws {RequiredError}
4985
5821
  */
@@ -4991,47 +5827,112 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
4991
5827
  * @param {*} [options] Override http request option.
4992
5828
  * @throws {RequiredError}
4993
5829
  */
4994
- conversationCreate: (conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5830
+ conversationCreate: (conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5831
+ /**
5832
+ *
5833
+ * @summary Deletes a schedule
5834
+ * @param {string} id id of entity to query
5835
+ * @param {*} [options] Override http request option.
5836
+ * @throws {RequiredError}
5837
+ */
5838
+ conversationDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5839
+ /**
5840
+ *
5841
+ * @summary Update a conversation
5842
+ * @param {ConversationUpdateRequest} conversationUpdateRequest
5843
+ * @param {*} [options] Override http request option.
5844
+ * @throws {RequiredError}
5845
+ */
5846
+ conversationUpdate: (conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5847
+ /**
5848
+ *
5849
+ * @summary Gets a customer
5850
+ * @param {string} id id of entity to query
5851
+ * @param {*} [options] Override http request option.
5852
+ * @throws {RequiredError}
5853
+ */
5854
+ customer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5855
+ /**
5856
+ *
5857
+ * @summary Creates a new customer
5858
+ * @param {CreateCustomerRequest} createCustomerRequest
5859
+ * @param {*} [options] Override http request option.
5860
+ * @throws {RequiredError}
5861
+ */
5862
+ customerCreate: (createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5863
+ /**
5864
+ *
5865
+ * @summary Deletes a customer
5866
+ * @param {string} id id of entity to query
5867
+ * @param {*} [options] Override http request option.
5868
+ * @throws {RequiredError}
5869
+ */
5870
+ customerDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5871
+ /**
5872
+ *
5873
+ * @summary Gets a customer group
5874
+ * @param {string} id id of entity to query
5875
+ * @param {*} [options] Override http request option.
5876
+ * @throws {RequiredError}
5877
+ */
5878
+ customerGroup: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5879
+ /**
5880
+ *
5881
+ * @summary Creates a new customer group
5882
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
5883
+ * @param {*} [options] Override http request option.
5884
+ * @throws {RequiredError}
5885
+ */
5886
+ customerGroupCreate: (createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5887
+ /**
5888
+ *
5889
+ * @summary Deletes a customer group
5890
+ * @param {string} id id of entity to query
5891
+ * @param {*} [options] Override http request option.
5892
+ * @throws {RequiredError}
5893
+ */
5894
+ customerGroupDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4995
5895
  /**
4996
5896
  *
4997
- * @summary Deletes a schedule
4998
- * @param {string} id
5897
+ * @summary Updates a customer group
5898
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
4999
5899
  * @param {*} [options] Override http request option.
5000
5900
  * @throws {RequiredError}
5001
5901
  */
5002
- conversationDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5902
+ customerGroupUpdate: (updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5003
5903
  /**
5004
5904
  *
5005
- * @summary Update a conversation
5006
- * @param {ConversationUpdateRequest} conversationUpdateRequest
5905
+ * @summary Gets all or specific set of customer groups
5906
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5907
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5007
5908
  * @param {*} [options] Override http request option.
5008
5909
  * @throws {RequiredError}
5009
5910
  */
5010
- conversationUpdate: (conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5911
+ customerGroups: (q?: string, id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5011
5912
  /**
5012
5913
  *
5013
- * @summary Gets a customer
5014
- * @param {string} id
5914
+ * @summary Creates new customer groups
5915
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
5015
5916
  * @param {*} [options] Override http request option.
5016
5917
  * @throws {RequiredError}
5017
5918
  */
5018
- customer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5919
+ customerGroupsCreate: (createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5019
5920
  /**
5020
5921
  *
5021
- * @summary Creates a new customer
5022
- * @param {CreateCustomerRequest} createCustomerRequest
5922
+ * @summary Deletes multiple customer groups
5923
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5023
5924
  * @param {*} [options] Override http request option.
5024
5925
  * @throws {RequiredError}
5025
5926
  */
5026
- customerCreate: (createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5927
+ customerGroupsDelete: (id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5027
5928
  /**
5028
5929
  *
5029
- * @summary Deletes a customer
5030
- * @param {string} id
5930
+ * @summary Updates multiple customer groups
5931
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
5031
5932
  * @param {*} [options] Override http request option.
5032
5933
  * @throws {RequiredError}
5033
5934
  */
5034
- customerDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5935
+ customerGroupsUpdate: (updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5035
5936
  /**
5036
5937
  *
5037
5938
  * @summary Updates a customer
@@ -5044,7 +5945,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5044
5945
  *
5045
5946
  * @summary Gets all or specific set of customers
5046
5947
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5047
- * @param {Array<string>} [id]
5948
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5048
5949
  * @param {*} [options] Override http request option.
5049
5950
  * @throws {RequiredError}
5050
5951
  */
@@ -5060,7 +5961,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5060
5961
  /**
5061
5962
  *
5062
5963
  * @summary Deletes multiple customers
5063
- * @param {Array<string>} [id]
5964
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5064
5965
  * @param {*} [options] Override http request option.
5065
5966
  * @throws {RequiredError}
5066
5967
  */
@@ -5073,6 +5974,46 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5073
5974
  * @throws {RequiredError}
5074
5975
  */
5075
5976
  customersUpdate: (updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5977
+ /**
5978
+ *
5979
+ * @summary Returns information about a specific file.
5980
+ * @param {string} fileId The ID of the file to use for this request
5981
+ * @param {*} [options] Override http request option.
5982
+ * @throws {RequiredError}
5983
+ */
5984
+ file: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5985
+ /**
5986
+ *
5987
+ * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
5988
+ * @param {File} file
5989
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
5990
+ * @param {*} [options] Override http request option.
5991
+ * @throws {RequiredError}
5992
+ */
5993
+ fileCreate: (file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5994
+ /**
5995
+ *
5996
+ * @summary Delete a file.
5997
+ * @param {string} fileId The ID of the file to use for this request
5998
+ * @param {*} [options] Override http request option.
5999
+ * @throws {RequiredError}
6000
+ */
6001
+ fileDelete: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6002
+ /**
6003
+ *
6004
+ * @summary Returns the contents of the specified file
6005
+ * @param {string} fileId The ID of the file to use for this request
6006
+ * @param {*} [options] Override http request option.
6007
+ * @throws {RequiredError}
6008
+ */
6009
+ fileDownload: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6010
+ /**
6011
+ *
6012
+ * @summary Returns a list of files that belong to the user\'s organization.
6013
+ * @param {*} [options] Override http request option.
6014
+ * @throws {RequiredError}
6015
+ */
6016
+ files: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
5076
6017
  /**
5077
6018
  * Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
5078
6019
  * @summary Generate a message from conversation
@@ -5092,16 +6033,16 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5092
6033
  /**
5093
6034
  *
5094
6035
  * @summary Get all messages from a conversation
6036
+ * @param {string} id id of entity to query
5095
6037
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5096
- * @param {Array<string>} [id]
5097
6038
  * @param {*} [options] Override http request option.
5098
6039
  * @throws {RequiredError}
5099
6040
  */
5100
- messages: (q?: string, id?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6041
+ messages: (id: string, q?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5101
6042
  /**
5102
6043
  *
5103
6044
  * @summary Get the results of a bulk API operation
5104
- * @param {string} id
6045
+ * @param {string} id id of entity to query
5105
6046
  * @param {*} [options] Override http request option.
5106
6047
  * @throws {RequiredError}
5107
6048
  */
@@ -5110,7 +6051,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5110
6051
  *
5111
6052
  * @summary Gets all or specific set of bulk API operations
5112
6053
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5113
- * @param {Array<string>} [id]
6054
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5114
6055
  * @param {*} [options] Override http request option.
5115
6056
  * @throws {RequiredError}
5116
6057
  */
@@ -5122,11 +6063,11 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5122
6063
  * @param {*} [options] Override http request option.
5123
6064
  * @throws {RequiredError}
5124
6065
  */
5125
- scheduleCreate: (scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6066
+ scheduleConversation: (scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5126
6067
  /**
5127
6068
  *
5128
6069
  * @summary Deletes a schedule
5129
- * @param {string} id
6070
+ * @param {string} id id of entity to query
5130
6071
  * @param {*} [options] Override http request option.
5131
6072
  * @throws {RequiredError}
5132
6073
  */
@@ -5142,7 +6083,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5142
6083
  /**
5143
6084
  *
5144
6085
  * @summary Deletes and cancels a schedule group
5145
- * @param {string} id
6086
+ * @param {string} id id of entity to query
5146
6087
  * @param {*} [options] Override http request option.
5147
6088
  * @throws {RequiredError}
5148
6089
  */
@@ -5150,7 +6091,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5150
6091
  /**
5151
6092
  *
5152
6093
  * @summary Gets a schedule group
5153
- * @param {string} id
6094
+ * @param {string} id id of entity to query
5154
6095
  * @param {*} [options] Override http request option.
5155
6096
  * @throws {RequiredError}
5156
6097
  */
@@ -5166,7 +6107,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5166
6107
  /**
5167
6108
  *
5168
6109
  * @summary Gets a schedule
5169
- * @param {string} id
6110
+ * @param {string} id id of entity to query
5170
6111
  * @param {*} [options] Override http request option.
5171
6112
  * @throws {RequiredError}
5172
6113
  */
@@ -5182,7 +6123,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5182
6123
  /**
5183
6124
  *
5184
6125
  * @summary Gets a workflow
5185
- * @param {string} id
6126
+ * @param {string} id id of entity to query
5186
6127
  * @param {*} [options] Override http request option.
5187
6128
  * @throws {RequiredError}
5188
6129
  */
@@ -5198,7 +6139,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5198
6139
  /**
5199
6140
  *
5200
6141
  * @summary Deletes a workflow
5201
- * @param {string} id
6142
+ * @param {string} id id of entity to query
5202
6143
  * @param {*} [options] Override http request option.
5203
6144
  * @throws {RequiredError}
5204
6145
  */
@@ -5215,7 +6156,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5215
6156
  *
5216
6157
  * @summary Gets all or specific set of workflows
5217
6158
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5218
- * @param {Array<string>} [id]
6159
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5219
6160
  * @param {*} [options] Override http request option.
5220
6161
  * @throws {RequiredError}
5221
6162
  */
@@ -5231,7 +6172,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5231
6172
  /**
5232
6173
  *
5233
6174
  * @summary Deletes multiple workflows
5234
- * @param {Array<string>} [id]
6175
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5235
6176
  * @param {*} [options] Override http request option.
5236
6177
  * @throws {RequiredError}
5237
6178
  */
@@ -5246,34 +6187,34 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5246
6187
  workflowsUpdate: (updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5247
6188
  };
5248
6189
  /**
5249
- * Scout9Api - functional programming interface
6190
+ * PocketScoutApi - functional programming interface
5250
6191
  * @export
5251
6192
  */
5252
- export declare const Scout9ApiFp: (configuration?: Configuration) => {
6193
+ export declare const PocketScoutApiFp: (configuration?: Configuration) => {
5253
6194
  /**
5254
6195
  *
5255
6196
  * @summary Gets a agent
5256
- * @param {string} id
6197
+ * @param {string} id id of entity to query
5257
6198
  * @param {*} [options] Override http request option.
5258
6199
  * @throws {RequiredError}
5259
6200
  */
5260
6201
  agent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAgentResponse>>;
5261
6202
  /**
5262
6203
  *
5263
- * @summary Create a new agent
5264
- * @param {CreateAgentRequest} createAgentRequest
6204
+ * @summary Deletes a agent
6205
+ * @param {string} id id of entity to query
5265
6206
  * @param {*} [options] Override http request option.
5266
6207
  * @throws {RequiredError}
5267
6208
  */
5268
- agentCreate(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAgentResponse>>;
6209
+ agentDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAgentResponse>>;
5269
6210
  /**
5270
6211
  *
5271
- * @summary Deletes a agent
5272
- * @param {string} id
6212
+ * @summary Registers a new agent
6213
+ * @param {CreateAgentRequest} createAgentRequest
5273
6214
  * @param {*} [options] Override http request option.
5274
6215
  * @throws {RequiredError}
5275
6216
  */
5276
- agentDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAgentResponse>>;
6217
+ agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAgentResponse>>;
5277
6218
  /**
5278
6219
  *
5279
6220
  * @summary Update a agent
@@ -5286,7 +6227,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5286
6227
  *
5287
6228
  * @summary Gets all or specific set of agents
5288
6229
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5289
- * @param {Array<string>} [id]
6230
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5290
6231
  * @param {*} [options] Override http request option.
5291
6232
  * @throws {RequiredError}
5292
6233
  */
@@ -5302,7 +6243,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5302
6243
  /**
5303
6244
  *
5304
6245
  * @summary Deletes multiple agents
5305
- * @param {Array<string>} [id]
6246
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5306
6247
  * @param {*} [options] Override http request option.
5307
6248
  * @throws {RequiredError}
5308
6249
  */
@@ -5318,7 +6259,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5318
6259
  /**
5319
6260
  *
5320
6261
  * @summary Gets a context
5321
- * @param {string} id
6262
+ * @param {string} id id of entity to query
5322
6263
  * @param {*} [options] Override http request option.
5323
6264
  * @throws {RequiredError}
5324
6265
  */
@@ -5334,7 +6275,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5334
6275
  /**
5335
6276
  *
5336
6277
  * @summary Deletes a schedule
5337
- * @param {string} id
6278
+ * @param {string} id id of entity to query
5338
6279
  * @param {*} [options] Override http request option.
5339
6280
  * @throws {RequiredError}
5340
6281
  */
@@ -5351,7 +6292,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5351
6292
  *
5352
6293
  * @summary Gets all or specific set of contexts
5353
6294
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5354
- * @param {Array<string>} [id]
6295
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5355
6296
  * @param {*} [options] Override http request option.
5356
6297
  * @throws {RequiredError}
5357
6298
  */
@@ -5367,7 +6308,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5367
6308
  /**
5368
6309
  *
5369
6310
  * @summary Deletes multiple contexts
5370
- * @param {Array<string>} [id]
6311
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5371
6312
  * @param {*} [options] Override http request option.
5372
6313
  * @throws {RequiredError}
5373
6314
  */
@@ -5383,7 +6324,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5383
6324
  /**
5384
6325
  *
5385
6326
  * @summary Gets a conversation
5386
- * @param {string} id
6327
+ * @param {string} id id of entity to query
5387
6328
  * @param {*} [options] Override http request option.
5388
6329
  * @throws {RequiredError}
5389
6330
  */
@@ -5399,7 +6340,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5399
6340
  /**
5400
6341
  *
5401
6342
  * @summary Deletes a schedule
5402
- * @param {string} id
6343
+ * @param {string} id id of entity to query
5403
6344
  * @param {*} [options] Override http request option.
5404
6345
  * @throws {RequiredError}
5405
6346
  */
@@ -5415,7 +6356,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5415
6356
  /**
5416
6357
  *
5417
6358
  * @summary Gets a customer
5418
- * @param {string} id
6359
+ * @param {string} id id of entity to query
5419
6360
  * @param {*} [options] Override http request option.
5420
6361
  * @throws {RequiredError}
5421
6362
  */
@@ -5431,11 +6372,76 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5431
6372
  /**
5432
6373
  *
5433
6374
  * @summary Deletes a customer
5434
- * @param {string} id
6375
+ * @param {string} id id of entity to query
5435
6376
  * @param {*} [options] Override http request option.
5436
6377
  * @throws {RequiredError}
5437
6378
  */
5438
6379
  customerDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerResponse>>;
6380
+ /**
6381
+ *
6382
+ * @summary Gets a customer group
6383
+ * @param {string} id id of entity to query
6384
+ * @param {*} [options] Override http request option.
6385
+ * @throws {RequiredError}
6386
+ */
6387
+ customerGroup(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerGroupResponse>>;
6388
+ /**
6389
+ *
6390
+ * @summary Creates a new customer group
6391
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
6392
+ * @param {*} [options] Override http request option.
6393
+ * @throws {RequiredError}
6394
+ */
6395
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupResponse>>;
6396
+ /**
6397
+ *
6398
+ * @summary Deletes a customer group
6399
+ * @param {string} id id of entity to query
6400
+ * @param {*} [options] Override http request option.
6401
+ * @throws {RequiredError}
6402
+ */
6403
+ customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupResponse>>;
6404
+ /**
6405
+ *
6406
+ * @summary Updates a customer group
6407
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
6408
+ * @param {*} [options] Override http request option.
6409
+ * @throws {RequiredError}
6410
+ */
6411
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupResponse>>;
6412
+ /**
6413
+ *
6414
+ * @summary Gets all or specific set of customer groups
6415
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6416
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6417
+ * @param {*} [options] Override http request option.
6418
+ * @throws {RequiredError}
6419
+ */
6420
+ customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListCustomerGroupsResponseInner>>>;
6421
+ /**
6422
+ *
6423
+ * @summary Creates new customer groups
6424
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
6425
+ * @param {*} [options] Override http request option.
6426
+ * @throws {RequiredError}
6427
+ */
6428
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerGroupsResponse>>;
6429
+ /**
6430
+ *
6431
+ * @summary Deletes multiple customer groups
6432
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6433
+ * @param {*} [options] Override http request option.
6434
+ * @throws {RequiredError}
6435
+ */
6436
+ customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteCustomerGroupsResponse>>;
6437
+ /**
6438
+ *
6439
+ * @summary Updates multiple customer groups
6440
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
6441
+ * @param {*} [options] Override http request option.
6442
+ * @throws {RequiredError}
6443
+ */
6444
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerGroupsResponse>>;
5439
6445
  /**
5440
6446
  *
5441
6447
  * @summary Updates a customer
@@ -5448,7 +6454,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5448
6454
  *
5449
6455
  * @summary Gets all or specific set of customers
5450
6456
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5451
- * @param {Array<string>} [id]
6457
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5452
6458
  * @param {*} [options] Override http request option.
5453
6459
  * @throws {RequiredError}
5454
6460
  */
@@ -5464,7 +6470,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5464
6470
  /**
5465
6471
  *
5466
6472
  * @summary Deletes multiple customers
5467
- * @param {Array<string>} [id]
6473
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5468
6474
  * @param {*} [options] Override http request option.
5469
6475
  * @throws {RequiredError}
5470
6476
  */
@@ -5477,6 +6483,46 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5477
6483
  * @throws {RequiredError}
5478
6484
  */
5479
6485
  customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomersResponse>>;
6486
+ /**
6487
+ *
6488
+ * @summary Returns information about a specific file.
6489
+ * @param {string} fileId The ID of the file to use for this request
6490
+ * @param {*} [options] Override http request option.
6491
+ * @throws {RequiredError}
6492
+ */
6493
+ file(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
6494
+ /**
6495
+ *
6496
+ * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
6497
+ * @param {File} file
6498
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
6499
+ * @param {*} [options] Override http request option.
6500
+ * @throws {RequiredError}
6501
+ */
6502
+ fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
6503
+ /**
6504
+ *
6505
+ * @summary Delete a file.
6506
+ * @param {string} fileId The ID of the file to use for this request
6507
+ * @param {*} [options] Override http request option.
6508
+ * @throws {RequiredError}
6509
+ */
6510
+ fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFileResponse>>;
6511
+ /**
6512
+ *
6513
+ * @summary Returns the contents of the specified file
6514
+ * @param {string} fileId The ID of the file to use for this request
6515
+ * @param {*} [options] Override http request option.
6516
+ * @throws {RequiredError}
6517
+ */
6518
+ fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
6519
+ /**
6520
+ *
6521
+ * @summary Returns a list of files that belong to the user\'s organization.
6522
+ * @param {*} [options] Override http request option.
6523
+ * @throws {RequiredError}
6524
+ */
6525
+ files(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
5480
6526
  /**
5481
6527
  * Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
5482
6528
  * @summary Generate a message from conversation
@@ -5496,16 +6542,16 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5496
6542
  /**
5497
6543
  *
5498
6544
  * @summary Get all messages from a conversation
6545
+ * @param {string} id id of entity to query
5499
6546
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5500
- * @param {Array<string>} [id]
5501
6547
  * @param {*} [options] Override http request option.
5502
6548
  * @throws {RequiredError}
5503
6549
  */
5504
- messages(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageGetResponseInner>>>;
6550
+ messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageGetResponseInner>>>;
5505
6551
  /**
5506
6552
  *
5507
6553
  * @summary Get the results of a bulk API operation
5508
- * @param {string} id
6554
+ * @param {string} id id of entity to query
5509
6555
  * @param {*} [options] Override http request option.
5510
6556
  * @throws {RequiredError}
5511
6557
  */
@@ -5514,7 +6560,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5514
6560
  *
5515
6561
  * @summary Gets all or specific set of bulk API operations
5516
6562
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5517
- * @param {Array<string>} [id]
6563
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5518
6564
  * @param {*} [options] Override http request option.
5519
6565
  * @throws {RequiredError}
5520
6566
  */
@@ -5526,11 +6572,11 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5526
6572
  * @param {*} [options] Override http request option.
5527
6573
  * @throws {RequiredError}
5528
6574
  */
5529
- scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleCreateResponse>>;
6575
+ scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleCreateResponse>>;
5530
6576
  /**
5531
6577
  *
5532
6578
  * @summary Deletes a schedule
5533
- * @param {string} id
6579
+ * @param {string} id id of entity to query
5534
6580
  * @param {*} [options] Override http request option.
5535
6581
  * @throws {RequiredError}
5536
6582
  */
@@ -5546,7 +6592,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5546
6592
  /**
5547
6593
  *
5548
6594
  * @summary Deletes and cancels a schedule group
5549
- * @param {string} id
6595
+ * @param {string} id id of entity to query
5550
6596
  * @param {*} [options] Override http request option.
5551
6597
  * @throws {RequiredError}
5552
6598
  */
@@ -5554,7 +6600,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5554
6600
  /**
5555
6601
  *
5556
6602
  * @summary Gets a schedule group
5557
- * @param {string} id
6603
+ * @param {string} id id of entity to query
5558
6604
  * @param {*} [options] Override http request option.
5559
6605
  * @throws {RequiredError}
5560
6606
  */
@@ -5570,7 +6616,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5570
6616
  /**
5571
6617
  *
5572
6618
  * @summary Gets a schedule
5573
- * @param {string} id
6619
+ * @param {string} id id of entity to query
5574
6620
  * @param {*} [options] Override http request option.
5575
6621
  * @throws {RequiredError}
5576
6622
  */
@@ -5586,7 +6632,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5586
6632
  /**
5587
6633
  *
5588
6634
  * @summary Gets a workflow
5589
- * @param {string} id
6635
+ * @param {string} id id of entity to query
5590
6636
  * @param {*} [options] Override http request option.
5591
6637
  * @throws {RequiredError}
5592
6638
  */
@@ -5602,7 +6648,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5602
6648
  /**
5603
6649
  *
5604
6650
  * @summary Deletes a workflow
5605
- * @param {string} id
6651
+ * @param {string} id id of entity to query
5606
6652
  * @param {*} [options] Override http request option.
5607
6653
  * @throws {RequiredError}
5608
6654
  */
@@ -5619,7 +6665,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5619
6665
  *
5620
6666
  * @summary Gets all or specific set of workflows
5621
6667
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5622
- * @param {Array<string>} [id]
6668
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5623
6669
  * @param {*} [options] Override http request option.
5624
6670
  * @throws {RequiredError}
5625
6671
  */
@@ -5635,7 +6681,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5635
6681
  /**
5636
6682
  *
5637
6683
  * @summary Deletes multiple workflows
5638
- * @param {Array<string>} [id]
6684
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5639
6685
  * @param {*} [options] Override http request option.
5640
6686
  * @throws {RequiredError}
5641
6687
  */
@@ -5650,34 +6696,34 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
5650
6696
  workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkflowsResponse>>;
5651
6697
  };
5652
6698
  /**
5653
- * Scout9Api - factory interface
6699
+ * PocketScoutApi - factory interface
5654
6700
  * @export
5655
6701
  */
5656
- export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6702
+ export declare const PocketScoutApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5657
6703
  /**
5658
6704
  *
5659
6705
  * @summary Gets a agent
5660
- * @param {string} id
6706
+ * @param {string} id id of entity to query
5661
6707
  * @param {*} [options] Override http request option.
5662
6708
  * @throws {RequiredError}
5663
6709
  */
5664
6710
  agent(id: string, options?: any): AxiosPromise<GetAgentResponse>;
5665
6711
  /**
5666
6712
  *
5667
- * @summary Create a new agent
5668
- * @param {CreateAgentRequest} createAgentRequest
6713
+ * @summary Deletes a agent
6714
+ * @param {string} id id of entity to query
5669
6715
  * @param {*} [options] Override http request option.
5670
6716
  * @throws {RequiredError}
5671
6717
  */
5672
- agentCreate(createAgentRequest: CreateAgentRequest, options?: any): AxiosPromise<CreateAgentResponse>;
6718
+ agentDelete(id: string, options?: any): AxiosPromise<DeleteAgentResponse>;
5673
6719
  /**
5674
6720
  *
5675
- * @summary Deletes a agent
5676
- * @param {string} id
6721
+ * @summary Registers a new agent
6722
+ * @param {CreateAgentRequest} createAgentRequest
5677
6723
  * @param {*} [options] Override http request option.
5678
6724
  * @throws {RequiredError}
5679
6725
  */
5680
- agentDelete(id: string, options?: any): AxiosPromise<DeleteAgentResponse>;
6726
+ agentRegister(createAgentRequest: CreateAgentRequest, options?: any): AxiosPromise<CreateAgentResponse>;
5681
6727
  /**
5682
6728
  *
5683
6729
  * @summary Update a agent
@@ -5690,7 +6736,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5690
6736
  *
5691
6737
  * @summary Gets all or specific set of agents
5692
6738
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5693
- * @param {Array<string>} [id]
6739
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5694
6740
  * @param {*} [options] Override http request option.
5695
6741
  * @throws {RequiredError}
5696
6742
  */
@@ -5706,7 +6752,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5706
6752
  /**
5707
6753
  *
5708
6754
  * @summary Deletes multiple agents
5709
- * @param {Array<string>} [id]
6755
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5710
6756
  * @param {*} [options] Override http request option.
5711
6757
  * @throws {RequiredError}
5712
6758
  */
@@ -5722,7 +6768,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5722
6768
  /**
5723
6769
  *
5724
6770
  * @summary Gets a context
5725
- * @param {string} id
6771
+ * @param {string} id id of entity to query
5726
6772
  * @param {*} [options] Override http request option.
5727
6773
  * @throws {RequiredError}
5728
6774
  */
@@ -5738,7 +6784,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5738
6784
  /**
5739
6785
  *
5740
6786
  * @summary Deletes a schedule
5741
- * @param {string} id
6787
+ * @param {string} id id of entity to query
5742
6788
  * @param {*} [options] Override http request option.
5743
6789
  * @throws {RequiredError}
5744
6790
  */
@@ -5755,7 +6801,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5755
6801
  *
5756
6802
  * @summary Gets all or specific set of contexts
5757
6803
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5758
- * @param {Array<string>} [id]
6804
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5759
6805
  * @param {*} [options] Override http request option.
5760
6806
  * @throws {RequiredError}
5761
6807
  */
@@ -5771,7 +6817,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5771
6817
  /**
5772
6818
  *
5773
6819
  * @summary Deletes multiple contexts
5774
- * @param {Array<string>} [id]
6820
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5775
6821
  * @param {*} [options] Override http request option.
5776
6822
  * @throws {RequiredError}
5777
6823
  */
@@ -5787,7 +6833,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5787
6833
  /**
5788
6834
  *
5789
6835
  * @summary Gets a conversation
5790
- * @param {string} id
6836
+ * @param {string} id id of entity to query
5791
6837
  * @param {*} [options] Override http request option.
5792
6838
  * @throws {RequiredError}
5793
6839
  */
@@ -5803,7 +6849,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5803
6849
  /**
5804
6850
  *
5805
6851
  * @summary Deletes a schedule
5806
- * @param {string} id
6852
+ * @param {string} id id of entity to query
5807
6853
  * @param {*} [options] Override http request option.
5808
6854
  * @throws {RequiredError}
5809
6855
  */
@@ -5819,7 +6865,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5819
6865
  /**
5820
6866
  *
5821
6867
  * @summary Gets a customer
5822
- * @param {string} id
6868
+ * @param {string} id id of entity to query
5823
6869
  * @param {*} [options] Override http request option.
5824
6870
  * @throws {RequiredError}
5825
6871
  */
@@ -5835,11 +6881,76 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5835
6881
  /**
5836
6882
  *
5837
6883
  * @summary Deletes a customer
5838
- * @param {string} id
6884
+ * @param {string} id id of entity to query
5839
6885
  * @param {*} [options] Override http request option.
5840
6886
  * @throws {RequiredError}
5841
6887
  */
5842
6888
  customerDelete(id: string, options?: any): AxiosPromise<DeleteCustomerResponse>;
6889
+ /**
6890
+ *
6891
+ * @summary Gets a customer group
6892
+ * @param {string} id id of entity to query
6893
+ * @param {*} [options] Override http request option.
6894
+ * @throws {RequiredError}
6895
+ */
6896
+ customerGroup(id: string, options?: any): AxiosPromise<GetCustomerGroupResponse>;
6897
+ /**
6898
+ *
6899
+ * @summary Creates a new customer group
6900
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
6901
+ * @param {*} [options] Override http request option.
6902
+ * @throws {RequiredError}
6903
+ */
6904
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: any): AxiosPromise<CreateCustomerGroupResponse>;
6905
+ /**
6906
+ *
6907
+ * @summary Deletes a customer group
6908
+ * @param {string} id id of entity to query
6909
+ * @param {*} [options] Override http request option.
6910
+ * @throws {RequiredError}
6911
+ */
6912
+ customerGroupDelete(id: string, options?: any): AxiosPromise<DeleteCustomerGroupResponse>;
6913
+ /**
6914
+ *
6915
+ * @summary Updates a customer group
6916
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
6917
+ * @param {*} [options] Override http request option.
6918
+ * @throws {RequiredError}
6919
+ */
6920
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: any): AxiosPromise<UpdateCustomerGroupResponse>;
6921
+ /**
6922
+ *
6923
+ * @summary Gets all or specific set of customer groups
6924
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6925
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6926
+ * @param {*} [options] Override http request option.
6927
+ * @throws {RequiredError}
6928
+ */
6929
+ customerGroups(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<ListCustomerGroupsResponseInner>>;
6930
+ /**
6931
+ *
6932
+ * @summary Creates new customer groups
6933
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
6934
+ * @param {*} [options] Override http request option.
6935
+ * @throws {RequiredError}
6936
+ */
6937
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: any): AxiosPromise<CreateCustomerGroupsResponse>;
6938
+ /**
6939
+ *
6940
+ * @summary Deletes multiple customer groups
6941
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6942
+ * @param {*} [options] Override http request option.
6943
+ * @throws {RequiredError}
6944
+ */
6945
+ customerGroupsDelete(id?: Array<string>, options?: any): AxiosPromise<DeleteCustomerGroupsResponse>;
6946
+ /**
6947
+ *
6948
+ * @summary Updates multiple customer groups
6949
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
6950
+ * @param {*} [options] Override http request option.
6951
+ * @throws {RequiredError}
6952
+ */
6953
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: any): AxiosPromise<UpdateCustomerGroupsResponse>;
5843
6954
  /**
5844
6955
  *
5845
6956
  * @summary Updates a customer
@@ -5852,7 +6963,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5852
6963
  *
5853
6964
  * @summary Gets all or specific set of customers
5854
6965
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5855
- * @param {Array<string>} [id]
6966
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5856
6967
  * @param {*} [options] Override http request option.
5857
6968
  * @throws {RequiredError}
5858
6969
  */
@@ -5868,7 +6979,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5868
6979
  /**
5869
6980
  *
5870
6981
  * @summary Deletes multiple customers
5871
- * @param {Array<string>} [id]
6982
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5872
6983
  * @param {*} [options] Override http request option.
5873
6984
  * @throws {RequiredError}
5874
6985
  */
@@ -5881,6 +6992,46 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5881
6992
  * @throws {RequiredError}
5882
6993
  */
5883
6994
  customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: any): AxiosPromise<UpdateCustomersResponse>;
6995
+ /**
6996
+ *
6997
+ * @summary Returns information about a specific file.
6998
+ * @param {string} fileId The ID of the file to use for this request
6999
+ * @param {*} [options] Override http request option.
7000
+ * @throws {RequiredError}
7001
+ */
7002
+ file(fileId: string, options?: any): AxiosPromise<Scout9File>;
7003
+ /**
7004
+ *
7005
+ * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
7006
+ * @param {File} file
7007
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
7008
+ * @param {*} [options] Override http request option.
7009
+ * @throws {RequiredError}
7010
+ */
7011
+ fileCreate(file: File | Buffer | Blob, purpose?: string, options?: any): AxiosPromise<Scout9File>;
7012
+ /**
7013
+ *
7014
+ * @summary Delete a file.
7015
+ * @param {string} fileId The ID of the file to use for this request
7016
+ * @param {*} [options] Override http request option.
7017
+ * @throws {RequiredError}
7018
+ */
7019
+ fileDelete(fileId: string, options?: any): AxiosPromise<DeleteFileResponse>;
7020
+ /**
7021
+ *
7022
+ * @summary Returns the contents of the specified file
7023
+ * @param {string} fileId The ID of the file to use for this request
7024
+ * @param {*} [options] Override http request option.
7025
+ * @throws {RequiredError}
7026
+ */
7027
+ fileDownload(fileId: string, options?: any): AxiosPromise<string>;
7028
+ /**
7029
+ *
7030
+ * @summary Returns a list of files that belong to the user\'s organization.
7031
+ * @param {*} [options] Override http request option.
7032
+ * @throws {RequiredError}
7033
+ */
7034
+ files(options?: any): AxiosPromise<ListFilesResponse>;
5884
7035
  /**
5885
7036
  * Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
5886
7037
  * @summary Generate a message from conversation
@@ -5900,16 +7051,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5900
7051
  /**
5901
7052
  *
5902
7053
  * @summary Get all messages from a conversation
7054
+ * @param {string} id id of entity to query
5903
7055
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5904
- * @param {Array<string>} [id]
5905
7056
  * @param {*} [options] Override http request option.
5906
7057
  * @throws {RequiredError}
5907
7058
  */
5908
- messages(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<MessageGetResponseInner>>;
7059
+ messages(id: string, q?: string, options?: any): AxiosPromise<Array<MessageGetResponseInner>>;
5909
7060
  /**
5910
7061
  *
5911
7062
  * @summary Get the results of a bulk API operation
5912
- * @param {string} id
7063
+ * @param {string} id id of entity to query
5913
7064
  * @param {*} [options] Override http request option.
5914
7065
  * @throws {RequiredError}
5915
7066
  */
@@ -5918,7 +7069,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5918
7069
  *
5919
7070
  * @summary Gets all or specific set of bulk API operations
5920
7071
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5921
- * @param {Array<string>} [id]
7072
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5922
7073
  * @param {*} [options] Override http request option.
5923
7074
  * @throws {RequiredError}
5924
7075
  */
@@ -5930,11 +7081,11 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5930
7081
  * @param {*} [options] Override http request option.
5931
7082
  * @throws {RequiredError}
5932
7083
  */
5933
- scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: any): AxiosPromise<ScheduleCreateResponse>;
7084
+ scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: any): AxiosPromise<ScheduleCreateResponse>;
5934
7085
  /**
5935
7086
  *
5936
7087
  * @summary Deletes a schedule
5937
- * @param {string} id
7088
+ * @param {string} id id of entity to query
5938
7089
  * @param {*} [options] Override http request option.
5939
7090
  * @throws {RequiredError}
5940
7091
  */
@@ -5950,7 +7101,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5950
7101
  /**
5951
7102
  *
5952
7103
  * @summary Deletes and cancels a schedule group
5953
- * @param {string} id
7104
+ * @param {string} id id of entity to query
5954
7105
  * @param {*} [options] Override http request option.
5955
7106
  * @throws {RequiredError}
5956
7107
  */
@@ -5958,7 +7109,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5958
7109
  /**
5959
7110
  *
5960
7111
  * @summary Gets a schedule group
5961
- * @param {string} id
7112
+ * @param {string} id id of entity to query
5962
7113
  * @param {*} [options] Override http request option.
5963
7114
  * @throws {RequiredError}
5964
7115
  */
@@ -5974,7 +7125,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5974
7125
  /**
5975
7126
  *
5976
7127
  * @summary Gets a schedule
5977
- * @param {string} id
7128
+ * @param {string} id id of entity to query
5978
7129
  * @param {*} [options] Override http request option.
5979
7130
  * @throws {RequiredError}
5980
7131
  */
@@ -5990,7 +7141,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
5990
7141
  /**
5991
7142
  *
5992
7143
  * @summary Gets a workflow
5993
- * @param {string} id
7144
+ * @param {string} id id of entity to query
5994
7145
  * @param {*} [options] Override http request option.
5995
7146
  * @throws {RequiredError}
5996
7147
  */
@@ -6006,7 +7157,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
6006
7157
  /**
6007
7158
  *
6008
7159
  * @summary Deletes a workflow
6009
- * @param {string} id
7160
+ * @param {string} id id of entity to query
6010
7161
  * @param {*} [options] Override http request option.
6011
7162
  * @throws {RequiredError}
6012
7163
  */
@@ -6023,7 +7174,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
6023
7174
  *
6024
7175
  * @summary Gets all or specific set of workflows
6025
7176
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6026
- * @param {Array<string>} [id]
7177
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6027
7178
  * @param {*} [options] Override http request option.
6028
7179
  * @throws {RequiredError}
6029
7180
  */
@@ -6039,7 +7190,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
6039
7190
  /**
6040
7191
  *
6041
7192
  * @summary Deletes multiple workflows
6042
- * @param {Array<string>} [id]
7193
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6043
7194
  * @param {*} [options] Override http request option.
6044
7195
  * @throws {RequiredError}
6045
7196
  */
@@ -6054,56 +7205,56 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
6054
7205
  workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: any): AxiosPromise<UpdateWorkflowsResponse>;
6055
7206
  };
6056
7207
  /**
6057
- * Scout9Api - object-oriented interface
7208
+ * PocketScoutApi - object-oriented interface
6058
7209
  * @export
6059
- * @class Scout9Api
7210
+ * @class PocketScoutApi
6060
7211
  * @extends {BaseAPI}
6061
7212
  */
6062
- export declare class Scout9Api extends BaseAPI {
7213
+ export declare class PocketScoutApi extends BaseAPI {
6063
7214
  /**
6064
7215
  *
6065
7216
  * @summary Gets a agent
6066
- * @param {string} id
7217
+ * @param {string} id id of entity to query
6067
7218
  * @param {*} [options] Override http request option.
6068
7219
  * @throws {RequiredError}
6069
- * @memberof Scout9Api
7220
+ * @memberof PocketScoutApi
6070
7221
  */
6071
7222
  agent(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAgentResponse, any>>;
6072
7223
  /**
6073
7224
  *
6074
- * @summary Create a new agent
6075
- * @param {CreateAgentRequest} createAgentRequest
7225
+ * @summary Deletes a agent
7226
+ * @param {string} id id of entity to query
6076
7227
  * @param {*} [options] Override http request option.
6077
7228
  * @throws {RequiredError}
6078
- * @memberof Scout9Api
7229
+ * @memberof PocketScoutApi
6079
7230
  */
6080
- agentCreate(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentResponse, any>>;
7231
+ agentDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentResponse, any>>;
6081
7232
  /**
6082
7233
  *
6083
- * @summary Deletes a agent
6084
- * @param {string} id
7234
+ * @summary Registers a new agent
7235
+ * @param {CreateAgentRequest} createAgentRequest
6085
7236
  * @param {*} [options] Override http request option.
6086
7237
  * @throws {RequiredError}
6087
- * @memberof Scout9Api
7238
+ * @memberof PocketScoutApi
6088
7239
  */
6089
- agentDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentResponse, any>>;
7240
+ agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentResponse, any>>;
6090
7241
  /**
6091
7242
  *
6092
7243
  * @summary Update a agent
6093
7244
  * @param {UpdateAgentRequest} updateAgentRequest
6094
7245
  * @param {*} [options] Override http request option.
6095
7246
  * @throws {RequiredError}
6096
- * @memberof Scout9Api
7247
+ * @memberof PocketScoutApi
6097
7248
  */
6098
7249
  agentUpdate(updateAgentRequest: UpdateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentResponse, any>>;
6099
7250
  /**
6100
7251
  *
6101
7252
  * @summary Gets all or specific set of agents
6102
7253
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6103
- * @param {Array<string>} [id]
7254
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6104
7255
  * @param {*} [options] Override http request option.
6105
7256
  * @throws {RequiredError}
6106
- * @memberof Scout9Api
7257
+ * @memberof PocketScoutApi
6107
7258
  */
6108
7259
  agents(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAgentsResponseInner[], any>>;
6109
7260
  /**
@@ -6112,16 +7263,16 @@ export declare class Scout9Api extends BaseAPI {
6112
7263
  * @param {CreateAgentsRequest} createAgentsRequest
6113
7264
  * @param {*} [options] Override http request option.
6114
7265
  * @throws {RequiredError}
6115
- * @memberof Scout9Api
7266
+ * @memberof PocketScoutApi
6116
7267
  */
6117
7268
  agentsCreate(createAgentsRequest: CreateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentsResponse, any>>;
6118
7269
  /**
6119
7270
  *
6120
7271
  * @summary Deletes multiple agents
6121
- * @param {Array<string>} [id]
7272
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6122
7273
  * @param {*} [options] Override http request option.
6123
7274
  * @throws {RequiredError}
6124
- * @memberof Scout9Api
7275
+ * @memberof PocketScoutApi
6125
7276
  */
6126
7277
  agentsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentsResponse, any>>;
6127
7278
  /**
@@ -6130,16 +7281,16 @@ export declare class Scout9Api extends BaseAPI {
6130
7281
  * @param {UpdateAgentsRequest} updateAgentsRequest
6131
7282
  * @param {*} [options] Override http request option.
6132
7283
  * @throws {RequiredError}
6133
- * @memberof Scout9Api
7284
+ * @memberof PocketScoutApi
6134
7285
  */
6135
7286
  agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentsResponse, any>>;
6136
7287
  /**
6137
7288
  *
6138
7289
  * @summary Gets a context
6139
- * @param {string} id
7290
+ * @param {string} id id of entity to query
6140
7291
  * @param {*} [options] Override http request option.
6141
7292
  * @throws {RequiredError}
6142
- * @memberof Scout9Api
7293
+ * @memberof PocketScoutApi
6143
7294
  */
6144
7295
  context(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextResponse, any>>;
6145
7296
  /**
@@ -6148,16 +7299,16 @@ export declare class Scout9Api extends BaseAPI {
6148
7299
  * @param {CreateContextRequest} createContextRequest
6149
7300
  * @param {*} [options] Override http request option.
6150
7301
  * @throws {RequiredError}
6151
- * @memberof Scout9Api
7302
+ * @memberof PocketScoutApi
6152
7303
  */
6153
7304
  contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextResponse, any>>;
6154
7305
  /**
6155
7306
  *
6156
7307
  * @summary Deletes a schedule
6157
- * @param {string} id
7308
+ * @param {string} id id of entity to query
6158
7309
  * @param {*} [options] Override http request option.
6159
7310
  * @throws {RequiredError}
6160
- * @memberof Scout9Api
7311
+ * @memberof PocketScoutApi
6161
7312
  */
6162
7313
  contextDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextResponse, any>>;
6163
7314
  /**
@@ -6166,17 +7317,17 @@ export declare class Scout9Api extends BaseAPI {
6166
7317
  * @param {UpdateContextRequest} updateContextRequest
6167
7318
  * @param {*} [options] Override http request option.
6168
7319
  * @throws {RequiredError}
6169
- * @memberof Scout9Api
7320
+ * @memberof PocketScoutApi
6170
7321
  */
6171
7322
  contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextResponse, any>>;
6172
7323
  /**
6173
7324
  *
6174
7325
  * @summary Gets all or specific set of contexts
6175
7326
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6176
- * @param {Array<string>} [id]
7327
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6177
7328
  * @param {*} [options] Override http request option.
6178
7329
  * @throws {RequiredError}
6179
- * @memberof Scout9Api
7330
+ * @memberof PocketScoutApi
6180
7331
  */
6181
7332
  contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListContextsResponseInner[], any>>;
6182
7333
  /**
@@ -6185,16 +7336,16 @@ export declare class Scout9Api extends BaseAPI {
6185
7336
  * @param {CreateContextsRequest} createContextsRequest
6186
7337
  * @param {*} [options] Override http request option.
6187
7338
  * @throws {RequiredError}
6188
- * @memberof Scout9Api
7339
+ * @memberof PocketScoutApi
6189
7340
  */
6190
7341
  contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextsResponse, any>>;
6191
7342
  /**
6192
7343
  *
6193
7344
  * @summary Deletes multiple contexts
6194
- * @param {Array<string>} [id]
7345
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6195
7346
  * @param {*} [options] Override http request option.
6196
7347
  * @throws {RequiredError}
6197
- * @memberof Scout9Api
7348
+ * @memberof PocketScoutApi
6198
7349
  */
6199
7350
  contextsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextsResponse, any>>;
6200
7351
  /**
@@ -6203,16 +7354,16 @@ export declare class Scout9Api extends BaseAPI {
6203
7354
  * @param {UpdateContextRequest} updateContextRequest
6204
7355
  * @param {*} [options] Override http request option.
6205
7356
  * @throws {RequiredError}
6206
- * @memberof Scout9Api
7357
+ * @memberof PocketScoutApi
6207
7358
  */
6208
7359
  contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextsResponse, any>>;
6209
7360
  /**
6210
7361
  *
6211
7362
  * @summary Gets a conversation
6212
- * @param {string} id
7363
+ * @param {string} id id of entity to query
6213
7364
  * @param {*} [options] Override http request option.
6214
7365
  * @throws {RequiredError}
6215
- * @memberof Scout9Api
7366
+ * @memberof PocketScoutApi
6216
7367
  */
6217
7368
  conversation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationGetResponse, any>>;
6218
7369
  /**
@@ -6221,16 +7372,16 @@ export declare class Scout9Api extends BaseAPI {
6221
7372
  * @param {ConversationCreateRequest} conversationCreateRequest
6222
7373
  * @param {*} [options] Override http request option.
6223
7374
  * @throws {RequiredError}
6224
- * @memberof Scout9Api
7375
+ * @memberof PocketScoutApi
6225
7376
  */
6226
7377
  conversationCreate(conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationCreateResponse, any>>;
6227
7378
  /**
6228
7379
  *
6229
7380
  * @summary Deletes a schedule
6230
- * @param {string} id
7381
+ * @param {string} id id of entity to query
6231
7382
  * @param {*} [options] Override http request option.
6232
7383
  * @throws {RequiredError}
6233
- * @memberof Scout9Api
7384
+ * @memberof PocketScoutApi
6234
7385
  */
6235
7386
  conversationDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationRemoveResponse, any>>;
6236
7387
  /**
@@ -6239,16 +7390,16 @@ export declare class Scout9Api extends BaseAPI {
6239
7390
  * @param {ConversationUpdateRequest} conversationUpdateRequest
6240
7391
  * @param {*} [options] Override http request option.
6241
7392
  * @throws {RequiredError}
6242
- * @memberof Scout9Api
7393
+ * @memberof PocketScoutApi
6243
7394
  */
6244
7395
  conversationUpdate(conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationUpdateResponse, any>>;
6245
7396
  /**
6246
7397
  *
6247
7398
  * @summary Gets a customer
6248
- * @param {string} id
7399
+ * @param {string} id id of entity to query
6249
7400
  * @param {*} [options] Override http request option.
6250
7401
  * @throws {RequiredError}
6251
- * @memberof Scout9Api
7402
+ * @memberof PocketScoutApi
6252
7403
  */
6253
7404
  customer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponse, any>>;
6254
7405
  /**
@@ -6257,35 +7408,108 @@ export declare class Scout9Api extends BaseAPI {
6257
7408
  * @param {CreateCustomerRequest} createCustomerRequest
6258
7409
  * @param {*} [options] Override http request option.
6259
7410
  * @throws {RequiredError}
6260
- * @memberof Scout9Api
7411
+ * @memberof PocketScoutApi
6261
7412
  */
6262
7413
  customerCreate(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerResponse, any>>;
6263
7414
  /**
6264
7415
  *
6265
7416
  * @summary Deletes a customer
6266
- * @param {string} id
7417
+ * @param {string} id id of entity to query
6267
7418
  * @param {*} [options] Override http request option.
6268
7419
  * @throws {RequiredError}
6269
- * @memberof Scout9Api
7420
+ * @memberof PocketScoutApi
6270
7421
  */
6271
7422
  customerDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerResponse, any>>;
7423
+ /**
7424
+ *
7425
+ * @summary Gets a customer group
7426
+ * @param {string} id id of entity to query
7427
+ * @param {*} [options] Override http request option.
7428
+ * @throws {RequiredError}
7429
+ * @memberof PocketScoutApi
7430
+ */
7431
+ customerGroup(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerGroupResponse, any>>;
7432
+ /**
7433
+ *
7434
+ * @summary Creates a new customer group
7435
+ * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
7436
+ * @param {*} [options] Override http request option.
7437
+ * @throws {RequiredError}
7438
+ * @memberof PocketScoutApi
7439
+ */
7440
+ customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupResponse, any>>;
7441
+ /**
7442
+ *
7443
+ * @summary Deletes a customer group
7444
+ * @param {string} id id of entity to query
7445
+ * @param {*} [options] Override http request option.
7446
+ * @throws {RequiredError}
7447
+ * @memberof PocketScoutApi
7448
+ */
7449
+ customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupResponse, any>>;
7450
+ /**
7451
+ *
7452
+ * @summary Updates a customer group
7453
+ * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
7454
+ * @param {*} [options] Override http request option.
7455
+ * @throws {RequiredError}
7456
+ * @memberof PocketScoutApi
7457
+ */
7458
+ customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupResponse, any>>;
7459
+ /**
7460
+ *
7461
+ * @summary Gets all or specific set of customer groups
7462
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7463
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7464
+ * @param {*} [options] Override http request option.
7465
+ * @throws {RequiredError}
7466
+ * @memberof PocketScoutApi
7467
+ */
7468
+ customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerGroupsResponseInner[], any>>;
7469
+ /**
7470
+ *
7471
+ * @summary Creates new customer groups
7472
+ * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
7473
+ * @param {*} [options] Override http request option.
7474
+ * @throws {RequiredError}
7475
+ * @memberof PocketScoutApi
7476
+ */
7477
+ customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupsResponse, any>>;
7478
+ /**
7479
+ *
7480
+ * @summary Deletes multiple customer groups
7481
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7482
+ * @param {*} [options] Override http request option.
7483
+ * @throws {RequiredError}
7484
+ * @memberof PocketScoutApi
7485
+ */
7486
+ customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupsResponse, any>>;
7487
+ /**
7488
+ *
7489
+ * @summary Updates multiple customer groups
7490
+ * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
7491
+ * @param {*} [options] Override http request option.
7492
+ * @throws {RequiredError}
7493
+ * @memberof PocketScoutApi
7494
+ */
7495
+ customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupsResponse, any>>;
6272
7496
  /**
6273
7497
  *
6274
7498
  * @summary Updates a customer
6275
7499
  * @param {UpdateCustomerRequest} updateCustomerRequest
6276
7500
  * @param {*} [options] Override http request option.
6277
7501
  * @throws {RequiredError}
6278
- * @memberof Scout9Api
7502
+ * @memberof PocketScoutApi
6279
7503
  */
6280
7504
  customerUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponse, any>>;
6281
7505
  /**
6282
7506
  *
6283
7507
  * @summary Gets all or specific set of customers
6284
7508
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6285
- * @param {Array<string>} [id]
7509
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6286
7510
  * @param {*} [options] Override http request option.
6287
7511
  * @throws {RequiredError}
6288
- * @memberof Scout9Api
7512
+ * @memberof PocketScoutApi
6289
7513
  */
6290
7514
  customers(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomersResponseInner[], any>>;
6291
7515
  /**
@@ -6294,16 +7518,16 @@ export declare class Scout9Api extends BaseAPI {
6294
7518
  * @param {CreateCustomersRequest} createCustomersRequest
6295
7519
  * @param {*} [options] Override http request option.
6296
7520
  * @throws {RequiredError}
6297
- * @memberof Scout9Api
7521
+ * @memberof PocketScoutApi
6298
7522
  */
6299
7523
  customersCreate(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomersResponse, any>>;
6300
7524
  /**
6301
7525
  *
6302
7526
  * @summary Deletes multiple customers
6303
- * @param {Array<string>} [id]
7527
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6304
7528
  * @param {*} [options] Override http request option.
6305
7529
  * @throws {RequiredError}
6306
- * @memberof Scout9Api
7530
+ * @memberof PocketScoutApi
6307
7531
  */
6308
7532
  customersDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomersResponse, any>>;
6309
7533
  /**
@@ -6312,16 +7536,61 @@ export declare class Scout9Api extends BaseAPI {
6312
7536
  * @param {UpdateCustomerRequest} updateCustomerRequest
6313
7537
  * @param {*} [options] Override http request option.
6314
7538
  * @throws {RequiredError}
6315
- * @memberof Scout9Api
7539
+ * @memberof PocketScoutApi
6316
7540
  */
6317
7541
  customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
7542
+ /**
7543
+ *
7544
+ * @summary Returns information about a specific file.
7545
+ * @param {string} fileId The ID of the file to use for this request
7546
+ * @param {*} [options] Override http request option.
7547
+ * @throws {RequiredError}
7548
+ * @memberof PocketScoutApi
7549
+ */
7550
+ file(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
7551
+ /**
7552
+ *
7553
+ * @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
7554
+ * @param {File} file
7555
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
7556
+ * @param {*} [options] Override http request option.
7557
+ * @throws {RequiredError}
7558
+ * @memberof PocketScoutApi
7559
+ */
7560
+ fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
7561
+ /**
7562
+ *
7563
+ * @summary Delete a file.
7564
+ * @param {string} fileId The ID of the file to use for this request
7565
+ * @param {*} [options] Override http request option.
7566
+ * @throws {RequiredError}
7567
+ * @memberof PocketScoutApi
7568
+ */
7569
+ fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFileResponse, any>>;
7570
+ /**
7571
+ *
7572
+ * @summary Returns the contents of the specified file
7573
+ * @param {string} fileId The ID of the file to use for this request
7574
+ * @param {*} [options] Override http request option.
7575
+ * @throws {RequiredError}
7576
+ * @memberof PocketScoutApi
7577
+ */
7578
+ fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
7579
+ /**
7580
+ *
7581
+ * @summary Returns a list of files that belong to the user\'s organization.
7582
+ * @param {*} [options] Override http request option.
7583
+ * @throws {RequiredError}
7584
+ * @memberof PocketScoutApi
7585
+ */
7586
+ files(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
6318
7587
  /**
6319
7588
  * Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
6320
7589
  * @summary Generate a message from conversation
6321
7590
  * @param {GenerateRequest} generateRequest
6322
7591
  * @param {*} [options] Override http request option.
6323
7592
  * @throws {RequiredError}
6324
- * @memberof Scout9Api
7593
+ * @memberof PocketScoutApi
6325
7594
  */
6326
7595
  generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateResponse, any>>;
6327
7596
  /**
@@ -6330,36 +7599,36 @@ export declare class Scout9Api extends BaseAPI {
6330
7599
  * @param {MessageCreateRequest} messageCreateRequest
6331
7600
  * @param {*} [options] Override http request option.
6332
7601
  * @throws {RequiredError}
6333
- * @memberof Scout9Api
7602
+ * @memberof PocketScoutApi
6334
7603
  */
6335
7604
  message(messageCreateRequest: MessageCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageCreateResponse, any>>;
6336
7605
  /**
6337
7606
  *
6338
7607
  * @summary Get all messages from a conversation
7608
+ * @param {string} id id of entity to query
6339
7609
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6340
- * @param {Array<string>} [id]
6341
7610
  * @param {*} [options] Override http request option.
6342
7611
  * @throws {RequiredError}
6343
- * @memberof Scout9Api
7612
+ * @memberof PocketScoutApi
6344
7613
  */
6345
- messages(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageGetResponseInner[], any>>;
7614
+ messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageGetResponseInner[], any>>;
6346
7615
  /**
6347
7616
  *
6348
7617
  * @summary Get the results of a bulk API operation
6349
- * @param {string} id
7618
+ * @param {string} id id of entity to query
6350
7619
  * @param {*} [options] Override http request option.
6351
7620
  * @throws {RequiredError}
6352
- * @memberof Scout9Api
7621
+ * @memberof PocketScoutApi
6353
7622
  */
6354
7623
  operation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetApiOperationResponse, any>>;
6355
7624
  /**
6356
7625
  *
6357
7626
  * @summary Gets all or specific set of bulk API operations
6358
7627
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6359
- * @param {Array<string>} [id]
7628
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6360
7629
  * @param {*} [options] Override http request option.
6361
7630
  * @throws {RequiredError}
6362
- * @memberof Scout9Api
7631
+ * @memberof PocketScoutApi
6363
7632
  */
6364
7633
  operations(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListApiOperationsResponseInner[], any>>;
6365
7634
  /**
@@ -6368,16 +7637,16 @@ export declare class Scout9Api extends BaseAPI {
6368
7637
  * @param {ScheduleCreateRequest} scheduleCreateRequest
6369
7638
  * @param {*} [options] Override http request option.
6370
7639
  * @throws {RequiredError}
6371
- * @memberof Scout9Api
7640
+ * @memberof PocketScoutApi
6372
7641
  */
6373
- scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
7642
+ scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
6374
7643
  /**
6375
7644
  *
6376
7645
  * @summary Deletes a schedule
6377
- * @param {string} id
7646
+ * @param {string} id id of entity to query
6378
7647
  * @param {*} [options] Override http request option.
6379
7648
  * @throws {RequiredError}
6380
- * @memberof Scout9Api
7649
+ * @memberof PocketScoutApi
6381
7650
  */
6382
7651
  scheduleDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleRemoveResponse, any>>;
6383
7652
  /**
@@ -6386,25 +7655,25 @@ export declare class Scout9Api extends BaseAPI {
6386
7655
  * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
6387
7656
  * @param {*} [options] Override http request option.
6388
7657
  * @throws {RequiredError}
6389
- * @memberof Scout9Api
7658
+ * @memberof PocketScoutApi
6390
7659
  */
6391
7660
  scheduleGroupCreate(scheduleGroupCreateRequest: ScheduleGroupCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupCreateResponse, any>>;
6392
7661
  /**
6393
7662
  *
6394
7663
  * @summary Deletes and cancels a schedule group
6395
- * @param {string} id
7664
+ * @param {string} id id of entity to query
6396
7665
  * @param {*} [options] Override http request option.
6397
7666
  * @throws {RequiredError}
6398
- * @memberof Scout9Api
7667
+ * @memberof PocketScoutApi
6399
7668
  */
6400
7669
  scheduleGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupRemoveResponse, any>>;
6401
7670
  /**
6402
7671
  *
6403
7672
  * @summary Gets a schedule group
6404
- * @param {string} id
7673
+ * @param {string} id id of entity to query
6405
7674
  * @param {*} [options] Override http request option.
6406
7675
  * @throws {RequiredError}
6407
- * @memberof Scout9Api
7676
+ * @memberof PocketScoutApi
6408
7677
  */
6409
7678
  scheduleGroupRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupGetResponse, any>>;
6410
7679
  /**
@@ -6413,16 +7682,16 @@ export declare class Scout9Api extends BaseAPI {
6413
7682
  * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
6414
7683
  * @param {*} [options] Override http request option.
6415
7684
  * @throws {RequiredError}
6416
- * @memberof Scout9Api
7685
+ * @memberof PocketScoutApi
6417
7686
  */
6418
7687
  scheduleGroupUpdate(scheduleGroupUpdateRequest: ScheduleGroupUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupUpdateResponse, any>>;
6419
7688
  /**
6420
7689
  *
6421
7690
  * @summary Gets a schedule
6422
- * @param {string} id
7691
+ * @param {string} id id of entity to query
6423
7692
  * @param {*} [options] Override http request option.
6424
7693
  * @throws {RequiredError}
6425
- * @memberof Scout9Api
7694
+ * @memberof PocketScoutApi
6426
7695
  */
6427
7696
  scheduleRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
6428
7697
  /**
@@ -6431,16 +7700,16 @@ export declare class Scout9Api extends BaseAPI {
6431
7700
  * @param {ScheduleUpdateRequest} scheduleUpdateRequest
6432
7701
  * @param {*} [options] Override http request option.
6433
7702
  * @throws {RequiredError}
6434
- * @memberof Scout9Api
7703
+ * @memberof PocketScoutApi
6435
7704
  */
6436
7705
  scheduleUpdate(scheduleUpdateRequest: ScheduleUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleUpdateResponse, any>>;
6437
7706
  /**
6438
7707
  *
6439
7708
  * @summary Gets a workflow
6440
- * @param {string} id
7709
+ * @param {string} id id of entity to query
6441
7710
  * @param {*} [options] Override http request option.
6442
7711
  * @throws {RequiredError}
6443
- * @memberof Scout9Api
7712
+ * @memberof PocketScoutApi
6444
7713
  */
6445
7714
  workflow(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkflowResponse, any>>;
6446
7715
  /**
@@ -6449,16 +7718,16 @@ export declare class Scout9Api extends BaseAPI {
6449
7718
  * @param {CreateWorkflowRequest} createWorkflowRequest
6450
7719
  * @param {*} [options] Override http request option.
6451
7720
  * @throws {RequiredError}
6452
- * @memberof Scout9Api
7721
+ * @memberof PocketScoutApi
6453
7722
  */
6454
7723
  workflowCreate(createWorkflowRequest: CreateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowResponse, any>>;
6455
7724
  /**
6456
7725
  *
6457
7726
  * @summary Deletes a workflow
6458
- * @param {string} id
7727
+ * @param {string} id id of entity to query
6459
7728
  * @param {*} [options] Override http request option.
6460
7729
  * @throws {RequiredError}
6461
- * @memberof Scout9Api
7730
+ * @memberof PocketScoutApi
6462
7731
  */
6463
7732
  workflowDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowResponse, any>>;
6464
7733
  /**
@@ -6467,17 +7736,17 @@ export declare class Scout9Api extends BaseAPI {
6467
7736
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
6468
7737
  * @param {*} [options] Override http request option.
6469
7738
  * @throws {RequiredError}
6470
- * @memberof Scout9Api
7739
+ * @memberof PocketScoutApi
6471
7740
  */
6472
7741
  workflowUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowResponse, any>>;
6473
7742
  /**
6474
7743
  *
6475
7744
  * @summary Gets all or specific set of workflows
6476
7745
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6477
- * @param {Array<string>} [id]
7746
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6478
7747
  * @param {*} [options] Override http request option.
6479
7748
  * @throws {RequiredError}
6480
- * @memberof Scout9Api
7749
+ * @memberof PocketScoutApi
6481
7750
  */
6482
7751
  workflows(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowsResponseInner[], any>>;
6483
7752
  /**
@@ -6486,16 +7755,16 @@ export declare class Scout9Api extends BaseAPI {
6486
7755
  * @param {CreateWorkflowsRequest} createWorkflowsRequest
6487
7756
  * @param {*} [options] Override http request option.
6488
7757
  * @throws {RequiredError}
6489
- * @memberof Scout9Api
7758
+ * @memberof PocketScoutApi
6490
7759
  */
6491
7760
  workflowsCreate(createWorkflowsRequest: CreateWorkflowsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowsResponse, any>>;
6492
7761
  /**
6493
7762
  *
6494
7763
  * @summary Deletes multiple workflows
6495
- * @param {Array<string>} [id]
7764
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6496
7765
  * @param {*} [options] Override http request option.
6497
7766
  * @throws {RequiredError}
6498
- * @memberof Scout9Api
7767
+ * @memberof PocketScoutApi
6499
7768
  */
6500
7769
  workflowsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowsResponse, any>>;
6501
7770
  /**
@@ -6504,7 +7773,7 @@ export declare class Scout9Api extends BaseAPI {
6504
7773
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
6505
7774
  * @param {*} [options] Override http request option.
6506
7775
  * @throws {RequiredError}
6507
- * @memberof Scout9Api
7776
+ * @memberof PocketScoutApi
6508
7777
  */
6509
7778
  workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowsResponse, any>>;
6510
7779
  }