@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/build/api.d.ts +859 -287
- package/build/api.js +683 -307
- package/package.json +1 -1
- package/src/api.ts +1143 -371
- package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Scout9 Pocket Scout API
|
|
2
|
+
* Scout9\'s Pocket Scout API
|
|
3
3
|
* Pocket Scout APIs for managing Scout9 users and conversations with your Pocket Scout agents
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
/// <reference types="node" />
|
|
12
13
|
import type { Configuration } from './configuration';
|
|
13
14
|
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
15
|
import type { RequestArgs } from './base';
|
|
@@ -24,13 +25,13 @@ export interface Agent {
|
|
|
24
25
|
* @type {string}
|
|
25
26
|
* @memberof Agent
|
|
26
27
|
*/
|
|
27
|
-
'firstName'
|
|
28
|
+
'firstName'?: string;
|
|
28
29
|
/**
|
|
29
30
|
* Agent last name
|
|
30
31
|
* @type {string}
|
|
31
32
|
* @memberof Agent
|
|
32
33
|
*/
|
|
33
|
-
'lastName'
|
|
34
|
+
'lastName'?: string;
|
|
34
35
|
/**
|
|
35
36
|
* Agent is inactive
|
|
36
37
|
* @type {boolean}
|
|
@@ -66,7 +67,7 @@ export interface Agent {
|
|
|
66
67
|
* @type {string}
|
|
67
68
|
* @memberof Agent
|
|
68
69
|
*/
|
|
69
|
-
'forwardPhone'
|
|
70
|
+
'forwardPhone'?: string;
|
|
70
71
|
/**
|
|
71
72
|
* Title of the agent, defaults to \"Agent\"
|
|
72
73
|
* @type {string}
|
|
@@ -86,18 +87,24 @@ export interface Agent {
|
|
|
86
87
|
*/
|
|
87
88
|
'includedLocations'?: Array<string>;
|
|
88
89
|
/**
|
|
89
|
-
*
|
|
90
|
-
* @type {
|
|
90
|
+
* AI Model
|
|
91
|
+
* @type {string}
|
|
91
92
|
* @memberof Agent
|
|
92
93
|
*/
|
|
93
|
-
'
|
|
94
|
+
'model'?: AgentModelEnum;
|
|
94
95
|
/**
|
|
95
|
-
*
|
|
96
|
-
* @type {string}
|
|
96
|
+
* Locations id the agent is excluded from
|
|
97
|
+
* @type {Array<string>}
|
|
97
98
|
* @memberof Agent
|
|
98
99
|
*/
|
|
99
|
-
'
|
|
100
|
+
'excludedLocations'?: Array<string>;
|
|
100
101
|
}
|
|
102
|
+
export declare const AgentModelEnum: {
|
|
103
|
+
readonly PocketScout: "Pocket Scout";
|
|
104
|
+
readonly Bard: "bard";
|
|
105
|
+
readonly Null: "null";
|
|
106
|
+
};
|
|
107
|
+
export type AgentModelEnum = typeof AgentModelEnum[keyof typeof AgentModelEnum];
|
|
101
108
|
/**
|
|
102
109
|
* @type AnyValue
|
|
103
110
|
* @export
|
|
@@ -486,11 +493,11 @@ export interface ConversationContextFieldCondition {
|
|
|
486
493
|
*/
|
|
487
494
|
'key': string;
|
|
488
495
|
/**
|
|
489
|
-
*
|
|
490
|
-
* @type {
|
|
496
|
+
* The operator of the condition or query
|
|
497
|
+
* @type {string}
|
|
491
498
|
* @memberof ConversationContextFieldCondition
|
|
492
499
|
*/
|
|
493
|
-
'operator':
|
|
500
|
+
'operator': ConversationContextFieldConditionOperatorEnum;
|
|
494
501
|
/**
|
|
495
502
|
* The regex of the condition
|
|
496
503
|
* @type {string}
|
|
@@ -504,6 +511,31 @@ export interface ConversationContextFieldCondition {
|
|
|
504
511
|
*/
|
|
505
512
|
'value': AnyValue;
|
|
506
513
|
}
|
|
514
|
+
export declare const ConversationContextFieldConditionOperatorEnum: {
|
|
515
|
+
readonly Eq: "eq";
|
|
516
|
+
readonly Equal: "equal";
|
|
517
|
+
readonly Ne: "ne";
|
|
518
|
+
readonly NotEquals: "not-equals";
|
|
519
|
+
readonly Gt: "gt";
|
|
520
|
+
readonly GreaterThan: "greater-than";
|
|
521
|
+
readonly Gte: "gte";
|
|
522
|
+
readonly GreaterThanEquals: "greater-than-equals";
|
|
523
|
+
readonly Lt: "lt";
|
|
524
|
+
readonly LessThan: "less-than";
|
|
525
|
+
readonly Lte: "lte";
|
|
526
|
+
readonly LessThanEquals: "less-than-equals";
|
|
527
|
+
readonly ArrayContains: "array-contains";
|
|
528
|
+
readonly In: "in";
|
|
529
|
+
readonly ArrayContainsAny: "array-contains-any";
|
|
530
|
+
readonly NotIn: "not-in";
|
|
531
|
+
readonly Exists: "exists";
|
|
532
|
+
readonly NotExists: "notExists";
|
|
533
|
+
readonly Contains: "contains";
|
|
534
|
+
readonly NotContains: "notContains";
|
|
535
|
+
readonly StartsWith: "startsWith";
|
|
536
|
+
readonly EndsWith: "endsWith";
|
|
537
|
+
};
|
|
538
|
+
export type ConversationContextFieldConditionOperatorEnum = typeof ConversationContextFieldConditionOperatorEnum[keyof typeof ConversationContextFieldConditionOperatorEnum];
|
|
507
539
|
/**
|
|
508
540
|
*
|
|
509
541
|
* @export
|
|
@@ -558,7 +590,7 @@ export interface ConversationCreateRequest {
|
|
|
558
590
|
* @type {ConversationUpdateRequestBaseWorkflow}
|
|
559
591
|
* @memberof ConversationCreateRequest
|
|
560
592
|
*/
|
|
561
|
-
'$workflow'
|
|
593
|
+
'$workflow'?: ConversationUpdateRequestBaseWorkflow;
|
|
562
594
|
}
|
|
563
595
|
/**
|
|
564
596
|
*
|
|
@@ -571,7 +603,7 @@ export interface ConversationCreateRequestBase {
|
|
|
571
603
|
* @type {ConversationUpdateRequestBaseWorkflow}
|
|
572
604
|
* @memberof ConversationCreateRequestBase
|
|
573
605
|
*/
|
|
574
|
-
'$workflow'
|
|
606
|
+
'$workflow'?: ConversationUpdateRequestBaseWorkflow;
|
|
575
607
|
}
|
|
576
608
|
/**
|
|
577
609
|
*
|
|
@@ -1001,7 +1033,7 @@ export interface CreateAgentRequest {
|
|
|
1001
1033
|
* @type {string}
|
|
1002
1034
|
* @memberof CreateAgentRequest
|
|
1003
1035
|
*/
|
|
1004
|
-
'forwardEmail'
|
|
1036
|
+
'forwardEmail': string;
|
|
1005
1037
|
/**
|
|
1006
1038
|
* Forward phone
|
|
1007
1039
|
* @type {string}
|
|
@@ -1026,6 +1058,12 @@ export interface CreateAgentRequest {
|
|
|
1026
1058
|
* @memberof CreateAgentRequest
|
|
1027
1059
|
*/
|
|
1028
1060
|
'includedLocations'?: Array<string>;
|
|
1061
|
+
/**
|
|
1062
|
+
* AI Model
|
|
1063
|
+
* @type {string}
|
|
1064
|
+
* @memberof CreateAgentRequest
|
|
1065
|
+
*/
|
|
1066
|
+
'model'?: CreateAgentRequestModelEnum;
|
|
1029
1067
|
/**
|
|
1030
1068
|
* Locations id the agent is excluded from
|
|
1031
1069
|
* @type {Array<string>}
|
|
@@ -1033,11 +1071,91 @@ export interface CreateAgentRequest {
|
|
|
1033
1071
|
*/
|
|
1034
1072
|
'excludedLocations'?: Array<string>;
|
|
1035
1073
|
/**
|
|
1036
|
-
*
|
|
1037
|
-
* @type {
|
|
1074
|
+
* Sample conversations that help build out your agent to mimic your responses
|
|
1075
|
+
* @type {Array<CreateAgentRequestAllOfConversationsInner>}
|
|
1038
1076
|
* @memberof CreateAgentRequest
|
|
1039
1077
|
*/
|
|
1040
|
-
'
|
|
1078
|
+
'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Sample audio files that help build out your agent to mimic your voice
|
|
1081
|
+
* @type {Array<string>}
|
|
1082
|
+
* @memberof CreateAgentRequest
|
|
1083
|
+
*/
|
|
1084
|
+
'audio'?: Array<string>;
|
|
1085
|
+
}
|
|
1086
|
+
export declare const CreateAgentRequestModelEnum: {
|
|
1087
|
+
readonly PocketScout: "Pocket Scout";
|
|
1088
|
+
readonly Bard: "bard";
|
|
1089
|
+
readonly Null: "null";
|
|
1090
|
+
};
|
|
1091
|
+
export type CreateAgentRequestModelEnum = typeof CreateAgentRequestModelEnum[keyof typeof CreateAgentRequestModelEnum];
|
|
1092
|
+
/**
|
|
1093
|
+
*
|
|
1094
|
+
* @export
|
|
1095
|
+
* @interface CreateAgentRequestAllOf
|
|
1096
|
+
*/
|
|
1097
|
+
export interface CreateAgentRequestAllOf {
|
|
1098
|
+
/**
|
|
1099
|
+
* Sample conversations that help build out your agent to mimic your responses
|
|
1100
|
+
* @type {Array<CreateAgentRequestAllOfConversationsInner>}
|
|
1101
|
+
* @memberof CreateAgentRequestAllOf
|
|
1102
|
+
*/
|
|
1103
|
+
'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Sample audio files that help build out your agent to mimic your voice
|
|
1106
|
+
* @type {Array<string>}
|
|
1107
|
+
* @memberof CreateAgentRequestAllOf
|
|
1108
|
+
*/
|
|
1109
|
+
'audio'?: Array<string>;
|
|
1110
|
+
}
|
|
1111
|
+
/**
|
|
1112
|
+
* @type CreateAgentRequestAllOfConversationsInner
|
|
1113
|
+
* @export
|
|
1114
|
+
*/
|
|
1115
|
+
export type CreateAgentRequestAllOfConversationsInner = CreateAgentRequestAllOfConversationsInnerOneOf | string;
|
|
1116
|
+
/**
|
|
1117
|
+
* Conversation sample
|
|
1118
|
+
* @export
|
|
1119
|
+
* @interface CreateAgentRequestAllOfConversationsInnerOneOf
|
|
1120
|
+
*/
|
|
1121
|
+
export interface CreateAgentRequestAllOfConversationsInnerOneOf {
|
|
1122
|
+
/**
|
|
1123
|
+
* The type or category of the conversation (this helps with associating work flows)
|
|
1124
|
+
* @type {string}
|
|
1125
|
+
* @memberof CreateAgentRequestAllOfConversationsInnerOneOf
|
|
1126
|
+
*/
|
|
1127
|
+
'type': string;
|
|
1128
|
+
/**
|
|
1129
|
+
* The context of the conversation, this helps with associating work flows, or any caveats to the conversation
|
|
1130
|
+
* @type {string}
|
|
1131
|
+
* @memberof CreateAgentRequestAllOfConversationsInnerOneOf
|
|
1132
|
+
*/
|
|
1133
|
+
'context'?: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Conversation
|
|
1136
|
+
* @type {Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>}
|
|
1137
|
+
* @memberof CreateAgentRequestAllOfConversationsInnerOneOf
|
|
1138
|
+
*/
|
|
1139
|
+
'conversation': Array<CreateAgentRequestAllOfConversationsInnerOneOfConversationInner>;
|
|
1140
|
+
}
|
|
1141
|
+
/**
|
|
1142
|
+
*
|
|
1143
|
+
* @export
|
|
1144
|
+
* @interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
|
|
1145
|
+
*/
|
|
1146
|
+
export interface CreateAgentRequestAllOfConversationsInnerOneOfConversationInner {
|
|
1147
|
+
/**
|
|
1148
|
+
* The speaker of the message, if this from the agent then this must have \"agent\" or match the agent\'s first or full name
|
|
1149
|
+
* @type {string}
|
|
1150
|
+
* @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
|
|
1151
|
+
*/
|
|
1152
|
+
'speaker': string;
|
|
1153
|
+
/**
|
|
1154
|
+
* The message content
|
|
1155
|
+
* @type {string}
|
|
1156
|
+
* @memberof CreateAgentRequestAllOfConversationsInnerOneOfConversationInner
|
|
1157
|
+
*/
|
|
1158
|
+
'message': string;
|
|
1041
1159
|
}
|
|
1042
1160
|
/**
|
|
1043
1161
|
*
|
|
@@ -1130,7 +1248,7 @@ export interface CreateAgentsRequestAgentsInner {
|
|
|
1130
1248
|
* @type {string}
|
|
1131
1249
|
* @memberof CreateAgentsRequestAgentsInner
|
|
1132
1250
|
*/
|
|
1133
|
-
'forwardPhone'
|
|
1251
|
+
'forwardPhone'?: string;
|
|
1134
1252
|
/**
|
|
1135
1253
|
* Title of the agent, defaults to \"Agent\"
|
|
1136
1254
|
* @type {string}
|
|
@@ -1150,18 +1268,24 @@ export interface CreateAgentsRequestAgentsInner {
|
|
|
1150
1268
|
*/
|
|
1151
1269
|
'includedLocations'?: Array<string>;
|
|
1152
1270
|
/**
|
|
1153
|
-
*
|
|
1154
|
-
* @type {
|
|
1271
|
+
* AI Model
|
|
1272
|
+
* @type {string}
|
|
1155
1273
|
* @memberof CreateAgentsRequestAgentsInner
|
|
1156
1274
|
*/
|
|
1157
|
-
'
|
|
1275
|
+
'model'?: CreateAgentsRequestAgentsInnerModelEnum;
|
|
1158
1276
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
* @type {string}
|
|
1277
|
+
* Locations id the agent is excluded from
|
|
1278
|
+
* @type {Array<string>}
|
|
1161
1279
|
* @memberof CreateAgentsRequestAgentsInner
|
|
1162
1280
|
*/
|
|
1163
|
-
'
|
|
1281
|
+
'excludedLocations'?: Array<string>;
|
|
1164
1282
|
}
|
|
1283
|
+
export declare const CreateAgentsRequestAgentsInnerModelEnum: {
|
|
1284
|
+
readonly PocketScout: "Pocket Scout";
|
|
1285
|
+
readonly Bard: "bard";
|
|
1286
|
+
readonly Null: "null";
|
|
1287
|
+
};
|
|
1288
|
+
export type CreateAgentsRequestAgentsInnerModelEnum = typeof CreateAgentsRequestAgentsInnerModelEnum[keyof typeof CreateAgentsRequestAgentsInnerModelEnum];
|
|
1165
1289
|
/**
|
|
1166
1290
|
*
|
|
1167
1291
|
* @export
|
|
@@ -2144,6 +2268,31 @@ export interface DeleteCustomersResponse {
|
|
|
2144
2268
|
*/
|
|
2145
2269
|
'$operation': string;
|
|
2146
2270
|
}
|
|
2271
|
+
/**
|
|
2272
|
+
*
|
|
2273
|
+
* @export
|
|
2274
|
+
* @interface DeleteFileResponse
|
|
2275
|
+
*/
|
|
2276
|
+
export interface DeleteFileResponse {
|
|
2277
|
+
/**
|
|
2278
|
+
*
|
|
2279
|
+
* @type {string}
|
|
2280
|
+
* @memberof DeleteFileResponse
|
|
2281
|
+
*/
|
|
2282
|
+
'id': string;
|
|
2283
|
+
/**
|
|
2284
|
+
*
|
|
2285
|
+
* @type {string}
|
|
2286
|
+
* @memberof DeleteFileResponse
|
|
2287
|
+
*/
|
|
2288
|
+
'object': string;
|
|
2289
|
+
/**
|
|
2290
|
+
*
|
|
2291
|
+
* @type {boolean}
|
|
2292
|
+
* @memberof DeleteFileResponse
|
|
2293
|
+
*/
|
|
2294
|
+
'deleted': boolean;
|
|
2295
|
+
}
|
|
2147
2296
|
/**
|
|
2148
2297
|
*
|
|
2149
2298
|
* @export
|
|
@@ -2208,11 +2357,50 @@ export interface ErrorResponse {
|
|
|
2208
2357
|
*/
|
|
2209
2358
|
export interface GenerateRequest {
|
|
2210
2359
|
/**
|
|
2211
|
-
*
|
|
2212
|
-
* @type {
|
|
2360
|
+
*
|
|
2361
|
+
* @type {GenerateRequestConvo}
|
|
2213
2362
|
* @memberof GenerateRequest
|
|
2214
2363
|
*/
|
|
2215
|
-
'convo':
|
|
2364
|
+
'convo': GenerateRequestConvo;
|
|
2365
|
+
/**
|
|
2366
|
+
*
|
|
2367
|
+
* @type {GenerateRequestMocks}
|
|
2368
|
+
* @memberof GenerateRequest
|
|
2369
|
+
*/
|
|
2370
|
+
'mocks'?: GenerateRequestMocks;
|
|
2371
|
+
}
|
|
2372
|
+
/**
|
|
2373
|
+
* @type GenerateRequestConvo
|
|
2374
|
+
* The conversation to generate a message from
|
|
2375
|
+
* @export
|
|
2376
|
+
*/
|
|
2377
|
+
export type GenerateRequestConvo = ConversationCreateRequest | string;
|
|
2378
|
+
/**
|
|
2379
|
+
* If any mocks are provided, the response will be mocked and conversation will not be created. Requires .convo to be a Conversation object
|
|
2380
|
+
* @export
|
|
2381
|
+
* @interface GenerateRequestMocks
|
|
2382
|
+
*/
|
|
2383
|
+
export interface GenerateRequestMocks {
|
|
2384
|
+
/**
|
|
2385
|
+
* Any key,value information about the conversation, customr, or offer goes here
|
|
2386
|
+
* @type {{ [key: string]: any; }}
|
|
2387
|
+
* @memberof GenerateRequestMocks
|
|
2388
|
+
*/
|
|
2389
|
+
'info'?: {
|
|
2390
|
+
[key: string]: any;
|
|
2391
|
+
};
|
|
2392
|
+
/**
|
|
2393
|
+
* Conversation Context fields to mock, use this to test out conversation logic
|
|
2394
|
+
* @type {Array<ConversationContextField>}
|
|
2395
|
+
* @memberof GenerateRequestMocks
|
|
2396
|
+
*/
|
|
2397
|
+
'context'?: Array<ConversationContextField>;
|
|
2398
|
+
/**
|
|
2399
|
+
* Conversation Messages to mock, use this to test out anticipated responses
|
|
2400
|
+
* @type {Array<MessageBase>}
|
|
2401
|
+
* @memberof GenerateRequestMocks
|
|
2402
|
+
*/
|
|
2403
|
+
'messages'?: Array<MessageBase>;
|
|
2216
2404
|
}
|
|
2217
2405
|
/**
|
|
2218
2406
|
*
|
|
@@ -2244,13 +2432,48 @@ export interface GenerateResponse {
|
|
|
2244
2432
|
* @memberof GenerateResponse
|
|
2245
2433
|
*/
|
|
2246
2434
|
'time': string;
|
|
2435
|
+
/**
|
|
2436
|
+
* Any key,value information about the conversation, customr, or offer goes here
|
|
2437
|
+
* @type {{ [key: string]: any; }}
|
|
2438
|
+
* @memberof GenerateResponse
|
|
2439
|
+
*/
|
|
2440
|
+
'info': {
|
|
2441
|
+
[key: string]: any;
|
|
2442
|
+
};
|
|
2443
|
+
/**
|
|
2444
|
+
* Conversation Context fields to mock, use this to test out conversation logic
|
|
2445
|
+
* @type {Array<ConversationContextField>}
|
|
2446
|
+
* @memberof GenerateResponse
|
|
2447
|
+
*/
|
|
2448
|
+
'included': Array<ConversationContextField>;
|
|
2247
2449
|
}
|
|
2248
2450
|
export declare const GenerateResponseRoleEnum: {
|
|
2249
|
-
readonly
|
|
2250
|
-
readonly
|
|
2251
|
-
readonly
|
|
2451
|
+
readonly Customer: "customer";
|
|
2452
|
+
readonly Agent: "agent";
|
|
2453
|
+
readonly Context: "context";
|
|
2252
2454
|
};
|
|
2253
2455
|
export type GenerateResponseRoleEnum = typeof GenerateResponseRoleEnum[keyof typeof GenerateResponseRoleEnum];
|
|
2456
|
+
/**
|
|
2457
|
+
*
|
|
2458
|
+
* @export
|
|
2459
|
+
* @interface GenerateResponseAllOf
|
|
2460
|
+
*/
|
|
2461
|
+
export interface GenerateResponseAllOf {
|
|
2462
|
+
/**
|
|
2463
|
+
* Any key,value information about the conversation, customr, or offer goes here
|
|
2464
|
+
* @type {{ [key: string]: any; }}
|
|
2465
|
+
* @memberof GenerateResponseAllOf
|
|
2466
|
+
*/
|
|
2467
|
+
'info': {
|
|
2468
|
+
[key: string]: any;
|
|
2469
|
+
};
|
|
2470
|
+
/**
|
|
2471
|
+
* Conversation Context fields to mock, use this to test out conversation logic
|
|
2472
|
+
* @type {Array<ConversationContextField>}
|
|
2473
|
+
* @memberof GenerateResponseAllOf
|
|
2474
|
+
*/
|
|
2475
|
+
'included': Array<ConversationContextField>;
|
|
2476
|
+
}
|
|
2254
2477
|
/**
|
|
2255
2478
|
*
|
|
2256
2479
|
* @export
|
|
@@ -2304,7 +2527,7 @@ export interface GetAgentResponse {
|
|
|
2304
2527
|
* @type {string}
|
|
2305
2528
|
* @memberof GetAgentResponse
|
|
2306
2529
|
*/
|
|
2307
|
-
'forwardPhone'
|
|
2530
|
+
'forwardPhone'?: string;
|
|
2308
2531
|
/**
|
|
2309
2532
|
* Title of the agent, defaults to \"Agent\"
|
|
2310
2533
|
* @type {string}
|
|
@@ -2324,17 +2547,17 @@ export interface GetAgentResponse {
|
|
|
2324
2547
|
*/
|
|
2325
2548
|
'includedLocations'?: Array<string>;
|
|
2326
2549
|
/**
|
|
2327
|
-
*
|
|
2328
|
-
* @type {
|
|
2550
|
+
* AI Model
|
|
2551
|
+
* @type {string}
|
|
2329
2552
|
* @memberof GetAgentResponse
|
|
2330
2553
|
*/
|
|
2331
|
-
'
|
|
2554
|
+
'model'?: GetAgentResponseModelEnum;
|
|
2332
2555
|
/**
|
|
2333
|
-
*
|
|
2334
|
-
* @type {string}
|
|
2556
|
+
* Locations id the agent is excluded from
|
|
2557
|
+
* @type {Array<string>}
|
|
2335
2558
|
* @memberof GetAgentResponse
|
|
2336
2559
|
*/
|
|
2337
|
-
'
|
|
2560
|
+
'excludedLocations'?: Array<string>;
|
|
2338
2561
|
/**
|
|
2339
2562
|
* The ID of the agent
|
|
2340
2563
|
* @type {string}
|
|
@@ -2342,6 +2565,12 @@ export interface GetAgentResponse {
|
|
|
2342
2565
|
*/
|
|
2343
2566
|
'$id': string;
|
|
2344
2567
|
}
|
|
2568
|
+
export declare const GetAgentResponseModelEnum: {
|
|
2569
|
+
readonly PocketScout: "Pocket Scout";
|
|
2570
|
+
readonly Bard: "bard";
|
|
2571
|
+
readonly Null: "null";
|
|
2572
|
+
};
|
|
2573
|
+
export type GetAgentResponseModelEnum = typeof GetAgentResponseModelEnum[keyof typeof GetAgentResponseModelEnum];
|
|
2345
2574
|
/**
|
|
2346
2575
|
*
|
|
2347
2576
|
* @export
|
|
@@ -2766,13 +2995,13 @@ export interface ListAgentsResponseInner {
|
|
|
2766
2995
|
* @type {string}
|
|
2767
2996
|
* @memberof ListAgentsResponseInner
|
|
2768
2997
|
*/
|
|
2769
|
-
'firstName'
|
|
2998
|
+
'firstName'?: string;
|
|
2770
2999
|
/**
|
|
2771
3000
|
* Agent last name
|
|
2772
3001
|
* @type {string}
|
|
2773
3002
|
* @memberof ListAgentsResponseInner
|
|
2774
3003
|
*/
|
|
2775
|
-
'lastName'
|
|
3004
|
+
'lastName'?: string;
|
|
2776
3005
|
/**
|
|
2777
3006
|
* Agent is inactive
|
|
2778
3007
|
* @type {boolean}
|
|
@@ -2808,7 +3037,7 @@ export interface ListAgentsResponseInner {
|
|
|
2808
3037
|
* @type {string}
|
|
2809
3038
|
* @memberof ListAgentsResponseInner
|
|
2810
3039
|
*/
|
|
2811
|
-
'forwardPhone'
|
|
3040
|
+
'forwardPhone'?: string;
|
|
2812
3041
|
/**
|
|
2813
3042
|
* Title of the agent, defaults to \"Agent\"
|
|
2814
3043
|
* @type {string}
|
|
@@ -2828,17 +3057,17 @@ export interface ListAgentsResponseInner {
|
|
|
2828
3057
|
*/
|
|
2829
3058
|
'includedLocations'?: Array<string>;
|
|
2830
3059
|
/**
|
|
2831
|
-
*
|
|
2832
|
-
* @type {
|
|
3060
|
+
* AI Model
|
|
3061
|
+
* @type {string}
|
|
2833
3062
|
* @memberof ListAgentsResponseInner
|
|
2834
3063
|
*/
|
|
2835
|
-
'
|
|
3064
|
+
'model'?: ListAgentsResponseInnerModelEnum;
|
|
2836
3065
|
/**
|
|
2837
|
-
*
|
|
2838
|
-
* @type {string}
|
|
3066
|
+
* Locations id the agent is excluded from
|
|
3067
|
+
* @type {Array<string>}
|
|
2839
3068
|
* @memberof ListAgentsResponseInner
|
|
2840
3069
|
*/
|
|
2841
|
-
'
|
|
3070
|
+
'excludedLocations'?: Array<string>;
|
|
2842
3071
|
/**
|
|
2843
3072
|
* The ID of the agent
|
|
2844
3073
|
* @type {string}
|
|
@@ -2846,6 +3075,12 @@ export interface ListAgentsResponseInner {
|
|
|
2846
3075
|
*/
|
|
2847
3076
|
'$id': string;
|
|
2848
3077
|
}
|
|
3078
|
+
export declare const ListAgentsResponseInnerModelEnum: {
|
|
3079
|
+
readonly PocketScout: "Pocket Scout";
|
|
3080
|
+
readonly Bard: "bard";
|
|
3081
|
+
readonly Null: "null";
|
|
3082
|
+
};
|
|
3083
|
+
export type ListAgentsResponseInnerModelEnum = typeof ListAgentsResponseInnerModelEnum[keyof typeof ListAgentsResponseInnerModelEnum];
|
|
2849
3084
|
/**
|
|
2850
3085
|
*
|
|
2851
3086
|
* @export
|
|
@@ -3185,6 +3420,25 @@ export interface ListCustomersResponseInnerAllOf {
|
|
|
3185
3420
|
*/
|
|
3186
3421
|
'$id': string;
|
|
3187
3422
|
}
|
|
3423
|
+
/**
|
|
3424
|
+
*
|
|
3425
|
+
* @export
|
|
3426
|
+
* @interface ListFilesResponse
|
|
3427
|
+
*/
|
|
3428
|
+
export interface ListFilesResponse {
|
|
3429
|
+
/**
|
|
3430
|
+
*
|
|
3431
|
+
* @type {string}
|
|
3432
|
+
* @memberof ListFilesResponse
|
|
3433
|
+
*/
|
|
3434
|
+
'object': string;
|
|
3435
|
+
/**
|
|
3436
|
+
*
|
|
3437
|
+
* @type {Array<Scout9File>}
|
|
3438
|
+
* @memberof ListFilesResponse
|
|
3439
|
+
*/
|
|
3440
|
+
'data': Array<Scout9File>;
|
|
3441
|
+
}
|
|
3188
3442
|
/**
|
|
3189
3443
|
*
|
|
3190
3444
|
* @export
|
|
@@ -3340,11 +3594,55 @@ export interface Message {
|
|
|
3340
3594
|
'time': string;
|
|
3341
3595
|
}
|
|
3342
3596
|
export declare const MessageRoleEnum: {
|
|
3343
|
-
readonly
|
|
3344
|
-
readonly
|
|
3345
|
-
readonly
|
|
3597
|
+
readonly Customer: "customer";
|
|
3598
|
+
readonly Agent: "agent";
|
|
3599
|
+
readonly Context: "context";
|
|
3346
3600
|
};
|
|
3347
3601
|
export type MessageRoleEnum = typeof MessageRoleEnum[keyof typeof MessageRoleEnum];
|
|
3602
|
+
/**
|
|
3603
|
+
*
|
|
3604
|
+
* @export
|
|
3605
|
+
* @interface MessageAllOf
|
|
3606
|
+
*/
|
|
3607
|
+
export interface MessageAllOf {
|
|
3608
|
+
/**
|
|
3609
|
+
* The time the message was sent
|
|
3610
|
+
* @type {string}
|
|
3611
|
+
* @memberof MessageAllOf
|
|
3612
|
+
*/
|
|
3613
|
+
'time': string;
|
|
3614
|
+
}
|
|
3615
|
+
/**
|
|
3616
|
+
*
|
|
3617
|
+
* @export
|
|
3618
|
+
* @interface MessageBase
|
|
3619
|
+
*/
|
|
3620
|
+
export interface MessageBase {
|
|
3621
|
+
/**
|
|
3622
|
+
* The role of the message (customer, agent, or business)
|
|
3623
|
+
* @type {string}
|
|
3624
|
+
* @memberof MessageBase
|
|
3625
|
+
*/
|
|
3626
|
+
'role': MessageBaseRoleEnum;
|
|
3627
|
+
/**
|
|
3628
|
+
* The content of the message
|
|
3629
|
+
* @type {string}
|
|
3630
|
+
* @memberof MessageBase
|
|
3631
|
+
*/
|
|
3632
|
+
'content': string;
|
|
3633
|
+
/**
|
|
3634
|
+
* The name of the sender
|
|
3635
|
+
* @type {string}
|
|
3636
|
+
* @memberof MessageBase
|
|
3637
|
+
*/
|
|
3638
|
+
'name'?: string;
|
|
3639
|
+
}
|
|
3640
|
+
export declare const MessageBaseRoleEnum: {
|
|
3641
|
+
readonly Customer: "customer";
|
|
3642
|
+
readonly Agent: "agent";
|
|
3643
|
+
readonly Context: "context";
|
|
3644
|
+
};
|
|
3645
|
+
export type MessageBaseRoleEnum = typeof MessageBaseRoleEnum[keyof typeof MessageBaseRoleEnum];
|
|
3348
3646
|
/**
|
|
3349
3647
|
*
|
|
3350
3648
|
* @export
|
|
@@ -3445,9 +3743,9 @@ export interface MessageGetResponseInner {
|
|
|
3445
3743
|
'$id': string;
|
|
3446
3744
|
}
|
|
3447
3745
|
export declare const MessageGetResponseInnerRoleEnum: {
|
|
3448
|
-
readonly
|
|
3449
|
-
readonly
|
|
3450
|
-
readonly
|
|
3746
|
+
readonly Customer: "customer";
|
|
3747
|
+
readonly Agent: "agent";
|
|
3748
|
+
readonly Context: "context";
|
|
3451
3749
|
};
|
|
3452
3750
|
export type MessageGetResponseInnerRoleEnum = typeof MessageGetResponseInnerRoleEnum[keyof typeof MessageGetResponseInnerRoleEnum];
|
|
3453
3751
|
/**
|
|
@@ -3659,7 +3957,7 @@ export interface ScheduleCreateRequest {
|
|
|
3659
3957
|
* @type {ConversationUpdateRequestBaseWorkflow}
|
|
3660
3958
|
* @memberof ScheduleCreateRequest
|
|
3661
3959
|
*/
|
|
3662
|
-
'$workflow'
|
|
3960
|
+
'$workflow'?: ConversationUpdateRequestBaseWorkflow;
|
|
3663
3961
|
}
|
|
3664
3962
|
/**
|
|
3665
3963
|
*
|
|
@@ -3771,6 +4069,24 @@ export interface ScheduleGetResponse {
|
|
|
3771
4069
|
* @memberof ScheduleGetResponse
|
|
3772
4070
|
*/
|
|
3773
4071
|
'$workflow': string;
|
|
4072
|
+
/**
|
|
4073
|
+
* The client web url of the conversation
|
|
4074
|
+
* @type {string}
|
|
4075
|
+
* @memberof ScheduleGetResponse
|
|
4076
|
+
*/
|
|
4077
|
+
'clientWebUrl'?: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* The agent web url of the conversation (requires phone two-factor authentication)
|
|
4080
|
+
* @type {string}
|
|
4081
|
+
* @memberof ScheduleGetResponse
|
|
4082
|
+
*/
|
|
4083
|
+
'agentWebUrl'?: string;
|
|
4084
|
+
/**
|
|
4085
|
+
* The agent test web url of the conversation, used for testing the conversation without notifying the customer
|
|
4086
|
+
* @type {string}
|
|
4087
|
+
* @memberof ScheduleGetResponse
|
|
4088
|
+
*/
|
|
4089
|
+
'agentTestWebUrl'?: string;
|
|
3774
4090
|
}
|
|
3775
4091
|
/**
|
|
3776
4092
|
*
|
|
@@ -3783,7 +4099,7 @@ export interface ScheduleGroupCreateRequest {
|
|
|
3783
4099
|
* @type {ConversationUpdateRequestBaseWorkflow}
|
|
3784
4100
|
* @memberof ScheduleGroupCreateRequest
|
|
3785
4101
|
*/
|
|
3786
|
-
'$workflow'
|
|
4102
|
+
'$workflow'?: ConversationUpdateRequestBaseWorkflow;
|
|
3787
4103
|
/**
|
|
3788
4104
|
* Default agent assigned to the conversation(s)
|
|
3789
4105
|
* @type {string}
|
|
@@ -4382,24 +4698,97 @@ export interface ScheduledConversationGroupAllOf {
|
|
|
4382
4698
|
*/
|
|
4383
4699
|
'delay'?: number;
|
|
4384
4700
|
}
|
|
4701
|
+
/**
|
|
4702
|
+
* The `File` object represents a document that has been uploaded to Scout9.
|
|
4703
|
+
* @export
|
|
4704
|
+
* @interface Scout9File
|
|
4705
|
+
*/
|
|
4706
|
+
export interface Scout9File {
|
|
4707
|
+
/**
|
|
4708
|
+
* The file identifier, which can be referenced in the API endpoints.
|
|
4709
|
+
* @type {string}
|
|
4710
|
+
* @memberof Scout9File
|
|
4711
|
+
*/
|
|
4712
|
+
'id': string;
|
|
4713
|
+
/**
|
|
4714
|
+
* The object type, which is always \"file\".
|
|
4715
|
+
* @type {string}
|
|
4716
|
+
* @memberof Scout9File
|
|
4717
|
+
*/
|
|
4718
|
+
'object': string;
|
|
4719
|
+
/**
|
|
4720
|
+
* The size of the file in bytes.
|
|
4721
|
+
* @type {number}
|
|
4722
|
+
* @memberof Scout9File
|
|
4723
|
+
*/
|
|
4724
|
+
'bytes': number;
|
|
4725
|
+
/**
|
|
4726
|
+
* The unix timestamp for when the file was created.
|
|
4727
|
+
* @type {number}
|
|
4728
|
+
* @memberof Scout9File
|
|
4729
|
+
*/
|
|
4730
|
+
'created_at': number;
|
|
4731
|
+
/**
|
|
4732
|
+
* The name of the file.
|
|
4733
|
+
* @type {string}
|
|
4734
|
+
* @memberof Scout9File
|
|
4735
|
+
*/
|
|
4736
|
+
'filename': string;
|
|
4737
|
+
/**
|
|
4738
|
+
* The intended purpose of the file. Currently, only \"fine-tune\" is supported.
|
|
4739
|
+
* @type {string}
|
|
4740
|
+
* @memberof Scout9File
|
|
4741
|
+
*/
|
|
4742
|
+
'purpose': string;
|
|
4743
|
+
/**
|
|
4744
|
+
* The current status of the file, which can be either `uploaded`, `processed`, `pending`, `error`, `deleting` or `deleted`.
|
|
4745
|
+
* @type {string}
|
|
4746
|
+
* @memberof Scout9File
|
|
4747
|
+
*/
|
|
4748
|
+
'status'?: string;
|
|
4749
|
+
/**
|
|
4750
|
+
* Additional details about the status of the file. If the file is in the `error` state, this will include a message describing the error.
|
|
4751
|
+
* @type {string}
|
|
4752
|
+
* @memberof Scout9File
|
|
4753
|
+
*/
|
|
4754
|
+
'status_details'?: string | null;
|
|
4755
|
+
}
|
|
4385
4756
|
/**
|
|
4386
4757
|
*
|
|
4387
4758
|
* @export
|
|
4388
4759
|
* @interface UpdateAgentRequest
|
|
4389
4760
|
*/
|
|
4390
4761
|
export interface UpdateAgentRequest {
|
|
4762
|
+
/**
|
|
4763
|
+
* The ID of the agent to update
|
|
4764
|
+
* @type {string}
|
|
4765
|
+
* @memberof UpdateAgentRequest
|
|
4766
|
+
*/
|
|
4767
|
+
'$id': string;
|
|
4768
|
+
/**
|
|
4769
|
+
* Sample conversations that help build out your agent to mimic your responses
|
|
4770
|
+
* @type {Array<CreateAgentRequestAllOfConversationsInner>}
|
|
4771
|
+
* @memberof UpdateAgentRequest
|
|
4772
|
+
*/
|
|
4773
|
+
'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
|
|
4774
|
+
/**
|
|
4775
|
+
* Sample audio files that help build out your agent to mimic your voice
|
|
4776
|
+
* @type {Array<string>}
|
|
4777
|
+
* @memberof UpdateAgentRequest
|
|
4778
|
+
*/
|
|
4779
|
+
'audio'?: Array<string>;
|
|
4391
4780
|
/**
|
|
4392
4781
|
* Agent first name
|
|
4393
4782
|
* @type {string}
|
|
4394
4783
|
* @memberof UpdateAgentRequest
|
|
4395
4784
|
*/
|
|
4396
|
-
'firstName'
|
|
4785
|
+
'firstName'?: string;
|
|
4397
4786
|
/**
|
|
4398
4787
|
* Agent last name
|
|
4399
4788
|
* @type {string}
|
|
4400
4789
|
* @memberof UpdateAgentRequest
|
|
4401
4790
|
*/
|
|
4402
|
-
'lastName'
|
|
4791
|
+
'lastName'?: string;
|
|
4403
4792
|
/**
|
|
4404
4793
|
* Agent is inactive
|
|
4405
4794
|
* @type {boolean}
|
|
@@ -4435,7 +4824,7 @@ export interface UpdateAgentRequest {
|
|
|
4435
4824
|
* @type {string}
|
|
4436
4825
|
* @memberof UpdateAgentRequest
|
|
4437
4826
|
*/
|
|
4438
|
-
'forwardPhone'
|
|
4827
|
+
'forwardPhone'?: string;
|
|
4439
4828
|
/**
|
|
4440
4829
|
* Title of the agent, defaults to \"Agent\"
|
|
4441
4830
|
* @type {string}
|
|
@@ -4455,24 +4844,24 @@ export interface UpdateAgentRequest {
|
|
|
4455
4844
|
*/
|
|
4456
4845
|
'includedLocations'?: Array<string>;
|
|
4457
4846
|
/**
|
|
4458
|
-
*
|
|
4459
|
-
* @type {Array<string>}
|
|
4460
|
-
* @memberof UpdateAgentRequest
|
|
4461
|
-
*/
|
|
4462
|
-
'excludedLocations'?: Array<string>;
|
|
4463
|
-
/**
|
|
4464
|
-
* Transcript of the agent
|
|
4847
|
+
* AI Model
|
|
4465
4848
|
* @type {string}
|
|
4466
4849
|
* @memberof UpdateAgentRequest
|
|
4467
4850
|
*/
|
|
4468
|
-
'
|
|
4851
|
+
'model'?: UpdateAgentRequestModelEnum;
|
|
4469
4852
|
/**
|
|
4470
|
-
*
|
|
4471
|
-
* @type {string}
|
|
4853
|
+
* Locations id the agent is excluded from
|
|
4854
|
+
* @type {Array<string>}
|
|
4472
4855
|
* @memberof UpdateAgentRequest
|
|
4473
4856
|
*/
|
|
4474
|
-
'
|
|
4857
|
+
'excludedLocations'?: Array<string>;
|
|
4475
4858
|
}
|
|
4859
|
+
export declare const UpdateAgentRequestModelEnum: {
|
|
4860
|
+
readonly PocketScout: "Pocket Scout";
|
|
4861
|
+
readonly Bard: "bard";
|
|
4862
|
+
readonly Null: "null";
|
|
4863
|
+
};
|
|
4864
|
+
export type UpdateAgentRequestModelEnum = typeof UpdateAgentRequestModelEnum[keyof typeof UpdateAgentRequestModelEnum];
|
|
4476
4865
|
/**
|
|
4477
4866
|
*
|
|
4478
4867
|
* @export
|
|
@@ -4485,6 +4874,18 @@ export interface UpdateAgentRequestAllOf {
|
|
|
4485
4874
|
* @memberof UpdateAgentRequestAllOf
|
|
4486
4875
|
*/
|
|
4487
4876
|
'$id': string;
|
|
4877
|
+
/**
|
|
4878
|
+
* Sample conversations that help build out your agent to mimic your responses
|
|
4879
|
+
* @type {Array<CreateAgentRequestAllOfConversationsInner>}
|
|
4880
|
+
* @memberof UpdateAgentRequestAllOf
|
|
4881
|
+
*/
|
|
4882
|
+
'conversations'?: Array<CreateAgentRequestAllOfConversationsInner>;
|
|
4883
|
+
/**
|
|
4884
|
+
* Sample audio files that help build out your agent to mimic your voice
|
|
4885
|
+
* @type {Array<string>}
|
|
4886
|
+
* @memberof UpdateAgentRequestAllOf
|
|
4887
|
+
*/
|
|
4888
|
+
'audio'?: Array<string>;
|
|
4488
4889
|
}
|
|
4489
4890
|
/**
|
|
4490
4891
|
*
|
|
@@ -4577,7 +4978,7 @@ export interface UpdateAgentsRequestAgentsInner {
|
|
|
4577
4978
|
* @type {string}
|
|
4578
4979
|
* @memberof UpdateAgentsRequestAgentsInner
|
|
4579
4980
|
*/
|
|
4580
|
-
'forwardPhone'
|
|
4981
|
+
'forwardPhone'?: string;
|
|
4581
4982
|
/**
|
|
4582
4983
|
* Title of the agent, defaults to \"Agent\"
|
|
4583
4984
|
* @type {string}
|
|
@@ -4597,17 +4998,17 @@ export interface UpdateAgentsRequestAgentsInner {
|
|
|
4597
4998
|
*/
|
|
4598
4999
|
'includedLocations'?: Array<string>;
|
|
4599
5000
|
/**
|
|
4600
|
-
*
|
|
4601
|
-
* @type {
|
|
5001
|
+
* AI Model
|
|
5002
|
+
* @type {string}
|
|
4602
5003
|
* @memberof UpdateAgentsRequestAgentsInner
|
|
4603
5004
|
*/
|
|
4604
|
-
'
|
|
5005
|
+
'model'?: UpdateAgentsRequestAgentsInnerModelEnum;
|
|
4605
5006
|
/**
|
|
4606
|
-
*
|
|
4607
|
-
* @type {string}
|
|
5007
|
+
* Locations id the agent is excluded from
|
|
5008
|
+
* @type {Array<string>}
|
|
4608
5009
|
* @memberof UpdateAgentsRequestAgentsInner
|
|
4609
5010
|
*/
|
|
4610
|
-
'
|
|
5011
|
+
'excludedLocations'?: Array<string>;
|
|
4611
5012
|
/**
|
|
4612
5013
|
* The ID of the agent
|
|
4613
5014
|
* @type {string}
|
|
@@ -4615,6 +5016,12 @@ export interface UpdateAgentsRequestAgentsInner {
|
|
|
4615
5016
|
*/
|
|
4616
5017
|
'$id': string;
|
|
4617
5018
|
}
|
|
5019
|
+
export declare const UpdateAgentsRequestAgentsInnerModelEnum: {
|
|
5020
|
+
readonly PocketScout: "Pocket Scout";
|
|
5021
|
+
readonly Bard: "bard";
|
|
5022
|
+
readonly Null: "null";
|
|
5023
|
+
};
|
|
5024
|
+
export type UpdateAgentsRequestAgentsInnerModelEnum = typeof UpdateAgentsRequestAgentsInnerModelEnum[keyof typeof UpdateAgentsRequestAgentsInnerModelEnum];
|
|
4618
5025
|
/**
|
|
4619
5026
|
*
|
|
4620
5027
|
* @export
|
|
@@ -5271,34 +5678,34 @@ export interface Workflow {
|
|
|
5271
5678
|
'onError'?: string;
|
|
5272
5679
|
}
|
|
5273
5680
|
/**
|
|
5274
|
-
*
|
|
5681
|
+
* PocketScoutApi - axios parameter creator
|
|
5275
5682
|
* @export
|
|
5276
5683
|
*/
|
|
5277
|
-
export declare const
|
|
5684
|
+
export declare const PocketScoutApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5278
5685
|
/**
|
|
5279
5686
|
*
|
|
5280
5687
|
* @summary Gets a agent
|
|
5281
|
-
* @param {string} id
|
|
5688
|
+
* @param {string} id id of entity to query
|
|
5282
5689
|
* @param {*} [options] Override http request option.
|
|
5283
5690
|
* @throws {RequiredError}
|
|
5284
5691
|
*/
|
|
5285
5692
|
agent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5286
5693
|
/**
|
|
5287
5694
|
*
|
|
5288
|
-
* @summary
|
|
5289
|
-
* @param {
|
|
5695
|
+
* @summary Deletes a agent
|
|
5696
|
+
* @param {string} id id of entity to query
|
|
5290
5697
|
* @param {*} [options] Override http request option.
|
|
5291
5698
|
* @throws {RequiredError}
|
|
5292
5699
|
*/
|
|
5293
|
-
|
|
5700
|
+
agentDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5294
5701
|
/**
|
|
5295
5702
|
*
|
|
5296
|
-
* @summary
|
|
5297
|
-
* @param {
|
|
5703
|
+
* @summary Registers a new agent
|
|
5704
|
+
* @param {CreateAgentRequest} createAgentRequest
|
|
5298
5705
|
* @param {*} [options] Override http request option.
|
|
5299
5706
|
* @throws {RequiredError}
|
|
5300
5707
|
*/
|
|
5301
|
-
|
|
5708
|
+
agentRegister: (createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5302
5709
|
/**
|
|
5303
5710
|
*
|
|
5304
5711
|
* @summary Update a agent
|
|
@@ -5311,7 +5718,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5311
5718
|
*
|
|
5312
5719
|
* @summary Gets all or specific set of agents
|
|
5313
5720
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5314
|
-
* @param {Array<string>} [id]
|
|
5721
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5315
5722
|
* @param {*} [options] Override http request option.
|
|
5316
5723
|
* @throws {RequiredError}
|
|
5317
5724
|
*/
|
|
@@ -5327,7 +5734,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5327
5734
|
/**
|
|
5328
5735
|
*
|
|
5329
5736
|
* @summary Deletes multiple agents
|
|
5330
|
-
* @param {Array<string>} [id]
|
|
5737
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5331
5738
|
* @param {*} [options] Override http request option.
|
|
5332
5739
|
* @throws {RequiredError}
|
|
5333
5740
|
*/
|
|
@@ -5343,7 +5750,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5343
5750
|
/**
|
|
5344
5751
|
*
|
|
5345
5752
|
* @summary Gets a context
|
|
5346
|
-
* @param {string} id
|
|
5753
|
+
* @param {string} id id of entity to query
|
|
5347
5754
|
* @param {*} [options] Override http request option.
|
|
5348
5755
|
* @throws {RequiredError}
|
|
5349
5756
|
*/
|
|
@@ -5359,7 +5766,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5359
5766
|
/**
|
|
5360
5767
|
*
|
|
5361
5768
|
* @summary Deletes a schedule
|
|
5362
|
-
* @param {string} id
|
|
5769
|
+
* @param {string} id id of entity to query
|
|
5363
5770
|
* @param {*} [options] Override http request option.
|
|
5364
5771
|
* @throws {RequiredError}
|
|
5365
5772
|
*/
|
|
@@ -5376,7 +5783,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5376
5783
|
*
|
|
5377
5784
|
* @summary Gets all or specific set of contexts
|
|
5378
5785
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5379
|
-
* @param {Array<string>} [id]
|
|
5786
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5380
5787
|
* @param {*} [options] Override http request option.
|
|
5381
5788
|
* @throws {RequiredError}
|
|
5382
5789
|
*/
|
|
@@ -5392,7 +5799,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5392
5799
|
/**
|
|
5393
5800
|
*
|
|
5394
5801
|
* @summary Deletes multiple contexts
|
|
5395
|
-
* @param {Array<string>} [id]
|
|
5802
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5396
5803
|
* @param {*} [options] Override http request option.
|
|
5397
5804
|
* @throws {RequiredError}
|
|
5398
5805
|
*/
|
|
@@ -5408,7 +5815,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5408
5815
|
/**
|
|
5409
5816
|
*
|
|
5410
5817
|
* @summary Gets a conversation
|
|
5411
|
-
* @param {string} id
|
|
5818
|
+
* @param {string} id id of entity to query
|
|
5412
5819
|
* @param {*} [options] Override http request option.
|
|
5413
5820
|
* @throws {RequiredError}
|
|
5414
5821
|
*/
|
|
@@ -5424,7 +5831,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5424
5831
|
/**
|
|
5425
5832
|
*
|
|
5426
5833
|
* @summary Deletes a schedule
|
|
5427
|
-
* @param {string} id
|
|
5834
|
+
* @param {string} id id of entity to query
|
|
5428
5835
|
* @param {*} [options] Override http request option.
|
|
5429
5836
|
* @throws {RequiredError}
|
|
5430
5837
|
*/
|
|
@@ -5440,7 +5847,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5440
5847
|
/**
|
|
5441
5848
|
*
|
|
5442
5849
|
* @summary Gets a customer
|
|
5443
|
-
* @param {string} id
|
|
5850
|
+
* @param {string} id id of entity to query
|
|
5444
5851
|
* @param {*} [options] Override http request option.
|
|
5445
5852
|
* @throws {RequiredError}
|
|
5446
5853
|
*/
|
|
@@ -5456,7 +5863,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5456
5863
|
/**
|
|
5457
5864
|
*
|
|
5458
5865
|
* @summary Deletes a customer
|
|
5459
|
-
* @param {string} id
|
|
5866
|
+
* @param {string} id id of entity to query
|
|
5460
5867
|
* @param {*} [options] Override http request option.
|
|
5461
5868
|
* @throws {RequiredError}
|
|
5462
5869
|
*/
|
|
@@ -5464,7 +5871,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5464
5871
|
/**
|
|
5465
5872
|
*
|
|
5466
5873
|
* @summary Gets a customer group
|
|
5467
|
-
* @param {string} id
|
|
5874
|
+
* @param {string} id id of entity to query
|
|
5468
5875
|
* @param {*} [options] Override http request option.
|
|
5469
5876
|
* @throws {RequiredError}
|
|
5470
5877
|
*/
|
|
@@ -5480,7 +5887,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5480
5887
|
/**
|
|
5481
5888
|
*
|
|
5482
5889
|
* @summary Deletes a customer group
|
|
5483
|
-
* @param {string} id
|
|
5890
|
+
* @param {string} id id of entity to query
|
|
5484
5891
|
* @param {*} [options] Override http request option.
|
|
5485
5892
|
* @throws {RequiredError}
|
|
5486
5893
|
*/
|
|
@@ -5497,7 +5904,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5497
5904
|
*
|
|
5498
5905
|
* @summary Gets all or specific set of customer groups
|
|
5499
5906
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5500
|
-
* @param {Array<string>} [id]
|
|
5907
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5501
5908
|
* @param {*} [options] Override http request option.
|
|
5502
5909
|
* @throws {RequiredError}
|
|
5503
5910
|
*/
|
|
@@ -5513,7 +5920,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5513
5920
|
/**
|
|
5514
5921
|
*
|
|
5515
5922
|
* @summary Deletes multiple customer groups
|
|
5516
|
-
* @param {Array<string>} [id]
|
|
5923
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5517
5924
|
* @param {*} [options] Override http request option.
|
|
5518
5925
|
* @throws {RequiredError}
|
|
5519
5926
|
*/
|
|
@@ -5538,7 +5945,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5538
5945
|
*
|
|
5539
5946
|
* @summary Gets all or specific set of customers
|
|
5540
5947
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5541
|
-
* @param {Array<string>} [id]
|
|
5948
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5542
5949
|
* @param {*} [options] Override http request option.
|
|
5543
5950
|
* @throws {RequiredError}
|
|
5544
5951
|
*/
|
|
@@ -5554,7 +5961,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5554
5961
|
/**
|
|
5555
5962
|
*
|
|
5556
5963
|
* @summary Deletes multiple customers
|
|
5557
|
-
* @param {Array<string>} [id]
|
|
5964
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5558
5965
|
* @param {*} [options] Override http request option.
|
|
5559
5966
|
* @throws {RequiredError}
|
|
5560
5967
|
*/
|
|
@@ -5567,6 +5974,46 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5567
5974
|
* @throws {RequiredError}
|
|
5568
5975
|
*/
|
|
5569
5976
|
customersUpdate: (updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5977
|
+
/**
|
|
5978
|
+
*
|
|
5979
|
+
* @summary Returns information about a specific file.
|
|
5980
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
5981
|
+
* @param {*} [options] Override http request option.
|
|
5982
|
+
* @throws {RequiredError}
|
|
5983
|
+
*/
|
|
5984
|
+
file: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5985
|
+
/**
|
|
5986
|
+
*
|
|
5987
|
+
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
5988
|
+
* @param {File} file
|
|
5989
|
+
* @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
|
|
5990
|
+
* @param {*} [options] Override http request option.
|
|
5991
|
+
* @throws {RequiredError}
|
|
5992
|
+
*/
|
|
5993
|
+
fileCreate: (file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5994
|
+
/**
|
|
5995
|
+
*
|
|
5996
|
+
* @summary Delete a file.
|
|
5997
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
5998
|
+
* @param {*} [options] Override http request option.
|
|
5999
|
+
* @throws {RequiredError}
|
|
6000
|
+
*/
|
|
6001
|
+
fileDelete: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6002
|
+
/**
|
|
6003
|
+
*
|
|
6004
|
+
* @summary Returns the contents of the specified file
|
|
6005
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
6006
|
+
* @param {*} [options] Override http request option.
|
|
6007
|
+
* @throws {RequiredError}
|
|
6008
|
+
*/
|
|
6009
|
+
fileDownload: (fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6010
|
+
/**
|
|
6011
|
+
*
|
|
6012
|
+
* @summary Returns a list of files that belong to the user\'s organization.
|
|
6013
|
+
* @param {*} [options] Override http request option.
|
|
6014
|
+
* @throws {RequiredError}
|
|
6015
|
+
*/
|
|
6016
|
+
files: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5570
6017
|
/**
|
|
5571
6018
|
* Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
|
|
5572
6019
|
* @summary Generate a message from conversation
|
|
@@ -5586,16 +6033,16 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5586
6033
|
/**
|
|
5587
6034
|
*
|
|
5588
6035
|
* @summary Get all messages from a conversation
|
|
6036
|
+
* @param {string} id id of entity to query
|
|
5589
6037
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5590
|
-
* @param {Array<string>} [id]
|
|
5591
6038
|
* @param {*} [options] Override http request option.
|
|
5592
6039
|
* @throws {RequiredError}
|
|
5593
6040
|
*/
|
|
5594
|
-
messages: (
|
|
6041
|
+
messages: (id: string, q?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5595
6042
|
/**
|
|
5596
6043
|
*
|
|
5597
6044
|
* @summary Get the results of a bulk API operation
|
|
5598
|
-
* @param {string} id
|
|
6045
|
+
* @param {string} id id of entity to query
|
|
5599
6046
|
* @param {*} [options] Override http request option.
|
|
5600
6047
|
* @throws {RequiredError}
|
|
5601
6048
|
*/
|
|
@@ -5604,7 +6051,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5604
6051
|
*
|
|
5605
6052
|
* @summary Gets all or specific set of bulk API operations
|
|
5606
6053
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5607
|
-
* @param {Array<string>} [id]
|
|
6054
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5608
6055
|
* @param {*} [options] Override http request option.
|
|
5609
6056
|
* @throws {RequiredError}
|
|
5610
6057
|
*/
|
|
@@ -5616,11 +6063,11 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5616
6063
|
* @param {*} [options] Override http request option.
|
|
5617
6064
|
* @throws {RequiredError}
|
|
5618
6065
|
*/
|
|
5619
|
-
|
|
6066
|
+
scheduleConversation: (scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5620
6067
|
/**
|
|
5621
6068
|
*
|
|
5622
6069
|
* @summary Deletes a schedule
|
|
5623
|
-
* @param {string} id
|
|
6070
|
+
* @param {string} id id of entity to query
|
|
5624
6071
|
* @param {*} [options] Override http request option.
|
|
5625
6072
|
* @throws {RequiredError}
|
|
5626
6073
|
*/
|
|
@@ -5636,7 +6083,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5636
6083
|
/**
|
|
5637
6084
|
*
|
|
5638
6085
|
* @summary Deletes and cancels a schedule group
|
|
5639
|
-
* @param {string} id
|
|
6086
|
+
* @param {string} id id of entity to query
|
|
5640
6087
|
* @param {*} [options] Override http request option.
|
|
5641
6088
|
* @throws {RequiredError}
|
|
5642
6089
|
*/
|
|
@@ -5644,7 +6091,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5644
6091
|
/**
|
|
5645
6092
|
*
|
|
5646
6093
|
* @summary Gets a schedule group
|
|
5647
|
-
* @param {string} id
|
|
6094
|
+
* @param {string} id id of entity to query
|
|
5648
6095
|
* @param {*} [options] Override http request option.
|
|
5649
6096
|
* @throws {RequiredError}
|
|
5650
6097
|
*/
|
|
@@ -5660,7 +6107,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5660
6107
|
/**
|
|
5661
6108
|
*
|
|
5662
6109
|
* @summary Gets a schedule
|
|
5663
|
-
* @param {string} id
|
|
6110
|
+
* @param {string} id id of entity to query
|
|
5664
6111
|
* @param {*} [options] Override http request option.
|
|
5665
6112
|
* @throws {RequiredError}
|
|
5666
6113
|
*/
|
|
@@ -5676,7 +6123,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5676
6123
|
/**
|
|
5677
6124
|
*
|
|
5678
6125
|
* @summary Gets a workflow
|
|
5679
|
-
* @param {string} id
|
|
6126
|
+
* @param {string} id id of entity to query
|
|
5680
6127
|
* @param {*} [options] Override http request option.
|
|
5681
6128
|
* @throws {RequiredError}
|
|
5682
6129
|
*/
|
|
@@ -5692,7 +6139,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5692
6139
|
/**
|
|
5693
6140
|
*
|
|
5694
6141
|
* @summary Deletes a workflow
|
|
5695
|
-
* @param {string} id
|
|
6142
|
+
* @param {string} id id of entity to query
|
|
5696
6143
|
* @param {*} [options] Override http request option.
|
|
5697
6144
|
* @throws {RequiredError}
|
|
5698
6145
|
*/
|
|
@@ -5709,7 +6156,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5709
6156
|
*
|
|
5710
6157
|
* @summary Gets all or specific set of workflows
|
|
5711
6158
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5712
|
-
* @param {Array<string>} [id]
|
|
6159
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5713
6160
|
* @param {*} [options] Override http request option.
|
|
5714
6161
|
* @throws {RequiredError}
|
|
5715
6162
|
*/
|
|
@@ -5725,7 +6172,7 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5725
6172
|
/**
|
|
5726
6173
|
*
|
|
5727
6174
|
* @summary Deletes multiple workflows
|
|
5728
|
-
* @param {Array<string>} [id]
|
|
6175
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5729
6176
|
* @param {*} [options] Override http request option.
|
|
5730
6177
|
* @throws {RequiredError}
|
|
5731
6178
|
*/
|
|
@@ -5740,34 +6187,34 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
5740
6187
|
workflowsUpdate: (updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5741
6188
|
};
|
|
5742
6189
|
/**
|
|
5743
|
-
*
|
|
6190
|
+
* PocketScoutApi - functional programming interface
|
|
5744
6191
|
* @export
|
|
5745
6192
|
*/
|
|
5746
|
-
export declare const
|
|
6193
|
+
export declare const PocketScoutApiFp: (configuration?: Configuration) => {
|
|
5747
6194
|
/**
|
|
5748
6195
|
*
|
|
5749
6196
|
* @summary Gets a agent
|
|
5750
|
-
* @param {string} id
|
|
6197
|
+
* @param {string} id id of entity to query
|
|
5751
6198
|
* @param {*} [options] Override http request option.
|
|
5752
6199
|
* @throws {RequiredError}
|
|
5753
6200
|
*/
|
|
5754
6201
|
agent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAgentResponse>>;
|
|
5755
6202
|
/**
|
|
5756
6203
|
*
|
|
5757
|
-
* @summary
|
|
5758
|
-
* @param {
|
|
6204
|
+
* @summary Deletes a agent
|
|
6205
|
+
* @param {string} id id of entity to query
|
|
5759
6206
|
* @param {*} [options] Override http request option.
|
|
5760
6207
|
* @throws {RequiredError}
|
|
5761
6208
|
*/
|
|
5762
|
-
|
|
6209
|
+
agentDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAgentResponse>>;
|
|
5763
6210
|
/**
|
|
5764
6211
|
*
|
|
5765
|
-
* @summary
|
|
5766
|
-
* @param {
|
|
6212
|
+
* @summary Registers a new agent
|
|
6213
|
+
* @param {CreateAgentRequest} createAgentRequest
|
|
5767
6214
|
* @param {*} [options] Override http request option.
|
|
5768
6215
|
* @throws {RequiredError}
|
|
5769
6216
|
*/
|
|
5770
|
-
|
|
6217
|
+
agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAgentResponse>>;
|
|
5771
6218
|
/**
|
|
5772
6219
|
*
|
|
5773
6220
|
* @summary Update a agent
|
|
@@ -5780,7 +6227,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5780
6227
|
*
|
|
5781
6228
|
* @summary Gets all or specific set of agents
|
|
5782
6229
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5783
|
-
* @param {Array<string>} [id]
|
|
6230
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5784
6231
|
* @param {*} [options] Override http request option.
|
|
5785
6232
|
* @throws {RequiredError}
|
|
5786
6233
|
*/
|
|
@@ -5796,7 +6243,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5796
6243
|
/**
|
|
5797
6244
|
*
|
|
5798
6245
|
* @summary Deletes multiple agents
|
|
5799
|
-
* @param {Array<string>} [id]
|
|
6246
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5800
6247
|
* @param {*} [options] Override http request option.
|
|
5801
6248
|
* @throws {RequiredError}
|
|
5802
6249
|
*/
|
|
@@ -5812,7 +6259,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5812
6259
|
/**
|
|
5813
6260
|
*
|
|
5814
6261
|
* @summary Gets a context
|
|
5815
|
-
* @param {string} id
|
|
6262
|
+
* @param {string} id id of entity to query
|
|
5816
6263
|
* @param {*} [options] Override http request option.
|
|
5817
6264
|
* @throws {RequiredError}
|
|
5818
6265
|
*/
|
|
@@ -5828,7 +6275,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5828
6275
|
/**
|
|
5829
6276
|
*
|
|
5830
6277
|
* @summary Deletes a schedule
|
|
5831
|
-
* @param {string} id
|
|
6278
|
+
* @param {string} id id of entity to query
|
|
5832
6279
|
* @param {*} [options] Override http request option.
|
|
5833
6280
|
* @throws {RequiredError}
|
|
5834
6281
|
*/
|
|
@@ -5845,7 +6292,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5845
6292
|
*
|
|
5846
6293
|
* @summary Gets all or specific set of contexts
|
|
5847
6294
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5848
|
-
* @param {Array<string>} [id]
|
|
6295
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5849
6296
|
* @param {*} [options] Override http request option.
|
|
5850
6297
|
* @throws {RequiredError}
|
|
5851
6298
|
*/
|
|
@@ -5861,7 +6308,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5861
6308
|
/**
|
|
5862
6309
|
*
|
|
5863
6310
|
* @summary Deletes multiple contexts
|
|
5864
|
-
* @param {Array<string>} [id]
|
|
6311
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5865
6312
|
* @param {*} [options] Override http request option.
|
|
5866
6313
|
* @throws {RequiredError}
|
|
5867
6314
|
*/
|
|
@@ -5877,7 +6324,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5877
6324
|
/**
|
|
5878
6325
|
*
|
|
5879
6326
|
* @summary Gets a conversation
|
|
5880
|
-
* @param {string} id
|
|
6327
|
+
* @param {string} id id of entity to query
|
|
5881
6328
|
* @param {*} [options] Override http request option.
|
|
5882
6329
|
* @throws {RequiredError}
|
|
5883
6330
|
*/
|
|
@@ -5893,7 +6340,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5893
6340
|
/**
|
|
5894
6341
|
*
|
|
5895
6342
|
* @summary Deletes a schedule
|
|
5896
|
-
* @param {string} id
|
|
6343
|
+
* @param {string} id id of entity to query
|
|
5897
6344
|
* @param {*} [options] Override http request option.
|
|
5898
6345
|
* @throws {RequiredError}
|
|
5899
6346
|
*/
|
|
@@ -5909,7 +6356,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5909
6356
|
/**
|
|
5910
6357
|
*
|
|
5911
6358
|
* @summary Gets a customer
|
|
5912
|
-
* @param {string} id
|
|
6359
|
+
* @param {string} id id of entity to query
|
|
5913
6360
|
* @param {*} [options] Override http request option.
|
|
5914
6361
|
* @throws {RequiredError}
|
|
5915
6362
|
*/
|
|
@@ -5925,7 +6372,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5925
6372
|
/**
|
|
5926
6373
|
*
|
|
5927
6374
|
* @summary Deletes a customer
|
|
5928
|
-
* @param {string} id
|
|
6375
|
+
* @param {string} id id of entity to query
|
|
5929
6376
|
* @param {*} [options] Override http request option.
|
|
5930
6377
|
* @throws {RequiredError}
|
|
5931
6378
|
*/
|
|
@@ -5933,7 +6380,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5933
6380
|
/**
|
|
5934
6381
|
*
|
|
5935
6382
|
* @summary Gets a customer group
|
|
5936
|
-
* @param {string} id
|
|
6383
|
+
* @param {string} id id of entity to query
|
|
5937
6384
|
* @param {*} [options] Override http request option.
|
|
5938
6385
|
* @throws {RequiredError}
|
|
5939
6386
|
*/
|
|
@@ -5949,7 +6396,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5949
6396
|
/**
|
|
5950
6397
|
*
|
|
5951
6398
|
* @summary Deletes a customer group
|
|
5952
|
-
* @param {string} id
|
|
6399
|
+
* @param {string} id id of entity to query
|
|
5953
6400
|
* @param {*} [options] Override http request option.
|
|
5954
6401
|
* @throws {RequiredError}
|
|
5955
6402
|
*/
|
|
@@ -5966,7 +6413,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5966
6413
|
*
|
|
5967
6414
|
* @summary Gets all or specific set of customer groups
|
|
5968
6415
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
5969
|
-
* @param {Array<string>} [id]
|
|
6416
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5970
6417
|
* @param {*} [options] Override http request option.
|
|
5971
6418
|
* @throws {RequiredError}
|
|
5972
6419
|
*/
|
|
@@ -5982,7 +6429,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
5982
6429
|
/**
|
|
5983
6430
|
*
|
|
5984
6431
|
* @summary Deletes multiple customer groups
|
|
5985
|
-
* @param {Array<string>} [id]
|
|
6432
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
5986
6433
|
* @param {*} [options] Override http request option.
|
|
5987
6434
|
* @throws {RequiredError}
|
|
5988
6435
|
*/
|
|
@@ -6007,7 +6454,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6007
6454
|
*
|
|
6008
6455
|
* @summary Gets all or specific set of customers
|
|
6009
6456
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6010
|
-
* @param {Array<string>} [id]
|
|
6457
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6011
6458
|
* @param {*} [options] Override http request option.
|
|
6012
6459
|
* @throws {RequiredError}
|
|
6013
6460
|
*/
|
|
@@ -6023,7 +6470,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6023
6470
|
/**
|
|
6024
6471
|
*
|
|
6025
6472
|
* @summary Deletes multiple customers
|
|
6026
|
-
* @param {Array<string>} [id]
|
|
6473
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6027
6474
|
* @param {*} [options] Override http request option.
|
|
6028
6475
|
* @throws {RequiredError}
|
|
6029
6476
|
*/
|
|
@@ -6036,6 +6483,46 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6036
6483
|
* @throws {RequiredError}
|
|
6037
6484
|
*/
|
|
6038
6485
|
customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomersResponse>>;
|
|
6486
|
+
/**
|
|
6487
|
+
*
|
|
6488
|
+
* @summary Returns information about a specific file.
|
|
6489
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
6490
|
+
* @param {*} [options] Override http request option.
|
|
6491
|
+
* @throws {RequiredError}
|
|
6492
|
+
*/
|
|
6493
|
+
file(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
|
|
6494
|
+
/**
|
|
6495
|
+
*
|
|
6496
|
+
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
6497
|
+
* @param {File} file
|
|
6498
|
+
* @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
|
|
6499
|
+
* @param {*} [options] Override http request option.
|
|
6500
|
+
* @throws {RequiredError}
|
|
6501
|
+
*/
|
|
6502
|
+
fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Scout9File>>;
|
|
6503
|
+
/**
|
|
6504
|
+
*
|
|
6505
|
+
* @summary Delete a file.
|
|
6506
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
6507
|
+
* @param {*} [options] Override http request option.
|
|
6508
|
+
* @throws {RequiredError}
|
|
6509
|
+
*/
|
|
6510
|
+
fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFileResponse>>;
|
|
6511
|
+
/**
|
|
6512
|
+
*
|
|
6513
|
+
* @summary Returns the contents of the specified file
|
|
6514
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
6515
|
+
* @param {*} [options] Override http request option.
|
|
6516
|
+
* @throws {RequiredError}
|
|
6517
|
+
*/
|
|
6518
|
+
fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
6519
|
+
/**
|
|
6520
|
+
*
|
|
6521
|
+
* @summary Returns a list of files that belong to the user\'s organization.
|
|
6522
|
+
* @param {*} [options] Override http request option.
|
|
6523
|
+
* @throws {RequiredError}
|
|
6524
|
+
*/
|
|
6525
|
+
files(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
6039
6526
|
/**
|
|
6040
6527
|
* Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
|
|
6041
6528
|
* @summary Generate a message from conversation
|
|
@@ -6055,16 +6542,16 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6055
6542
|
/**
|
|
6056
6543
|
*
|
|
6057
6544
|
* @summary Get all messages from a conversation
|
|
6545
|
+
* @param {string} id id of entity to query
|
|
6058
6546
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6059
|
-
* @param {Array<string>} [id]
|
|
6060
6547
|
* @param {*} [options] Override http request option.
|
|
6061
6548
|
* @throws {RequiredError}
|
|
6062
6549
|
*/
|
|
6063
|
-
messages(
|
|
6550
|
+
messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MessageGetResponseInner>>>;
|
|
6064
6551
|
/**
|
|
6065
6552
|
*
|
|
6066
6553
|
* @summary Get the results of a bulk API operation
|
|
6067
|
-
* @param {string} id
|
|
6554
|
+
* @param {string} id id of entity to query
|
|
6068
6555
|
* @param {*} [options] Override http request option.
|
|
6069
6556
|
* @throws {RequiredError}
|
|
6070
6557
|
*/
|
|
@@ -6073,7 +6560,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6073
6560
|
*
|
|
6074
6561
|
* @summary Gets all or specific set of bulk API operations
|
|
6075
6562
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6076
|
-
* @param {Array<string>} [id]
|
|
6563
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6077
6564
|
* @param {*} [options] Override http request option.
|
|
6078
6565
|
* @throws {RequiredError}
|
|
6079
6566
|
*/
|
|
@@ -6085,11 +6572,11 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6085
6572
|
* @param {*} [options] Override http request option.
|
|
6086
6573
|
* @throws {RequiredError}
|
|
6087
6574
|
*/
|
|
6088
|
-
|
|
6575
|
+
scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleCreateResponse>>;
|
|
6089
6576
|
/**
|
|
6090
6577
|
*
|
|
6091
6578
|
* @summary Deletes a schedule
|
|
6092
|
-
* @param {string} id
|
|
6579
|
+
* @param {string} id id of entity to query
|
|
6093
6580
|
* @param {*} [options] Override http request option.
|
|
6094
6581
|
* @throws {RequiredError}
|
|
6095
6582
|
*/
|
|
@@ -6105,7 +6592,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6105
6592
|
/**
|
|
6106
6593
|
*
|
|
6107
6594
|
* @summary Deletes and cancels a schedule group
|
|
6108
|
-
* @param {string} id
|
|
6595
|
+
* @param {string} id id of entity to query
|
|
6109
6596
|
* @param {*} [options] Override http request option.
|
|
6110
6597
|
* @throws {RequiredError}
|
|
6111
6598
|
*/
|
|
@@ -6113,7 +6600,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6113
6600
|
/**
|
|
6114
6601
|
*
|
|
6115
6602
|
* @summary Gets a schedule group
|
|
6116
|
-
* @param {string} id
|
|
6603
|
+
* @param {string} id id of entity to query
|
|
6117
6604
|
* @param {*} [options] Override http request option.
|
|
6118
6605
|
* @throws {RequiredError}
|
|
6119
6606
|
*/
|
|
@@ -6129,7 +6616,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6129
6616
|
/**
|
|
6130
6617
|
*
|
|
6131
6618
|
* @summary Gets a schedule
|
|
6132
|
-
* @param {string} id
|
|
6619
|
+
* @param {string} id id of entity to query
|
|
6133
6620
|
* @param {*} [options] Override http request option.
|
|
6134
6621
|
* @throws {RequiredError}
|
|
6135
6622
|
*/
|
|
@@ -6145,7 +6632,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6145
6632
|
/**
|
|
6146
6633
|
*
|
|
6147
6634
|
* @summary Gets a workflow
|
|
6148
|
-
* @param {string} id
|
|
6635
|
+
* @param {string} id id of entity to query
|
|
6149
6636
|
* @param {*} [options] Override http request option.
|
|
6150
6637
|
* @throws {RequiredError}
|
|
6151
6638
|
*/
|
|
@@ -6161,7 +6648,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6161
6648
|
/**
|
|
6162
6649
|
*
|
|
6163
6650
|
* @summary Deletes a workflow
|
|
6164
|
-
* @param {string} id
|
|
6651
|
+
* @param {string} id id of entity to query
|
|
6165
6652
|
* @param {*} [options] Override http request option.
|
|
6166
6653
|
* @throws {RequiredError}
|
|
6167
6654
|
*/
|
|
@@ -6178,7 +6665,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6178
6665
|
*
|
|
6179
6666
|
* @summary Gets all or specific set of workflows
|
|
6180
6667
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6181
|
-
* @param {Array<string>} [id]
|
|
6668
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6182
6669
|
* @param {*} [options] Override http request option.
|
|
6183
6670
|
* @throws {RequiredError}
|
|
6184
6671
|
*/
|
|
@@ -6194,7 +6681,7 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6194
6681
|
/**
|
|
6195
6682
|
*
|
|
6196
6683
|
* @summary Deletes multiple workflows
|
|
6197
|
-
* @param {Array<string>} [id]
|
|
6684
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6198
6685
|
* @param {*} [options] Override http request option.
|
|
6199
6686
|
* @throws {RequiredError}
|
|
6200
6687
|
*/
|
|
@@ -6209,34 +6696,34 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
6209
6696
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkflowsResponse>>;
|
|
6210
6697
|
};
|
|
6211
6698
|
/**
|
|
6212
|
-
*
|
|
6699
|
+
* PocketScoutApi - factory interface
|
|
6213
6700
|
* @export
|
|
6214
6701
|
*/
|
|
6215
|
-
export declare const
|
|
6702
|
+
export declare const PocketScoutApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6216
6703
|
/**
|
|
6217
6704
|
*
|
|
6218
6705
|
* @summary Gets a agent
|
|
6219
|
-
* @param {string} id
|
|
6706
|
+
* @param {string} id id of entity to query
|
|
6220
6707
|
* @param {*} [options] Override http request option.
|
|
6221
6708
|
* @throws {RequiredError}
|
|
6222
6709
|
*/
|
|
6223
6710
|
agent(id: string, options?: any): AxiosPromise<GetAgentResponse>;
|
|
6224
6711
|
/**
|
|
6225
6712
|
*
|
|
6226
|
-
* @summary
|
|
6227
|
-
* @param {
|
|
6713
|
+
* @summary Deletes a agent
|
|
6714
|
+
* @param {string} id id of entity to query
|
|
6228
6715
|
* @param {*} [options] Override http request option.
|
|
6229
6716
|
* @throws {RequiredError}
|
|
6230
6717
|
*/
|
|
6231
|
-
|
|
6718
|
+
agentDelete(id: string, options?: any): AxiosPromise<DeleteAgentResponse>;
|
|
6232
6719
|
/**
|
|
6233
6720
|
*
|
|
6234
|
-
* @summary
|
|
6235
|
-
* @param {
|
|
6721
|
+
* @summary Registers a new agent
|
|
6722
|
+
* @param {CreateAgentRequest} createAgentRequest
|
|
6236
6723
|
* @param {*} [options] Override http request option.
|
|
6237
6724
|
* @throws {RequiredError}
|
|
6238
6725
|
*/
|
|
6239
|
-
|
|
6726
|
+
agentRegister(createAgentRequest: CreateAgentRequest, options?: any): AxiosPromise<CreateAgentResponse>;
|
|
6240
6727
|
/**
|
|
6241
6728
|
*
|
|
6242
6729
|
* @summary Update a agent
|
|
@@ -6249,7 +6736,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6249
6736
|
*
|
|
6250
6737
|
* @summary Gets all or specific set of agents
|
|
6251
6738
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6252
|
-
* @param {Array<string>} [id]
|
|
6739
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6253
6740
|
* @param {*} [options] Override http request option.
|
|
6254
6741
|
* @throws {RequiredError}
|
|
6255
6742
|
*/
|
|
@@ -6265,7 +6752,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6265
6752
|
/**
|
|
6266
6753
|
*
|
|
6267
6754
|
* @summary Deletes multiple agents
|
|
6268
|
-
* @param {Array<string>} [id]
|
|
6755
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6269
6756
|
* @param {*} [options] Override http request option.
|
|
6270
6757
|
* @throws {RequiredError}
|
|
6271
6758
|
*/
|
|
@@ -6281,7 +6768,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6281
6768
|
/**
|
|
6282
6769
|
*
|
|
6283
6770
|
* @summary Gets a context
|
|
6284
|
-
* @param {string} id
|
|
6771
|
+
* @param {string} id id of entity to query
|
|
6285
6772
|
* @param {*} [options] Override http request option.
|
|
6286
6773
|
* @throws {RequiredError}
|
|
6287
6774
|
*/
|
|
@@ -6297,7 +6784,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6297
6784
|
/**
|
|
6298
6785
|
*
|
|
6299
6786
|
* @summary Deletes a schedule
|
|
6300
|
-
* @param {string} id
|
|
6787
|
+
* @param {string} id id of entity to query
|
|
6301
6788
|
* @param {*} [options] Override http request option.
|
|
6302
6789
|
* @throws {RequiredError}
|
|
6303
6790
|
*/
|
|
@@ -6314,7 +6801,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6314
6801
|
*
|
|
6315
6802
|
* @summary Gets all or specific set of contexts
|
|
6316
6803
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6317
|
-
* @param {Array<string>} [id]
|
|
6804
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6318
6805
|
* @param {*} [options] Override http request option.
|
|
6319
6806
|
* @throws {RequiredError}
|
|
6320
6807
|
*/
|
|
@@ -6330,7 +6817,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6330
6817
|
/**
|
|
6331
6818
|
*
|
|
6332
6819
|
* @summary Deletes multiple contexts
|
|
6333
|
-
* @param {Array<string>} [id]
|
|
6820
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6334
6821
|
* @param {*} [options] Override http request option.
|
|
6335
6822
|
* @throws {RequiredError}
|
|
6336
6823
|
*/
|
|
@@ -6346,7 +6833,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6346
6833
|
/**
|
|
6347
6834
|
*
|
|
6348
6835
|
* @summary Gets a conversation
|
|
6349
|
-
* @param {string} id
|
|
6836
|
+
* @param {string} id id of entity to query
|
|
6350
6837
|
* @param {*} [options] Override http request option.
|
|
6351
6838
|
* @throws {RequiredError}
|
|
6352
6839
|
*/
|
|
@@ -6362,7 +6849,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6362
6849
|
/**
|
|
6363
6850
|
*
|
|
6364
6851
|
* @summary Deletes a schedule
|
|
6365
|
-
* @param {string} id
|
|
6852
|
+
* @param {string} id id of entity to query
|
|
6366
6853
|
* @param {*} [options] Override http request option.
|
|
6367
6854
|
* @throws {RequiredError}
|
|
6368
6855
|
*/
|
|
@@ -6378,7 +6865,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6378
6865
|
/**
|
|
6379
6866
|
*
|
|
6380
6867
|
* @summary Gets a customer
|
|
6381
|
-
* @param {string} id
|
|
6868
|
+
* @param {string} id id of entity to query
|
|
6382
6869
|
* @param {*} [options] Override http request option.
|
|
6383
6870
|
* @throws {RequiredError}
|
|
6384
6871
|
*/
|
|
@@ -6394,7 +6881,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6394
6881
|
/**
|
|
6395
6882
|
*
|
|
6396
6883
|
* @summary Deletes a customer
|
|
6397
|
-
* @param {string} id
|
|
6884
|
+
* @param {string} id id of entity to query
|
|
6398
6885
|
* @param {*} [options] Override http request option.
|
|
6399
6886
|
* @throws {RequiredError}
|
|
6400
6887
|
*/
|
|
@@ -6402,7 +6889,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6402
6889
|
/**
|
|
6403
6890
|
*
|
|
6404
6891
|
* @summary Gets a customer group
|
|
6405
|
-
* @param {string} id
|
|
6892
|
+
* @param {string} id id of entity to query
|
|
6406
6893
|
* @param {*} [options] Override http request option.
|
|
6407
6894
|
* @throws {RequiredError}
|
|
6408
6895
|
*/
|
|
@@ -6418,7 +6905,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6418
6905
|
/**
|
|
6419
6906
|
*
|
|
6420
6907
|
* @summary Deletes a customer group
|
|
6421
|
-
* @param {string} id
|
|
6908
|
+
* @param {string} id id of entity to query
|
|
6422
6909
|
* @param {*} [options] Override http request option.
|
|
6423
6910
|
* @throws {RequiredError}
|
|
6424
6911
|
*/
|
|
@@ -6435,7 +6922,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6435
6922
|
*
|
|
6436
6923
|
* @summary Gets all or specific set of customer groups
|
|
6437
6924
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6438
|
-
* @param {Array<string>} [id]
|
|
6925
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6439
6926
|
* @param {*} [options] Override http request option.
|
|
6440
6927
|
* @throws {RequiredError}
|
|
6441
6928
|
*/
|
|
@@ -6451,7 +6938,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6451
6938
|
/**
|
|
6452
6939
|
*
|
|
6453
6940
|
* @summary Deletes multiple customer groups
|
|
6454
|
-
* @param {Array<string>} [id]
|
|
6941
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6455
6942
|
* @param {*} [options] Override http request option.
|
|
6456
6943
|
* @throws {RequiredError}
|
|
6457
6944
|
*/
|
|
@@ -6476,7 +6963,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6476
6963
|
*
|
|
6477
6964
|
* @summary Gets all or specific set of customers
|
|
6478
6965
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6479
|
-
* @param {Array<string>} [id]
|
|
6966
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6480
6967
|
* @param {*} [options] Override http request option.
|
|
6481
6968
|
* @throws {RequiredError}
|
|
6482
6969
|
*/
|
|
@@ -6492,7 +6979,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6492
6979
|
/**
|
|
6493
6980
|
*
|
|
6494
6981
|
* @summary Deletes multiple customers
|
|
6495
|
-
* @param {Array<string>} [id]
|
|
6982
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6496
6983
|
* @param {*} [options] Override http request option.
|
|
6497
6984
|
* @throws {RequiredError}
|
|
6498
6985
|
*/
|
|
@@ -6505,6 +6992,46 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6505
6992
|
* @throws {RequiredError}
|
|
6506
6993
|
*/
|
|
6507
6994
|
customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: any): AxiosPromise<UpdateCustomersResponse>;
|
|
6995
|
+
/**
|
|
6996
|
+
*
|
|
6997
|
+
* @summary Returns information about a specific file.
|
|
6998
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
6999
|
+
* @param {*} [options] Override http request option.
|
|
7000
|
+
* @throws {RequiredError}
|
|
7001
|
+
*/
|
|
7002
|
+
file(fileId: string, options?: any): AxiosPromise<Scout9File>;
|
|
7003
|
+
/**
|
|
7004
|
+
*
|
|
7005
|
+
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
7006
|
+
* @param {File} file
|
|
7007
|
+
* @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
|
|
7008
|
+
* @param {*} [options] Override http request option.
|
|
7009
|
+
* @throws {RequiredError}
|
|
7010
|
+
*/
|
|
7011
|
+
fileCreate(file: File | Buffer | Blob, purpose?: string, options?: any): AxiosPromise<Scout9File>;
|
|
7012
|
+
/**
|
|
7013
|
+
*
|
|
7014
|
+
* @summary Delete a file.
|
|
7015
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
7016
|
+
* @param {*} [options] Override http request option.
|
|
7017
|
+
* @throws {RequiredError}
|
|
7018
|
+
*/
|
|
7019
|
+
fileDelete(fileId: string, options?: any): AxiosPromise<DeleteFileResponse>;
|
|
7020
|
+
/**
|
|
7021
|
+
*
|
|
7022
|
+
* @summary Returns the contents of the specified file
|
|
7023
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
7024
|
+
* @param {*} [options] Override http request option.
|
|
7025
|
+
* @throws {RequiredError}
|
|
7026
|
+
*/
|
|
7027
|
+
fileDownload(fileId: string, options?: any): AxiosPromise<string>;
|
|
7028
|
+
/**
|
|
7029
|
+
*
|
|
7030
|
+
* @summary Returns a list of files that belong to the user\'s organization.
|
|
7031
|
+
* @param {*} [options] Override http request option.
|
|
7032
|
+
* @throws {RequiredError}
|
|
7033
|
+
*/
|
|
7034
|
+
files(options?: any): AxiosPromise<ListFilesResponse>;
|
|
6508
7035
|
/**
|
|
6509
7036
|
* Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
|
|
6510
7037
|
* @summary Generate a message from conversation
|
|
@@ -6524,16 +7051,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6524
7051
|
/**
|
|
6525
7052
|
*
|
|
6526
7053
|
* @summary Get all messages from a conversation
|
|
7054
|
+
* @param {string} id id of entity to query
|
|
6527
7055
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6528
|
-
* @param {Array<string>} [id]
|
|
6529
7056
|
* @param {*} [options] Override http request option.
|
|
6530
7057
|
* @throws {RequiredError}
|
|
6531
7058
|
*/
|
|
6532
|
-
messages(
|
|
7059
|
+
messages(id: string, q?: string, options?: any): AxiosPromise<Array<MessageGetResponseInner>>;
|
|
6533
7060
|
/**
|
|
6534
7061
|
*
|
|
6535
7062
|
* @summary Get the results of a bulk API operation
|
|
6536
|
-
* @param {string} id
|
|
7063
|
+
* @param {string} id id of entity to query
|
|
6537
7064
|
* @param {*} [options] Override http request option.
|
|
6538
7065
|
* @throws {RequiredError}
|
|
6539
7066
|
*/
|
|
@@ -6542,7 +7069,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6542
7069
|
*
|
|
6543
7070
|
* @summary Gets all or specific set of bulk API operations
|
|
6544
7071
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6545
|
-
* @param {Array<string>} [id]
|
|
7072
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6546
7073
|
* @param {*} [options] Override http request option.
|
|
6547
7074
|
* @throws {RequiredError}
|
|
6548
7075
|
*/
|
|
@@ -6554,11 +7081,11 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6554
7081
|
* @param {*} [options] Override http request option.
|
|
6555
7082
|
* @throws {RequiredError}
|
|
6556
7083
|
*/
|
|
6557
|
-
|
|
7084
|
+
scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: any): AxiosPromise<ScheduleCreateResponse>;
|
|
6558
7085
|
/**
|
|
6559
7086
|
*
|
|
6560
7087
|
* @summary Deletes a schedule
|
|
6561
|
-
* @param {string} id
|
|
7088
|
+
* @param {string} id id of entity to query
|
|
6562
7089
|
* @param {*} [options] Override http request option.
|
|
6563
7090
|
* @throws {RequiredError}
|
|
6564
7091
|
*/
|
|
@@ -6574,7 +7101,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6574
7101
|
/**
|
|
6575
7102
|
*
|
|
6576
7103
|
* @summary Deletes and cancels a schedule group
|
|
6577
|
-
* @param {string} id
|
|
7104
|
+
* @param {string} id id of entity to query
|
|
6578
7105
|
* @param {*} [options] Override http request option.
|
|
6579
7106
|
* @throws {RequiredError}
|
|
6580
7107
|
*/
|
|
@@ -6582,7 +7109,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6582
7109
|
/**
|
|
6583
7110
|
*
|
|
6584
7111
|
* @summary Gets a schedule group
|
|
6585
|
-
* @param {string} id
|
|
7112
|
+
* @param {string} id id of entity to query
|
|
6586
7113
|
* @param {*} [options] Override http request option.
|
|
6587
7114
|
* @throws {RequiredError}
|
|
6588
7115
|
*/
|
|
@@ -6598,7 +7125,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6598
7125
|
/**
|
|
6599
7126
|
*
|
|
6600
7127
|
* @summary Gets a schedule
|
|
6601
|
-
* @param {string} id
|
|
7128
|
+
* @param {string} id id of entity to query
|
|
6602
7129
|
* @param {*} [options] Override http request option.
|
|
6603
7130
|
* @throws {RequiredError}
|
|
6604
7131
|
*/
|
|
@@ -6614,7 +7141,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6614
7141
|
/**
|
|
6615
7142
|
*
|
|
6616
7143
|
* @summary Gets a workflow
|
|
6617
|
-
* @param {string} id
|
|
7144
|
+
* @param {string} id id of entity to query
|
|
6618
7145
|
* @param {*} [options] Override http request option.
|
|
6619
7146
|
* @throws {RequiredError}
|
|
6620
7147
|
*/
|
|
@@ -6630,7 +7157,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6630
7157
|
/**
|
|
6631
7158
|
*
|
|
6632
7159
|
* @summary Deletes a workflow
|
|
6633
|
-
* @param {string} id
|
|
7160
|
+
* @param {string} id id of entity to query
|
|
6634
7161
|
* @param {*} [options] Override http request option.
|
|
6635
7162
|
* @throws {RequiredError}
|
|
6636
7163
|
*/
|
|
@@ -6647,7 +7174,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6647
7174
|
*
|
|
6648
7175
|
* @summary Gets all or specific set of workflows
|
|
6649
7176
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6650
|
-
* @param {Array<string>} [id]
|
|
7177
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6651
7178
|
* @param {*} [options] Override http request option.
|
|
6652
7179
|
* @throws {RequiredError}
|
|
6653
7180
|
*/
|
|
@@ -6663,7 +7190,7 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6663
7190
|
/**
|
|
6664
7191
|
*
|
|
6665
7192
|
* @summary Deletes multiple workflows
|
|
6666
|
-
* @param {Array<string>} [id]
|
|
7193
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6667
7194
|
* @param {*} [options] Override http request option.
|
|
6668
7195
|
* @throws {RequiredError}
|
|
6669
7196
|
*/
|
|
@@ -6678,56 +7205,56 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
6678
7205
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: any): AxiosPromise<UpdateWorkflowsResponse>;
|
|
6679
7206
|
};
|
|
6680
7207
|
/**
|
|
6681
|
-
*
|
|
7208
|
+
* PocketScoutApi - object-oriented interface
|
|
6682
7209
|
* @export
|
|
6683
|
-
* @class
|
|
7210
|
+
* @class PocketScoutApi
|
|
6684
7211
|
* @extends {BaseAPI}
|
|
6685
7212
|
*/
|
|
6686
|
-
export declare class
|
|
7213
|
+
export declare class PocketScoutApi extends BaseAPI {
|
|
6687
7214
|
/**
|
|
6688
7215
|
*
|
|
6689
7216
|
* @summary Gets a agent
|
|
6690
|
-
* @param {string} id
|
|
7217
|
+
* @param {string} id id of entity to query
|
|
6691
7218
|
* @param {*} [options] Override http request option.
|
|
6692
7219
|
* @throws {RequiredError}
|
|
6693
|
-
* @memberof
|
|
7220
|
+
* @memberof PocketScoutApi
|
|
6694
7221
|
*/
|
|
6695
7222
|
agent(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAgentResponse, any>>;
|
|
6696
7223
|
/**
|
|
6697
7224
|
*
|
|
6698
|
-
* @summary
|
|
6699
|
-
* @param {
|
|
7225
|
+
* @summary Deletes a agent
|
|
7226
|
+
* @param {string} id id of entity to query
|
|
6700
7227
|
* @param {*} [options] Override http request option.
|
|
6701
7228
|
* @throws {RequiredError}
|
|
6702
|
-
* @memberof
|
|
7229
|
+
* @memberof PocketScoutApi
|
|
6703
7230
|
*/
|
|
6704
|
-
|
|
7231
|
+
agentDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentResponse, any>>;
|
|
6705
7232
|
/**
|
|
6706
7233
|
*
|
|
6707
|
-
* @summary
|
|
6708
|
-
* @param {
|
|
7234
|
+
* @summary Registers a new agent
|
|
7235
|
+
* @param {CreateAgentRequest} createAgentRequest
|
|
6709
7236
|
* @param {*} [options] Override http request option.
|
|
6710
7237
|
* @throws {RequiredError}
|
|
6711
|
-
* @memberof
|
|
7238
|
+
* @memberof PocketScoutApi
|
|
6712
7239
|
*/
|
|
6713
|
-
|
|
7240
|
+
agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentResponse, any>>;
|
|
6714
7241
|
/**
|
|
6715
7242
|
*
|
|
6716
7243
|
* @summary Update a agent
|
|
6717
7244
|
* @param {UpdateAgentRequest} updateAgentRequest
|
|
6718
7245
|
* @param {*} [options] Override http request option.
|
|
6719
7246
|
* @throws {RequiredError}
|
|
6720
|
-
* @memberof
|
|
7247
|
+
* @memberof PocketScoutApi
|
|
6721
7248
|
*/
|
|
6722
7249
|
agentUpdate(updateAgentRequest: UpdateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentResponse, any>>;
|
|
6723
7250
|
/**
|
|
6724
7251
|
*
|
|
6725
7252
|
* @summary Gets all or specific set of agents
|
|
6726
7253
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6727
|
-
* @param {Array<string>} [id]
|
|
7254
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6728
7255
|
* @param {*} [options] Override http request option.
|
|
6729
7256
|
* @throws {RequiredError}
|
|
6730
|
-
* @memberof
|
|
7257
|
+
* @memberof PocketScoutApi
|
|
6731
7258
|
*/
|
|
6732
7259
|
agents(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAgentsResponseInner[], any>>;
|
|
6733
7260
|
/**
|
|
@@ -6736,16 +7263,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6736
7263
|
* @param {CreateAgentsRequest} createAgentsRequest
|
|
6737
7264
|
* @param {*} [options] Override http request option.
|
|
6738
7265
|
* @throws {RequiredError}
|
|
6739
|
-
* @memberof
|
|
7266
|
+
* @memberof PocketScoutApi
|
|
6740
7267
|
*/
|
|
6741
7268
|
agentsCreate(createAgentsRequest: CreateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentsResponse, any>>;
|
|
6742
7269
|
/**
|
|
6743
7270
|
*
|
|
6744
7271
|
* @summary Deletes multiple agents
|
|
6745
|
-
* @param {Array<string>} [id]
|
|
7272
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6746
7273
|
* @param {*} [options] Override http request option.
|
|
6747
7274
|
* @throws {RequiredError}
|
|
6748
|
-
* @memberof
|
|
7275
|
+
* @memberof PocketScoutApi
|
|
6749
7276
|
*/
|
|
6750
7277
|
agentsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentsResponse, any>>;
|
|
6751
7278
|
/**
|
|
@@ -6754,16 +7281,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6754
7281
|
* @param {UpdateAgentsRequest} updateAgentsRequest
|
|
6755
7282
|
* @param {*} [options] Override http request option.
|
|
6756
7283
|
* @throws {RequiredError}
|
|
6757
|
-
* @memberof
|
|
7284
|
+
* @memberof PocketScoutApi
|
|
6758
7285
|
*/
|
|
6759
7286
|
agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentsResponse, any>>;
|
|
6760
7287
|
/**
|
|
6761
7288
|
*
|
|
6762
7289
|
* @summary Gets a context
|
|
6763
|
-
* @param {string} id
|
|
7290
|
+
* @param {string} id id of entity to query
|
|
6764
7291
|
* @param {*} [options] Override http request option.
|
|
6765
7292
|
* @throws {RequiredError}
|
|
6766
|
-
* @memberof
|
|
7293
|
+
* @memberof PocketScoutApi
|
|
6767
7294
|
*/
|
|
6768
7295
|
context(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextResponse, any>>;
|
|
6769
7296
|
/**
|
|
@@ -6772,16 +7299,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6772
7299
|
* @param {CreateContextRequest} createContextRequest
|
|
6773
7300
|
* @param {*} [options] Override http request option.
|
|
6774
7301
|
* @throws {RequiredError}
|
|
6775
|
-
* @memberof
|
|
7302
|
+
* @memberof PocketScoutApi
|
|
6776
7303
|
*/
|
|
6777
7304
|
contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextResponse, any>>;
|
|
6778
7305
|
/**
|
|
6779
7306
|
*
|
|
6780
7307
|
* @summary Deletes a schedule
|
|
6781
|
-
* @param {string} id
|
|
7308
|
+
* @param {string} id id of entity to query
|
|
6782
7309
|
* @param {*} [options] Override http request option.
|
|
6783
7310
|
* @throws {RequiredError}
|
|
6784
|
-
* @memberof
|
|
7311
|
+
* @memberof PocketScoutApi
|
|
6785
7312
|
*/
|
|
6786
7313
|
contextDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextResponse, any>>;
|
|
6787
7314
|
/**
|
|
@@ -6790,17 +7317,17 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6790
7317
|
* @param {UpdateContextRequest} updateContextRequest
|
|
6791
7318
|
* @param {*} [options] Override http request option.
|
|
6792
7319
|
* @throws {RequiredError}
|
|
6793
|
-
* @memberof
|
|
7320
|
+
* @memberof PocketScoutApi
|
|
6794
7321
|
*/
|
|
6795
7322
|
contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextResponse, any>>;
|
|
6796
7323
|
/**
|
|
6797
7324
|
*
|
|
6798
7325
|
* @summary Gets all or specific set of contexts
|
|
6799
7326
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6800
|
-
* @param {Array<string>} [id]
|
|
7327
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6801
7328
|
* @param {*} [options] Override http request option.
|
|
6802
7329
|
* @throws {RequiredError}
|
|
6803
|
-
* @memberof
|
|
7330
|
+
* @memberof PocketScoutApi
|
|
6804
7331
|
*/
|
|
6805
7332
|
contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListContextsResponseInner[], any>>;
|
|
6806
7333
|
/**
|
|
@@ -6809,16 +7336,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6809
7336
|
* @param {CreateContextsRequest} createContextsRequest
|
|
6810
7337
|
* @param {*} [options] Override http request option.
|
|
6811
7338
|
* @throws {RequiredError}
|
|
6812
|
-
* @memberof
|
|
7339
|
+
* @memberof PocketScoutApi
|
|
6813
7340
|
*/
|
|
6814
7341
|
contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextsResponse, any>>;
|
|
6815
7342
|
/**
|
|
6816
7343
|
*
|
|
6817
7344
|
* @summary Deletes multiple contexts
|
|
6818
|
-
* @param {Array<string>} [id]
|
|
7345
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6819
7346
|
* @param {*} [options] Override http request option.
|
|
6820
7347
|
* @throws {RequiredError}
|
|
6821
|
-
* @memberof
|
|
7348
|
+
* @memberof PocketScoutApi
|
|
6822
7349
|
*/
|
|
6823
7350
|
contextsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextsResponse, any>>;
|
|
6824
7351
|
/**
|
|
@@ -6827,16 +7354,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6827
7354
|
* @param {UpdateContextRequest} updateContextRequest
|
|
6828
7355
|
* @param {*} [options] Override http request option.
|
|
6829
7356
|
* @throws {RequiredError}
|
|
6830
|
-
* @memberof
|
|
7357
|
+
* @memberof PocketScoutApi
|
|
6831
7358
|
*/
|
|
6832
7359
|
contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextsResponse, any>>;
|
|
6833
7360
|
/**
|
|
6834
7361
|
*
|
|
6835
7362
|
* @summary Gets a conversation
|
|
6836
|
-
* @param {string} id
|
|
7363
|
+
* @param {string} id id of entity to query
|
|
6837
7364
|
* @param {*} [options] Override http request option.
|
|
6838
7365
|
* @throws {RequiredError}
|
|
6839
|
-
* @memberof
|
|
7366
|
+
* @memberof PocketScoutApi
|
|
6840
7367
|
*/
|
|
6841
7368
|
conversation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationGetResponse, any>>;
|
|
6842
7369
|
/**
|
|
@@ -6845,16 +7372,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6845
7372
|
* @param {ConversationCreateRequest} conversationCreateRequest
|
|
6846
7373
|
* @param {*} [options] Override http request option.
|
|
6847
7374
|
* @throws {RequiredError}
|
|
6848
|
-
* @memberof
|
|
7375
|
+
* @memberof PocketScoutApi
|
|
6849
7376
|
*/
|
|
6850
7377
|
conversationCreate(conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationCreateResponse, any>>;
|
|
6851
7378
|
/**
|
|
6852
7379
|
*
|
|
6853
7380
|
* @summary Deletes a schedule
|
|
6854
|
-
* @param {string} id
|
|
7381
|
+
* @param {string} id id of entity to query
|
|
6855
7382
|
* @param {*} [options] Override http request option.
|
|
6856
7383
|
* @throws {RequiredError}
|
|
6857
|
-
* @memberof
|
|
7384
|
+
* @memberof PocketScoutApi
|
|
6858
7385
|
*/
|
|
6859
7386
|
conversationDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationRemoveResponse, any>>;
|
|
6860
7387
|
/**
|
|
@@ -6863,16 +7390,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6863
7390
|
* @param {ConversationUpdateRequest} conversationUpdateRequest
|
|
6864
7391
|
* @param {*} [options] Override http request option.
|
|
6865
7392
|
* @throws {RequiredError}
|
|
6866
|
-
* @memberof
|
|
7393
|
+
* @memberof PocketScoutApi
|
|
6867
7394
|
*/
|
|
6868
7395
|
conversationUpdate(conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationUpdateResponse, any>>;
|
|
6869
7396
|
/**
|
|
6870
7397
|
*
|
|
6871
7398
|
* @summary Gets a customer
|
|
6872
|
-
* @param {string} id
|
|
7399
|
+
* @param {string} id id of entity to query
|
|
6873
7400
|
* @param {*} [options] Override http request option.
|
|
6874
7401
|
* @throws {RequiredError}
|
|
6875
|
-
* @memberof
|
|
7402
|
+
* @memberof PocketScoutApi
|
|
6876
7403
|
*/
|
|
6877
7404
|
customer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponse, any>>;
|
|
6878
7405
|
/**
|
|
@@ -6881,25 +7408,25 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6881
7408
|
* @param {CreateCustomerRequest} createCustomerRequest
|
|
6882
7409
|
* @param {*} [options] Override http request option.
|
|
6883
7410
|
* @throws {RequiredError}
|
|
6884
|
-
* @memberof
|
|
7411
|
+
* @memberof PocketScoutApi
|
|
6885
7412
|
*/
|
|
6886
7413
|
customerCreate(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerResponse, any>>;
|
|
6887
7414
|
/**
|
|
6888
7415
|
*
|
|
6889
7416
|
* @summary Deletes a customer
|
|
6890
|
-
* @param {string} id
|
|
7417
|
+
* @param {string} id id of entity to query
|
|
6891
7418
|
* @param {*} [options] Override http request option.
|
|
6892
7419
|
* @throws {RequiredError}
|
|
6893
|
-
* @memberof
|
|
7420
|
+
* @memberof PocketScoutApi
|
|
6894
7421
|
*/
|
|
6895
7422
|
customerDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerResponse, any>>;
|
|
6896
7423
|
/**
|
|
6897
7424
|
*
|
|
6898
7425
|
* @summary Gets a customer group
|
|
6899
|
-
* @param {string} id
|
|
7426
|
+
* @param {string} id id of entity to query
|
|
6900
7427
|
* @param {*} [options] Override http request option.
|
|
6901
7428
|
* @throws {RequiredError}
|
|
6902
|
-
* @memberof
|
|
7429
|
+
* @memberof PocketScoutApi
|
|
6903
7430
|
*/
|
|
6904
7431
|
customerGroup(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerGroupResponse, any>>;
|
|
6905
7432
|
/**
|
|
@@ -6908,16 +7435,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6908
7435
|
* @param {CreateCustomerGroupRequest} createCustomerGroupRequest
|
|
6909
7436
|
* @param {*} [options] Override http request option.
|
|
6910
7437
|
* @throws {RequiredError}
|
|
6911
|
-
* @memberof
|
|
7438
|
+
* @memberof PocketScoutApi
|
|
6912
7439
|
*/
|
|
6913
7440
|
customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupResponse, any>>;
|
|
6914
7441
|
/**
|
|
6915
7442
|
*
|
|
6916
7443
|
* @summary Deletes a customer group
|
|
6917
|
-
* @param {string} id
|
|
7444
|
+
* @param {string} id id of entity to query
|
|
6918
7445
|
* @param {*} [options] Override http request option.
|
|
6919
7446
|
* @throws {RequiredError}
|
|
6920
|
-
* @memberof
|
|
7447
|
+
* @memberof PocketScoutApi
|
|
6921
7448
|
*/
|
|
6922
7449
|
customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupResponse, any>>;
|
|
6923
7450
|
/**
|
|
@@ -6926,17 +7453,17 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6926
7453
|
* @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
|
|
6927
7454
|
* @param {*} [options] Override http request option.
|
|
6928
7455
|
* @throws {RequiredError}
|
|
6929
|
-
* @memberof
|
|
7456
|
+
* @memberof PocketScoutApi
|
|
6930
7457
|
*/
|
|
6931
7458
|
customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupResponse, any>>;
|
|
6932
7459
|
/**
|
|
6933
7460
|
*
|
|
6934
7461
|
* @summary Gets all or specific set of customer groups
|
|
6935
7462
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6936
|
-
* @param {Array<string>} [id]
|
|
7463
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6937
7464
|
* @param {*} [options] Override http request option.
|
|
6938
7465
|
* @throws {RequiredError}
|
|
6939
|
-
* @memberof
|
|
7466
|
+
* @memberof PocketScoutApi
|
|
6940
7467
|
*/
|
|
6941
7468
|
customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerGroupsResponseInner[], any>>;
|
|
6942
7469
|
/**
|
|
@@ -6945,16 +7472,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6945
7472
|
* @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
|
|
6946
7473
|
* @param {*} [options] Override http request option.
|
|
6947
7474
|
* @throws {RequiredError}
|
|
6948
|
-
* @memberof
|
|
7475
|
+
* @memberof PocketScoutApi
|
|
6949
7476
|
*/
|
|
6950
7477
|
customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupsResponse, any>>;
|
|
6951
7478
|
/**
|
|
6952
7479
|
*
|
|
6953
7480
|
* @summary Deletes multiple customer groups
|
|
6954
|
-
* @param {Array<string>} [id]
|
|
7481
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6955
7482
|
* @param {*} [options] Override http request option.
|
|
6956
7483
|
* @throws {RequiredError}
|
|
6957
|
-
* @memberof
|
|
7484
|
+
* @memberof PocketScoutApi
|
|
6958
7485
|
*/
|
|
6959
7486
|
customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupsResponse, any>>;
|
|
6960
7487
|
/**
|
|
@@ -6963,7 +7490,7 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6963
7490
|
* @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
|
|
6964
7491
|
* @param {*} [options] Override http request option.
|
|
6965
7492
|
* @throws {RequiredError}
|
|
6966
|
-
* @memberof
|
|
7493
|
+
* @memberof PocketScoutApi
|
|
6967
7494
|
*/
|
|
6968
7495
|
customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupsResponse, any>>;
|
|
6969
7496
|
/**
|
|
@@ -6972,17 +7499,17 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6972
7499
|
* @param {UpdateCustomerRequest} updateCustomerRequest
|
|
6973
7500
|
* @param {*} [options] Override http request option.
|
|
6974
7501
|
* @throws {RequiredError}
|
|
6975
|
-
* @memberof
|
|
7502
|
+
* @memberof PocketScoutApi
|
|
6976
7503
|
*/
|
|
6977
7504
|
customerUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponse, any>>;
|
|
6978
7505
|
/**
|
|
6979
7506
|
*
|
|
6980
7507
|
* @summary Gets all or specific set of customers
|
|
6981
7508
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
6982
|
-
* @param {Array<string>} [id]
|
|
7509
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
6983
7510
|
* @param {*} [options] Override http request option.
|
|
6984
7511
|
* @throws {RequiredError}
|
|
6985
|
-
* @memberof
|
|
7512
|
+
* @memberof PocketScoutApi
|
|
6986
7513
|
*/
|
|
6987
7514
|
customers(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomersResponseInner[], any>>;
|
|
6988
7515
|
/**
|
|
@@ -6991,16 +7518,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
6991
7518
|
* @param {CreateCustomersRequest} createCustomersRequest
|
|
6992
7519
|
* @param {*} [options] Override http request option.
|
|
6993
7520
|
* @throws {RequiredError}
|
|
6994
|
-
* @memberof
|
|
7521
|
+
* @memberof PocketScoutApi
|
|
6995
7522
|
*/
|
|
6996
7523
|
customersCreate(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomersResponse, any>>;
|
|
6997
7524
|
/**
|
|
6998
7525
|
*
|
|
6999
7526
|
* @summary Deletes multiple customers
|
|
7000
|
-
* @param {Array<string>} [id]
|
|
7527
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7001
7528
|
* @param {*} [options] Override http request option.
|
|
7002
7529
|
* @throws {RequiredError}
|
|
7003
|
-
* @memberof
|
|
7530
|
+
* @memberof PocketScoutApi
|
|
7004
7531
|
*/
|
|
7005
7532
|
customersDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomersResponse, any>>;
|
|
7006
7533
|
/**
|
|
@@ -7009,16 +7536,61 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7009
7536
|
* @param {UpdateCustomerRequest} updateCustomerRequest
|
|
7010
7537
|
* @param {*} [options] Override http request option.
|
|
7011
7538
|
* @throws {RequiredError}
|
|
7012
|
-
* @memberof
|
|
7539
|
+
* @memberof PocketScoutApi
|
|
7013
7540
|
*/
|
|
7014
7541
|
customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
|
|
7542
|
+
/**
|
|
7543
|
+
*
|
|
7544
|
+
* @summary Returns information about a specific file.
|
|
7545
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
7546
|
+
* @param {*} [options] Override http request option.
|
|
7547
|
+
* @throws {RequiredError}
|
|
7548
|
+
* @memberof PocketScoutApi
|
|
7549
|
+
*/
|
|
7550
|
+
file(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
|
|
7551
|
+
/**
|
|
7552
|
+
*
|
|
7553
|
+
* @summary Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
|
|
7554
|
+
* @param {File} file
|
|
7555
|
+
* @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
|
|
7556
|
+
* @param {*} [options] Override http request option.
|
|
7557
|
+
* @throws {RequiredError}
|
|
7558
|
+
* @memberof PocketScoutApi
|
|
7559
|
+
*/
|
|
7560
|
+
fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
|
|
7561
|
+
/**
|
|
7562
|
+
*
|
|
7563
|
+
* @summary Delete a file.
|
|
7564
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
7565
|
+
* @param {*} [options] Override http request option.
|
|
7566
|
+
* @throws {RequiredError}
|
|
7567
|
+
* @memberof PocketScoutApi
|
|
7568
|
+
*/
|
|
7569
|
+
fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFileResponse, any>>;
|
|
7570
|
+
/**
|
|
7571
|
+
*
|
|
7572
|
+
* @summary Returns the contents of the specified file
|
|
7573
|
+
* @param {string} fileId The ID of the file to use for this request
|
|
7574
|
+
* @param {*} [options] Override http request option.
|
|
7575
|
+
* @throws {RequiredError}
|
|
7576
|
+
* @memberof PocketScoutApi
|
|
7577
|
+
*/
|
|
7578
|
+
fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
7579
|
+
/**
|
|
7580
|
+
*
|
|
7581
|
+
* @summary Returns a list of files that belong to the user\'s organization.
|
|
7582
|
+
* @param {*} [options] Override http request option.
|
|
7583
|
+
* @throws {RequiredError}
|
|
7584
|
+
* @memberof PocketScoutApi
|
|
7585
|
+
*/
|
|
7586
|
+
files(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
|
|
7015
7587
|
/**
|
|
7016
7588
|
* Generates a message in the agent\'s voice based on the state of the given conversation. This is useful for testing and debugging. The message will not be sent to the conversation, you must run .message() with the body of the generated message to send it to the conversation.
|
|
7017
7589
|
* @summary Generate a message from conversation
|
|
7018
7590
|
* @param {GenerateRequest} generateRequest
|
|
7019
7591
|
* @param {*} [options] Override http request option.
|
|
7020
7592
|
* @throws {RequiredError}
|
|
7021
|
-
* @memberof
|
|
7593
|
+
* @memberof PocketScoutApi
|
|
7022
7594
|
*/
|
|
7023
7595
|
generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateResponse, any>>;
|
|
7024
7596
|
/**
|
|
@@ -7027,36 +7599,36 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7027
7599
|
* @param {MessageCreateRequest} messageCreateRequest
|
|
7028
7600
|
* @param {*} [options] Override http request option.
|
|
7029
7601
|
* @throws {RequiredError}
|
|
7030
|
-
* @memberof
|
|
7602
|
+
* @memberof PocketScoutApi
|
|
7031
7603
|
*/
|
|
7032
7604
|
message(messageCreateRequest: MessageCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageCreateResponse, any>>;
|
|
7033
7605
|
/**
|
|
7034
7606
|
*
|
|
7035
7607
|
* @summary Get all messages from a conversation
|
|
7608
|
+
* @param {string} id id of entity to query
|
|
7036
7609
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
7037
|
-
* @param {Array<string>} [id]
|
|
7038
7610
|
* @param {*} [options] Override http request option.
|
|
7039
7611
|
* @throws {RequiredError}
|
|
7040
|
-
* @memberof
|
|
7612
|
+
* @memberof PocketScoutApi
|
|
7041
7613
|
*/
|
|
7042
|
-
messages(
|
|
7614
|
+
messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageGetResponseInner[], any>>;
|
|
7043
7615
|
/**
|
|
7044
7616
|
*
|
|
7045
7617
|
* @summary Get the results of a bulk API operation
|
|
7046
|
-
* @param {string} id
|
|
7618
|
+
* @param {string} id id of entity to query
|
|
7047
7619
|
* @param {*} [options] Override http request option.
|
|
7048
7620
|
* @throws {RequiredError}
|
|
7049
|
-
* @memberof
|
|
7621
|
+
* @memberof PocketScoutApi
|
|
7050
7622
|
*/
|
|
7051
7623
|
operation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetApiOperationResponse, any>>;
|
|
7052
7624
|
/**
|
|
7053
7625
|
*
|
|
7054
7626
|
* @summary Gets all or specific set of bulk API operations
|
|
7055
7627
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
7056
|
-
* @param {Array<string>} [id]
|
|
7628
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7057
7629
|
* @param {*} [options] Override http request option.
|
|
7058
7630
|
* @throws {RequiredError}
|
|
7059
|
-
* @memberof
|
|
7631
|
+
* @memberof PocketScoutApi
|
|
7060
7632
|
*/
|
|
7061
7633
|
operations(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListApiOperationsResponseInner[], any>>;
|
|
7062
7634
|
/**
|
|
@@ -7065,16 +7637,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7065
7637
|
* @param {ScheduleCreateRequest} scheduleCreateRequest
|
|
7066
7638
|
* @param {*} [options] Override http request option.
|
|
7067
7639
|
* @throws {RequiredError}
|
|
7068
|
-
* @memberof
|
|
7640
|
+
* @memberof PocketScoutApi
|
|
7069
7641
|
*/
|
|
7070
|
-
|
|
7642
|
+
scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
|
|
7071
7643
|
/**
|
|
7072
7644
|
*
|
|
7073
7645
|
* @summary Deletes a schedule
|
|
7074
|
-
* @param {string} id
|
|
7646
|
+
* @param {string} id id of entity to query
|
|
7075
7647
|
* @param {*} [options] Override http request option.
|
|
7076
7648
|
* @throws {RequiredError}
|
|
7077
|
-
* @memberof
|
|
7649
|
+
* @memberof PocketScoutApi
|
|
7078
7650
|
*/
|
|
7079
7651
|
scheduleDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleRemoveResponse, any>>;
|
|
7080
7652
|
/**
|
|
@@ -7083,25 +7655,25 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7083
7655
|
* @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
|
|
7084
7656
|
* @param {*} [options] Override http request option.
|
|
7085
7657
|
* @throws {RequiredError}
|
|
7086
|
-
* @memberof
|
|
7658
|
+
* @memberof PocketScoutApi
|
|
7087
7659
|
*/
|
|
7088
7660
|
scheduleGroupCreate(scheduleGroupCreateRequest: ScheduleGroupCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupCreateResponse, any>>;
|
|
7089
7661
|
/**
|
|
7090
7662
|
*
|
|
7091
7663
|
* @summary Deletes and cancels a schedule group
|
|
7092
|
-
* @param {string} id
|
|
7664
|
+
* @param {string} id id of entity to query
|
|
7093
7665
|
* @param {*} [options] Override http request option.
|
|
7094
7666
|
* @throws {RequiredError}
|
|
7095
|
-
* @memberof
|
|
7667
|
+
* @memberof PocketScoutApi
|
|
7096
7668
|
*/
|
|
7097
7669
|
scheduleGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupRemoveResponse, any>>;
|
|
7098
7670
|
/**
|
|
7099
7671
|
*
|
|
7100
7672
|
* @summary Gets a schedule group
|
|
7101
|
-
* @param {string} id
|
|
7673
|
+
* @param {string} id id of entity to query
|
|
7102
7674
|
* @param {*} [options] Override http request option.
|
|
7103
7675
|
* @throws {RequiredError}
|
|
7104
|
-
* @memberof
|
|
7676
|
+
* @memberof PocketScoutApi
|
|
7105
7677
|
*/
|
|
7106
7678
|
scheduleGroupRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupGetResponse, any>>;
|
|
7107
7679
|
/**
|
|
@@ -7110,16 +7682,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7110
7682
|
* @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
|
|
7111
7683
|
* @param {*} [options] Override http request option.
|
|
7112
7684
|
* @throws {RequiredError}
|
|
7113
|
-
* @memberof
|
|
7685
|
+
* @memberof PocketScoutApi
|
|
7114
7686
|
*/
|
|
7115
7687
|
scheduleGroupUpdate(scheduleGroupUpdateRequest: ScheduleGroupUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupUpdateResponse, any>>;
|
|
7116
7688
|
/**
|
|
7117
7689
|
*
|
|
7118
7690
|
* @summary Gets a schedule
|
|
7119
|
-
* @param {string} id
|
|
7691
|
+
* @param {string} id id of entity to query
|
|
7120
7692
|
* @param {*} [options] Override http request option.
|
|
7121
7693
|
* @throws {RequiredError}
|
|
7122
|
-
* @memberof
|
|
7694
|
+
* @memberof PocketScoutApi
|
|
7123
7695
|
*/
|
|
7124
7696
|
scheduleRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
|
|
7125
7697
|
/**
|
|
@@ -7128,16 +7700,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7128
7700
|
* @param {ScheduleUpdateRequest} scheduleUpdateRequest
|
|
7129
7701
|
* @param {*} [options] Override http request option.
|
|
7130
7702
|
* @throws {RequiredError}
|
|
7131
|
-
* @memberof
|
|
7703
|
+
* @memberof PocketScoutApi
|
|
7132
7704
|
*/
|
|
7133
7705
|
scheduleUpdate(scheduleUpdateRequest: ScheduleUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleUpdateResponse, any>>;
|
|
7134
7706
|
/**
|
|
7135
7707
|
*
|
|
7136
7708
|
* @summary Gets a workflow
|
|
7137
|
-
* @param {string} id
|
|
7709
|
+
* @param {string} id id of entity to query
|
|
7138
7710
|
* @param {*} [options] Override http request option.
|
|
7139
7711
|
* @throws {RequiredError}
|
|
7140
|
-
* @memberof
|
|
7712
|
+
* @memberof PocketScoutApi
|
|
7141
7713
|
*/
|
|
7142
7714
|
workflow(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkflowResponse, any>>;
|
|
7143
7715
|
/**
|
|
@@ -7146,16 +7718,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7146
7718
|
* @param {CreateWorkflowRequest} createWorkflowRequest
|
|
7147
7719
|
* @param {*} [options] Override http request option.
|
|
7148
7720
|
* @throws {RequiredError}
|
|
7149
|
-
* @memberof
|
|
7721
|
+
* @memberof PocketScoutApi
|
|
7150
7722
|
*/
|
|
7151
7723
|
workflowCreate(createWorkflowRequest: CreateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowResponse, any>>;
|
|
7152
7724
|
/**
|
|
7153
7725
|
*
|
|
7154
7726
|
* @summary Deletes a workflow
|
|
7155
|
-
* @param {string} id
|
|
7727
|
+
* @param {string} id id of entity to query
|
|
7156
7728
|
* @param {*} [options] Override http request option.
|
|
7157
7729
|
* @throws {RequiredError}
|
|
7158
|
-
* @memberof
|
|
7730
|
+
* @memberof PocketScoutApi
|
|
7159
7731
|
*/
|
|
7160
7732
|
workflowDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowResponse, any>>;
|
|
7161
7733
|
/**
|
|
@@ -7164,17 +7736,17 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7164
7736
|
* @param {UpdateWorkflowRequest} updateWorkflowRequest
|
|
7165
7737
|
* @param {*} [options] Override http request option.
|
|
7166
7738
|
* @throws {RequiredError}
|
|
7167
|
-
* @memberof
|
|
7739
|
+
* @memberof PocketScoutApi
|
|
7168
7740
|
*/
|
|
7169
7741
|
workflowUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowResponse, any>>;
|
|
7170
7742
|
/**
|
|
7171
7743
|
*
|
|
7172
7744
|
* @summary Gets all or specific set of workflows
|
|
7173
7745
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
7174
|
-
* @param {Array<string>} [id]
|
|
7746
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7175
7747
|
* @param {*} [options] Override http request option.
|
|
7176
7748
|
* @throws {RequiredError}
|
|
7177
|
-
* @memberof
|
|
7749
|
+
* @memberof PocketScoutApi
|
|
7178
7750
|
*/
|
|
7179
7751
|
workflows(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowsResponseInner[], any>>;
|
|
7180
7752
|
/**
|
|
@@ -7183,16 +7755,16 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7183
7755
|
* @param {CreateWorkflowsRequest} createWorkflowsRequest
|
|
7184
7756
|
* @param {*} [options] Override http request option.
|
|
7185
7757
|
* @throws {RequiredError}
|
|
7186
|
-
* @memberof
|
|
7758
|
+
* @memberof PocketScoutApi
|
|
7187
7759
|
*/
|
|
7188
7760
|
workflowsCreate(createWorkflowsRequest: CreateWorkflowsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowsResponse, any>>;
|
|
7189
7761
|
/**
|
|
7190
7762
|
*
|
|
7191
7763
|
* @summary Deletes multiple workflows
|
|
7192
|
-
* @param {Array<string>} [id]
|
|
7764
|
+
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7193
7765
|
* @param {*} [options] Override http request option.
|
|
7194
7766
|
* @throws {RequiredError}
|
|
7195
|
-
* @memberof
|
|
7767
|
+
* @memberof PocketScoutApi
|
|
7196
7768
|
*/
|
|
7197
7769
|
workflowsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowsResponse, any>>;
|
|
7198
7770
|
/**
|
|
@@ -7201,7 +7773,7 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
7201
7773
|
* @param {UpdateWorkflowRequest} updateWorkflowRequest
|
|
7202
7774
|
* @param {*} [options] Override http request option.
|
|
7203
7775
|
* @throws {RequiredError}
|
|
7204
|
-
* @memberof
|
|
7776
|
+
* @memberof PocketScoutApi
|
|
7205
7777
|
*/
|
|
7206
7778
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowsResponse, any>>;
|
|
7207
7779
|
}
|