@scout9/admin 1.0.8 → 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/src/api.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Scout9 Pocket Scout API
4
+ * Scout9\'s Pocket Scout API
5
5
  * Pocket Scout APIs for managing Scout9 users and conversations with your Pocket Scout agents
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0.0
@@ -34,13 +34,13 @@ export interface Agent {
34
34
  * @type {string}
35
35
  * @memberof Agent
36
36
  */
37
- 'firstName': string;
37
+ 'firstName'?: string;
38
38
  /**
39
39
  * Agent last name
40
40
  * @type {string}
41
41
  * @memberof Agent
42
42
  */
43
- 'lastName': string;
43
+ 'lastName'?: string;
44
44
  /**
45
45
  * Agent is inactive
46
46
  * @type {boolean}
@@ -76,7 +76,7 @@ export interface Agent {
76
76
  * @type {string}
77
77
  * @memberof Agent
78
78
  */
79
- 'forwardPhone': string;
79
+ 'forwardPhone'?: string;
80
80
  /**
81
81
  * Title of the agent, defaults to \"Agent\"
82
82
  * @type {string}
@@ -96,18 +96,27 @@ export interface Agent {
96
96
  */
97
97
  'includedLocations'?: Array<string>;
98
98
  /**
99
- * Locations id the agent is excluded from
100
- * @type {Array<string>}
99
+ * AI Model
100
+ * @type {string}
101
101
  * @memberof Agent
102
102
  */
103
- 'excludedLocations'?: Array<string>;
103
+ 'model'?: AgentModelEnum;
104
104
  /**
105
- * Transcript of the agent
106
- * @type {string}
105
+ * Locations id the agent is excluded from
106
+ * @type {Array<string>}
107
107
  * @memberof Agent
108
108
  */
109
- 'transcript'?: string;
109
+ 'excludedLocations'?: Array<string>;
110
110
  }
111
+
112
+ export const AgentModelEnum = {
113
+ PocketScout: 'Pocket Scout',
114
+ Bard: 'bard',
115
+ Null: 'null'
116
+ } as const;
117
+
118
+ export type AgentModelEnum = typeof AgentModelEnum[keyof typeof AgentModelEnum];
119
+
111
120
  /**
112
121
  * @type AnyValue
113
122
  * @export
@@ -502,11 +511,11 @@ export interface ConversationContextFieldCondition {
502
511
  */
503
512
  'key': string;
504
513
  /**
505
- *
506
- * @type {Operator}
514
+ * The operator of the condition or query
515
+ * @type {string}
507
516
  * @memberof ConversationContextFieldCondition
508
517
  */
509
- 'operator': Operator;
518
+ 'operator': ConversationContextFieldConditionOperatorEnum;
510
519
  /**
511
520
  * The regex of the condition
512
521
  * @type {string}
@@ -521,6 +530,32 @@ export interface ConversationContextFieldCondition {
521
530
  'value': AnyValue;
522
531
  }
523
532
 
533
+ export const ConversationContextFieldConditionOperatorEnum = {
534
+ Eq: 'eq',
535
+ Equal: 'equal',
536
+ Ne: 'ne',
537
+ NotEquals: 'not-equals',
538
+ Gt: 'gt',
539
+ GreaterThan: 'greater-than',
540
+ Gte: 'gte',
541
+ GreaterThanEquals: 'greater-than-equals',
542
+ Lt: 'lt',
543
+ LessThan: 'less-than',
544
+ Lte: 'lte',
545
+ LessThanEquals: 'less-than-equals',
546
+ ArrayContains: 'array-contains',
547
+ In: 'in',
548
+ ArrayContainsAny: 'array-contains-any',
549
+ NotIn: 'not-in',
550
+ Exists: 'exists',
551
+ NotExists: 'notExists',
552
+ Contains: 'contains',
553
+ NotContains: 'notContains',
554
+ StartsWith: 'startsWith',
555
+ EndsWith: 'endsWith'
556
+ } as const;
557
+
558
+ export type ConversationContextFieldConditionOperatorEnum = typeof ConversationContextFieldConditionOperatorEnum[keyof typeof ConversationContextFieldConditionOperatorEnum];
524
559
 
525
560
  /**
526
561
  *
@@ -576,7 +611,7 @@ export interface ConversationCreateRequest {
576
611
  * @type {ConversationUpdateRequestBaseWorkflow}
577
612
  * @memberof ConversationCreateRequest
578
613
  */
579
- '$workflow': ConversationUpdateRequestBaseWorkflow;
614
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
580
615
  }
581
616
 
582
617
 
@@ -591,7 +626,7 @@ export interface ConversationCreateRequestBase {
591
626
  * @type {ConversationUpdateRequestBaseWorkflow}
592
627
  * @memberof ConversationCreateRequestBase
593
628
  */
594
- '$workflow': ConversationUpdateRequestBaseWorkflow;
629
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
595
630
  }
596
631
  /**
597
632
  *
@@ -1031,7 +1066,7 @@ export interface CreateAgentRequest {
1031
1066
  * @type {string}
1032
1067
  * @memberof CreateAgentRequest
1033
1068
  */
1034
- 'forwardEmail'?: string;
1069
+ 'forwardEmail': string;
1035
1070
  /**
1036
1071
  * Forward phone
1037
1072
  * @type {string}
@@ -1056,6 +1091,12 @@ export interface CreateAgentRequest {
1056
1091
  * @memberof CreateAgentRequest
1057
1092
  */
1058
1093
  'includedLocations'?: Array<string>;
1094
+ /**
1095
+ * AI Model
1096
+ * @type {string}
1097
+ * @memberof CreateAgentRequest
1098
+ */
1099
+ 'model'?: CreateAgentRequestModelEnum;
1059
1100
  /**
1060
1101
  * Locations id the agent is excluded from
1061
1102
  * @type {Array<string>}
@@ -1063,11 +1104,95 @@ export interface CreateAgentRequest {
1063
1104
  */
1064
1105
  'excludedLocations'?: Array<string>;
1065
1106
  /**
1066
- * Transcript of the agent
1067
- * @type {string}
1107
+ * Sample conversations that help build out your agent to mimic your responses
1108
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
1109
+ * @memberof CreateAgentRequest
1110
+ */
1111
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
1112
+ /**
1113
+ * Sample audio files that help build out your agent to mimic your voice
1114
+ * @type {Array<string>}
1068
1115
  * @memberof CreateAgentRequest
1069
1116
  */
1070
- 'transcript'?: string;
1117
+ 'audio'?: Array<string>;
1118
+ }
1119
+
1120
+ export const CreateAgentRequestModelEnum = {
1121
+ PocketScout: 'Pocket Scout',
1122
+ Bard: 'bard',
1123
+ Null: 'null'
1124
+ } as const;
1125
+
1126
+ export type CreateAgentRequestModelEnum = typeof CreateAgentRequestModelEnum[keyof typeof CreateAgentRequestModelEnum];
1127
+
1128
+ /**
1129
+ *
1130
+ * @export
1131
+ * @interface CreateAgentRequestAllOf
1132
+ */
1133
+ export interface CreateAgentRequestAllOf {
1134
+ /**
1135
+ * Sample conversations that help build out your agent to mimic your responses
1136
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
1137
+ * @memberof CreateAgentRequestAllOf
1138
+ */
1139
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
1140
+ /**
1141
+ * Sample audio files that help build out your agent to mimic your voice
1142
+ * @type {Array<string>}
1143
+ * @memberof CreateAgentRequestAllOf
1144
+ */
1145
+ 'audio'?: Array<string>;
1146
+ }
1147
+ /**
1148
+ * @type CreateAgentRequestAllOfConversationsInner
1149
+ * @export
1150
+ */
1151
+ export type CreateAgentRequestAllOfConversationsInner = CreateAgentRequestAllOfConversationsInnerOneOf | string;
1152
+
1153
+ /**
1154
+ * Conversation sample
1155
+ * @export
1156
+ * @interface CreateAgentRequestAllOfConversationsInnerOneOf
1157
+ */
1158
+ export interface CreateAgentRequestAllOfConversationsInnerOneOf {
1159
+ /**
1160
+ * The type or category of the conversation (this helps with associating work flows)
1161
+ * @type {string}
1162
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1163
+ */
1164
+ 'type': string;
1165
+ /**
1166
+ * The context of the conversation, this helps with associating work flows, or any caveats to the conversation
1167
+ * @type {string}
1168
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1169
+ */
1170
+ 'context'?: string;
1171
+ /**
1172
+ * Conversation
1173
+ * @type {Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>}
1174
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOf
1175
+ */
1176
+ 'conversation': Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>;
1177
+ }
1178
+ /**
1179
+ *
1180
+ * @export
1181
+ * @interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1182
+ */
1183
+ export interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner {
1184
+ /**
1185
+ * The speaker of the message, if this from the agent then this must have \"agent\" or match the agent\'s first or full name
1186
+ * @type {string}
1187
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1188
+ */
1189
+ 'speaker': string;
1190
+ /**
1191
+ * The message content
1192
+ * @type {string}
1193
+ * @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
1194
+ */
1195
+ 'message': string;
1071
1196
  }
1072
1197
  /**
1073
1198
  *
@@ -1160,7 +1285,7 @@ export interface CreateAgentsRequestAgentsInner {
1160
1285
  * @type {string}
1161
1286
  * @memberof CreateAgentsRequestAgentsInner
1162
1287
  */
1163
- 'forwardPhone': string;
1288
+ 'forwardPhone'?: string;
1164
1289
  /**
1165
1290
  * Title of the agent, defaults to \"Agent\"
1166
1291
  * @type {string}
@@ -1180,18 +1305,27 @@ export interface CreateAgentsRequestAgentsInner {
1180
1305
  */
1181
1306
  'includedLocations'?: Array<string>;
1182
1307
  /**
1183
- * Locations id the agent is excluded from
1184
- * @type {Array<string>}
1308
+ * AI Model
1309
+ * @type {string}
1185
1310
  * @memberof CreateAgentsRequestAgentsInner
1186
1311
  */
1187
- 'excludedLocations'?: Array<string>;
1312
+ 'model'?: CreateAgentsRequestAgentsInnerModelEnum;
1188
1313
  /**
1189
- * Transcript of the agent
1190
- * @type {string}
1314
+ * Locations id the agent is excluded from
1315
+ * @type {Array<string>}
1191
1316
  * @memberof CreateAgentsRequestAgentsInner
1192
1317
  */
1193
- 'transcript'?: string;
1318
+ 'excludedLocations'?: Array<string>;
1194
1319
  }
1320
+
1321
+ export const CreateAgentsRequestAgentsInnerModelEnum = {
1322
+ PocketScout: 'Pocket Scout',
1323
+ Bard: 'bard',
1324
+ Null: 'null'
1325
+ } as const;
1326
+
1327
+ export type CreateAgentsRequestAgentsInnerModelEnum = typeof CreateAgentsRequestAgentsInnerModelEnum[keyof typeof CreateAgentsRequestAgentsInnerModelEnum];
1328
+
1195
1329
  /**
1196
1330
  *
1197
1331
  * @export
@@ -2174,6 +2308,31 @@ export interface DeleteCustomersResponse {
2174
2308
  */
2175
2309
  '$operation': string;
2176
2310
  }
2311
+ /**
2312
+ *
2313
+ * @export
2314
+ * @interface DeleteFileResponse
2315
+ */
2316
+ export interface DeleteFileResponse {
2317
+ /**
2318
+ *
2319
+ * @type {string}
2320
+ * @memberof DeleteFileResponse
2321
+ */
2322
+ 'id': string;
2323
+ /**
2324
+ *
2325
+ * @type {string}
2326
+ * @memberof DeleteFileResponse
2327
+ */
2328
+ 'object': string;
2329
+ /**
2330
+ *
2331
+ * @type {boolean}
2332
+ * @memberof DeleteFileResponse
2333
+ */
2334
+ 'deleted': boolean;
2335
+ }
2177
2336
  /**
2178
2337
  *
2179
2338
  * @export
@@ -2238,11 +2397,49 @@ export interface ErrorResponse {
2238
2397
  */
2239
2398
  export interface GenerateRequest {
2240
2399
  /**
2241
- * Conversation ID to generate message from
2242
- * @type {string}
2400
+ *
2401
+ * @type {GenerateRequestConvo}
2243
2402
  * @memberof GenerateRequest
2244
2403
  */
2245
- 'convo': string;
2404
+ 'convo': GenerateRequestConvo;
2405
+ /**
2406
+ *
2407
+ * @type {GenerateRequestMocks}
2408
+ * @memberof GenerateRequest
2409
+ */
2410
+ 'mocks'?: GenerateRequestMocks;
2411
+ }
2412
+ /**
2413
+ * @type GenerateRequestConvo
2414
+ * The conversation to generate a message from
2415
+ * @export
2416
+ */
2417
+ export type GenerateRequestConvo = ConversationCreateRequest | string;
2418
+
2419
+ /**
2420
+ * If any mocks are provided, the response will be mocked and conversation will not be created. Requires .convo to be a Conversation object
2421
+ * @export
2422
+ * @interface GenerateRequestMocks
2423
+ */
2424
+ export interface GenerateRequestMocks {
2425
+ /**
2426
+ * Any key,value information about the conversation, customr, or offer goes here
2427
+ * @type {{ [key: string]: any; }}
2428
+ * @memberof GenerateRequestMocks
2429
+ */
2430
+ 'info'?: { [key: string]: any; };
2431
+ /**
2432
+ * Conversation Context fields to mock, use this to test out conversation logic
2433
+ * @type {Array<ConversationContextField>}
2434
+ * @memberof GenerateRequestMocks
2435
+ */
2436
+ 'context'?: Array<ConversationContextField>;
2437
+ /**
2438
+ * Conversation Messages to mock, use this to test out anticipated responses
2439
+ * @type {Array<MessageBase>}
2440
+ * @memberof GenerateRequestMocks
2441
+ */
2442
+ 'messages'?: Array<MessageBase>;
2246
2443
  }
2247
2444
  /**
2248
2445
  *
@@ -2274,16 +2471,47 @@ export interface GenerateResponse {
2274
2471
  * @memberof GenerateResponse
2275
2472
  */
2276
2473
  'time': string;
2474
+ /**
2475
+ * Any key,value information about the conversation, customr, or offer goes here
2476
+ * @type {{ [key: string]: any; }}
2477
+ * @memberof GenerateResponse
2478
+ */
2479
+ 'info': { [key: string]: any; };
2480
+ /**
2481
+ * Conversation Context fields to mock, use this to test out conversation logic
2482
+ * @type {Array<ConversationContextField>}
2483
+ * @memberof GenerateResponse
2484
+ */
2485
+ 'included': Array<ConversationContextField>;
2277
2486
  }
2278
2487
 
2279
2488
  export const GenerateResponseRoleEnum = {
2280
- User: 'user',
2281
- Assistant: 'assistant',
2282
- System: 'system'
2489
+ Customer: 'customer',
2490
+ Agent: 'agent',
2491
+ Context: 'context'
2283
2492
  } as const;
2284
2493
 
2285
2494
  export type GenerateResponseRoleEnum = typeof GenerateResponseRoleEnum[keyof typeof GenerateResponseRoleEnum];
2286
2495
 
2496
+ /**
2497
+ *
2498
+ * @export
2499
+ * @interface GenerateResponseAllOf
2500
+ */
2501
+ export interface GenerateResponseAllOf {
2502
+ /**
2503
+ * Any key,value information about the conversation, customr, or offer goes here
2504
+ * @type {{ [key: string]: any; }}
2505
+ * @memberof GenerateResponseAllOf
2506
+ */
2507
+ 'info': { [key: string]: any; };
2508
+ /**
2509
+ * Conversation Context fields to mock, use this to test out conversation logic
2510
+ * @type {Array<ConversationContextField>}
2511
+ * @memberof GenerateResponseAllOf
2512
+ */
2513
+ 'included': Array<ConversationContextField>;
2514
+ }
2287
2515
  /**
2288
2516
  *
2289
2517
  * @export
@@ -2337,7 +2565,7 @@ export interface GetAgentResponse {
2337
2565
  * @type {string}
2338
2566
  * @memberof GetAgentResponse
2339
2567
  */
2340
- 'forwardPhone': string;
2568
+ 'forwardPhone'?: string;
2341
2569
  /**
2342
2570
  * Title of the agent, defaults to \"Agent\"
2343
2571
  * @type {string}
@@ -2357,17 +2585,17 @@ export interface GetAgentResponse {
2357
2585
  */
2358
2586
  'includedLocations'?: Array<string>;
2359
2587
  /**
2360
- * Locations id the agent is excluded from
2361
- * @type {Array<string>}
2588
+ * AI Model
2589
+ * @type {string}
2362
2590
  * @memberof GetAgentResponse
2363
2591
  */
2364
- 'excludedLocations'?: Array<string>;
2592
+ 'model'?: GetAgentResponseModelEnum;
2365
2593
  /**
2366
- * Transcript of the agent
2367
- * @type {string}
2594
+ * Locations id the agent is excluded from
2595
+ * @type {Array<string>}
2368
2596
  * @memberof GetAgentResponse
2369
2597
  */
2370
- 'transcript'?: string;
2598
+ 'excludedLocations'?: Array<string>;
2371
2599
  /**
2372
2600
  * The ID of the agent
2373
2601
  * @type {string}
@@ -2375,6 +2603,15 @@ export interface GetAgentResponse {
2375
2603
  */
2376
2604
  '$id': string;
2377
2605
  }
2606
+
2607
+ export const GetAgentResponseModelEnum = {
2608
+ PocketScout: 'Pocket Scout',
2609
+ Bard: 'bard',
2610
+ Null: 'null'
2611
+ } as const;
2612
+
2613
+ export type GetAgentResponseModelEnum = typeof GetAgentResponseModelEnum[keyof typeof GetAgentResponseModelEnum];
2614
+
2378
2615
  /**
2379
2616
  *
2380
2617
  * @export
@@ -2798,13 +3035,13 @@ export interface ListAgentsResponseInner {
2798
3035
  * @type {string}
2799
3036
  * @memberof ListAgentsResponseInner
2800
3037
  */
2801
- 'firstName': string;
3038
+ 'firstName'?: string;
2802
3039
  /**
2803
3040
  * Agent last name
2804
3041
  * @type {string}
2805
3042
  * @memberof ListAgentsResponseInner
2806
3043
  */
2807
- 'lastName': string;
3044
+ 'lastName'?: string;
2808
3045
  /**
2809
3046
  * Agent is inactive
2810
3047
  * @type {boolean}
@@ -2840,7 +3077,7 @@ export interface ListAgentsResponseInner {
2840
3077
  * @type {string}
2841
3078
  * @memberof ListAgentsResponseInner
2842
3079
  */
2843
- 'forwardPhone': string;
3080
+ 'forwardPhone'?: string;
2844
3081
  /**
2845
3082
  * Title of the agent, defaults to \"Agent\"
2846
3083
  * @type {string}
@@ -2860,17 +3097,17 @@ export interface ListAgentsResponseInner {
2860
3097
  */
2861
3098
  'includedLocations'?: Array<string>;
2862
3099
  /**
2863
- * Locations id the agent is excluded from
2864
- * @type {Array<string>}
3100
+ * AI Model
3101
+ * @type {string}
2865
3102
  * @memberof ListAgentsResponseInner
2866
3103
  */
2867
- 'excludedLocations'?: Array<string>;
3104
+ 'model'?: ListAgentsResponseInnerModelEnum;
2868
3105
  /**
2869
- * Transcript of the agent
2870
- * @type {string}
3106
+ * Locations id the agent is excluded from
3107
+ * @type {Array<string>}
2871
3108
  * @memberof ListAgentsResponseInner
2872
3109
  */
2873
- 'transcript'?: string;
3110
+ 'excludedLocations'?: Array<string>;
2874
3111
  /**
2875
3112
  * The ID of the agent
2876
3113
  * @type {string}
@@ -2878,6 +3115,15 @@ export interface ListAgentsResponseInner {
2878
3115
  */
2879
3116
  '$id': string;
2880
3117
  }
3118
+
3119
+ export const ListAgentsResponseInnerModelEnum = {
3120
+ PocketScout: 'Pocket Scout',
3121
+ Bard: 'bard',
3122
+ Null: 'null'
3123
+ } as const;
3124
+
3125
+ export type ListAgentsResponseInnerModelEnum = typeof ListAgentsResponseInnerModelEnum[keyof typeof ListAgentsResponseInnerModelEnum];
3126
+
2881
3127
  /**
2882
3128
  *
2883
3129
  * @export
@@ -3216,6 +3462,25 @@ export interface ListCustomersResponseInnerAllOf {
3216
3462
  */
3217
3463
  '$id': string;
3218
3464
  }
3465
+ /**
3466
+ *
3467
+ * @export
3468
+ * @interface ListFilesResponse
3469
+ */
3470
+ export interface ListFilesResponse {
3471
+ /**
3472
+ *
3473
+ * @type {string}
3474
+ * @memberof ListFilesResponse
3475
+ */
3476
+ 'object': string;
3477
+ /**
3478
+ *
3479
+ * @type {Array<Scout9File>}
3480
+ * @memberof ListFilesResponse
3481
+ */
3482
+ 'data': Array<Scout9File>;
3483
+ }
3219
3484
  /**
3220
3485
  *
3221
3486
  * @export
@@ -3375,13 +3640,60 @@ export interface Message {
3375
3640
  }
3376
3641
 
3377
3642
  export const MessageRoleEnum = {
3378
- User: 'user',
3379
- Assistant: 'assistant',
3380
- System: 'system'
3643
+ Customer: 'customer',
3644
+ Agent: 'agent',
3645
+ Context: 'context'
3381
3646
  } as const;
3382
3647
 
3383
3648
  export type MessageRoleEnum = typeof MessageRoleEnum[keyof typeof MessageRoleEnum];
3384
3649
 
3650
+ /**
3651
+ *
3652
+ * @export
3653
+ * @interface MessageAllOf
3654
+ */
3655
+ export interface MessageAllOf {
3656
+ /**
3657
+ * The time the message was sent
3658
+ * @type {string}
3659
+ * @memberof MessageAllOf
3660
+ */
3661
+ 'time': string;
3662
+ }
3663
+ /**
3664
+ *
3665
+ * @export
3666
+ * @interface MessageBase
3667
+ */
3668
+ export interface MessageBase {
3669
+ /**
3670
+ * The role of the message (customer, agent, or business)
3671
+ * @type {string}
3672
+ * @memberof MessageBase
3673
+ */
3674
+ 'role': MessageBaseRoleEnum;
3675
+ /**
3676
+ * The content of the message
3677
+ * @type {string}
3678
+ * @memberof MessageBase
3679
+ */
3680
+ 'content': string;
3681
+ /**
3682
+ * The name of the sender
3683
+ * @type {string}
3684
+ * @memberof MessageBase
3685
+ */
3686
+ 'name'?: string;
3687
+ }
3688
+
3689
+ export const MessageBaseRoleEnum = {
3690
+ Customer: 'customer',
3691
+ Agent: 'agent',
3692
+ Context: 'context'
3693
+ } as const;
3694
+
3695
+ export type MessageBaseRoleEnum = typeof MessageBaseRoleEnum[keyof typeof MessageBaseRoleEnum];
3696
+
3385
3697
  /**
3386
3698
  *
3387
3699
  * @export
@@ -3486,9 +3798,9 @@ export interface MessageGetResponseInner {
3486
3798
  }
3487
3799
 
3488
3800
  export const MessageGetResponseInnerRoleEnum = {
3489
- User: 'user',
3490
- Assistant: 'assistant',
3491
- System: 'system'
3801
+ Customer: 'customer',
3802
+ Agent: 'agent',
3803
+ Context: 'context'
3492
3804
  } as const;
3493
3805
 
3494
3806
  export type MessageGetResponseInnerRoleEnum = typeof MessageGetResponseInnerRoleEnum[keyof typeof MessageGetResponseInnerRoleEnum];
@@ -3706,7 +4018,7 @@ export interface ScheduleCreateRequest {
3706
4018
  * @type {ConversationUpdateRequestBaseWorkflow}
3707
4019
  * @memberof ScheduleCreateRequest
3708
4020
  */
3709
- '$workflow': ConversationUpdateRequestBaseWorkflow;
4021
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3710
4022
  }
3711
4023
 
3712
4024
 
@@ -3820,7 +4132,25 @@ export interface ScheduleGetResponse {
3820
4132
  * @memberof ScheduleGetResponse
3821
4133
  */
3822
4134
  '$workflow': string;
3823
- }
4135
+ /**
4136
+ * The client web url of the conversation
4137
+ * @type {string}
4138
+ * @memberof ScheduleGetResponse
4139
+ */
4140
+ 'clientWebUrl'?: string;
4141
+ /**
4142
+ * The agent web url of the conversation (requires phone two-factor authentication)
4143
+ * @type {string}
4144
+ * @memberof ScheduleGetResponse
4145
+ */
4146
+ 'agentWebUrl'?: string;
4147
+ /**
4148
+ * The agent test web url of the conversation, used for testing the conversation without notifying the customer
4149
+ * @type {string}
4150
+ * @memberof ScheduleGetResponse
4151
+ */
4152
+ 'agentTestWebUrl'?: string;
4153
+ }
3824
4154
 
3825
4155
 
3826
4156
  /**
@@ -3834,7 +4164,7 @@ export interface ScheduleGroupCreateRequest {
3834
4164
  * @type {ConversationUpdateRequestBaseWorkflow}
3835
4165
  * @memberof ScheduleGroupCreateRequest
3836
4166
  */
3837
- '$workflow': ConversationUpdateRequestBaseWorkflow;
4167
+ '$workflow'?: ConversationUpdateRequestBaseWorkflow;
3838
4168
  /**
3839
4169
  * Default agent assigned to the conversation(s)
3840
4170
  * @type {string}
@@ -4438,24 +4768,97 @@ export interface ScheduledConversationGroupAllOf {
4438
4768
  */
4439
4769
  'delay'?: number;
4440
4770
  }
4771
+ /**
4772
+ * The `File` object represents a document that has been uploaded to Scout9.
4773
+ * @export
4774
+ * @interface Scout9File
4775
+ */
4776
+ export interface Scout9File {
4777
+ /**
4778
+ * The file identifier, which can be referenced in the API endpoints.
4779
+ * @type {string}
4780
+ * @memberof Scout9File
4781
+ */
4782
+ 'id': string;
4783
+ /**
4784
+ * The object type, which is always \"file\".
4785
+ * @type {string}
4786
+ * @memberof Scout9File
4787
+ */
4788
+ 'object': string;
4789
+ /**
4790
+ * The size of the file in bytes.
4791
+ * @type {number}
4792
+ * @memberof Scout9File
4793
+ */
4794
+ 'bytes': number;
4795
+ /**
4796
+ * The unix timestamp for when the file was created.
4797
+ * @type {number}
4798
+ * @memberof Scout9File
4799
+ */
4800
+ 'created_at': number;
4801
+ /**
4802
+ * The name of the file.
4803
+ * @type {string}
4804
+ * @memberof Scout9File
4805
+ */
4806
+ 'filename': string;
4807
+ /**
4808
+ * The intended purpose of the file. Currently, only \"fine-tune\" is supported.
4809
+ * @type {string}
4810
+ * @memberof Scout9File
4811
+ */
4812
+ 'purpose': string;
4813
+ /**
4814
+ * The current status of the file, which can be either `uploaded`, `processed`, `pending`, `error`, `deleting` or `deleted`.
4815
+ * @type {string}
4816
+ * @memberof Scout9File
4817
+ */
4818
+ 'status'?: string;
4819
+ /**
4820
+ * Additional details about the status of the file. If the file is in the `error` state, this will include a message describing the error.
4821
+ * @type {string}
4822
+ * @memberof Scout9File
4823
+ */
4824
+ 'status_details'?: string | null;
4825
+ }
4441
4826
  /**
4442
4827
  *
4443
4828
  * @export
4444
4829
  * @interface UpdateAgentRequest
4445
4830
  */
4446
4831
  export interface UpdateAgentRequest {
4832
+ /**
4833
+ * The ID of the agent to update
4834
+ * @type {string}
4835
+ * @memberof UpdateAgentRequest
4836
+ */
4837
+ '$id': string;
4838
+ /**
4839
+ * Sample conversations that help build out your agent to mimic your responses
4840
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
4841
+ * @memberof UpdateAgentRequest
4842
+ */
4843
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
4844
+ /**
4845
+ * Sample audio files that help build out your agent to mimic your voice
4846
+ * @type {Array<string>}
4847
+ * @memberof UpdateAgentRequest
4848
+ */
4849
+ 'audio'?: Array<string>;
4447
4850
  /**
4448
4851
  * Agent first name
4449
4852
  * @type {string}
4450
4853
  * @memberof UpdateAgentRequest
4451
4854
  */
4452
- 'firstName': string;
4855
+ 'firstName'?: string;
4453
4856
  /**
4454
4857
  * Agent last name
4455
4858
  * @type {string}
4456
4859
  * @memberof UpdateAgentRequest
4457
4860
  */
4458
- 'lastName': string;
4861
+ 'lastName'?: string;
4459
4862
  /**
4460
4863
  * Agent is inactive
4461
4864
  * @type {boolean}
@@ -4491,7 +4894,7 @@ export interface UpdateAgentRequest {
4491
4894
  * @type {string}
4492
4895
  * @memberof UpdateAgentRequest
4493
4896
  */
4494
- 'forwardPhone': string;
4897
+ 'forwardPhone'?: string;
4495
4898
  /**
4496
4899
  * Title of the agent, defaults to \"Agent\"
4497
4900
  * @type {string}
@@ -4511,24 +4914,27 @@ export interface UpdateAgentRequest {
4511
4914
  */
4512
4915
  'includedLocations'?: Array<string>;
4513
4916
  /**
4514
- * Locations id the agent is excluded from
4515
- * @type {Array<string>}
4516
- * @memberof UpdateAgentRequest
4517
- */
4518
- 'excludedLocations'?: Array<string>;
4519
- /**
4520
- * Transcript of the agent
4917
+ * AI Model
4521
4918
  * @type {string}
4522
4919
  * @memberof UpdateAgentRequest
4523
4920
  */
4524
- 'transcript'?: string;
4921
+ 'model'?: UpdateAgentRequestModelEnum;
4525
4922
  /**
4526
- * The ID of the agent to update
4527
- * @type {string}
4923
+ * Locations id the agent is excluded from
4924
+ * @type {Array<string>}
4528
4925
  * @memberof UpdateAgentRequest
4529
4926
  */
4530
- '$id': string;
4927
+ 'excludedLocations'?: Array<string>;
4531
4928
  }
4929
+
4930
+ export const UpdateAgentRequestModelEnum = {
4931
+ PocketScout: 'Pocket Scout',
4932
+ Bard: 'bard',
4933
+ Null: 'null'
4934
+ } as const;
4935
+
4936
+ export type UpdateAgentRequestModelEnum = typeof UpdateAgentRequestModelEnum[keyof typeof UpdateAgentRequestModelEnum];
4937
+
4532
4938
  /**
4533
4939
  *
4534
4940
  * @export
@@ -4541,6 +4947,18 @@ export interface UpdateAgentRequestAllOf {
4541
4947
  * @memberof UpdateAgentRequestAllOf
4542
4948
  */
4543
4949
  '$id': string;
4950
+ /**
4951
+ * Sample conversations that help build out your agent to mimic your responses
4952
+ * @type {Array<CreateAgentRequestAllOfConversationsInner>}
4953
+ * @memberof UpdateAgentRequestAllOf
4954
+ */
4955
+ 'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
4956
+ /**
4957
+ * Sample audio files that help build out your agent to mimic your voice
4958
+ * @type {Array<string>}
4959
+ * @memberof UpdateAgentRequestAllOf
4960
+ */
4961
+ 'audio'?: Array<string>;
4544
4962
  }
4545
4963
  /**
4546
4964
  *
@@ -4633,7 +5051,7 @@ export interface UpdateAgentsRequestAgentsInner {
4633
5051
  * @type {string}
4634
5052
  * @memberof UpdateAgentsRequestAgentsInner
4635
5053
  */
4636
- 'forwardPhone': string;
5054
+ 'forwardPhone'?: string;
4637
5055
  /**
4638
5056
  * Title of the agent, defaults to \"Agent\"
4639
5057
  * @type {string}
@@ -4653,17 +5071,17 @@ export interface UpdateAgentsRequestAgentsInner {
4653
5071
  */
4654
5072
  'includedLocations'?: Array<string>;
4655
5073
  /**
4656
- * Locations id the agent is excluded from
4657
- * @type {Array<string>}
5074
+ * AI Model
5075
+ * @type {string}
4658
5076
  * @memberof UpdateAgentsRequestAgentsInner
4659
5077
  */
4660
- 'excludedLocations'?: Array<string>;
5078
+ 'model'?: UpdateAgentsRequestAgentsInnerModelEnum;
4661
5079
  /**
4662
- * Transcript of the agent
4663
- * @type {string}
5080
+ * Locations id the agent is excluded from
5081
+ * @type {Array<string>}
4664
5082
  * @memberof UpdateAgentsRequestAgentsInner
4665
5083
  */
4666
- 'transcript'?: string;
5084
+ 'excludedLocations'?: Array<string>;
4667
5085
  /**
4668
5086
  * The ID of the agent
4669
5087
  * @type {string}
@@ -4671,6 +5089,15 @@ export interface UpdateAgentsRequestAgentsInner {
4671
5089
  */
4672
5090
  '$id': string;
4673
5091
  }
5092
+
5093
+ export const UpdateAgentsRequestAgentsInnerModelEnum = {
5094
+ PocketScout: 'Pocket Scout',
5095
+ Bard: 'bard',
5096
+ Null: 'null'
5097
+ } as const;
5098
+
5099
+ export type UpdateAgentsRequestAgentsInnerModelEnum = typeof UpdateAgentsRequestAgentsInnerModelEnum[keyof typeof UpdateAgentsRequestAgentsInnerModelEnum];
5100
+
4674
5101
  /**
4675
5102
  *
4676
5103
  * @export
@@ -5326,15 +5753,15 @@ export interface Workflow {
5326
5753
  }
5327
5754
 
5328
5755
  /**
5329
- * Scout9Api - axios parameter creator
5756
+ * PocketScoutApi - axios parameter creator
5330
5757
  * @export
5331
5758
  */
5332
- export const Scout9ApiAxiosParamCreator = function (configuration?: Configuration) {
5759
+ export const PocketScoutApiAxiosParamCreator = function (configuration?: Configuration) {
5333
5760
  return {
5334
5761
  /**
5335
5762
  *
5336
5763
  * @summary Gets a agent
5337
- * @param {string} id
5764
+ * @param {string} id id of entity to query
5338
5765
  * @param {*} [options] Override http request option.
5339
5766
  * @throws {RequiredError}
5340
5767
  */
@@ -5370,14 +5797,14 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5370
5797
  },
5371
5798
  /**
5372
5799
  *
5373
- * @summary Create a new agent
5374
- * @param {CreateAgentRequest} createAgentRequest
5800
+ * @summary Deletes a agent
5801
+ * @param {string} id id of entity to query
5375
5802
  * @param {*} [options] Override http request option.
5376
5803
  * @throws {RequiredError}
5377
5804
  */
5378
- agentCreate: async (createAgentRequest: CreateAgentRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5379
- // verify required parameter 'createAgentRequest' is not null or undefined
5380
- assertParamExists('agentCreate', 'createAgentRequest', createAgentRequest)
5805
+ agentDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5806
+ // verify required parameter 'id' is not null or undefined
5807
+ assertParamExists('agentDelete', 'id', id)
5381
5808
  const localVarPath = `/v1-agent`;
5382
5809
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5383
5810
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5386,18 +5813,19 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5386
5813
  baseOptions = configuration.baseOptions;
5387
5814
  }
5388
5815
 
5389
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
5816
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
5390
5817
  const localVarHeaderParameter = {} as any;
5391
5818
  const localVarQueryParameter = {} as any;
5392
5819
 
5820
+ if (id !== undefined) {
5821
+ localVarQueryParameter['id'] = id;
5822
+ }
5393
5823
 
5394
5824
 
5395
- localVarHeaderParameter['Content-Type'] = 'application/json';
5396
5825
 
5397
5826
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5398
5827
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5399
5828
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
5400
- localVarRequestOptions.data = serializeDataIfNeeded(createAgentRequest, localVarRequestOptions, configuration)
5401
5829
 
5402
5830
  return {
5403
5831
  url: toPathString(localVarUrlObj),
@@ -5406,14 +5834,14 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5406
5834
  },
5407
5835
  /**
5408
5836
  *
5409
- * @summary Deletes a agent
5410
- * @param {string} id
5837
+ * @summary Registers a new agent
5838
+ * @param {CreateAgentRequest} createAgentRequest
5411
5839
  * @param {*} [options] Override http request option.
5412
5840
  * @throws {RequiredError}
5413
5841
  */
5414
- agentDelete: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5415
- // verify required parameter 'id' is not null or undefined
5416
- assertParamExists('agentDelete', 'id', id)
5842
+ agentRegister: async (createAgentRequest: CreateAgentRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
5843
+ // verify required parameter 'createAgentRequest' is not null or undefined
5844
+ assertParamExists('agentRegister', 'createAgentRequest', createAgentRequest)
5417
5845
  const localVarPath = `/v1-agent`;
5418
5846
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5419
5847
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5422,19 +5850,18 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5422
5850
  baseOptions = configuration.baseOptions;
5423
5851
  }
5424
5852
 
5425
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
5853
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
5426
5854
  const localVarHeaderParameter = {} as any;
5427
5855
  const localVarQueryParameter = {} as any;
5428
5856
 
5429
- if (id !== undefined) {
5430
- localVarQueryParameter['id'] = id;
5431
- }
5432
5857
 
5433
5858
 
5859
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5434
5860
 
5435
5861
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5436
5862
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5437
5863
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
5864
+ localVarRequestOptions.data = serializeDataIfNeeded(createAgentRequest, localVarRequestOptions, configuration)
5438
5865
 
5439
5866
  return {
5440
5867
  url: toPathString(localVarUrlObj),
@@ -5481,7 +5908,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5481
5908
  *
5482
5909
  * @summary Gets all or specific set of agents
5483
5910
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5484
- * @param {Array<string>} [id]
5911
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5485
5912
  * @param {*} [options] Override http request option.
5486
5913
  * @throws {RequiredError}
5487
5914
  */
@@ -5556,7 +5983,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5556
5983
  /**
5557
5984
  *
5558
5985
  * @summary Deletes multiple agents
5559
- * @param {Array<string>} [id]
5986
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5560
5987
  * @param {*} [options] Override http request option.
5561
5988
  * @throws {RequiredError}
5562
5989
  */
@@ -5627,7 +6054,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5627
6054
  /**
5628
6055
  *
5629
6056
  * @summary Gets a context
5630
- * @param {string} id
6057
+ * @param {string} id id of entity to query
5631
6058
  * @param {*} [options] Override http request option.
5632
6059
  * @throws {RequiredError}
5633
6060
  */
@@ -5700,7 +6127,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5700
6127
  /**
5701
6128
  *
5702
6129
  * @summary Deletes a schedule
5703
- * @param {string} id
6130
+ * @param {string} id id of entity to query
5704
6131
  * @param {*} [options] Override http request option.
5705
6132
  * @throws {RequiredError}
5706
6133
  */
@@ -5774,7 +6201,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5774
6201
  *
5775
6202
  * @summary Gets all or specific set of contexts
5776
6203
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
5777
- * @param {Array<string>} [id]
6204
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5778
6205
  * @param {*} [options] Override http request option.
5779
6206
  * @throws {RequiredError}
5780
6207
  */
@@ -5849,7 +6276,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5849
6276
  /**
5850
6277
  *
5851
6278
  * @summary Deletes multiple contexts
5852
- * @param {Array<string>} [id]
6279
+ * @param {Array<string>} [id] ids for the entities this id belongs to
5853
6280
  * @param {*} [options] Override http request option.
5854
6281
  * @throws {RequiredError}
5855
6282
  */
@@ -5920,7 +6347,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5920
6347
  /**
5921
6348
  *
5922
6349
  * @summary Gets a conversation
5923
- * @param {string} id
6350
+ * @param {string} id id of entity to query
5924
6351
  * @param {*} [options] Override http request option.
5925
6352
  * @throws {RequiredError}
5926
6353
  */
@@ -5993,7 +6420,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
5993
6420
  /**
5994
6421
  *
5995
6422
  * @summary Deletes a schedule
5996
- * @param {string} id
6423
+ * @param {string} id id of entity to query
5997
6424
  * @param {*} [options] Override http request option.
5998
6425
  * @throws {RequiredError}
5999
6426
  */
@@ -6066,7 +6493,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6066
6493
  /**
6067
6494
  *
6068
6495
  * @summary Gets a customer
6069
- * @param {string} id
6496
+ * @param {string} id id of entity to query
6070
6497
  * @param {*} [options] Override http request option.
6071
6498
  * @throws {RequiredError}
6072
6499
  */
@@ -6139,7 +6566,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6139
6566
  /**
6140
6567
  *
6141
6568
  * @summary Deletes a customer
6142
- * @param {string} id
6569
+ * @param {string} id id of entity to query
6143
6570
  * @param {*} [options] Override http request option.
6144
6571
  * @throws {RequiredError}
6145
6572
  */
@@ -6176,7 +6603,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6176
6603
  /**
6177
6604
  *
6178
6605
  * @summary Gets a customer group
6179
- * @param {string} id
6606
+ * @param {string} id id of entity to query
6180
6607
  * @param {*} [options] Override http request option.
6181
6608
  * @throws {RequiredError}
6182
6609
  */
@@ -6249,7 +6676,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6249
6676
  /**
6250
6677
  *
6251
6678
  * @summary Deletes a customer group
6252
- * @param {string} id
6679
+ * @param {string} id id of entity to query
6253
6680
  * @param {*} [options] Override http request option.
6254
6681
  * @throws {RequiredError}
6255
6682
  */
@@ -6323,7 +6750,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6323
6750
  *
6324
6751
  * @summary Gets all or specific set of customer groups
6325
6752
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6326
- * @param {Array<string>} [id]
6753
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6327
6754
  * @param {*} [options] Override http request option.
6328
6755
  * @throws {RequiredError}
6329
6756
  */
@@ -6398,7 +6825,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6398
6825
  /**
6399
6826
  *
6400
6827
  * @summary Deletes multiple customer groups
6401
- * @param {Array<string>} [id]
6828
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6402
6829
  * @param {*} [options] Override http request option.
6403
6830
  * @throws {RequiredError}
6404
6831
  */
@@ -6506,7 +6933,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6506
6933
  *
6507
6934
  * @summary Gets all or specific set of customers
6508
6935
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6509
- * @param {Array<string>} [id]
6936
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6510
6937
  * @param {*} [options] Override http request option.
6511
6938
  * @throws {RequiredError}
6512
6939
  */
@@ -6581,7 +7008,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6581
7008
  /**
6582
7009
  *
6583
7010
  * @summary Deletes multiple customers
6584
- * @param {Array<string>} [id]
7011
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6585
7012
  * @param {*} [options] Override http request option.
6586
7013
  * @throws {RequiredError}
6587
7014
  */
@@ -6649,6 +7076,184 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6649
7076
  options: localVarRequestOptions,
6650
7077
  };
6651
7078
  },
7079
+ /**
7080
+ *
7081
+ * @summary Returns information about a specific file.
7082
+ * @param {string} fileId The ID of the file to use for this request
7083
+ * @param {*} [options] Override http request option.
7084
+ * @throws {RequiredError}
7085
+ */
7086
+ file: async (fileId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7087
+ // verify required parameter 'fileId' is not null or undefined
7088
+ assertParamExists('file', 'fileId', fileId)
7089
+ const localVarPath = `/files/{file_id}`
7090
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
7091
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7092
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7093
+ let baseOptions;
7094
+ if (configuration) {
7095
+ baseOptions = configuration.baseOptions;
7096
+ }
7097
+
7098
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
7099
+ const localVarHeaderParameter = {} as any;
7100
+ const localVarQueryParameter = {} as any;
7101
+
7102
+
7103
+
7104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7107
+
7108
+ return {
7109
+ url: toPathString(localVarUrlObj),
7110
+ options: localVarRequestOptions,
7111
+ };
7112
+ },
7113
+ /**
7114
+ *
7115
+ * @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.
7116
+ * @param {File} file
7117
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
7118
+ * @param {*} [options] Override http request option.
7119
+ * @throws {RequiredError}
7120
+ */
7121
+ fileCreate: async (file: File | Buffer | Blob, purpose?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7122
+ // verify required parameter 'file' is not null or undefined
7123
+ assertParamExists('fileCreate', 'file', file)
7124
+ const localVarPath = `/v1-utils-files`;
7125
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7126
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7127
+ let baseOptions;
7128
+ if (configuration) {
7129
+ baseOptions = configuration.baseOptions;
7130
+ }
7131
+
7132
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
7133
+ const localVarHeaderParameter = {} as any;
7134
+ const localVarQueryParameter = {} as any;
7135
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
7136
+
7137
+
7138
+ if (file !== undefined) {
7139
+ localVarFormParams.append('file', file as any);
7140
+ }
7141
+
7142
+ if (purpose !== undefined) {
7143
+ localVarFormParams.append('purpose', purpose as any);
7144
+ }
7145
+
7146
+
7147
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
7148
+
7149
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7150
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7151
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7152
+ localVarRequestOptions.data = localVarFormParams;
7153
+
7154
+ return {
7155
+ url: toPathString(localVarUrlObj),
7156
+ options: localVarRequestOptions,
7157
+ };
7158
+ },
7159
+ /**
7160
+ *
7161
+ * @summary Delete a file.
7162
+ * @param {string} fileId The ID of the file to use for this request
7163
+ * @param {*} [options] Override http request option.
7164
+ * @throws {RequiredError}
7165
+ */
7166
+ fileDelete: async (fileId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7167
+ // verify required parameter 'fileId' is not null or undefined
7168
+ assertParamExists('fileDelete', 'fileId', fileId)
7169
+ const localVarPath = `/files/{file_id}`
7170
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
7171
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7172
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7173
+ let baseOptions;
7174
+ if (configuration) {
7175
+ baseOptions = configuration.baseOptions;
7176
+ }
7177
+
7178
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
7179
+ const localVarHeaderParameter = {} as any;
7180
+ const localVarQueryParameter = {} as any;
7181
+
7182
+
7183
+
7184
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7185
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7186
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7187
+
7188
+ return {
7189
+ url: toPathString(localVarUrlObj),
7190
+ options: localVarRequestOptions,
7191
+ };
7192
+ },
7193
+ /**
7194
+ *
7195
+ * @summary Returns the contents of the specified file
7196
+ * @param {string} fileId The ID of the file to use for this request
7197
+ * @param {*} [options] Override http request option.
7198
+ * @throws {RequiredError}
7199
+ */
7200
+ fileDownload: async (fileId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7201
+ // verify required parameter 'fileId' is not null or undefined
7202
+ assertParamExists('fileDownload', 'fileId', fileId)
7203
+ const localVarPath = `/files/{file_id}/content`
7204
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
7205
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7206
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7207
+ let baseOptions;
7208
+ if (configuration) {
7209
+ baseOptions = configuration.baseOptions;
7210
+ }
7211
+
7212
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
7213
+ const localVarHeaderParameter = {} as any;
7214
+ const localVarQueryParameter = {} as any;
7215
+
7216
+
7217
+
7218
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7219
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7220
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7221
+
7222
+ return {
7223
+ url: toPathString(localVarUrlObj),
7224
+ options: localVarRequestOptions,
7225
+ };
7226
+ },
7227
+ /**
7228
+ *
7229
+ * @summary Returns a list of files that belong to the user\'s organization.
7230
+ * @param {*} [options] Override http request option.
7231
+ * @throws {RequiredError}
7232
+ */
7233
+ files: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7234
+ const localVarPath = `/v1-utils-files`;
7235
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7236
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7237
+ let baseOptions;
7238
+ if (configuration) {
7239
+ baseOptions = configuration.baseOptions;
7240
+ }
7241
+
7242
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
7243
+ const localVarHeaderParameter = {} as any;
7244
+ const localVarQueryParameter = {} as any;
7245
+
7246
+
7247
+
7248
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7249
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7250
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7251
+
7252
+ return {
7253
+ url: toPathString(localVarUrlObj),
7254
+ options: localVarRequestOptions,
7255
+ };
7256
+ },
6652
7257
  /**
6653
7258
  * 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.
6654
7259
  * @summary Generate a message from conversation
@@ -6724,12 +7329,14 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6724
7329
  /**
6725
7330
  *
6726
7331
  * @summary Get all messages from a conversation
7332
+ * @param {string} id id of entity to query
6727
7333
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6728
- * @param {Array<string>} [id]
6729
7334
  * @param {*} [options] Override http request option.
6730
7335
  * @throws {RequiredError}
6731
7336
  */
6732
- messages: async (q?: string, id?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7337
+ messages: async (id: string, q?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7338
+ // verify required parameter 'id' is not null or undefined
7339
+ assertParamExists('messages', 'id', id)
6733
7340
  const localVarPath = `/v1-messages`;
6734
7341
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6735
7342
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -6742,12 +7349,12 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6742
7349
  const localVarHeaderParameter = {} as any;
6743
7350
  const localVarQueryParameter = {} as any;
6744
7351
 
6745
- if (q !== undefined) {
6746
- localVarQueryParameter['q'] = q;
7352
+ if (id !== undefined) {
7353
+ localVarQueryParameter['id'] = id;
6747
7354
  }
6748
7355
 
6749
- if (id) {
6750
- localVarQueryParameter['id'] = id;
7356
+ if (q !== undefined) {
7357
+ localVarQueryParameter['q'] = q;
6751
7358
  }
6752
7359
 
6753
7360
 
@@ -6764,7 +7371,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6764
7371
  /**
6765
7372
  *
6766
7373
  * @summary Get the results of a bulk API operation
6767
- * @param {string} id
7374
+ * @param {string} id id of entity to query
6768
7375
  * @param {*} [options] Override http request option.
6769
7376
  * @throws {RequiredError}
6770
7377
  */
@@ -6802,7 +7409,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6802
7409
  *
6803
7410
  * @summary Gets all or specific set of bulk API operations
6804
7411
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
6805
- * @param {Array<string>} [id]
7412
+ * @param {Array<string>} [id] ids for the entities this id belongs to
6806
7413
  * @param {*} [options] Override http request option.
6807
7414
  * @throws {RequiredError}
6808
7415
  */
@@ -6845,9 +7452,9 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6845
7452
  * @param {*} [options] Override http request option.
6846
7453
  * @throws {RequiredError}
6847
7454
  */
6848
- scheduleCreate: async (scheduleCreateRequest: ScheduleCreateRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
7455
+ scheduleConversation: async (scheduleCreateRequest: ScheduleCreateRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
6849
7456
  // verify required parameter 'scheduleCreateRequest' is not null or undefined
6850
- assertParamExists('scheduleCreate', 'scheduleCreateRequest', scheduleCreateRequest)
7457
+ assertParamExists('scheduleConversation', 'scheduleCreateRequest', scheduleCreateRequest)
6851
7458
  const localVarPath = `/v1-schedule`;
6852
7459
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6853
7460
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -6877,7 +7484,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6877
7484
  /**
6878
7485
  *
6879
7486
  * @summary Deletes a schedule
6880
- * @param {string} id
7487
+ * @param {string} id id of entity to query
6881
7488
  * @param {*} [options] Override http request option.
6882
7489
  * @throws {RequiredError}
6883
7490
  */
@@ -6950,7 +7557,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6950
7557
  /**
6951
7558
  *
6952
7559
  * @summary Deletes and cancels a schedule group
6953
- * @param {string} id
7560
+ * @param {string} id id of entity to query
6954
7561
  * @param {*} [options] Override http request option.
6955
7562
  * @throws {RequiredError}
6956
7563
  */
@@ -6987,7 +7594,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
6987
7594
  /**
6988
7595
  *
6989
7596
  * @summary Gets a schedule group
6990
- * @param {string} id
7597
+ * @param {string} id id of entity to query
6991
7598
  * @param {*} [options] Override http request option.
6992
7599
  * @throws {RequiredError}
6993
7600
  */
@@ -7060,7 +7667,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7060
7667
  /**
7061
7668
  *
7062
7669
  * @summary Gets a schedule
7063
- * @param {string} id
7670
+ * @param {string} id id of entity to query
7064
7671
  * @param {*} [options] Override http request option.
7065
7672
  * @throws {RequiredError}
7066
7673
  */
@@ -7133,7 +7740,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7133
7740
  /**
7134
7741
  *
7135
7742
  * @summary Gets a workflow
7136
- * @param {string} id
7743
+ * @param {string} id id of entity to query
7137
7744
  * @param {*} [options] Override http request option.
7138
7745
  * @throws {RequiredError}
7139
7746
  */
@@ -7206,7 +7813,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7206
7813
  /**
7207
7814
  *
7208
7815
  * @summary Deletes a workflow
7209
- * @param {string} id
7816
+ * @param {string} id id of entity to query
7210
7817
  * @param {*} [options] Override http request option.
7211
7818
  * @throws {RequiredError}
7212
7819
  */
@@ -7280,7 +7887,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7280
7887
  *
7281
7888
  * @summary Gets all or specific set of workflows
7282
7889
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7283
- * @param {Array<string>} [id]
7890
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7284
7891
  * @param {*} [options] Override http request option.
7285
7892
  * @throws {RequiredError}
7286
7893
  */
@@ -7355,7 +7962,7 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7355
7962
  /**
7356
7963
  *
7357
7964
  * @summary Deletes multiple workflows
7358
- * @param {Array<string>} [id]
7965
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7359
7966
  * @param {*} [options] Override http request option.
7360
7967
  * @throws {RequiredError}
7361
7968
  */
@@ -7427,16 +8034,16 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
7427
8034
  };
7428
8035
 
7429
8036
  /**
7430
- * Scout9Api - functional programming interface
8037
+ * PocketScoutApi - functional programming interface
7431
8038
  * @export
7432
8039
  */
7433
- export const Scout9ApiFp = function(configuration?: Configuration) {
7434
- const localVarAxiosParamCreator = Scout9ApiAxiosParamCreator(configuration)
8040
+ export const PocketScoutApiFp = function(configuration?: Configuration) {
8041
+ const localVarAxiosParamCreator = PocketScoutApiAxiosParamCreator(configuration)
7435
8042
  return {
7436
8043
  /**
7437
8044
  *
7438
8045
  * @summary Gets a agent
7439
- * @param {string} id
8046
+ * @param {string} id id of entity to query
7440
8047
  * @param {*} [options] Override http request option.
7441
8048
  * @throws {RequiredError}
7442
8049
  */
@@ -7446,24 +8053,24 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7446
8053
  },
7447
8054
  /**
7448
8055
  *
7449
- * @summary Create a new agent
7450
- * @param {CreateAgentRequest} createAgentRequest
8056
+ * @summary Deletes a agent
8057
+ * @param {string} id id of entity to query
7451
8058
  * @param {*} [options] Override http request option.
7452
8059
  * @throws {RequiredError}
7453
8060
  */
7454
- async agentCreate(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAgentResponse>> {
7455
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentCreate(createAgentRequest, options);
8061
+ async agentDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAgentResponse>> {
8062
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
7456
8063
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7457
8064
  },
7458
8065
  /**
7459
8066
  *
7460
- * @summary Deletes a agent
7461
- * @param {string} id
8067
+ * @summary Registers a new agent
8068
+ * @param {CreateAgentRequest} createAgentRequest
7462
8069
  * @param {*} [options] Override http request option.
7463
8070
  * @throws {RequiredError}
7464
8071
  */
7465
- async agentDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAgentResponse>> {
7466
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
8072
+ async agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAgentResponse>> {
8073
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentRegister(createAgentRequest, options);
7467
8074
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7468
8075
  },
7469
8076
  /**
@@ -7481,7 +8088,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7481
8088
  *
7482
8089
  * @summary Gets all or specific set of agents
7483
8090
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7484
- * @param {Array<string>} [id]
8091
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7485
8092
  * @param {*} [options] Override http request option.
7486
8093
  * @throws {RequiredError}
7487
8094
  */
@@ -7503,7 +8110,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7503
8110
  /**
7504
8111
  *
7505
8112
  * @summary Deletes multiple agents
7506
- * @param {Array<string>} [id]
8113
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7507
8114
  * @param {*} [options] Override http request option.
7508
8115
  * @throws {RequiredError}
7509
8116
  */
@@ -7525,7 +8132,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7525
8132
  /**
7526
8133
  *
7527
8134
  * @summary Gets a context
7528
- * @param {string} id
8135
+ * @param {string} id id of entity to query
7529
8136
  * @param {*} [options] Override http request option.
7530
8137
  * @throws {RequiredError}
7531
8138
  */
@@ -7547,7 +8154,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7547
8154
  /**
7548
8155
  *
7549
8156
  * @summary Deletes a schedule
7550
- * @param {string} id
8157
+ * @param {string} id id of entity to query
7551
8158
  * @param {*} [options] Override http request option.
7552
8159
  * @throws {RequiredError}
7553
8160
  */
@@ -7570,7 +8177,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7570
8177
  *
7571
8178
  * @summary Gets all or specific set of contexts
7572
8179
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7573
- * @param {Array<string>} [id]
8180
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7574
8181
  * @param {*} [options] Override http request option.
7575
8182
  * @throws {RequiredError}
7576
8183
  */
@@ -7592,7 +8199,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7592
8199
  /**
7593
8200
  *
7594
8201
  * @summary Deletes multiple contexts
7595
- * @param {Array<string>} [id]
8202
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7596
8203
  * @param {*} [options] Override http request option.
7597
8204
  * @throws {RequiredError}
7598
8205
  */
@@ -7614,7 +8221,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7614
8221
  /**
7615
8222
  *
7616
8223
  * @summary Gets a conversation
7617
- * @param {string} id
8224
+ * @param {string} id id of entity to query
7618
8225
  * @param {*} [options] Override http request option.
7619
8226
  * @throws {RequiredError}
7620
8227
  */
@@ -7636,7 +8243,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7636
8243
  /**
7637
8244
  *
7638
8245
  * @summary Deletes a schedule
7639
- * @param {string} id
8246
+ * @param {string} id id of entity to query
7640
8247
  * @param {*} [options] Override http request option.
7641
8248
  * @throws {RequiredError}
7642
8249
  */
@@ -7658,7 +8265,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7658
8265
  /**
7659
8266
  *
7660
8267
  * @summary Gets a customer
7661
- * @param {string} id
8268
+ * @param {string} id id of entity to query
7662
8269
  * @param {*} [options] Override http request option.
7663
8270
  * @throws {RequiredError}
7664
8271
  */
@@ -7680,7 +8287,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7680
8287
  /**
7681
8288
  *
7682
8289
  * @summary Deletes a customer
7683
- * @param {string} id
8290
+ * @param {string} id id of entity to query
7684
8291
  * @param {*} [options] Override http request option.
7685
8292
  * @throws {RequiredError}
7686
8293
  */
@@ -7691,7 +8298,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7691
8298
  /**
7692
8299
  *
7693
8300
  * @summary Gets a customer group
7694
- * @param {string} id
8301
+ * @param {string} id id of entity to query
7695
8302
  * @param {*} [options] Override http request option.
7696
8303
  * @throws {RequiredError}
7697
8304
  */
@@ -7713,7 +8320,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7713
8320
  /**
7714
8321
  *
7715
8322
  * @summary Deletes a customer group
7716
- * @param {string} id
8323
+ * @param {string} id id of entity to query
7717
8324
  * @param {*} [options] Override http request option.
7718
8325
  * @throws {RequiredError}
7719
8326
  */
@@ -7736,7 +8343,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7736
8343
  *
7737
8344
  * @summary Gets all or specific set of customer groups
7738
8345
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7739
- * @param {Array<string>} [id]
8346
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7740
8347
  * @param {*} [options] Override http request option.
7741
8348
  * @throws {RequiredError}
7742
8349
  */
@@ -7758,7 +8365,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7758
8365
  /**
7759
8366
  *
7760
8367
  * @summary Deletes multiple customer groups
7761
- * @param {Array<string>} [id]
8368
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7762
8369
  * @param {*} [options] Override http request option.
7763
8370
  * @throws {RequiredError}
7764
8371
  */
@@ -7792,7 +8399,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7792
8399
  *
7793
8400
  * @summary Gets all or specific set of customers
7794
8401
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7795
- * @param {Array<string>} [id]
8402
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7796
8403
  * @param {*} [options] Override http request option.
7797
8404
  * @throws {RequiredError}
7798
8405
  */
@@ -7814,7 +8421,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7814
8421
  /**
7815
8422
  *
7816
8423
  * @summary Deletes multiple customers
7817
- * @param {Array<string>} [id]
8424
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7818
8425
  * @param {*} [options] Override http request option.
7819
8426
  * @throws {RequiredError}
7820
8427
  */
@@ -7833,6 +8440,61 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7833
8440
  const localVarAxiosArgs = await localVarAxiosParamCreator.customersUpdate(updateCustomerRequest, options);
7834
8441
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7835
8442
  },
8443
+ /**
8444
+ *
8445
+ * @summary Returns information about a specific file.
8446
+ * @param {string} fileId The ID of the file to use for this request
8447
+ * @param {*} [options] Override http request option.
8448
+ * @throws {RequiredError}
8449
+ */
8450
+ async file(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>> {
8451
+ const localVarAxiosArgs = await localVarAxiosParamCreator.file(fileId, options);
8452
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8453
+ },
8454
+ /**
8455
+ *
8456
+ * @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.
8457
+ * @param {File} file
8458
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
8459
+ * @param {*} [options] Override http request option.
8460
+ * @throws {RequiredError}
8461
+ */
8462
+ async fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>> {
8463
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileCreate(file, purpose, options);
8464
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8465
+ },
8466
+ /**
8467
+ *
8468
+ * @summary Delete a file.
8469
+ * @param {string} fileId The ID of the file to use for this request
8470
+ * @param {*} [options] Override http request option.
8471
+ * @throws {RequiredError}
8472
+ */
8473
+ async fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFileResponse>> {
8474
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileDelete(fileId, options);
8475
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8476
+ },
8477
+ /**
8478
+ *
8479
+ * @summary Returns the contents of the specified file
8480
+ * @param {string} fileId The ID of the file to use for this request
8481
+ * @param {*} [options] Override http request option.
8482
+ * @throws {RequiredError}
8483
+ */
8484
+ async fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
8485
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileDownload(fileId, options);
8486
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8487
+ },
8488
+ /**
8489
+ *
8490
+ * @summary Returns a list of files that belong to the user\'s organization.
8491
+ * @param {*} [options] Override http request option.
8492
+ * @throws {RequiredError}
8493
+ */
8494
+ async files(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>> {
8495
+ const localVarAxiosArgs = await localVarAxiosParamCreator.files(options);
8496
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
8497
+ },
7836
8498
  /**
7837
8499
  * 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.
7838
8500
  * @summary Generate a message from conversation
@@ -7858,19 +8520,19 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7858
8520
  /**
7859
8521
  *
7860
8522
  * @summary Get all messages from a conversation
8523
+ * @param {string} id id of entity to query
7861
8524
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7862
- * @param {Array<string>} [id]
7863
8525
  * @param {*} [options] Override http request option.
7864
8526
  * @throws {RequiredError}
7865
8527
  */
7866
- async messages(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageGetResponseInner>>> {
7867
- const localVarAxiosArgs = await localVarAxiosParamCreator.messages(q, id, options);
8528
+ async messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageGetResponseInner>>> {
8529
+ const localVarAxiosArgs = await localVarAxiosParamCreator.messages(id, q, options);
7868
8530
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7869
8531
  },
7870
8532
  /**
7871
8533
  *
7872
8534
  * @summary Get the results of a bulk API operation
7873
- * @param {string} id
8535
+ * @param {string} id id of entity to query
7874
8536
  * @param {*} [options] Override http request option.
7875
8537
  * @throws {RequiredError}
7876
8538
  */
@@ -7882,7 +8544,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7882
8544
  *
7883
8545
  * @summary Gets all or specific set of bulk API operations
7884
8546
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
7885
- * @param {Array<string>} [id]
8547
+ * @param {Array<string>} [id] ids for the entities this id belongs to
7886
8548
  * @param {*} [options] Override http request option.
7887
8549
  * @throws {RequiredError}
7888
8550
  */
@@ -7897,14 +8559,14 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7897
8559
  * @param {*} [options] Override http request option.
7898
8560
  * @throws {RequiredError}
7899
8561
  */
7900
- async scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleCreateResponse>> {
7901
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleCreate(scheduleCreateRequest, options);
8562
+ async scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleCreateResponse>> {
8563
+ const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleConversation(scheduleCreateRequest, options);
7902
8564
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
7903
8565
  },
7904
8566
  /**
7905
8567
  *
7906
8568
  * @summary Deletes a schedule
7907
- * @param {string} id
8569
+ * @param {string} id id of entity to query
7908
8570
  * @param {*} [options] Override http request option.
7909
8571
  * @throws {RequiredError}
7910
8572
  */
@@ -7926,7 +8588,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7926
8588
  /**
7927
8589
  *
7928
8590
  * @summary Deletes and cancels a schedule group
7929
- * @param {string} id
8591
+ * @param {string} id id of entity to query
7930
8592
  * @param {*} [options] Override http request option.
7931
8593
  * @throws {RequiredError}
7932
8594
  */
@@ -7937,7 +8599,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7937
8599
  /**
7938
8600
  *
7939
8601
  * @summary Gets a schedule group
7940
- * @param {string} id
8602
+ * @param {string} id id of entity to query
7941
8603
  * @param {*} [options] Override http request option.
7942
8604
  * @throws {RequiredError}
7943
8605
  */
@@ -7959,7 +8621,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7959
8621
  /**
7960
8622
  *
7961
8623
  * @summary Gets a schedule
7962
- * @param {string} id
8624
+ * @param {string} id id of entity to query
7963
8625
  * @param {*} [options] Override http request option.
7964
8626
  * @throws {RequiredError}
7965
8627
  */
@@ -7981,7 +8643,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
7981
8643
  /**
7982
8644
  *
7983
8645
  * @summary Gets a workflow
7984
- * @param {string} id
8646
+ * @param {string} id id of entity to query
7985
8647
  * @param {*} [options] Override http request option.
7986
8648
  * @throws {RequiredError}
7987
8649
  */
@@ -8003,7 +8665,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
8003
8665
  /**
8004
8666
  *
8005
8667
  * @summary Deletes a workflow
8006
- * @param {string} id
8668
+ * @param {string} id id of entity to query
8007
8669
  * @param {*} [options] Override http request option.
8008
8670
  * @throws {RequiredError}
8009
8671
  */
@@ -8026,7 +8688,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
8026
8688
  *
8027
8689
  * @summary Gets all or specific set of workflows
8028
8690
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8029
- * @param {Array<string>} [id]
8691
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8030
8692
  * @param {*} [options] Override http request option.
8031
8693
  * @throws {RequiredError}
8032
8694
  */
@@ -8048,7 +8710,7 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
8048
8710
  /**
8049
8711
  *
8050
8712
  * @summary Deletes multiple workflows
8051
- * @param {Array<string>} [id]
8713
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8052
8714
  * @param {*} [options] Override http request option.
8053
8715
  * @throws {RequiredError}
8054
8716
  */
@@ -8071,16 +8733,16 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
8071
8733
  };
8072
8734
 
8073
8735
  /**
8074
- * Scout9Api - factory interface
8736
+ * PocketScoutApi - factory interface
8075
8737
  * @export
8076
8738
  */
8077
- export const Scout9ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8078
- const localVarFp = Scout9ApiFp(configuration)
8739
+ export const PocketScoutApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
8740
+ const localVarFp = PocketScoutApiFp(configuration)
8079
8741
  return {
8080
8742
  /**
8081
8743
  *
8082
8744
  * @summary Gets a agent
8083
- * @param {string} id
8745
+ * @param {string} id id of entity to query
8084
8746
  * @param {*} [options] Override http request option.
8085
8747
  * @throws {RequiredError}
8086
8748
  */
@@ -8089,23 +8751,23 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8089
8751
  },
8090
8752
  /**
8091
8753
  *
8092
- * @summary Create a new agent
8093
- * @param {CreateAgentRequest} createAgentRequest
8754
+ * @summary Deletes a agent
8755
+ * @param {string} id id of entity to query
8094
8756
  * @param {*} [options] Override http request option.
8095
8757
  * @throws {RequiredError}
8096
8758
  */
8097
- agentCreate(createAgentRequest: CreateAgentRequest, options?: any): AxiosPromise<CreateAgentResponse> {
8098
- return localVarFp.agentCreate(createAgentRequest, options).then((request) => request(axios, basePath));
8759
+ agentDelete(id: string, options?: any): AxiosPromise<DeleteAgentResponse> {
8760
+ return localVarFp.agentDelete(id, options).then((request) => request(axios, basePath));
8099
8761
  },
8100
8762
  /**
8101
8763
  *
8102
- * @summary Deletes a agent
8103
- * @param {string} id
8764
+ * @summary Registers a new agent
8765
+ * @param {CreateAgentRequest} createAgentRequest
8104
8766
  * @param {*} [options] Override http request option.
8105
8767
  * @throws {RequiredError}
8106
8768
  */
8107
- agentDelete(id: string, options?: any): AxiosPromise<DeleteAgentResponse> {
8108
- return localVarFp.agentDelete(id, options).then((request) => request(axios, basePath));
8769
+ agentRegister(createAgentRequest: CreateAgentRequest, options?: any): AxiosPromise<CreateAgentResponse> {
8770
+ return localVarFp.agentRegister(createAgentRequest, options).then((request) => request(axios, basePath));
8109
8771
  },
8110
8772
  /**
8111
8773
  *
@@ -8121,7 +8783,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8121
8783
  *
8122
8784
  * @summary Gets all or specific set of agents
8123
8785
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8124
- * @param {Array<string>} [id]
8786
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8125
8787
  * @param {*} [options] Override http request option.
8126
8788
  * @throws {RequiredError}
8127
8789
  */
@@ -8141,7 +8803,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8141
8803
  /**
8142
8804
  *
8143
8805
  * @summary Deletes multiple agents
8144
- * @param {Array<string>} [id]
8806
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8145
8807
  * @param {*} [options] Override http request option.
8146
8808
  * @throws {RequiredError}
8147
8809
  */
@@ -8161,7 +8823,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8161
8823
  /**
8162
8824
  *
8163
8825
  * @summary Gets a context
8164
- * @param {string} id
8826
+ * @param {string} id id of entity to query
8165
8827
  * @param {*} [options] Override http request option.
8166
8828
  * @throws {RequiredError}
8167
8829
  */
@@ -8181,7 +8843,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8181
8843
  /**
8182
8844
  *
8183
8845
  * @summary Deletes a schedule
8184
- * @param {string} id
8846
+ * @param {string} id id of entity to query
8185
8847
  * @param {*} [options] Override http request option.
8186
8848
  * @throws {RequiredError}
8187
8849
  */
@@ -8202,7 +8864,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8202
8864
  *
8203
8865
  * @summary Gets all or specific set of contexts
8204
8866
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8205
- * @param {Array<string>} [id]
8867
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8206
8868
  * @param {*} [options] Override http request option.
8207
8869
  * @throws {RequiredError}
8208
8870
  */
@@ -8222,7 +8884,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8222
8884
  /**
8223
8885
  *
8224
8886
  * @summary Deletes multiple contexts
8225
- * @param {Array<string>} [id]
8887
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8226
8888
  * @param {*} [options] Override http request option.
8227
8889
  * @throws {RequiredError}
8228
8890
  */
@@ -8242,7 +8904,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8242
8904
  /**
8243
8905
  *
8244
8906
  * @summary Gets a conversation
8245
- * @param {string} id
8907
+ * @param {string} id id of entity to query
8246
8908
  * @param {*} [options] Override http request option.
8247
8909
  * @throws {RequiredError}
8248
8910
  */
@@ -8262,7 +8924,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8262
8924
  /**
8263
8925
  *
8264
8926
  * @summary Deletes a schedule
8265
- * @param {string} id
8927
+ * @param {string} id id of entity to query
8266
8928
  * @param {*} [options] Override http request option.
8267
8929
  * @throws {RequiredError}
8268
8930
  */
@@ -8282,7 +8944,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8282
8944
  /**
8283
8945
  *
8284
8946
  * @summary Gets a customer
8285
- * @param {string} id
8947
+ * @param {string} id id of entity to query
8286
8948
  * @param {*} [options] Override http request option.
8287
8949
  * @throws {RequiredError}
8288
8950
  */
@@ -8302,7 +8964,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8302
8964
  /**
8303
8965
  *
8304
8966
  * @summary Deletes a customer
8305
- * @param {string} id
8967
+ * @param {string} id id of entity to query
8306
8968
  * @param {*} [options] Override http request option.
8307
8969
  * @throws {RequiredError}
8308
8970
  */
@@ -8312,7 +8974,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8312
8974
  /**
8313
8975
  *
8314
8976
  * @summary Gets a customer group
8315
- * @param {string} id
8977
+ * @param {string} id id of entity to query
8316
8978
  * @param {*} [options] Override http request option.
8317
8979
  * @throws {RequiredError}
8318
8980
  */
@@ -8332,7 +8994,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8332
8994
  /**
8333
8995
  *
8334
8996
  * @summary Deletes a customer group
8335
- * @param {string} id
8997
+ * @param {string} id id of entity to query
8336
8998
  * @param {*} [options] Override http request option.
8337
8999
  * @throws {RequiredError}
8338
9000
  */
@@ -8353,7 +9015,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8353
9015
  *
8354
9016
  * @summary Gets all or specific set of customer groups
8355
9017
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8356
- * @param {Array<string>} [id]
9018
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8357
9019
  * @param {*} [options] Override http request option.
8358
9020
  * @throws {RequiredError}
8359
9021
  */
@@ -8373,7 +9035,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8373
9035
  /**
8374
9036
  *
8375
9037
  * @summary Deletes multiple customer groups
8376
- * @param {Array<string>} [id]
9038
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8377
9039
  * @param {*} [options] Override http request option.
8378
9040
  * @throws {RequiredError}
8379
9041
  */
@@ -8404,7 +9066,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8404
9066
  *
8405
9067
  * @summary Gets all or specific set of customers
8406
9068
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8407
- * @param {Array<string>} [id]
9069
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8408
9070
  * @param {*} [options] Override http request option.
8409
9071
  * @throws {RequiredError}
8410
9072
  */
@@ -8424,7 +9086,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8424
9086
  /**
8425
9087
  *
8426
9088
  * @summary Deletes multiple customers
8427
- * @param {Array<string>} [id]
9089
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8428
9090
  * @param {*} [options] Override http request option.
8429
9091
  * @throws {RequiredError}
8430
9092
  */
@@ -8441,6 +9103,56 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8441
9103
  customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: any): AxiosPromise<UpdateCustomersResponse> {
8442
9104
  return localVarFp.customersUpdate(updateCustomerRequest, options).then((request) => request(axios, basePath));
8443
9105
  },
9106
+ /**
9107
+ *
9108
+ * @summary Returns information about a specific file.
9109
+ * @param {string} fileId The ID of the file to use for this request
9110
+ * @param {*} [options] Override http request option.
9111
+ * @throws {RequiredError}
9112
+ */
9113
+ file(fileId: string, options?: any): AxiosPromise<Scout9File> {
9114
+ return localVarFp.file(fileId, options).then((request) => request(axios, basePath));
9115
+ },
9116
+ /**
9117
+ *
9118
+ * @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.
9119
+ * @param {File} file
9120
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
9121
+ * @param {*} [options] Override http request option.
9122
+ * @throws {RequiredError}
9123
+ */
9124
+ fileCreate(file: File | Buffer | Blob, purpose?: string, options?: any): AxiosPromise<Scout9File> {
9125
+ return localVarFp.fileCreate(file, purpose, options).then((request) => request(axios, basePath));
9126
+ },
9127
+ /**
9128
+ *
9129
+ * @summary Delete a file.
9130
+ * @param {string} fileId The ID of the file to use for this request
9131
+ * @param {*} [options] Override http request option.
9132
+ * @throws {RequiredError}
9133
+ */
9134
+ fileDelete(fileId: string, options?: any): AxiosPromise<DeleteFileResponse> {
9135
+ return localVarFp.fileDelete(fileId, options).then((request) => request(axios, basePath));
9136
+ },
9137
+ /**
9138
+ *
9139
+ * @summary Returns the contents of the specified file
9140
+ * @param {string} fileId The ID of the file to use for this request
9141
+ * @param {*} [options] Override http request option.
9142
+ * @throws {RequiredError}
9143
+ */
9144
+ fileDownload(fileId: string, options?: any): AxiosPromise<string> {
9145
+ return localVarFp.fileDownload(fileId, options).then((request) => request(axios, basePath));
9146
+ },
9147
+ /**
9148
+ *
9149
+ * @summary Returns a list of files that belong to the user\'s organization.
9150
+ * @param {*} [options] Override http request option.
9151
+ * @throws {RequiredError}
9152
+ */
9153
+ files(options?: any): AxiosPromise<ListFilesResponse> {
9154
+ return localVarFp.files(options).then((request) => request(axios, basePath));
9155
+ },
8444
9156
  /**
8445
9157
  * 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.
8446
9158
  * @summary Generate a message from conversation
@@ -8464,18 +9176,18 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8464
9176
  /**
8465
9177
  *
8466
9178
  * @summary Get all messages from a conversation
9179
+ * @param {string} id id of entity to query
8467
9180
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8468
- * @param {Array<string>} [id]
8469
9181
  * @param {*} [options] Override http request option.
8470
9182
  * @throws {RequiredError}
8471
9183
  */
8472
- messages(q?: string, id?: Array<string>, options?: any): AxiosPromise<Array<MessageGetResponseInner>> {
8473
- return localVarFp.messages(q, id, options).then((request) => request(axios, basePath));
9184
+ messages(id: string, q?: string, options?: any): AxiosPromise<Array<MessageGetResponseInner>> {
9185
+ return localVarFp.messages(id, q, options).then((request) => request(axios, basePath));
8474
9186
  },
8475
9187
  /**
8476
9188
  *
8477
9189
  * @summary Get the results of a bulk API operation
8478
- * @param {string} id
9190
+ * @param {string} id id of entity to query
8479
9191
  * @param {*} [options] Override http request option.
8480
9192
  * @throws {RequiredError}
8481
9193
  */
@@ -8486,7 +9198,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8486
9198
  *
8487
9199
  * @summary Gets all or specific set of bulk API operations
8488
9200
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8489
- * @param {Array<string>} [id]
9201
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8490
9202
  * @param {*} [options] Override http request option.
8491
9203
  * @throws {RequiredError}
8492
9204
  */
@@ -8500,13 +9212,13 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8500
9212
  * @param {*} [options] Override http request option.
8501
9213
  * @throws {RequiredError}
8502
9214
  */
8503
- scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: any): AxiosPromise<ScheduleCreateResponse> {
8504
- return localVarFp.scheduleCreate(scheduleCreateRequest, options).then((request) => request(axios, basePath));
9215
+ scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: any): AxiosPromise<ScheduleCreateResponse> {
9216
+ return localVarFp.scheduleConversation(scheduleCreateRequest, options).then((request) => request(axios, basePath));
8505
9217
  },
8506
9218
  /**
8507
9219
  *
8508
9220
  * @summary Deletes a schedule
8509
- * @param {string} id
9221
+ * @param {string} id id of entity to query
8510
9222
  * @param {*} [options] Override http request option.
8511
9223
  * @throws {RequiredError}
8512
9224
  */
@@ -8526,7 +9238,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8526
9238
  /**
8527
9239
  *
8528
9240
  * @summary Deletes and cancels a schedule group
8529
- * @param {string} id
9241
+ * @param {string} id id of entity to query
8530
9242
  * @param {*} [options] Override http request option.
8531
9243
  * @throws {RequiredError}
8532
9244
  */
@@ -8536,7 +9248,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8536
9248
  /**
8537
9249
  *
8538
9250
  * @summary Gets a schedule group
8539
- * @param {string} id
9251
+ * @param {string} id id of entity to query
8540
9252
  * @param {*} [options] Override http request option.
8541
9253
  * @throws {RequiredError}
8542
9254
  */
@@ -8556,7 +9268,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8556
9268
  /**
8557
9269
  *
8558
9270
  * @summary Gets a schedule
8559
- * @param {string} id
9271
+ * @param {string} id id of entity to query
8560
9272
  * @param {*} [options] Override http request option.
8561
9273
  * @throws {RequiredError}
8562
9274
  */
@@ -8576,7 +9288,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8576
9288
  /**
8577
9289
  *
8578
9290
  * @summary Gets a workflow
8579
- * @param {string} id
9291
+ * @param {string} id id of entity to query
8580
9292
  * @param {*} [options] Override http request option.
8581
9293
  * @throws {RequiredError}
8582
9294
  */
@@ -8596,7 +9308,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8596
9308
  /**
8597
9309
  *
8598
9310
  * @summary Deletes a workflow
8599
- * @param {string} id
9311
+ * @param {string} id id of entity to query
8600
9312
  * @param {*} [options] Override http request option.
8601
9313
  * @throws {RequiredError}
8602
9314
  */
@@ -8617,7 +9329,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8617
9329
  *
8618
9330
  * @summary Gets all or specific set of workflows
8619
9331
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8620
- * @param {Array<string>} [id]
9332
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8621
9333
  * @param {*} [options] Override http request option.
8622
9334
  * @throws {RequiredError}
8623
9335
  */
@@ -8637,7 +9349,7 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8637
9349
  /**
8638
9350
  *
8639
9351
  * @summary Deletes multiple workflows
8640
- * @param {Array<string>} [id]
9352
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8641
9353
  * @param {*} [options] Override http request option.
8642
9354
  * @throws {RequiredError}
8643
9355
  */
@@ -8658,46 +9370,46 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
8658
9370
  };
8659
9371
 
8660
9372
  /**
8661
- * Scout9Api - object-oriented interface
9373
+ * PocketScoutApi - object-oriented interface
8662
9374
  * @export
8663
- * @class Scout9Api
9375
+ * @class PocketScoutApi
8664
9376
  * @extends {BaseAPI}
8665
9377
  */
8666
- export class Scout9Api extends BaseAPI {
9378
+ export class PocketScoutApi extends BaseAPI {
8667
9379
  /**
8668
9380
  *
8669
9381
  * @summary Gets a agent
8670
- * @param {string} id
9382
+ * @param {string} id id of entity to query
8671
9383
  * @param {*} [options] Override http request option.
8672
9384
  * @throws {RequiredError}
8673
- * @memberof Scout9Api
9385
+ * @memberof PocketScoutApi
8674
9386
  */
8675
9387
  public agent(id: string, options?: AxiosRequestConfig) {
8676
- return Scout9ApiFp(this.configuration).agent(id, options).then((request) => request(this.axios, this.basePath));
9388
+ return PocketScoutApiFp(this.configuration).agent(id, options).then((request) => request(this.axios, this.basePath));
8677
9389
  }
8678
9390
 
8679
9391
  /**
8680
9392
  *
8681
- * @summary Create a new agent
8682
- * @param {CreateAgentRequest} createAgentRequest
9393
+ * @summary Deletes a agent
9394
+ * @param {string} id id of entity to query
8683
9395
  * @param {*} [options] Override http request option.
8684
9396
  * @throws {RequiredError}
8685
- * @memberof Scout9Api
9397
+ * @memberof PocketScoutApi
8686
9398
  */
8687
- public agentCreate(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig) {
8688
- return Scout9ApiFp(this.configuration).agentCreate(createAgentRequest, options).then((request) => request(this.axios, this.basePath));
9399
+ public agentDelete(id: string, options?: AxiosRequestConfig) {
9400
+ return PocketScoutApiFp(this.configuration).agentDelete(id, options).then((request) => request(this.axios, this.basePath));
8689
9401
  }
8690
9402
 
8691
9403
  /**
8692
9404
  *
8693
- * @summary Deletes a agent
8694
- * @param {string} id
9405
+ * @summary Registers a new agent
9406
+ * @param {CreateAgentRequest} createAgentRequest
8695
9407
  * @param {*} [options] Override http request option.
8696
9408
  * @throws {RequiredError}
8697
- * @memberof Scout9Api
9409
+ * @memberof PocketScoutApi
8698
9410
  */
8699
- public agentDelete(id: string, options?: AxiosRequestConfig) {
8700
- return Scout9ApiFp(this.configuration).agentDelete(id, options).then((request) => request(this.axios, this.basePath));
9411
+ public agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig) {
9412
+ return PocketScoutApiFp(this.configuration).agentRegister(createAgentRequest, options).then((request) => request(this.axios, this.basePath));
8701
9413
  }
8702
9414
 
8703
9415
  /**
@@ -8706,23 +9418,23 @@ export class Scout9Api extends BaseAPI {
8706
9418
  * @param {UpdateAgentRequest} updateAgentRequest
8707
9419
  * @param {*} [options] Override http request option.
8708
9420
  * @throws {RequiredError}
8709
- * @memberof Scout9Api
9421
+ * @memberof PocketScoutApi
8710
9422
  */
8711
9423
  public agentUpdate(updateAgentRequest: UpdateAgentRequest, options?: AxiosRequestConfig) {
8712
- return Scout9ApiFp(this.configuration).agentUpdate(updateAgentRequest, options).then((request) => request(this.axios, this.basePath));
9424
+ return PocketScoutApiFp(this.configuration).agentUpdate(updateAgentRequest, options).then((request) => request(this.axios, this.basePath));
8713
9425
  }
8714
9426
 
8715
9427
  /**
8716
9428
  *
8717
9429
  * @summary Gets all or specific set of agents
8718
9430
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8719
- * @param {Array<string>} [id]
9431
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8720
9432
  * @param {*} [options] Override http request option.
8721
9433
  * @throws {RequiredError}
8722
- * @memberof Scout9Api
9434
+ * @memberof PocketScoutApi
8723
9435
  */
8724
9436
  public agents(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
8725
- return Scout9ApiFp(this.configuration).agents(q, id, options).then((request) => request(this.axios, this.basePath));
9437
+ return PocketScoutApiFp(this.configuration).agents(q, id, options).then((request) => request(this.axios, this.basePath));
8726
9438
  }
8727
9439
 
8728
9440
  /**
@@ -8731,22 +9443,22 @@ export class Scout9Api extends BaseAPI {
8731
9443
  * @param {CreateAgentsRequest} createAgentsRequest
8732
9444
  * @param {*} [options] Override http request option.
8733
9445
  * @throws {RequiredError}
8734
- * @memberof Scout9Api
9446
+ * @memberof PocketScoutApi
8735
9447
  */
8736
9448
  public agentsCreate(createAgentsRequest: CreateAgentsRequest, options?: AxiosRequestConfig) {
8737
- return Scout9ApiFp(this.configuration).agentsCreate(createAgentsRequest, options).then((request) => request(this.axios, this.basePath));
9449
+ return PocketScoutApiFp(this.configuration).agentsCreate(createAgentsRequest, options).then((request) => request(this.axios, this.basePath));
8738
9450
  }
8739
9451
 
8740
9452
  /**
8741
9453
  *
8742
9454
  * @summary Deletes multiple agents
8743
- * @param {Array<string>} [id]
9455
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8744
9456
  * @param {*} [options] Override http request option.
8745
9457
  * @throws {RequiredError}
8746
- * @memberof Scout9Api
9458
+ * @memberof PocketScoutApi
8747
9459
  */
8748
9460
  public agentsDelete(id?: Array<string>, options?: AxiosRequestConfig) {
8749
- return Scout9ApiFp(this.configuration).agentsDelete(id, options).then((request) => request(this.axios, this.basePath));
9461
+ return PocketScoutApiFp(this.configuration).agentsDelete(id, options).then((request) => request(this.axios, this.basePath));
8750
9462
  }
8751
9463
 
8752
9464
  /**
@@ -8755,22 +9467,22 @@ export class Scout9Api extends BaseAPI {
8755
9467
  * @param {UpdateAgentsRequest} updateAgentsRequest
8756
9468
  * @param {*} [options] Override http request option.
8757
9469
  * @throws {RequiredError}
8758
- * @memberof Scout9Api
9470
+ * @memberof PocketScoutApi
8759
9471
  */
8760
9472
  public agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig) {
8761
- return Scout9ApiFp(this.configuration).agentsUpdate(updateAgentsRequest, options).then((request) => request(this.axios, this.basePath));
9473
+ return PocketScoutApiFp(this.configuration).agentsUpdate(updateAgentsRequest, options).then((request) => request(this.axios, this.basePath));
8762
9474
  }
8763
9475
 
8764
9476
  /**
8765
9477
  *
8766
9478
  * @summary Gets a context
8767
- * @param {string} id
9479
+ * @param {string} id id of entity to query
8768
9480
  * @param {*} [options] Override http request option.
8769
9481
  * @throws {RequiredError}
8770
- * @memberof Scout9Api
9482
+ * @memberof PocketScoutApi
8771
9483
  */
8772
9484
  public context(id: string, options?: AxiosRequestConfig) {
8773
- return Scout9ApiFp(this.configuration).context(id, options).then((request) => request(this.axios, this.basePath));
9485
+ return PocketScoutApiFp(this.configuration).context(id, options).then((request) => request(this.axios, this.basePath));
8774
9486
  }
8775
9487
 
8776
9488
  /**
@@ -8779,22 +9491,22 @@ export class Scout9Api extends BaseAPI {
8779
9491
  * @param {CreateContextRequest} createContextRequest
8780
9492
  * @param {*} [options] Override http request option.
8781
9493
  * @throws {RequiredError}
8782
- * @memberof Scout9Api
9494
+ * @memberof PocketScoutApi
8783
9495
  */
8784
9496
  public contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig) {
8785
- return Scout9ApiFp(this.configuration).contextCreate(createContextRequest, options).then((request) => request(this.axios, this.basePath));
9497
+ return PocketScoutApiFp(this.configuration).contextCreate(createContextRequest, options).then((request) => request(this.axios, this.basePath));
8786
9498
  }
8787
9499
 
8788
9500
  /**
8789
9501
  *
8790
9502
  * @summary Deletes a schedule
8791
- * @param {string} id
9503
+ * @param {string} id id of entity to query
8792
9504
  * @param {*} [options] Override http request option.
8793
9505
  * @throws {RequiredError}
8794
- * @memberof Scout9Api
9506
+ * @memberof PocketScoutApi
8795
9507
  */
8796
9508
  public contextDelete(id: string, options?: AxiosRequestConfig) {
8797
- return Scout9ApiFp(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
9509
+ return PocketScoutApiFp(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
8798
9510
  }
8799
9511
 
8800
9512
  /**
@@ -8803,23 +9515,23 @@ export class Scout9Api extends BaseAPI {
8803
9515
  * @param {UpdateContextRequest} updateContextRequest
8804
9516
  * @param {*} [options] Override http request option.
8805
9517
  * @throws {RequiredError}
8806
- * @memberof Scout9Api
9518
+ * @memberof PocketScoutApi
8807
9519
  */
8808
9520
  public contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig) {
8809
- return Scout9ApiFp(this.configuration).contextUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
9521
+ return PocketScoutApiFp(this.configuration).contextUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
8810
9522
  }
8811
9523
 
8812
9524
  /**
8813
9525
  *
8814
9526
  * @summary Gets all or specific set of contexts
8815
9527
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8816
- * @param {Array<string>} [id]
9528
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8817
9529
  * @param {*} [options] Override http request option.
8818
9530
  * @throws {RequiredError}
8819
- * @memberof Scout9Api
9531
+ * @memberof PocketScoutApi
8820
9532
  */
8821
9533
  public contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
8822
- return Scout9ApiFp(this.configuration).contexts(q, id, options).then((request) => request(this.axios, this.basePath));
9534
+ return PocketScoutApiFp(this.configuration).contexts(q, id, options).then((request) => request(this.axios, this.basePath));
8823
9535
  }
8824
9536
 
8825
9537
  /**
@@ -8828,22 +9540,22 @@ export class Scout9Api extends BaseAPI {
8828
9540
  * @param {CreateContextsRequest} createContextsRequest
8829
9541
  * @param {*} [options] Override http request option.
8830
9542
  * @throws {RequiredError}
8831
- * @memberof Scout9Api
9543
+ * @memberof PocketScoutApi
8832
9544
  */
8833
9545
  public contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig) {
8834
- return Scout9ApiFp(this.configuration).contextsCreate(createContextsRequest, options).then((request) => request(this.axios, this.basePath));
9546
+ return PocketScoutApiFp(this.configuration).contextsCreate(createContextsRequest, options).then((request) => request(this.axios, this.basePath));
8835
9547
  }
8836
9548
 
8837
9549
  /**
8838
9550
  *
8839
9551
  * @summary Deletes multiple contexts
8840
- * @param {Array<string>} [id]
9552
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8841
9553
  * @param {*} [options] Override http request option.
8842
9554
  * @throws {RequiredError}
8843
- * @memberof Scout9Api
9555
+ * @memberof PocketScoutApi
8844
9556
  */
8845
9557
  public contextsDelete(id?: Array<string>, options?: AxiosRequestConfig) {
8846
- return Scout9ApiFp(this.configuration).contextsDelete(id, options).then((request) => request(this.axios, this.basePath));
9558
+ return PocketScoutApiFp(this.configuration).contextsDelete(id, options).then((request) => request(this.axios, this.basePath));
8847
9559
  }
8848
9560
 
8849
9561
  /**
@@ -8852,22 +9564,22 @@ export class Scout9Api extends BaseAPI {
8852
9564
  * @param {UpdateContextRequest} updateContextRequest
8853
9565
  * @param {*} [options] Override http request option.
8854
9566
  * @throws {RequiredError}
8855
- * @memberof Scout9Api
9567
+ * @memberof PocketScoutApi
8856
9568
  */
8857
9569
  public contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig) {
8858
- return Scout9ApiFp(this.configuration).contextsUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
9570
+ return PocketScoutApiFp(this.configuration).contextsUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
8859
9571
  }
8860
9572
 
8861
9573
  /**
8862
9574
  *
8863
9575
  * @summary Gets a conversation
8864
- * @param {string} id
9576
+ * @param {string} id id of entity to query
8865
9577
  * @param {*} [options] Override http request option.
8866
9578
  * @throws {RequiredError}
8867
- * @memberof Scout9Api
9579
+ * @memberof PocketScoutApi
8868
9580
  */
8869
9581
  public conversation(id: string, options?: AxiosRequestConfig) {
8870
- return Scout9ApiFp(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
9582
+ return PocketScoutApiFp(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
8871
9583
  }
8872
9584
 
8873
9585
  /**
@@ -8876,22 +9588,22 @@ export class Scout9Api extends BaseAPI {
8876
9588
  * @param {ConversationCreateRequest} conversationCreateRequest
8877
9589
  * @param {*} [options] Override http request option.
8878
9590
  * @throws {RequiredError}
8879
- * @memberof Scout9Api
9591
+ * @memberof PocketScoutApi
8880
9592
  */
8881
9593
  public conversationCreate(conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig) {
8882
- return Scout9ApiFp(this.configuration).conversationCreate(conversationCreateRequest, options).then((request) => request(this.axios, this.basePath));
9594
+ return PocketScoutApiFp(this.configuration).conversationCreate(conversationCreateRequest, options).then((request) => request(this.axios, this.basePath));
8883
9595
  }
8884
9596
 
8885
9597
  /**
8886
9598
  *
8887
9599
  * @summary Deletes a schedule
8888
- * @param {string} id
9600
+ * @param {string} id id of entity to query
8889
9601
  * @param {*} [options] Override http request option.
8890
9602
  * @throws {RequiredError}
8891
- * @memberof Scout9Api
9603
+ * @memberof PocketScoutApi
8892
9604
  */
8893
9605
  public conversationDelete(id: string, options?: AxiosRequestConfig) {
8894
- return Scout9ApiFp(this.configuration).conversationDelete(id, options).then((request) => request(this.axios, this.basePath));
9606
+ return PocketScoutApiFp(this.configuration).conversationDelete(id, options).then((request) => request(this.axios, this.basePath));
8895
9607
  }
8896
9608
 
8897
9609
  /**
@@ -8900,22 +9612,22 @@ export class Scout9Api extends BaseAPI {
8900
9612
  * @param {ConversationUpdateRequest} conversationUpdateRequest
8901
9613
  * @param {*} [options] Override http request option.
8902
9614
  * @throws {RequiredError}
8903
- * @memberof Scout9Api
9615
+ * @memberof PocketScoutApi
8904
9616
  */
8905
9617
  public conversationUpdate(conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig) {
8906
- return Scout9ApiFp(this.configuration).conversationUpdate(conversationUpdateRequest, options).then((request) => request(this.axios, this.basePath));
9618
+ return PocketScoutApiFp(this.configuration).conversationUpdate(conversationUpdateRequest, options).then((request) => request(this.axios, this.basePath));
8907
9619
  }
8908
9620
 
8909
9621
  /**
8910
9622
  *
8911
9623
  * @summary Gets a customer
8912
- * @param {string} id
9624
+ * @param {string} id id of entity to query
8913
9625
  * @param {*} [options] Override http request option.
8914
9626
  * @throws {RequiredError}
8915
- * @memberof Scout9Api
9627
+ * @memberof PocketScoutApi
8916
9628
  */
8917
9629
  public customer(id: string, options?: AxiosRequestConfig) {
8918
- return Scout9ApiFp(this.configuration).customer(id, options).then((request) => request(this.axios, this.basePath));
9630
+ return PocketScoutApiFp(this.configuration).customer(id, options).then((request) => request(this.axios, this.basePath));
8919
9631
  }
8920
9632
 
8921
9633
  /**
@@ -8924,34 +9636,34 @@ export class Scout9Api extends BaseAPI {
8924
9636
  * @param {CreateCustomerRequest} createCustomerRequest
8925
9637
  * @param {*} [options] Override http request option.
8926
9638
  * @throws {RequiredError}
8927
- * @memberof Scout9Api
9639
+ * @memberof PocketScoutApi
8928
9640
  */
8929
9641
  public customerCreate(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig) {
8930
- return Scout9ApiFp(this.configuration).customerCreate(createCustomerRequest, options).then((request) => request(this.axios, this.basePath));
9642
+ return PocketScoutApiFp(this.configuration).customerCreate(createCustomerRequest, options).then((request) => request(this.axios, this.basePath));
8931
9643
  }
8932
9644
 
8933
9645
  /**
8934
9646
  *
8935
9647
  * @summary Deletes a customer
8936
- * @param {string} id
9648
+ * @param {string} id id of entity to query
8937
9649
  * @param {*} [options] Override http request option.
8938
9650
  * @throws {RequiredError}
8939
- * @memberof Scout9Api
9651
+ * @memberof PocketScoutApi
8940
9652
  */
8941
9653
  public customerDelete(id: string, options?: AxiosRequestConfig) {
8942
- return Scout9ApiFp(this.configuration).customerDelete(id, options).then((request) => request(this.axios, this.basePath));
9654
+ return PocketScoutApiFp(this.configuration).customerDelete(id, options).then((request) => request(this.axios, this.basePath));
8943
9655
  }
8944
9656
 
8945
9657
  /**
8946
9658
  *
8947
9659
  * @summary Gets a customer group
8948
- * @param {string} id
9660
+ * @param {string} id id of entity to query
8949
9661
  * @param {*} [options] Override http request option.
8950
9662
  * @throws {RequiredError}
8951
- * @memberof Scout9Api
9663
+ * @memberof PocketScoutApi
8952
9664
  */
8953
9665
  public customerGroup(id: string, options?: AxiosRequestConfig) {
8954
- return Scout9ApiFp(this.configuration).customerGroup(id, options).then((request) => request(this.axios, this.basePath));
9666
+ return PocketScoutApiFp(this.configuration).customerGroup(id, options).then((request) => request(this.axios, this.basePath));
8955
9667
  }
8956
9668
 
8957
9669
  /**
@@ -8960,22 +9672,22 @@ export class Scout9Api extends BaseAPI {
8960
9672
  * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
8961
9673
  * @param {*} [options] Override http request option.
8962
9674
  * @throws {RequiredError}
8963
- * @memberof Scout9Api
9675
+ * @memberof PocketScoutApi
8964
9676
  */
8965
9677
  public customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig) {
8966
- return Scout9ApiFp(this.configuration).customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
9678
+ return PocketScoutApiFp(this.configuration).customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
8967
9679
  }
8968
9680
 
8969
9681
  /**
8970
9682
  *
8971
9683
  * @summary Deletes a customer group
8972
- * @param {string} id
9684
+ * @param {string} id id of entity to query
8973
9685
  * @param {*} [options] Override http request option.
8974
9686
  * @throws {RequiredError}
8975
- * @memberof Scout9Api
9687
+ * @memberof PocketScoutApi
8976
9688
  */
8977
9689
  public customerGroupDelete(id: string, options?: AxiosRequestConfig) {
8978
- return Scout9ApiFp(this.configuration).customerGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
9690
+ return PocketScoutApiFp(this.configuration).customerGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
8979
9691
  }
8980
9692
 
8981
9693
  /**
@@ -8984,23 +9696,23 @@ export class Scout9Api extends BaseAPI {
8984
9696
  * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
8985
9697
  * @param {*} [options] Override http request option.
8986
9698
  * @throws {RequiredError}
8987
- * @memberof Scout9Api
9699
+ * @memberof PocketScoutApi
8988
9700
  */
8989
9701
  public customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig) {
8990
- return Scout9ApiFp(this.configuration).customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
9702
+ return PocketScoutApiFp(this.configuration).customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
8991
9703
  }
8992
9704
 
8993
9705
  /**
8994
9706
  *
8995
9707
  * @summary Gets all or specific set of customer groups
8996
9708
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
8997
- * @param {Array<string>} [id]
9709
+ * @param {Array<string>} [id] ids for the entities this id belongs to
8998
9710
  * @param {*} [options] Override http request option.
8999
9711
  * @throws {RequiredError}
9000
- * @memberof Scout9Api
9712
+ * @memberof PocketScoutApi
9001
9713
  */
9002
9714
  public customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9003
- return Scout9ApiFp(this.configuration).customerGroups(q, id, options).then((request) => request(this.axios, this.basePath));
9715
+ return PocketScoutApiFp(this.configuration).customerGroups(q, id, options).then((request) => request(this.axios, this.basePath));
9004
9716
  }
9005
9717
 
9006
9718
  /**
@@ -9009,22 +9721,22 @@ export class Scout9Api extends BaseAPI {
9009
9721
  * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
9010
9722
  * @param {*} [options] Override http request option.
9011
9723
  * @throws {RequiredError}
9012
- * @memberof Scout9Api
9724
+ * @memberof PocketScoutApi
9013
9725
  */
9014
9726
  public customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig) {
9015
- return Scout9ApiFp(this.configuration).customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9727
+ return PocketScoutApiFp(this.configuration).customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9016
9728
  }
9017
9729
 
9018
9730
  /**
9019
9731
  *
9020
9732
  * @summary Deletes multiple customer groups
9021
- * @param {Array<string>} [id]
9733
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9022
9734
  * @param {*} [options] Override http request option.
9023
9735
  * @throws {RequiredError}
9024
- * @memberof Scout9Api
9736
+ * @memberof PocketScoutApi
9025
9737
  */
9026
9738
  public customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig) {
9027
- return Scout9ApiFp(this.configuration).customerGroupsDelete(id, options).then((request) => request(this.axios, this.basePath));
9739
+ return PocketScoutApiFp(this.configuration).customerGroupsDelete(id, options).then((request) => request(this.axios, this.basePath));
9028
9740
  }
9029
9741
 
9030
9742
  /**
@@ -9033,10 +9745,10 @@ export class Scout9Api extends BaseAPI {
9033
9745
  * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
9034
9746
  * @param {*} [options] Override http request option.
9035
9747
  * @throws {RequiredError}
9036
- * @memberof Scout9Api
9748
+ * @memberof PocketScoutApi
9037
9749
  */
9038
9750
  public customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig) {
9039
- return Scout9ApiFp(this.configuration).customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9751
+ return PocketScoutApiFp(this.configuration).customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
9040
9752
  }
9041
9753
 
9042
9754
  /**
@@ -9045,23 +9757,23 @@ export class Scout9Api extends BaseAPI {
9045
9757
  * @param {UpdateCustomerRequest} updateCustomerRequest
9046
9758
  * @param {*} [options] Override http request option.
9047
9759
  * @throws {RequiredError}
9048
- * @memberof Scout9Api
9760
+ * @memberof PocketScoutApi
9049
9761
  */
9050
9762
  public customerUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) {
9051
- return Scout9ApiFp(this.configuration).customerUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
9763
+ return PocketScoutApiFp(this.configuration).customerUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
9052
9764
  }
9053
9765
 
9054
9766
  /**
9055
9767
  *
9056
9768
  * @summary Gets all or specific set of customers
9057
9769
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
9058
- * @param {Array<string>} [id]
9770
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9059
9771
  * @param {*} [options] Override http request option.
9060
9772
  * @throws {RequiredError}
9061
- * @memberof Scout9Api
9773
+ * @memberof PocketScoutApi
9062
9774
  */
9063
9775
  public customers(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9064
- return Scout9ApiFp(this.configuration).customers(q, id, options).then((request) => request(this.axios, this.basePath));
9776
+ return PocketScoutApiFp(this.configuration).customers(q, id, options).then((request) => request(this.axios, this.basePath));
9065
9777
  }
9066
9778
 
9067
9779
  /**
@@ -9070,22 +9782,22 @@ export class Scout9Api extends BaseAPI {
9070
9782
  * @param {CreateCustomersRequest} createCustomersRequest
9071
9783
  * @param {*} [options] Override http request option.
9072
9784
  * @throws {RequiredError}
9073
- * @memberof Scout9Api
9785
+ * @memberof PocketScoutApi
9074
9786
  */
9075
9787
  public customersCreate(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig) {
9076
- return Scout9ApiFp(this.configuration).customersCreate(createCustomersRequest, options).then((request) => request(this.axios, this.basePath));
9788
+ return PocketScoutApiFp(this.configuration).customersCreate(createCustomersRequest, options).then((request) => request(this.axios, this.basePath));
9077
9789
  }
9078
9790
 
9079
9791
  /**
9080
9792
  *
9081
9793
  * @summary Deletes multiple customers
9082
- * @param {Array<string>} [id]
9794
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9083
9795
  * @param {*} [options] Override http request option.
9084
9796
  * @throws {RequiredError}
9085
- * @memberof Scout9Api
9797
+ * @memberof PocketScoutApi
9086
9798
  */
9087
9799
  public customersDelete(id?: Array<string>, options?: AxiosRequestConfig) {
9088
- return Scout9ApiFp(this.configuration).customersDelete(id, options).then((request) => request(this.axios, this.basePath));
9800
+ return PocketScoutApiFp(this.configuration).customersDelete(id, options).then((request) => request(this.axios, this.basePath));
9089
9801
  }
9090
9802
 
9091
9803
  /**
@@ -9094,10 +9806,70 @@ export class Scout9Api extends BaseAPI {
9094
9806
  * @param {UpdateCustomerRequest} updateCustomerRequest
9095
9807
  * @param {*} [options] Override http request option.
9096
9808
  * @throws {RequiredError}
9097
- * @memberof Scout9Api
9809
+ * @memberof PocketScoutApi
9098
9810
  */
9099
9811
  public customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) {
9100
- return Scout9ApiFp(this.configuration).customersUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
9812
+ return PocketScoutApiFp(this.configuration).customersUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
9813
+ }
9814
+
9815
+ /**
9816
+ *
9817
+ * @summary Returns information about a specific file.
9818
+ * @param {string} fileId The ID of the file to use for this request
9819
+ * @param {*} [options] Override http request option.
9820
+ * @throws {RequiredError}
9821
+ * @memberof PocketScoutApi
9822
+ */
9823
+ public file(fileId: string, options?: AxiosRequestConfig) {
9824
+ return PocketScoutApiFp(this.configuration).file(fileId, options).then((request) => request(this.axios, this.basePath));
9825
+ }
9826
+
9827
+ /**
9828
+ *
9829
+ * @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.
9830
+ * @param {File} file
9831
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
9832
+ * @param {*} [options] Override http request option.
9833
+ * @throws {RequiredError}
9834
+ * @memberof PocketScoutApi
9835
+ */
9836
+ public fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig) {
9837
+ return PocketScoutApiFp(this.configuration).fileCreate(file, purpose, options).then((request) => request(this.axios, this.basePath));
9838
+ }
9839
+
9840
+ /**
9841
+ *
9842
+ * @summary Delete a file.
9843
+ * @param {string} fileId The ID of the file to use for this request
9844
+ * @param {*} [options] Override http request option.
9845
+ * @throws {RequiredError}
9846
+ * @memberof PocketScoutApi
9847
+ */
9848
+ public fileDelete(fileId: string, options?: AxiosRequestConfig) {
9849
+ return PocketScoutApiFp(this.configuration).fileDelete(fileId, options).then((request) => request(this.axios, this.basePath));
9850
+ }
9851
+
9852
+ /**
9853
+ *
9854
+ * @summary Returns the contents of the specified file
9855
+ * @param {string} fileId The ID of the file to use for this request
9856
+ * @param {*} [options] Override http request option.
9857
+ * @throws {RequiredError}
9858
+ * @memberof PocketScoutApi
9859
+ */
9860
+ public fileDownload(fileId: string, options?: AxiosRequestConfig) {
9861
+ return PocketScoutApiFp(this.configuration).fileDownload(fileId, options).then((request) => request(this.axios, this.basePath));
9862
+ }
9863
+
9864
+ /**
9865
+ *
9866
+ * @summary Returns a list of files that belong to the user\'s organization.
9867
+ * @param {*} [options] Override http request option.
9868
+ * @throws {RequiredError}
9869
+ * @memberof PocketScoutApi
9870
+ */
9871
+ public files(options?: AxiosRequestConfig) {
9872
+ return PocketScoutApiFp(this.configuration).files(options).then((request) => request(this.axios, this.basePath));
9101
9873
  }
9102
9874
 
9103
9875
  /**
@@ -9106,10 +9878,10 @@ export class Scout9Api extends BaseAPI {
9106
9878
  * @param {GenerateRequest} generateRequest
9107
9879
  * @param {*} [options] Override http request option.
9108
9880
  * @throws {RequiredError}
9109
- * @memberof Scout9Api
9881
+ * @memberof PocketScoutApi
9110
9882
  */
9111
9883
  public generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig) {
9112
- return Scout9ApiFp(this.configuration).generate(generateRequest, options).then((request) => request(this.axios, this.basePath));
9884
+ return PocketScoutApiFp(this.configuration).generate(generateRequest, options).then((request) => request(this.axios, this.basePath));
9113
9885
  }
9114
9886
 
9115
9887
  /**
@@ -9118,48 +9890,48 @@ export class Scout9Api extends BaseAPI {
9118
9890
  * @param {MessageCreateRequest} messageCreateRequest
9119
9891
  * @param {*} [options] Override http request option.
9120
9892
  * @throws {RequiredError}
9121
- * @memberof Scout9Api
9893
+ * @memberof PocketScoutApi
9122
9894
  */
9123
9895
  public message(messageCreateRequest: MessageCreateRequest, options?: AxiosRequestConfig) {
9124
- return Scout9ApiFp(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
9896
+ return PocketScoutApiFp(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
9125
9897
  }
9126
9898
 
9127
9899
  /**
9128
9900
  *
9129
9901
  * @summary Get all messages from a conversation
9902
+ * @param {string} id id of entity to query
9130
9903
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
9131
- * @param {Array<string>} [id]
9132
9904
  * @param {*} [options] Override http request option.
9133
9905
  * @throws {RequiredError}
9134
- * @memberof Scout9Api
9906
+ * @memberof PocketScoutApi
9135
9907
  */
9136
- public messages(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9137
- return Scout9ApiFp(this.configuration).messages(q, id, options).then((request) => request(this.axios, this.basePath));
9908
+ public messages(id: string, q?: string, options?: AxiosRequestConfig) {
9909
+ return PocketScoutApiFp(this.configuration).messages(id, q, options).then((request) => request(this.axios, this.basePath));
9138
9910
  }
9139
9911
 
9140
9912
  /**
9141
9913
  *
9142
9914
  * @summary Get the results of a bulk API operation
9143
- * @param {string} id
9915
+ * @param {string} id id of entity to query
9144
9916
  * @param {*} [options] Override http request option.
9145
9917
  * @throws {RequiredError}
9146
- * @memberof Scout9Api
9918
+ * @memberof PocketScoutApi
9147
9919
  */
9148
9920
  public operation(id: string, options?: AxiosRequestConfig) {
9149
- return Scout9ApiFp(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
9921
+ return PocketScoutApiFp(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
9150
9922
  }
9151
9923
 
9152
9924
  /**
9153
9925
  *
9154
9926
  * @summary Gets all or specific set of bulk API operations
9155
9927
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
9156
- * @param {Array<string>} [id]
9928
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9157
9929
  * @param {*} [options] Override http request option.
9158
9930
  * @throws {RequiredError}
9159
- * @memberof Scout9Api
9931
+ * @memberof PocketScoutApi
9160
9932
  */
9161
9933
  public operations(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9162
- return Scout9ApiFp(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
9934
+ return PocketScoutApiFp(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
9163
9935
  }
9164
9936
 
9165
9937
  /**
@@ -9168,22 +9940,22 @@ export class Scout9Api extends BaseAPI {
9168
9940
  * @param {ScheduleCreateRequest} scheduleCreateRequest
9169
9941
  * @param {*} [options] Override http request option.
9170
9942
  * @throws {RequiredError}
9171
- * @memberof Scout9Api
9943
+ * @memberof PocketScoutApi
9172
9944
  */
9173
- public scheduleCreate(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig) {
9174
- return Scout9ApiFp(this.configuration).scheduleCreate(scheduleCreateRequest, options).then((request) => request(this.axios, this.basePath));
9945
+ public scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig) {
9946
+ return PocketScoutApiFp(this.configuration).scheduleConversation(scheduleCreateRequest, options).then((request) => request(this.axios, this.basePath));
9175
9947
  }
9176
9948
 
9177
9949
  /**
9178
9950
  *
9179
9951
  * @summary Deletes a schedule
9180
- * @param {string} id
9952
+ * @param {string} id id of entity to query
9181
9953
  * @param {*} [options] Override http request option.
9182
9954
  * @throws {RequiredError}
9183
- * @memberof Scout9Api
9955
+ * @memberof PocketScoutApi
9184
9956
  */
9185
9957
  public scheduleDelete(id: string, options?: AxiosRequestConfig) {
9186
- return Scout9ApiFp(this.configuration).scheduleDelete(id, options).then((request) => request(this.axios, this.basePath));
9958
+ return PocketScoutApiFp(this.configuration).scheduleDelete(id, options).then((request) => request(this.axios, this.basePath));
9187
9959
  }
9188
9960
 
9189
9961
  /**
@@ -9192,34 +9964,34 @@ export class Scout9Api extends BaseAPI {
9192
9964
  * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
9193
9965
  * @param {*} [options] Override http request option.
9194
9966
  * @throws {RequiredError}
9195
- * @memberof Scout9Api
9967
+ * @memberof PocketScoutApi
9196
9968
  */
9197
9969
  public scheduleGroupCreate(scheduleGroupCreateRequest: ScheduleGroupCreateRequest, options?: AxiosRequestConfig) {
9198
- return Scout9ApiFp(this.configuration).scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(this.axios, this.basePath));
9970
+ return PocketScoutApiFp(this.configuration).scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(this.axios, this.basePath));
9199
9971
  }
9200
9972
 
9201
9973
  /**
9202
9974
  *
9203
9975
  * @summary Deletes and cancels a schedule group
9204
- * @param {string} id
9976
+ * @param {string} id id of entity to query
9205
9977
  * @param {*} [options] Override http request option.
9206
9978
  * @throws {RequiredError}
9207
- * @memberof Scout9Api
9979
+ * @memberof PocketScoutApi
9208
9980
  */
9209
9981
  public scheduleGroupDelete(id: string, options?: AxiosRequestConfig) {
9210
- return Scout9ApiFp(this.configuration).scheduleGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
9982
+ return PocketScoutApiFp(this.configuration).scheduleGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
9211
9983
  }
9212
9984
 
9213
9985
  /**
9214
9986
  *
9215
9987
  * @summary Gets a schedule group
9216
- * @param {string} id
9988
+ * @param {string} id id of entity to query
9217
9989
  * @param {*} [options] Override http request option.
9218
9990
  * @throws {RequiredError}
9219
- * @memberof Scout9Api
9991
+ * @memberof PocketScoutApi
9220
9992
  */
9221
9993
  public scheduleGroupRetrieve(id: string, options?: AxiosRequestConfig) {
9222
- return Scout9ApiFp(this.configuration).scheduleGroupRetrieve(id, options).then((request) => request(this.axios, this.basePath));
9994
+ return PocketScoutApiFp(this.configuration).scheduleGroupRetrieve(id, options).then((request) => request(this.axios, this.basePath));
9223
9995
  }
9224
9996
 
9225
9997
  /**
@@ -9228,22 +10000,22 @@ export class Scout9Api extends BaseAPI {
9228
10000
  * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
9229
10001
  * @param {*} [options] Override http request option.
9230
10002
  * @throws {RequiredError}
9231
- * @memberof Scout9Api
10003
+ * @memberof PocketScoutApi
9232
10004
  */
9233
10005
  public scheduleGroupUpdate(scheduleGroupUpdateRequest: ScheduleGroupUpdateRequest, options?: AxiosRequestConfig) {
9234
- return Scout9ApiFp(this.configuration).scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(this.axios, this.basePath));
10006
+ return PocketScoutApiFp(this.configuration).scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(this.axios, this.basePath));
9235
10007
  }
9236
10008
 
9237
10009
  /**
9238
10010
  *
9239
10011
  * @summary Gets a schedule
9240
- * @param {string} id
10012
+ * @param {string} id id of entity to query
9241
10013
  * @param {*} [options] Override http request option.
9242
10014
  * @throws {RequiredError}
9243
- * @memberof Scout9Api
10015
+ * @memberof PocketScoutApi
9244
10016
  */
9245
10017
  public scheduleRetrieve(id: string, options?: AxiosRequestConfig) {
9246
- return Scout9ApiFp(this.configuration).scheduleRetrieve(id, options).then((request) => request(this.axios, this.basePath));
10018
+ return PocketScoutApiFp(this.configuration).scheduleRetrieve(id, options).then((request) => request(this.axios, this.basePath));
9247
10019
  }
9248
10020
 
9249
10021
  /**
@@ -9252,22 +10024,22 @@ export class Scout9Api extends BaseAPI {
9252
10024
  * @param {ScheduleUpdateRequest} scheduleUpdateRequest
9253
10025
  * @param {*} [options] Override http request option.
9254
10026
  * @throws {RequiredError}
9255
- * @memberof Scout9Api
10027
+ * @memberof PocketScoutApi
9256
10028
  */
9257
10029
  public scheduleUpdate(scheduleUpdateRequest: ScheduleUpdateRequest, options?: AxiosRequestConfig) {
9258
- return Scout9ApiFp(this.configuration).scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(this.axios, this.basePath));
10030
+ return PocketScoutApiFp(this.configuration).scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(this.axios, this.basePath));
9259
10031
  }
9260
10032
 
9261
10033
  /**
9262
10034
  *
9263
10035
  * @summary Gets a workflow
9264
- * @param {string} id
10036
+ * @param {string} id id of entity to query
9265
10037
  * @param {*} [options] Override http request option.
9266
10038
  * @throws {RequiredError}
9267
- * @memberof Scout9Api
10039
+ * @memberof PocketScoutApi
9268
10040
  */
9269
10041
  public workflow(id: string, options?: AxiosRequestConfig) {
9270
- return Scout9ApiFp(this.configuration).workflow(id, options).then((request) => request(this.axios, this.basePath));
10042
+ return PocketScoutApiFp(this.configuration).workflow(id, options).then((request) => request(this.axios, this.basePath));
9271
10043
  }
9272
10044
 
9273
10045
  /**
@@ -9276,22 +10048,22 @@ export class Scout9Api extends BaseAPI {
9276
10048
  * @param {CreateWorkflowRequest} createWorkflowRequest
9277
10049
  * @param {*} [options] Override http request option.
9278
10050
  * @throws {RequiredError}
9279
- * @memberof Scout9Api
10051
+ * @memberof PocketScoutApi
9280
10052
  */
9281
10053
  public workflowCreate(createWorkflowRequest: CreateWorkflowRequest, options?: AxiosRequestConfig) {
9282
- return Scout9ApiFp(this.configuration).workflowCreate(createWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
10054
+ return PocketScoutApiFp(this.configuration).workflowCreate(createWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
9283
10055
  }
9284
10056
 
9285
10057
  /**
9286
10058
  *
9287
10059
  * @summary Deletes a workflow
9288
- * @param {string} id
10060
+ * @param {string} id id of entity to query
9289
10061
  * @param {*} [options] Override http request option.
9290
10062
  * @throws {RequiredError}
9291
- * @memberof Scout9Api
10063
+ * @memberof PocketScoutApi
9292
10064
  */
9293
10065
  public workflowDelete(id: string, options?: AxiosRequestConfig) {
9294
- return Scout9ApiFp(this.configuration).workflowDelete(id, options).then((request) => request(this.axios, this.basePath));
10066
+ return PocketScoutApiFp(this.configuration).workflowDelete(id, options).then((request) => request(this.axios, this.basePath));
9295
10067
  }
9296
10068
 
9297
10069
  /**
@@ -9300,23 +10072,23 @@ export class Scout9Api extends BaseAPI {
9300
10072
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
9301
10073
  * @param {*} [options] Override http request option.
9302
10074
  * @throws {RequiredError}
9303
- * @memberof Scout9Api
10075
+ * @memberof PocketScoutApi
9304
10076
  */
9305
10077
  public workflowUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig) {
9306
- return Scout9ApiFp(this.configuration).workflowUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
10078
+ return PocketScoutApiFp(this.configuration).workflowUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
9307
10079
  }
9308
10080
 
9309
10081
  /**
9310
10082
  *
9311
10083
  * @summary Gets all or specific set of workflows
9312
10084
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
9313
- * @param {Array<string>} [id]
10085
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9314
10086
  * @param {*} [options] Override http request option.
9315
10087
  * @throws {RequiredError}
9316
- * @memberof Scout9Api
10088
+ * @memberof PocketScoutApi
9317
10089
  */
9318
10090
  public workflows(q?: string, id?: Array<string>, options?: AxiosRequestConfig) {
9319
- return Scout9ApiFp(this.configuration).workflows(q, id, options).then((request) => request(this.axios, this.basePath));
10091
+ return PocketScoutApiFp(this.configuration).workflows(q, id, options).then((request) => request(this.axios, this.basePath));
9320
10092
  }
9321
10093
 
9322
10094
  /**
@@ -9325,22 +10097,22 @@ export class Scout9Api extends BaseAPI {
9325
10097
  * @param {CreateWorkflowsRequest} createWorkflowsRequest
9326
10098
  * @param {*} [options] Override http request option.
9327
10099
  * @throws {RequiredError}
9328
- * @memberof Scout9Api
10100
+ * @memberof PocketScoutApi
9329
10101
  */
9330
10102
  public workflowsCreate(createWorkflowsRequest: CreateWorkflowsRequest, options?: AxiosRequestConfig) {
9331
- return Scout9ApiFp(this.configuration).workflowsCreate(createWorkflowsRequest, options).then((request) => request(this.axios, this.basePath));
10103
+ return PocketScoutApiFp(this.configuration).workflowsCreate(createWorkflowsRequest, options).then((request) => request(this.axios, this.basePath));
9332
10104
  }
9333
10105
 
9334
10106
  /**
9335
10107
  *
9336
10108
  * @summary Deletes multiple workflows
9337
- * @param {Array<string>} [id]
10109
+ * @param {Array<string>} [id] ids for the entities this id belongs to
9338
10110
  * @param {*} [options] Override http request option.
9339
10111
  * @throws {RequiredError}
9340
- * @memberof Scout9Api
10112
+ * @memberof PocketScoutApi
9341
10113
  */
9342
10114
  public workflowsDelete(id?: Array<string>, options?: AxiosRequestConfig) {
9343
- return Scout9ApiFp(this.configuration).workflowsDelete(id, options).then((request) => request(this.axios, this.basePath));
10115
+ return PocketScoutApiFp(this.configuration).workflowsDelete(id, options).then((request) => request(this.axios, this.basePath));
9344
10116
  }
9345
10117
 
9346
10118
  /**
@@ -9349,10 +10121,10 @@ export class Scout9Api extends BaseAPI {
9349
10121
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
9350
10122
  * @param {*} [options] Override http request option.
9351
10123
  * @throws {RequiredError}
9352
- * @memberof Scout9Api
10124
+ * @memberof PocketScoutApi
9353
10125
  */
9354
10126
  public workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig) {
9355
- return Scout9ApiFp(this.configuration).workflowsUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
10127
+ return PocketScoutApiFp(this.configuration).workflowsUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
9356
10128
  }
9357
10129
  }
9358
10130