@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.js CHANGED
@@ -2,7 +2,7 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Scout9 Pocket Scout API
5
+ * Scout9\'s Pocket Scout API
6
6
  * Pocket Scout APIs for managing Scout9 users and conversations with your Pocket Scout agents
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
@@ -16,13 +16,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
16
16
  return (mod && mod.__esModule) ? mod : { "default": mod };
17
17
  };
18
18
  Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.Scout9Api = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.Operator = exports.MessageGetResponseInnerRoleEnum = exports.MessageCreateRequestRoleEnum = exports.MessageRoleEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.GetApiOperationResponseMethodEnum = exports.GenerateResponseRoleEnum = exports.ConversationEnvironment = exports.ApiOperationMethodEnum = void 0;
19
+ exports.PocketScoutApi = exports.PocketScoutApiFactory = exports.PocketScoutApiFp = exports.PocketScoutApiAxiosParamCreator = exports.UpdateAgentsRequestAgentsInnerModelEnum = exports.UpdateAgentRequestModelEnum = exports.Operator = exports.MessageGetResponseInnerRoleEnum = exports.MessageCreateRequestRoleEnum = exports.MessageBaseRoleEnum = exports.MessageRoleEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.ListAgentsResponseInnerModelEnum = exports.GetApiOperationResponseMethodEnum = exports.GetAgentResponseModelEnum = exports.GenerateResponseRoleEnum = exports.CreateAgentsRequestAgentsInnerModelEnum = exports.CreateAgentRequestModelEnum = exports.ConversationEnvironment = exports.ConversationContextFieldConditionOperatorEnum = exports.ApiOperationMethodEnum = exports.AgentModelEnum = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  // Some imports not used depending on template conditions
22
22
  // @ts-ignore
23
23
  const common_1 = require("./common");
24
24
  // @ts-ignore
25
25
  const base_1 = require("./base");
26
+ exports.AgentModelEnum = {
27
+ PocketScout: 'Pocket Scout',
28
+ Bard: 'bard',
29
+ Null: 'null'
30
+ };
26
31
  exports.ApiOperationMethodEnum = {
27
32
  Get: 'get',
28
33
  Post: 'post',
@@ -30,6 +35,30 @@ exports.ApiOperationMethodEnum = {
30
35
  Delete: 'delete',
31
36
  Patch: 'patch'
32
37
  };
38
+ exports.ConversationContextFieldConditionOperatorEnum = {
39
+ Eq: 'eq',
40
+ Equal: 'equal',
41
+ Ne: 'ne',
42
+ NotEquals: 'not-equals',
43
+ Gt: 'gt',
44
+ GreaterThan: 'greater-than',
45
+ Gte: 'gte',
46
+ GreaterThanEquals: 'greater-than-equals',
47
+ Lt: 'lt',
48
+ LessThan: 'less-than',
49
+ Lte: 'lte',
50
+ LessThanEquals: 'less-than-equals',
51
+ ArrayContains: 'array-contains',
52
+ In: 'in',
53
+ ArrayContainsAny: 'array-contains-any',
54
+ NotIn: 'not-in',
55
+ Exists: 'exists',
56
+ NotExists: 'notExists',
57
+ Contains: 'contains',
58
+ NotContains: 'notContains',
59
+ StartsWith: 'startsWith',
60
+ EndsWith: 'endsWith'
61
+ };
33
62
  /**
34
63
  * Environment this conversation is in (phone, web, or email) - this determines which device to send messages to
35
64
  * @export
@@ -40,10 +69,25 @@ exports.ConversationEnvironment = {
40
69
  Web: 'web',
41
70
  Email: 'email'
42
71
  };
72
+ exports.CreateAgentRequestModelEnum = {
73
+ PocketScout: 'Pocket Scout',
74
+ Bard: 'bard',
75
+ Null: 'null'
76
+ };
77
+ exports.CreateAgentsRequestAgentsInnerModelEnum = {
78
+ PocketScout: 'Pocket Scout',
79
+ Bard: 'bard',
80
+ Null: 'null'
81
+ };
43
82
  exports.GenerateResponseRoleEnum = {
44
- User: 'user',
45
- Assistant: 'assistant',
46
- System: 'system'
83
+ Customer: 'customer',
84
+ Agent: 'agent',
85
+ Context: 'context'
86
+ };
87
+ exports.GetAgentResponseModelEnum = {
88
+ PocketScout: 'Pocket Scout',
89
+ Bard: 'bard',
90
+ Null: 'null'
47
91
  };
48
92
  exports.GetApiOperationResponseMethodEnum = {
49
93
  Get: 'get',
@@ -52,6 +96,11 @@ exports.GetApiOperationResponseMethodEnum = {
52
96
  Delete: 'delete',
53
97
  Patch: 'patch'
54
98
  };
99
+ exports.ListAgentsResponseInnerModelEnum = {
100
+ PocketScout: 'Pocket Scout',
101
+ Bard: 'bard',
102
+ Null: 'null'
103
+ };
55
104
  exports.ListApiOperationsResponseInnerMethodEnum = {
56
105
  Get: 'get',
57
106
  Post: 'post',
@@ -60,9 +109,14 @@ exports.ListApiOperationsResponseInnerMethodEnum = {
60
109
  Patch: 'patch'
61
110
  };
62
111
  exports.MessageRoleEnum = {
63
- User: 'user',
64
- Assistant: 'assistant',
65
- System: 'system'
112
+ Customer: 'customer',
113
+ Agent: 'agent',
114
+ Context: 'context'
115
+ };
116
+ exports.MessageBaseRoleEnum = {
117
+ Customer: 'customer',
118
+ Agent: 'agent',
119
+ Context: 'context'
66
120
  };
67
121
  exports.MessageCreateRequestRoleEnum = {
68
122
  Agent: 'agent',
@@ -70,9 +124,9 @@ exports.MessageCreateRequestRoleEnum = {
70
124
  Context: 'context'
71
125
  };
72
126
  exports.MessageGetResponseInnerRoleEnum = {
73
- User: 'user',
74
- Assistant: 'assistant',
75
- System: 'system'
127
+ Customer: 'customer',
128
+ Agent: 'agent',
129
+ Context: 'context'
76
130
  };
77
131
  /**
78
132
  * The operator of the condition or query
@@ -97,16 +151,26 @@ exports.Operator = {
97
151
  ArrayContainsAny: 'array-contains-any',
98
152
  NotIn: 'not-in'
99
153
  };
154
+ exports.UpdateAgentRequestModelEnum = {
155
+ PocketScout: 'Pocket Scout',
156
+ Bard: 'bard',
157
+ Null: 'null'
158
+ };
159
+ exports.UpdateAgentsRequestAgentsInnerModelEnum = {
160
+ PocketScout: 'Pocket Scout',
161
+ Bard: 'bard',
162
+ Null: 'null'
163
+ };
100
164
  /**
101
- * Scout9Api - axios parameter creator
165
+ * PocketScoutApi - axios parameter creator
102
166
  * @export
103
167
  */
104
- const Scout9ApiAxiosParamCreator = function (configuration) {
168
+ const PocketScoutApiAxiosParamCreator = function (configuration) {
105
169
  return {
106
170
  /**
107
171
  *
108
172
  * @summary Gets a agent
109
- * @param {string} id
173
+ * @param {string} id id of entity to query
110
174
  * @param {*} [options] Override http request option.
111
175
  * @throws {RequiredError}
112
176
  */
@@ -136,14 +200,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
136
200
  },
137
201
  /**
138
202
  *
139
- * @summary Create a new agent
140
- * @param {CreateAgentRequest} createAgentRequest
203
+ * @summary Deletes a agent
204
+ * @param {string} id id of entity to query
141
205
  * @param {*} [options] Override http request option.
142
206
  * @throws {RequiredError}
143
207
  */
144
- agentCreate: async (createAgentRequest, options = {}) => {
145
- // verify required parameter 'createAgentRequest' is not null or undefined
146
- (0, common_1.assertParamExists)('agentCreate', 'createAgentRequest', createAgentRequest);
208
+ agentDelete: async (id, options = {}) => {
209
+ // verify required parameter 'id' is not null or undefined
210
+ (0, common_1.assertParamExists)('agentDelete', 'id', id);
147
211
  const localVarPath = `/v1-agent`;
148
212
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
149
213
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -151,14 +215,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
151
215
  if (configuration) {
152
216
  baseOptions = configuration.baseOptions;
153
217
  }
154
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
218
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
155
219
  const localVarHeaderParameter = {};
156
220
  const localVarQueryParameter = {};
157
- localVarHeaderParameter['Content-Type'] = 'application/json';
221
+ if (id !== undefined) {
222
+ localVarQueryParameter['id'] = id;
223
+ }
158
224
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
159
225
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
160
226
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
161
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createAgentRequest, localVarRequestOptions, configuration);
162
227
  return {
163
228
  url: (0, common_1.toPathString)(localVarUrlObj),
164
229
  options: localVarRequestOptions,
@@ -166,14 +231,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
166
231
  },
167
232
  /**
168
233
  *
169
- * @summary Deletes a agent
170
- * @param {string} id
234
+ * @summary Registers a new agent
235
+ * @param {CreateAgentRequest} createAgentRequest
171
236
  * @param {*} [options] Override http request option.
172
237
  * @throws {RequiredError}
173
238
  */
174
- agentDelete: async (id, options = {}) => {
175
- // verify required parameter 'id' is not null or undefined
176
- (0, common_1.assertParamExists)('agentDelete', 'id', id);
239
+ agentRegister: async (createAgentRequest, options = {}) => {
240
+ // verify required parameter 'createAgentRequest' is not null or undefined
241
+ (0, common_1.assertParamExists)('agentRegister', 'createAgentRequest', createAgentRequest);
177
242
  const localVarPath = `/v1-agent`;
178
243
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
179
244
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -181,15 +246,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
181
246
  if (configuration) {
182
247
  baseOptions = configuration.baseOptions;
183
248
  }
184
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
249
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
185
250
  const localVarHeaderParameter = {};
186
251
  const localVarQueryParameter = {};
187
- if (id !== undefined) {
188
- localVarQueryParameter['id'] = id;
189
- }
252
+ localVarHeaderParameter['Content-Type'] = 'application/json';
190
253
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
191
254
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
192
255
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
256
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createAgentRequest, localVarRequestOptions, configuration);
193
257
  return {
194
258
  url: (0, common_1.toPathString)(localVarUrlObj),
195
259
  options: localVarRequestOptions,
@@ -229,7 +293,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
229
293
  *
230
294
  * @summary Gets all or specific set of agents
231
295
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
232
- * @param {Array<string>} [id]
296
+ * @param {Array<string>} [id] ids for the entities this id belongs to
233
297
  * @param {*} [options] Override http request option.
234
298
  * @throws {RequiredError}
235
299
  */
@@ -291,7 +355,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
291
355
  /**
292
356
  *
293
357
  * @summary Deletes multiple agents
294
- * @param {Array<string>} [id]
358
+ * @param {Array<string>} [id] ids for the entities this id belongs to
295
359
  * @param {*} [options] Override http request option.
296
360
  * @throws {RequiredError}
297
361
  */
@@ -350,7 +414,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
350
414
  /**
351
415
  *
352
416
  * @summary Gets a context
353
- * @param {string} id
417
+ * @param {string} id id of entity to query
354
418
  * @param {*} [options] Override http request option.
355
419
  * @throws {RequiredError}
356
420
  */
@@ -411,7 +475,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
411
475
  /**
412
476
  *
413
477
  * @summary Deletes a schedule
414
- * @param {string} id
478
+ * @param {string} id id of entity to query
415
479
  * @param {*} [options] Override http request option.
416
480
  * @throws {RequiredError}
417
481
  */
@@ -473,7 +537,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
473
537
  *
474
538
  * @summary Gets all or specific set of contexts
475
539
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
476
- * @param {Array<string>} [id]
540
+ * @param {Array<string>} [id] ids for the entities this id belongs to
477
541
  * @param {*} [options] Override http request option.
478
542
  * @throws {RequiredError}
479
543
  */
@@ -535,7 +599,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
535
599
  /**
536
600
  *
537
601
  * @summary Deletes multiple contexts
538
- * @param {Array<string>} [id]
602
+ * @param {Array<string>} [id] ids for the entities this id belongs to
539
603
  * @param {*} [options] Override http request option.
540
604
  * @throws {RequiredError}
541
605
  */
@@ -594,7 +658,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
594
658
  /**
595
659
  *
596
660
  * @summary Gets a conversation
597
- * @param {string} id
661
+ * @param {string} id id of entity to query
598
662
  * @param {*} [options] Override http request option.
599
663
  * @throws {RequiredError}
600
664
  */
@@ -655,7 +719,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
655
719
  /**
656
720
  *
657
721
  * @summary Deletes a schedule
658
- * @param {string} id
722
+ * @param {string} id id of entity to query
659
723
  * @param {*} [options] Override http request option.
660
724
  * @throws {RequiredError}
661
725
  */
@@ -716,7 +780,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
716
780
  /**
717
781
  *
718
782
  * @summary Gets a customer
719
- * @param {string} id
783
+ * @param {string} id id of entity to query
720
784
  * @param {*} [options] Override http request option.
721
785
  * @throws {RequiredError}
722
786
  */
@@ -777,7 +841,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
777
841
  /**
778
842
  *
779
843
  * @summary Deletes a customer
780
- * @param {string} id
844
+ * @param {string} id id of entity to query
781
845
  * @param {*} [options] Override http request option.
782
846
  * @throws {RequiredError}
783
847
  */
@@ -808,7 +872,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
808
872
  /**
809
873
  *
810
874
  * @summary Gets a customer group
811
- * @param {string} id
875
+ * @param {string} id id of entity to query
812
876
  * @param {*} [options] Override http request option.
813
877
  * @throws {RequiredError}
814
878
  */
@@ -869,7 +933,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
869
933
  /**
870
934
  *
871
935
  * @summary Deletes a customer group
872
- * @param {string} id
936
+ * @param {string} id id of entity to query
873
937
  * @param {*} [options] Override http request option.
874
938
  * @throws {RequiredError}
875
939
  */
@@ -931,7 +995,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
931
995
  *
932
996
  * @summary Gets all or specific set of customer groups
933
997
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
934
- * @param {Array<string>} [id]
998
+ * @param {Array<string>} [id] ids for the entities this id belongs to
935
999
  * @param {*} [options] Override http request option.
936
1000
  * @throws {RequiredError}
937
1001
  */
@@ -993,7 +1057,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
993
1057
  /**
994
1058
  *
995
1059
  * @summary Deletes multiple customer groups
996
- * @param {Array<string>} [id]
1060
+ * @param {Array<string>} [id] ids for the entities this id belongs to
997
1061
  * @param {*} [options] Override http request option.
998
1062
  * @throws {RequiredError}
999
1063
  */
@@ -1083,7 +1147,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1083
1147
  *
1084
1148
  * @summary Gets all or specific set of customers
1085
1149
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1086
- * @param {Array<string>} [id]
1150
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1087
1151
  * @param {*} [options] Override http request option.
1088
1152
  * @throws {RequiredError}
1089
1153
  */
@@ -1145,7 +1209,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1145
1209
  /**
1146
1210
  *
1147
1211
  * @summary Deletes multiple customers
1148
- * @param {Array<string>} [id]
1212
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1149
1213
  * @param {*} [options] Override http request option.
1150
1214
  * @throws {RequiredError}
1151
1215
  */
@@ -1201,6 +1265,156 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1201
1265
  options: localVarRequestOptions,
1202
1266
  };
1203
1267
  },
1268
+ /**
1269
+ *
1270
+ * @summary Returns information about a specific file.
1271
+ * @param {string} fileId The ID of the file to use for this request
1272
+ * @param {*} [options] Override http request option.
1273
+ * @throws {RequiredError}
1274
+ */
1275
+ file: async (fileId, options = {}) => {
1276
+ // verify required parameter 'fileId' is not null or undefined
1277
+ (0, common_1.assertParamExists)('file', 'fileId', fileId);
1278
+ const localVarPath = `/files/{file_id}`
1279
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1280
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1281
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1282
+ let baseOptions;
1283
+ if (configuration) {
1284
+ baseOptions = configuration.baseOptions;
1285
+ }
1286
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1287
+ const localVarHeaderParameter = {};
1288
+ const localVarQueryParameter = {};
1289
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1290
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1291
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1292
+ return {
1293
+ url: (0, common_1.toPathString)(localVarUrlObj),
1294
+ options: localVarRequestOptions,
1295
+ };
1296
+ },
1297
+ /**
1298
+ *
1299
+ * @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.
1300
+ * @param {File} file
1301
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
1302
+ * @param {*} [options] Override http request option.
1303
+ * @throws {RequiredError}
1304
+ */
1305
+ fileCreate: async (file, purpose, options = {}) => {
1306
+ // verify required parameter 'file' is not null or undefined
1307
+ (0, common_1.assertParamExists)('fileCreate', 'file', file);
1308
+ const localVarPath = `/v1-utils-files`;
1309
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1310
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1311
+ let baseOptions;
1312
+ if (configuration) {
1313
+ baseOptions = configuration.baseOptions;
1314
+ }
1315
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1316
+ const localVarHeaderParameter = {};
1317
+ const localVarQueryParameter = {};
1318
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
1319
+ if (file !== undefined) {
1320
+ localVarFormParams.append('file', file);
1321
+ }
1322
+ if (purpose !== undefined) {
1323
+ localVarFormParams.append('purpose', purpose);
1324
+ }
1325
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
1326
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1327
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1328
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1329
+ localVarRequestOptions.data = localVarFormParams;
1330
+ return {
1331
+ url: (0, common_1.toPathString)(localVarUrlObj),
1332
+ options: localVarRequestOptions,
1333
+ };
1334
+ },
1335
+ /**
1336
+ *
1337
+ * @summary Delete a file.
1338
+ * @param {string} fileId The ID of the file to use for this request
1339
+ * @param {*} [options] Override http request option.
1340
+ * @throws {RequiredError}
1341
+ */
1342
+ fileDelete: async (fileId, options = {}) => {
1343
+ // verify required parameter 'fileId' is not null or undefined
1344
+ (0, common_1.assertParamExists)('fileDelete', 'fileId', fileId);
1345
+ const localVarPath = `/files/{file_id}`
1346
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1347
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1348
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1349
+ let baseOptions;
1350
+ if (configuration) {
1351
+ baseOptions = configuration.baseOptions;
1352
+ }
1353
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1354
+ const localVarHeaderParameter = {};
1355
+ const localVarQueryParameter = {};
1356
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1357
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1358
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1359
+ return {
1360
+ url: (0, common_1.toPathString)(localVarUrlObj),
1361
+ options: localVarRequestOptions,
1362
+ };
1363
+ },
1364
+ /**
1365
+ *
1366
+ * @summary Returns the contents of the specified file
1367
+ * @param {string} fileId The ID of the file to use for this request
1368
+ * @param {*} [options] Override http request option.
1369
+ * @throws {RequiredError}
1370
+ */
1371
+ fileDownload: async (fileId, options = {}) => {
1372
+ // verify required parameter 'fileId' is not null or undefined
1373
+ (0, common_1.assertParamExists)('fileDownload', 'fileId', fileId);
1374
+ const localVarPath = `/files/{file_id}/content`
1375
+ .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1376
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1377
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1378
+ let baseOptions;
1379
+ if (configuration) {
1380
+ baseOptions = configuration.baseOptions;
1381
+ }
1382
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1383
+ const localVarHeaderParameter = {};
1384
+ const localVarQueryParameter = {};
1385
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1386
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1387
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1388
+ return {
1389
+ url: (0, common_1.toPathString)(localVarUrlObj),
1390
+ options: localVarRequestOptions,
1391
+ };
1392
+ },
1393
+ /**
1394
+ *
1395
+ * @summary Returns a list of files that belong to the user\'s organization.
1396
+ * @param {*} [options] Override http request option.
1397
+ * @throws {RequiredError}
1398
+ */
1399
+ files: async (options = {}) => {
1400
+ const localVarPath = `/v1-utils-files`;
1401
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1402
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1403
+ let baseOptions;
1404
+ if (configuration) {
1405
+ baseOptions = configuration.baseOptions;
1406
+ }
1407
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1408
+ const localVarHeaderParameter = {};
1409
+ const localVarQueryParameter = {};
1410
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1411
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1412
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1413
+ return {
1414
+ url: (0, common_1.toPathString)(localVarUrlObj),
1415
+ options: localVarRequestOptions,
1416
+ };
1417
+ },
1204
1418
  /**
1205
1419
  * 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.
1206
1420
  * @summary Generate a message from conversation
@@ -1264,12 +1478,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1264
1478
  /**
1265
1479
  *
1266
1480
  * @summary Get all messages from a conversation
1481
+ * @param {string} id id of entity to query
1267
1482
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1268
- * @param {Array<string>} [id]
1269
1483
  * @param {*} [options] Override http request option.
1270
1484
  * @throws {RequiredError}
1271
1485
  */
1272
- messages: async (q, id, options = {}) => {
1486
+ messages: async (id, q, options = {}) => {
1487
+ // verify required parameter 'id' is not null or undefined
1488
+ (0, common_1.assertParamExists)('messages', 'id', id);
1273
1489
  const localVarPath = `/v1-messages`;
1274
1490
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1275
1491
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1280,12 +1496,12 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1280
1496
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1281
1497
  const localVarHeaderParameter = {};
1282
1498
  const localVarQueryParameter = {};
1499
+ if (id !== undefined) {
1500
+ localVarQueryParameter['id'] = id;
1501
+ }
1283
1502
  if (q !== undefined) {
1284
1503
  localVarQueryParameter['q'] = q;
1285
1504
  }
1286
- if (id) {
1287
- localVarQueryParameter['id'] = id;
1288
- }
1289
1505
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1290
1506
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1291
1507
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -1297,7 +1513,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1297
1513
  /**
1298
1514
  *
1299
1515
  * @summary Get the results of a bulk API operation
1300
- * @param {string} id
1516
+ * @param {string} id id of entity to query
1301
1517
  * @param {*} [options] Override http request option.
1302
1518
  * @throws {RequiredError}
1303
1519
  */
@@ -1329,7 +1545,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1329
1545
  *
1330
1546
  * @summary Gets all or specific set of bulk API operations
1331
1547
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1332
- * @param {Array<string>} [id]
1548
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1333
1549
  * @param {*} [options] Override http request option.
1334
1550
  * @throws {RequiredError}
1335
1551
  */
@@ -1365,9 +1581,9 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1365
1581
  * @param {*} [options] Override http request option.
1366
1582
  * @throws {RequiredError}
1367
1583
  */
1368
- scheduleCreate: async (scheduleCreateRequest, options = {}) => {
1584
+ scheduleConversation: async (scheduleCreateRequest, options = {}) => {
1369
1585
  // verify required parameter 'scheduleCreateRequest' is not null or undefined
1370
- (0, common_1.assertParamExists)('scheduleCreate', 'scheduleCreateRequest', scheduleCreateRequest);
1586
+ (0, common_1.assertParamExists)('scheduleConversation', 'scheduleCreateRequest', scheduleCreateRequest);
1371
1587
  const localVarPath = `/v1-schedule`;
1372
1588
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1373
1589
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1391,7 +1607,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1391
1607
  /**
1392
1608
  *
1393
1609
  * @summary Deletes a schedule
1394
- * @param {string} id
1610
+ * @param {string} id id of entity to query
1395
1611
  * @param {*} [options] Override http request option.
1396
1612
  * @throws {RequiredError}
1397
1613
  */
@@ -1452,7 +1668,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1452
1668
  /**
1453
1669
  *
1454
1670
  * @summary Deletes and cancels a schedule group
1455
- * @param {string} id
1671
+ * @param {string} id id of entity to query
1456
1672
  * @param {*} [options] Override http request option.
1457
1673
  * @throws {RequiredError}
1458
1674
  */
@@ -1483,7 +1699,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1483
1699
  /**
1484
1700
  *
1485
1701
  * @summary Gets a schedule group
1486
- * @param {string} id
1702
+ * @param {string} id id of entity to query
1487
1703
  * @param {*} [options] Override http request option.
1488
1704
  * @throws {RequiredError}
1489
1705
  */
@@ -1544,7 +1760,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1544
1760
  /**
1545
1761
  *
1546
1762
  * @summary Gets a schedule
1547
- * @param {string} id
1763
+ * @param {string} id id of entity to query
1548
1764
  * @param {*} [options] Override http request option.
1549
1765
  * @throws {RequiredError}
1550
1766
  */
@@ -1605,7 +1821,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1605
1821
  /**
1606
1822
  *
1607
1823
  * @summary Gets a workflow
1608
- * @param {string} id
1824
+ * @param {string} id id of entity to query
1609
1825
  * @param {*} [options] Override http request option.
1610
1826
  * @throws {RequiredError}
1611
1827
  */
@@ -1666,7 +1882,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1666
1882
  /**
1667
1883
  *
1668
1884
  * @summary Deletes a workflow
1669
- * @param {string} id
1885
+ * @param {string} id id of entity to query
1670
1886
  * @param {*} [options] Override http request option.
1671
1887
  * @throws {RequiredError}
1672
1888
  */
@@ -1728,7 +1944,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1728
1944
  *
1729
1945
  * @summary Gets all or specific set of workflows
1730
1946
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1731
- * @param {Array<string>} [id]
1947
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1732
1948
  * @param {*} [options] Override http request option.
1733
1949
  * @throws {RequiredError}
1734
1950
  */
@@ -1790,7 +2006,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1790
2006
  /**
1791
2007
  *
1792
2008
  * @summary Deletes multiple workflows
1793
- * @param {Array<string>} [id]
2009
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1794
2010
  * @param {*} [options] Override http request option.
1795
2011
  * @throws {RequiredError}
1796
2012
  */
@@ -1848,18 +2064,18 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1848
2064
  },
1849
2065
  };
1850
2066
  };
1851
- exports.Scout9ApiAxiosParamCreator = Scout9ApiAxiosParamCreator;
2067
+ exports.PocketScoutApiAxiosParamCreator = PocketScoutApiAxiosParamCreator;
1852
2068
  /**
1853
- * Scout9Api - functional programming interface
2069
+ * PocketScoutApi - functional programming interface
1854
2070
  * @export
1855
2071
  */
1856
- const Scout9ApiFp = function (configuration) {
1857
- const localVarAxiosParamCreator = (0, exports.Scout9ApiAxiosParamCreator)(configuration);
2072
+ const PocketScoutApiFp = function (configuration) {
2073
+ const localVarAxiosParamCreator = (0, exports.PocketScoutApiAxiosParamCreator)(configuration);
1858
2074
  return {
1859
2075
  /**
1860
2076
  *
1861
2077
  * @summary Gets a agent
1862
- * @param {string} id
2078
+ * @param {string} id id of entity to query
1863
2079
  * @param {*} [options] Override http request option.
1864
2080
  * @throws {RequiredError}
1865
2081
  */
@@ -1869,24 +2085,24 @@ const Scout9ApiFp = function (configuration) {
1869
2085
  },
1870
2086
  /**
1871
2087
  *
1872
- * @summary Create a new agent
1873
- * @param {CreateAgentRequest} createAgentRequest
2088
+ * @summary Deletes a agent
2089
+ * @param {string} id id of entity to query
1874
2090
  * @param {*} [options] Override http request option.
1875
2091
  * @throws {RequiredError}
1876
2092
  */
1877
- async agentCreate(createAgentRequest, options) {
1878
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentCreate(createAgentRequest, options);
2093
+ async agentDelete(id, options) {
2094
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
1879
2095
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1880
2096
  },
1881
2097
  /**
1882
2098
  *
1883
- * @summary Deletes a agent
1884
- * @param {string} id
2099
+ * @summary Registers a new agent
2100
+ * @param {CreateAgentRequest} createAgentRequest
1885
2101
  * @param {*} [options] Override http request option.
1886
2102
  * @throws {RequiredError}
1887
2103
  */
1888
- async agentDelete(id, options) {
1889
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
2104
+ async agentRegister(createAgentRequest, options) {
2105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentRegister(createAgentRequest, options);
1890
2106
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1891
2107
  },
1892
2108
  /**
@@ -1904,7 +2120,7 @@ const Scout9ApiFp = function (configuration) {
1904
2120
  *
1905
2121
  * @summary Gets all or specific set of agents
1906
2122
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1907
- * @param {Array<string>} [id]
2123
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1908
2124
  * @param {*} [options] Override http request option.
1909
2125
  * @throws {RequiredError}
1910
2126
  */
@@ -1926,7 +2142,7 @@ const Scout9ApiFp = function (configuration) {
1926
2142
  /**
1927
2143
  *
1928
2144
  * @summary Deletes multiple agents
1929
- * @param {Array<string>} [id]
2145
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1930
2146
  * @param {*} [options] Override http request option.
1931
2147
  * @throws {RequiredError}
1932
2148
  */
@@ -1948,7 +2164,7 @@ const Scout9ApiFp = function (configuration) {
1948
2164
  /**
1949
2165
  *
1950
2166
  * @summary Gets a context
1951
- * @param {string} id
2167
+ * @param {string} id id of entity to query
1952
2168
  * @param {*} [options] Override http request option.
1953
2169
  * @throws {RequiredError}
1954
2170
  */
@@ -1970,7 +2186,7 @@ const Scout9ApiFp = function (configuration) {
1970
2186
  /**
1971
2187
  *
1972
2188
  * @summary Deletes a schedule
1973
- * @param {string} id
2189
+ * @param {string} id id of entity to query
1974
2190
  * @param {*} [options] Override http request option.
1975
2191
  * @throws {RequiredError}
1976
2192
  */
@@ -1993,7 +2209,7 @@ const Scout9ApiFp = function (configuration) {
1993
2209
  *
1994
2210
  * @summary Gets all or specific set of contexts
1995
2211
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1996
- * @param {Array<string>} [id]
2212
+ * @param {Array<string>} [id] ids for the entities this id belongs to
1997
2213
  * @param {*} [options] Override http request option.
1998
2214
  * @throws {RequiredError}
1999
2215
  */
@@ -2015,7 +2231,7 @@ const Scout9ApiFp = function (configuration) {
2015
2231
  /**
2016
2232
  *
2017
2233
  * @summary Deletes multiple contexts
2018
- * @param {Array<string>} [id]
2234
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2019
2235
  * @param {*} [options] Override http request option.
2020
2236
  * @throws {RequiredError}
2021
2237
  */
@@ -2037,7 +2253,7 @@ const Scout9ApiFp = function (configuration) {
2037
2253
  /**
2038
2254
  *
2039
2255
  * @summary Gets a conversation
2040
- * @param {string} id
2256
+ * @param {string} id id of entity to query
2041
2257
  * @param {*} [options] Override http request option.
2042
2258
  * @throws {RequiredError}
2043
2259
  */
@@ -2059,7 +2275,7 @@ const Scout9ApiFp = function (configuration) {
2059
2275
  /**
2060
2276
  *
2061
2277
  * @summary Deletes a schedule
2062
- * @param {string} id
2278
+ * @param {string} id id of entity to query
2063
2279
  * @param {*} [options] Override http request option.
2064
2280
  * @throws {RequiredError}
2065
2281
  */
@@ -2081,7 +2297,7 @@ const Scout9ApiFp = function (configuration) {
2081
2297
  /**
2082
2298
  *
2083
2299
  * @summary Gets a customer
2084
- * @param {string} id
2300
+ * @param {string} id id of entity to query
2085
2301
  * @param {*} [options] Override http request option.
2086
2302
  * @throws {RequiredError}
2087
2303
  */
@@ -2103,7 +2319,7 @@ const Scout9ApiFp = function (configuration) {
2103
2319
  /**
2104
2320
  *
2105
2321
  * @summary Deletes a customer
2106
- * @param {string} id
2322
+ * @param {string} id id of entity to query
2107
2323
  * @param {*} [options] Override http request option.
2108
2324
  * @throws {RequiredError}
2109
2325
  */
@@ -2114,7 +2330,7 @@ const Scout9ApiFp = function (configuration) {
2114
2330
  /**
2115
2331
  *
2116
2332
  * @summary Gets a customer group
2117
- * @param {string} id
2333
+ * @param {string} id id of entity to query
2118
2334
  * @param {*} [options] Override http request option.
2119
2335
  * @throws {RequiredError}
2120
2336
  */
@@ -2136,7 +2352,7 @@ const Scout9ApiFp = function (configuration) {
2136
2352
  /**
2137
2353
  *
2138
2354
  * @summary Deletes a customer group
2139
- * @param {string} id
2355
+ * @param {string} id id of entity to query
2140
2356
  * @param {*} [options] Override http request option.
2141
2357
  * @throws {RequiredError}
2142
2358
  */
@@ -2159,7 +2375,7 @@ const Scout9ApiFp = function (configuration) {
2159
2375
  *
2160
2376
  * @summary Gets all or specific set of customer groups
2161
2377
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2162
- * @param {Array<string>} [id]
2378
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2163
2379
  * @param {*} [options] Override http request option.
2164
2380
  * @throws {RequiredError}
2165
2381
  */
@@ -2181,7 +2397,7 @@ const Scout9ApiFp = function (configuration) {
2181
2397
  /**
2182
2398
  *
2183
2399
  * @summary Deletes multiple customer groups
2184
- * @param {Array<string>} [id]
2400
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2185
2401
  * @param {*} [options] Override http request option.
2186
2402
  * @throws {RequiredError}
2187
2403
  */
@@ -2215,7 +2431,7 @@ const Scout9ApiFp = function (configuration) {
2215
2431
  *
2216
2432
  * @summary Gets all or specific set of customers
2217
2433
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2218
- * @param {Array<string>} [id]
2434
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2219
2435
  * @param {*} [options] Override http request option.
2220
2436
  * @throws {RequiredError}
2221
2437
  */
@@ -2237,7 +2453,7 @@ const Scout9ApiFp = function (configuration) {
2237
2453
  /**
2238
2454
  *
2239
2455
  * @summary Deletes multiple customers
2240
- * @param {Array<string>} [id]
2456
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2241
2457
  * @param {*} [options] Override http request option.
2242
2458
  * @throws {RequiredError}
2243
2459
  */
@@ -2256,6 +2472,61 @@ const Scout9ApiFp = function (configuration) {
2256
2472
  const localVarAxiosArgs = await localVarAxiosParamCreator.customersUpdate(updateCustomerRequest, options);
2257
2473
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2258
2474
  },
2475
+ /**
2476
+ *
2477
+ * @summary Returns information about a specific file.
2478
+ * @param {string} fileId The ID of the file to use for this request
2479
+ * @param {*} [options] Override http request option.
2480
+ * @throws {RequiredError}
2481
+ */
2482
+ async file(fileId, options) {
2483
+ const localVarAxiosArgs = await localVarAxiosParamCreator.file(fileId, options);
2484
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2485
+ },
2486
+ /**
2487
+ *
2488
+ * @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.
2489
+ * @param {File} file
2490
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
2491
+ * @param {*} [options] Override http request option.
2492
+ * @throws {RequiredError}
2493
+ */
2494
+ async fileCreate(file, purpose, options) {
2495
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileCreate(file, purpose, options);
2496
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2497
+ },
2498
+ /**
2499
+ *
2500
+ * @summary Delete a file.
2501
+ * @param {string} fileId The ID of the file to use for this request
2502
+ * @param {*} [options] Override http request option.
2503
+ * @throws {RequiredError}
2504
+ */
2505
+ async fileDelete(fileId, options) {
2506
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileDelete(fileId, options);
2507
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2508
+ },
2509
+ /**
2510
+ *
2511
+ * @summary Returns the contents of the specified file
2512
+ * @param {string} fileId The ID of the file to use for this request
2513
+ * @param {*} [options] Override http request option.
2514
+ * @throws {RequiredError}
2515
+ */
2516
+ async fileDownload(fileId, options) {
2517
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileDownload(fileId, options);
2518
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2519
+ },
2520
+ /**
2521
+ *
2522
+ * @summary Returns a list of files that belong to the user\'s organization.
2523
+ * @param {*} [options] Override http request option.
2524
+ * @throws {RequiredError}
2525
+ */
2526
+ async files(options) {
2527
+ const localVarAxiosArgs = await localVarAxiosParamCreator.files(options);
2528
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2529
+ },
2259
2530
  /**
2260
2531
  * 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.
2261
2532
  * @summary Generate a message from conversation
@@ -2281,19 +2552,19 @@ const Scout9ApiFp = function (configuration) {
2281
2552
  /**
2282
2553
  *
2283
2554
  * @summary Get all messages from a conversation
2555
+ * @param {string} id id of entity to query
2284
2556
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2285
- * @param {Array<string>} [id]
2286
2557
  * @param {*} [options] Override http request option.
2287
2558
  * @throws {RequiredError}
2288
2559
  */
2289
- async messages(q, id, options) {
2290
- const localVarAxiosArgs = await localVarAxiosParamCreator.messages(q, id, options);
2560
+ async messages(id, q, options) {
2561
+ const localVarAxiosArgs = await localVarAxiosParamCreator.messages(id, q, options);
2291
2562
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2292
2563
  },
2293
2564
  /**
2294
2565
  *
2295
2566
  * @summary Get the results of a bulk API operation
2296
- * @param {string} id
2567
+ * @param {string} id id of entity to query
2297
2568
  * @param {*} [options] Override http request option.
2298
2569
  * @throws {RequiredError}
2299
2570
  */
@@ -2305,7 +2576,7 @@ const Scout9ApiFp = function (configuration) {
2305
2576
  *
2306
2577
  * @summary Gets all or specific set of bulk API operations
2307
2578
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2308
- * @param {Array<string>} [id]
2579
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2309
2580
  * @param {*} [options] Override http request option.
2310
2581
  * @throws {RequiredError}
2311
2582
  */
@@ -2320,14 +2591,14 @@ const Scout9ApiFp = function (configuration) {
2320
2591
  * @param {*} [options] Override http request option.
2321
2592
  * @throws {RequiredError}
2322
2593
  */
2323
- async scheduleCreate(scheduleCreateRequest, options) {
2324
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleCreate(scheduleCreateRequest, options);
2594
+ async scheduleConversation(scheduleCreateRequest, options) {
2595
+ const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleConversation(scheduleCreateRequest, options);
2325
2596
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2326
2597
  },
2327
2598
  /**
2328
2599
  *
2329
2600
  * @summary Deletes a schedule
2330
- * @param {string} id
2601
+ * @param {string} id id of entity to query
2331
2602
  * @param {*} [options] Override http request option.
2332
2603
  * @throws {RequiredError}
2333
2604
  */
@@ -2349,7 +2620,7 @@ const Scout9ApiFp = function (configuration) {
2349
2620
  /**
2350
2621
  *
2351
2622
  * @summary Deletes and cancels a schedule group
2352
- * @param {string} id
2623
+ * @param {string} id id of entity to query
2353
2624
  * @param {*} [options] Override http request option.
2354
2625
  * @throws {RequiredError}
2355
2626
  */
@@ -2360,7 +2631,7 @@ const Scout9ApiFp = function (configuration) {
2360
2631
  /**
2361
2632
  *
2362
2633
  * @summary Gets a schedule group
2363
- * @param {string} id
2634
+ * @param {string} id id of entity to query
2364
2635
  * @param {*} [options] Override http request option.
2365
2636
  * @throws {RequiredError}
2366
2637
  */
@@ -2382,7 +2653,7 @@ const Scout9ApiFp = function (configuration) {
2382
2653
  /**
2383
2654
  *
2384
2655
  * @summary Gets a schedule
2385
- * @param {string} id
2656
+ * @param {string} id id of entity to query
2386
2657
  * @param {*} [options] Override http request option.
2387
2658
  * @throws {RequiredError}
2388
2659
  */
@@ -2404,7 +2675,7 @@ const Scout9ApiFp = function (configuration) {
2404
2675
  /**
2405
2676
  *
2406
2677
  * @summary Gets a workflow
2407
- * @param {string} id
2678
+ * @param {string} id id of entity to query
2408
2679
  * @param {*} [options] Override http request option.
2409
2680
  * @throws {RequiredError}
2410
2681
  */
@@ -2426,7 +2697,7 @@ const Scout9ApiFp = function (configuration) {
2426
2697
  /**
2427
2698
  *
2428
2699
  * @summary Deletes a workflow
2429
- * @param {string} id
2700
+ * @param {string} id id of entity to query
2430
2701
  * @param {*} [options] Override http request option.
2431
2702
  * @throws {RequiredError}
2432
2703
  */
@@ -2449,7 +2720,7 @@ const Scout9ApiFp = function (configuration) {
2449
2720
  *
2450
2721
  * @summary Gets all or specific set of workflows
2451
2722
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2452
- * @param {Array<string>} [id]
2723
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2453
2724
  * @param {*} [options] Override http request option.
2454
2725
  * @throws {RequiredError}
2455
2726
  */
@@ -2471,7 +2742,7 @@ const Scout9ApiFp = function (configuration) {
2471
2742
  /**
2472
2743
  *
2473
2744
  * @summary Deletes multiple workflows
2474
- * @param {Array<string>} [id]
2745
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2475
2746
  * @param {*} [options] Override http request option.
2476
2747
  * @throws {RequiredError}
2477
2748
  */
@@ -2492,18 +2763,18 @@ const Scout9ApiFp = function (configuration) {
2492
2763
  },
2493
2764
  };
2494
2765
  };
2495
- exports.Scout9ApiFp = Scout9ApiFp;
2766
+ exports.PocketScoutApiFp = PocketScoutApiFp;
2496
2767
  /**
2497
- * Scout9Api - factory interface
2768
+ * PocketScoutApi - factory interface
2498
2769
  * @export
2499
2770
  */
2500
- const Scout9ApiFactory = function (configuration, basePath, axios) {
2501
- const localVarFp = (0, exports.Scout9ApiFp)(configuration);
2771
+ const PocketScoutApiFactory = function (configuration, basePath, axios) {
2772
+ const localVarFp = (0, exports.PocketScoutApiFp)(configuration);
2502
2773
  return {
2503
2774
  /**
2504
2775
  *
2505
2776
  * @summary Gets a agent
2506
- * @param {string} id
2777
+ * @param {string} id id of entity to query
2507
2778
  * @param {*} [options] Override http request option.
2508
2779
  * @throws {RequiredError}
2509
2780
  */
@@ -2512,23 +2783,23 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2512
2783
  },
2513
2784
  /**
2514
2785
  *
2515
- * @summary Create a new agent
2516
- * @param {CreateAgentRequest} createAgentRequest
2786
+ * @summary Deletes a agent
2787
+ * @param {string} id id of entity to query
2517
2788
  * @param {*} [options] Override http request option.
2518
2789
  * @throws {RequiredError}
2519
2790
  */
2520
- agentCreate(createAgentRequest, options) {
2521
- return localVarFp.agentCreate(createAgentRequest, options).then((request) => request(axios, basePath));
2791
+ agentDelete(id, options) {
2792
+ return localVarFp.agentDelete(id, options).then((request) => request(axios, basePath));
2522
2793
  },
2523
2794
  /**
2524
2795
  *
2525
- * @summary Deletes a agent
2526
- * @param {string} id
2796
+ * @summary Registers a new agent
2797
+ * @param {CreateAgentRequest} createAgentRequest
2527
2798
  * @param {*} [options] Override http request option.
2528
2799
  * @throws {RequiredError}
2529
2800
  */
2530
- agentDelete(id, options) {
2531
- return localVarFp.agentDelete(id, options).then((request) => request(axios, basePath));
2801
+ agentRegister(createAgentRequest, options) {
2802
+ return localVarFp.agentRegister(createAgentRequest, options).then((request) => request(axios, basePath));
2532
2803
  },
2533
2804
  /**
2534
2805
  *
@@ -2544,7 +2815,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2544
2815
  *
2545
2816
  * @summary Gets all or specific set of agents
2546
2817
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2547
- * @param {Array<string>} [id]
2818
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2548
2819
  * @param {*} [options] Override http request option.
2549
2820
  * @throws {RequiredError}
2550
2821
  */
@@ -2564,7 +2835,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2564
2835
  /**
2565
2836
  *
2566
2837
  * @summary Deletes multiple agents
2567
- * @param {Array<string>} [id]
2838
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2568
2839
  * @param {*} [options] Override http request option.
2569
2840
  * @throws {RequiredError}
2570
2841
  */
@@ -2584,7 +2855,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2584
2855
  /**
2585
2856
  *
2586
2857
  * @summary Gets a context
2587
- * @param {string} id
2858
+ * @param {string} id id of entity to query
2588
2859
  * @param {*} [options] Override http request option.
2589
2860
  * @throws {RequiredError}
2590
2861
  */
@@ -2604,7 +2875,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2604
2875
  /**
2605
2876
  *
2606
2877
  * @summary Deletes a schedule
2607
- * @param {string} id
2878
+ * @param {string} id id of entity to query
2608
2879
  * @param {*} [options] Override http request option.
2609
2880
  * @throws {RequiredError}
2610
2881
  */
@@ -2625,7 +2896,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2625
2896
  *
2626
2897
  * @summary Gets all or specific set of contexts
2627
2898
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2628
- * @param {Array<string>} [id]
2899
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2629
2900
  * @param {*} [options] Override http request option.
2630
2901
  * @throws {RequiredError}
2631
2902
  */
@@ -2645,7 +2916,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2645
2916
  /**
2646
2917
  *
2647
2918
  * @summary Deletes multiple contexts
2648
- * @param {Array<string>} [id]
2919
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2649
2920
  * @param {*} [options] Override http request option.
2650
2921
  * @throws {RequiredError}
2651
2922
  */
@@ -2665,7 +2936,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2665
2936
  /**
2666
2937
  *
2667
2938
  * @summary Gets a conversation
2668
- * @param {string} id
2939
+ * @param {string} id id of entity to query
2669
2940
  * @param {*} [options] Override http request option.
2670
2941
  * @throws {RequiredError}
2671
2942
  */
@@ -2685,7 +2956,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2685
2956
  /**
2686
2957
  *
2687
2958
  * @summary Deletes a schedule
2688
- * @param {string} id
2959
+ * @param {string} id id of entity to query
2689
2960
  * @param {*} [options] Override http request option.
2690
2961
  * @throws {RequiredError}
2691
2962
  */
@@ -2705,7 +2976,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2705
2976
  /**
2706
2977
  *
2707
2978
  * @summary Gets a customer
2708
- * @param {string} id
2979
+ * @param {string} id id of entity to query
2709
2980
  * @param {*} [options] Override http request option.
2710
2981
  * @throws {RequiredError}
2711
2982
  */
@@ -2725,7 +2996,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2725
2996
  /**
2726
2997
  *
2727
2998
  * @summary Deletes a customer
2728
- * @param {string} id
2999
+ * @param {string} id id of entity to query
2729
3000
  * @param {*} [options] Override http request option.
2730
3001
  * @throws {RequiredError}
2731
3002
  */
@@ -2735,7 +3006,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2735
3006
  /**
2736
3007
  *
2737
3008
  * @summary Gets a customer group
2738
- * @param {string} id
3009
+ * @param {string} id id of entity to query
2739
3010
  * @param {*} [options] Override http request option.
2740
3011
  * @throws {RequiredError}
2741
3012
  */
@@ -2755,7 +3026,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2755
3026
  /**
2756
3027
  *
2757
3028
  * @summary Deletes a customer group
2758
- * @param {string} id
3029
+ * @param {string} id id of entity to query
2759
3030
  * @param {*} [options] Override http request option.
2760
3031
  * @throws {RequiredError}
2761
3032
  */
@@ -2776,7 +3047,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2776
3047
  *
2777
3048
  * @summary Gets all or specific set of customer groups
2778
3049
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2779
- * @param {Array<string>} [id]
3050
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2780
3051
  * @param {*} [options] Override http request option.
2781
3052
  * @throws {RequiredError}
2782
3053
  */
@@ -2796,7 +3067,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2796
3067
  /**
2797
3068
  *
2798
3069
  * @summary Deletes multiple customer groups
2799
- * @param {Array<string>} [id]
3070
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2800
3071
  * @param {*} [options] Override http request option.
2801
3072
  * @throws {RequiredError}
2802
3073
  */
@@ -2827,7 +3098,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2827
3098
  *
2828
3099
  * @summary Gets all or specific set of customers
2829
3100
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2830
- * @param {Array<string>} [id]
3101
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2831
3102
  * @param {*} [options] Override http request option.
2832
3103
  * @throws {RequiredError}
2833
3104
  */
@@ -2847,7 +3118,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2847
3118
  /**
2848
3119
  *
2849
3120
  * @summary Deletes multiple customers
2850
- * @param {Array<string>} [id]
3121
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2851
3122
  * @param {*} [options] Override http request option.
2852
3123
  * @throws {RequiredError}
2853
3124
  */
@@ -2864,6 +3135,56 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2864
3135
  customersUpdate(updateCustomerRequest, options) {
2865
3136
  return localVarFp.customersUpdate(updateCustomerRequest, options).then((request) => request(axios, basePath));
2866
3137
  },
3138
+ /**
3139
+ *
3140
+ * @summary Returns information about a specific file.
3141
+ * @param {string} fileId The ID of the file to use for this request
3142
+ * @param {*} [options] Override http request option.
3143
+ * @throws {RequiredError}
3144
+ */
3145
+ file(fileId, options) {
3146
+ return localVarFp.file(fileId, options).then((request) => request(axios, basePath));
3147
+ },
3148
+ /**
3149
+ *
3150
+ * @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.
3151
+ * @param {File} file
3152
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
3153
+ * @param {*} [options] Override http request option.
3154
+ * @throws {RequiredError}
3155
+ */
3156
+ fileCreate(file, purpose, options) {
3157
+ return localVarFp.fileCreate(file, purpose, options).then((request) => request(axios, basePath));
3158
+ },
3159
+ /**
3160
+ *
3161
+ * @summary Delete a file.
3162
+ * @param {string} fileId The ID of the file to use for this request
3163
+ * @param {*} [options] Override http request option.
3164
+ * @throws {RequiredError}
3165
+ */
3166
+ fileDelete(fileId, options) {
3167
+ return localVarFp.fileDelete(fileId, options).then((request) => request(axios, basePath));
3168
+ },
3169
+ /**
3170
+ *
3171
+ * @summary Returns the contents of the specified file
3172
+ * @param {string} fileId The ID of the file to use for this request
3173
+ * @param {*} [options] Override http request option.
3174
+ * @throws {RequiredError}
3175
+ */
3176
+ fileDownload(fileId, options) {
3177
+ return localVarFp.fileDownload(fileId, options).then((request) => request(axios, basePath));
3178
+ },
3179
+ /**
3180
+ *
3181
+ * @summary Returns a list of files that belong to the user\'s organization.
3182
+ * @param {*} [options] Override http request option.
3183
+ * @throws {RequiredError}
3184
+ */
3185
+ files(options) {
3186
+ return localVarFp.files(options).then((request) => request(axios, basePath));
3187
+ },
2867
3188
  /**
2868
3189
  * 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.
2869
3190
  * @summary Generate a message from conversation
@@ -2887,18 +3208,18 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2887
3208
  /**
2888
3209
  *
2889
3210
  * @summary Get all messages from a conversation
3211
+ * @param {string} id id of entity to query
2890
3212
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2891
- * @param {Array<string>} [id]
2892
3213
  * @param {*} [options] Override http request option.
2893
3214
  * @throws {RequiredError}
2894
3215
  */
2895
- messages(q, id, options) {
2896
- return localVarFp.messages(q, id, options).then((request) => request(axios, basePath));
3216
+ messages(id, q, options) {
3217
+ return localVarFp.messages(id, q, options).then((request) => request(axios, basePath));
2897
3218
  },
2898
3219
  /**
2899
3220
  *
2900
3221
  * @summary Get the results of a bulk API operation
2901
- * @param {string} id
3222
+ * @param {string} id id of entity to query
2902
3223
  * @param {*} [options] Override http request option.
2903
3224
  * @throws {RequiredError}
2904
3225
  */
@@ -2909,7 +3230,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2909
3230
  *
2910
3231
  * @summary Gets all or specific set of bulk API operations
2911
3232
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2912
- * @param {Array<string>} [id]
3233
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2913
3234
  * @param {*} [options] Override http request option.
2914
3235
  * @throws {RequiredError}
2915
3236
  */
@@ -2923,13 +3244,13 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2923
3244
  * @param {*} [options] Override http request option.
2924
3245
  * @throws {RequiredError}
2925
3246
  */
2926
- scheduleCreate(scheduleCreateRequest, options) {
2927
- return localVarFp.scheduleCreate(scheduleCreateRequest, options).then((request) => request(axios, basePath));
3247
+ scheduleConversation(scheduleCreateRequest, options) {
3248
+ return localVarFp.scheduleConversation(scheduleCreateRequest, options).then((request) => request(axios, basePath));
2928
3249
  },
2929
3250
  /**
2930
3251
  *
2931
3252
  * @summary Deletes a schedule
2932
- * @param {string} id
3253
+ * @param {string} id id of entity to query
2933
3254
  * @param {*} [options] Override http request option.
2934
3255
  * @throws {RequiredError}
2935
3256
  */
@@ -2949,7 +3270,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2949
3270
  /**
2950
3271
  *
2951
3272
  * @summary Deletes and cancels a schedule group
2952
- * @param {string} id
3273
+ * @param {string} id id of entity to query
2953
3274
  * @param {*} [options] Override http request option.
2954
3275
  * @throws {RequiredError}
2955
3276
  */
@@ -2959,7 +3280,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2959
3280
  /**
2960
3281
  *
2961
3282
  * @summary Gets a schedule group
2962
- * @param {string} id
3283
+ * @param {string} id id of entity to query
2963
3284
  * @param {*} [options] Override http request option.
2964
3285
  * @throws {RequiredError}
2965
3286
  */
@@ -2979,7 +3300,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2979
3300
  /**
2980
3301
  *
2981
3302
  * @summary Gets a schedule
2982
- * @param {string} id
3303
+ * @param {string} id id of entity to query
2983
3304
  * @param {*} [options] Override http request option.
2984
3305
  * @throws {RequiredError}
2985
3306
  */
@@ -2999,7 +3320,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
2999
3320
  /**
3000
3321
  *
3001
3322
  * @summary Gets a workflow
3002
- * @param {string} id
3323
+ * @param {string} id id of entity to query
3003
3324
  * @param {*} [options] Override http request option.
3004
3325
  * @throws {RequiredError}
3005
3326
  */
@@ -3019,7 +3340,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3019
3340
  /**
3020
3341
  *
3021
3342
  * @summary Deletes a workflow
3022
- * @param {string} id
3343
+ * @param {string} id id of entity to query
3023
3344
  * @param {*} [options] Override http request option.
3024
3345
  * @throws {RequiredError}
3025
3346
  */
@@ -3040,7 +3361,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3040
3361
  *
3041
3362
  * @summary Gets all or specific set of workflows
3042
3363
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3043
- * @param {Array<string>} [id]
3364
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3044
3365
  * @param {*} [options] Override http request option.
3045
3366
  * @throws {RequiredError}
3046
3367
  */
@@ -3060,7 +3381,7 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3060
3381
  /**
3061
3382
  *
3062
3383
  * @summary Deletes multiple workflows
3063
- * @param {Array<string>} [id]
3384
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3064
3385
  * @param {*} [options] Override http request option.
3065
3386
  * @throws {RequiredError}
3066
3387
  */
@@ -3079,46 +3400,46 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3079
3400
  },
3080
3401
  };
3081
3402
  };
3082
- exports.Scout9ApiFactory = Scout9ApiFactory;
3403
+ exports.PocketScoutApiFactory = PocketScoutApiFactory;
3083
3404
  /**
3084
- * Scout9Api - object-oriented interface
3405
+ * PocketScoutApi - object-oriented interface
3085
3406
  * @export
3086
- * @class Scout9Api
3407
+ * @class PocketScoutApi
3087
3408
  * @extends {BaseAPI}
3088
3409
  */
3089
- class Scout9Api extends base_1.BaseAPI {
3410
+ class PocketScoutApi extends base_1.BaseAPI {
3090
3411
  /**
3091
3412
  *
3092
3413
  * @summary Gets a agent
3093
- * @param {string} id
3414
+ * @param {string} id id of entity to query
3094
3415
  * @param {*} [options] Override http request option.
3095
3416
  * @throws {RequiredError}
3096
- * @memberof Scout9Api
3417
+ * @memberof PocketScoutApi
3097
3418
  */
3098
3419
  agent(id, options) {
3099
- return (0, exports.Scout9ApiFp)(this.configuration).agent(id, options).then((request) => request(this.axios, this.basePath));
3420
+ return (0, exports.PocketScoutApiFp)(this.configuration).agent(id, options).then((request) => request(this.axios, this.basePath));
3100
3421
  }
3101
3422
  /**
3102
3423
  *
3103
- * @summary Create a new agent
3104
- * @param {CreateAgentRequest} createAgentRequest
3424
+ * @summary Deletes a agent
3425
+ * @param {string} id id of entity to query
3105
3426
  * @param {*} [options] Override http request option.
3106
3427
  * @throws {RequiredError}
3107
- * @memberof Scout9Api
3428
+ * @memberof PocketScoutApi
3108
3429
  */
3109
- agentCreate(createAgentRequest, options) {
3110
- return (0, exports.Scout9ApiFp)(this.configuration).agentCreate(createAgentRequest, options).then((request) => request(this.axios, this.basePath));
3430
+ agentDelete(id, options) {
3431
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentDelete(id, options).then((request) => request(this.axios, this.basePath));
3111
3432
  }
3112
3433
  /**
3113
3434
  *
3114
- * @summary Deletes a agent
3115
- * @param {string} id
3435
+ * @summary Registers a new agent
3436
+ * @param {CreateAgentRequest} createAgentRequest
3116
3437
  * @param {*} [options] Override http request option.
3117
3438
  * @throws {RequiredError}
3118
- * @memberof Scout9Api
3439
+ * @memberof PocketScoutApi
3119
3440
  */
3120
- agentDelete(id, options) {
3121
- return (0, exports.Scout9ApiFp)(this.configuration).agentDelete(id, options).then((request) => request(this.axios, this.basePath));
3441
+ agentRegister(createAgentRequest, options) {
3442
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentRegister(createAgentRequest, options).then((request) => request(this.axios, this.basePath));
3122
3443
  }
3123
3444
  /**
3124
3445
  *
@@ -3126,22 +3447,22 @@ class Scout9Api extends base_1.BaseAPI {
3126
3447
  * @param {UpdateAgentRequest} updateAgentRequest
3127
3448
  * @param {*} [options] Override http request option.
3128
3449
  * @throws {RequiredError}
3129
- * @memberof Scout9Api
3450
+ * @memberof PocketScoutApi
3130
3451
  */
3131
3452
  agentUpdate(updateAgentRequest, options) {
3132
- return (0, exports.Scout9ApiFp)(this.configuration).agentUpdate(updateAgentRequest, options).then((request) => request(this.axios, this.basePath));
3453
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentUpdate(updateAgentRequest, options).then((request) => request(this.axios, this.basePath));
3133
3454
  }
3134
3455
  /**
3135
3456
  *
3136
3457
  * @summary Gets all or specific set of agents
3137
3458
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3138
- * @param {Array<string>} [id]
3459
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3139
3460
  * @param {*} [options] Override http request option.
3140
3461
  * @throws {RequiredError}
3141
- * @memberof Scout9Api
3462
+ * @memberof PocketScoutApi
3142
3463
  */
3143
3464
  agents(q, id, options) {
3144
- return (0, exports.Scout9ApiFp)(this.configuration).agents(q, id, options).then((request) => request(this.axios, this.basePath));
3465
+ return (0, exports.PocketScoutApiFp)(this.configuration).agents(q, id, options).then((request) => request(this.axios, this.basePath));
3145
3466
  }
3146
3467
  /**
3147
3468
  *
@@ -3149,21 +3470,21 @@ class Scout9Api extends base_1.BaseAPI {
3149
3470
  * @param {CreateAgentsRequest} createAgentsRequest
3150
3471
  * @param {*} [options] Override http request option.
3151
3472
  * @throws {RequiredError}
3152
- * @memberof Scout9Api
3473
+ * @memberof PocketScoutApi
3153
3474
  */
3154
3475
  agentsCreate(createAgentsRequest, options) {
3155
- return (0, exports.Scout9ApiFp)(this.configuration).agentsCreate(createAgentsRequest, options).then((request) => request(this.axios, this.basePath));
3476
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentsCreate(createAgentsRequest, options).then((request) => request(this.axios, this.basePath));
3156
3477
  }
3157
3478
  /**
3158
3479
  *
3159
3480
  * @summary Deletes multiple agents
3160
- * @param {Array<string>} [id]
3481
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3161
3482
  * @param {*} [options] Override http request option.
3162
3483
  * @throws {RequiredError}
3163
- * @memberof Scout9Api
3484
+ * @memberof PocketScoutApi
3164
3485
  */
3165
3486
  agentsDelete(id, options) {
3166
- return (0, exports.Scout9ApiFp)(this.configuration).agentsDelete(id, options).then((request) => request(this.axios, this.basePath));
3487
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentsDelete(id, options).then((request) => request(this.axios, this.basePath));
3167
3488
  }
3168
3489
  /**
3169
3490
  *
@@ -3171,21 +3492,21 @@ class Scout9Api extends base_1.BaseAPI {
3171
3492
  * @param {UpdateAgentsRequest} updateAgentsRequest
3172
3493
  * @param {*} [options] Override http request option.
3173
3494
  * @throws {RequiredError}
3174
- * @memberof Scout9Api
3495
+ * @memberof PocketScoutApi
3175
3496
  */
3176
3497
  agentsUpdate(updateAgentsRequest, options) {
3177
- return (0, exports.Scout9ApiFp)(this.configuration).agentsUpdate(updateAgentsRequest, options).then((request) => request(this.axios, this.basePath));
3498
+ return (0, exports.PocketScoutApiFp)(this.configuration).agentsUpdate(updateAgentsRequest, options).then((request) => request(this.axios, this.basePath));
3178
3499
  }
3179
3500
  /**
3180
3501
  *
3181
3502
  * @summary Gets a context
3182
- * @param {string} id
3503
+ * @param {string} id id of entity to query
3183
3504
  * @param {*} [options] Override http request option.
3184
3505
  * @throws {RequiredError}
3185
- * @memberof Scout9Api
3506
+ * @memberof PocketScoutApi
3186
3507
  */
3187
3508
  context(id, options) {
3188
- return (0, exports.Scout9ApiFp)(this.configuration).context(id, options).then((request) => request(this.axios, this.basePath));
3509
+ return (0, exports.PocketScoutApiFp)(this.configuration).context(id, options).then((request) => request(this.axios, this.basePath));
3189
3510
  }
3190
3511
  /**
3191
3512
  *
@@ -3193,21 +3514,21 @@ class Scout9Api extends base_1.BaseAPI {
3193
3514
  * @param {CreateContextRequest} createContextRequest
3194
3515
  * @param {*} [options] Override http request option.
3195
3516
  * @throws {RequiredError}
3196
- * @memberof Scout9Api
3517
+ * @memberof PocketScoutApi
3197
3518
  */
3198
3519
  contextCreate(createContextRequest, options) {
3199
- return (0, exports.Scout9ApiFp)(this.configuration).contextCreate(createContextRequest, options).then((request) => request(this.axios, this.basePath));
3520
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextCreate(createContextRequest, options).then((request) => request(this.axios, this.basePath));
3200
3521
  }
3201
3522
  /**
3202
3523
  *
3203
3524
  * @summary Deletes a schedule
3204
- * @param {string} id
3525
+ * @param {string} id id of entity to query
3205
3526
  * @param {*} [options] Override http request option.
3206
3527
  * @throws {RequiredError}
3207
- * @memberof Scout9Api
3528
+ * @memberof PocketScoutApi
3208
3529
  */
3209
3530
  contextDelete(id, options) {
3210
- return (0, exports.Scout9ApiFp)(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
3531
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
3211
3532
  }
3212
3533
  /**
3213
3534
  *
@@ -3215,22 +3536,22 @@ class Scout9Api extends base_1.BaseAPI {
3215
3536
  * @param {UpdateContextRequest} updateContextRequest
3216
3537
  * @param {*} [options] Override http request option.
3217
3538
  * @throws {RequiredError}
3218
- * @memberof Scout9Api
3539
+ * @memberof PocketScoutApi
3219
3540
  */
3220
3541
  contextUpdate(updateContextRequest, options) {
3221
- return (0, exports.Scout9ApiFp)(this.configuration).contextUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3542
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3222
3543
  }
3223
3544
  /**
3224
3545
  *
3225
3546
  * @summary Gets all or specific set of contexts
3226
3547
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3227
- * @param {Array<string>} [id]
3548
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3228
3549
  * @param {*} [options] Override http request option.
3229
3550
  * @throws {RequiredError}
3230
- * @memberof Scout9Api
3551
+ * @memberof PocketScoutApi
3231
3552
  */
3232
3553
  contexts(q, id, options) {
3233
- return (0, exports.Scout9ApiFp)(this.configuration).contexts(q, id, options).then((request) => request(this.axios, this.basePath));
3554
+ return (0, exports.PocketScoutApiFp)(this.configuration).contexts(q, id, options).then((request) => request(this.axios, this.basePath));
3234
3555
  }
3235
3556
  /**
3236
3557
  *
@@ -3238,21 +3559,21 @@ class Scout9Api extends base_1.BaseAPI {
3238
3559
  * @param {CreateContextsRequest} createContextsRequest
3239
3560
  * @param {*} [options] Override http request option.
3240
3561
  * @throws {RequiredError}
3241
- * @memberof Scout9Api
3562
+ * @memberof PocketScoutApi
3242
3563
  */
3243
3564
  contextsCreate(createContextsRequest, options) {
3244
- return (0, exports.Scout9ApiFp)(this.configuration).contextsCreate(createContextsRequest, options).then((request) => request(this.axios, this.basePath));
3565
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextsCreate(createContextsRequest, options).then((request) => request(this.axios, this.basePath));
3245
3566
  }
3246
3567
  /**
3247
3568
  *
3248
3569
  * @summary Deletes multiple contexts
3249
- * @param {Array<string>} [id]
3570
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3250
3571
  * @param {*} [options] Override http request option.
3251
3572
  * @throws {RequiredError}
3252
- * @memberof Scout9Api
3573
+ * @memberof PocketScoutApi
3253
3574
  */
3254
3575
  contextsDelete(id, options) {
3255
- return (0, exports.Scout9ApiFp)(this.configuration).contextsDelete(id, options).then((request) => request(this.axios, this.basePath));
3576
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextsDelete(id, options).then((request) => request(this.axios, this.basePath));
3256
3577
  }
3257
3578
  /**
3258
3579
  *
@@ -3260,21 +3581,21 @@ class Scout9Api extends base_1.BaseAPI {
3260
3581
  * @param {UpdateContextRequest} updateContextRequest
3261
3582
  * @param {*} [options] Override http request option.
3262
3583
  * @throws {RequiredError}
3263
- * @memberof Scout9Api
3584
+ * @memberof PocketScoutApi
3264
3585
  */
3265
3586
  contextsUpdate(updateContextRequest, options) {
3266
- return (0, exports.Scout9ApiFp)(this.configuration).contextsUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3587
+ return (0, exports.PocketScoutApiFp)(this.configuration).contextsUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3267
3588
  }
3268
3589
  /**
3269
3590
  *
3270
3591
  * @summary Gets a conversation
3271
- * @param {string} id
3592
+ * @param {string} id id of entity to query
3272
3593
  * @param {*} [options] Override http request option.
3273
3594
  * @throws {RequiredError}
3274
- * @memberof Scout9Api
3595
+ * @memberof PocketScoutApi
3275
3596
  */
3276
3597
  conversation(id, options) {
3277
- return (0, exports.Scout9ApiFp)(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
3598
+ return (0, exports.PocketScoutApiFp)(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
3278
3599
  }
3279
3600
  /**
3280
3601
  *
@@ -3282,21 +3603,21 @@ class Scout9Api extends base_1.BaseAPI {
3282
3603
  * @param {ConversationCreateRequest} conversationCreateRequest
3283
3604
  * @param {*} [options] Override http request option.
3284
3605
  * @throws {RequiredError}
3285
- * @memberof Scout9Api
3606
+ * @memberof PocketScoutApi
3286
3607
  */
3287
3608
  conversationCreate(conversationCreateRequest, options) {
3288
- return (0, exports.Scout9ApiFp)(this.configuration).conversationCreate(conversationCreateRequest, options).then((request) => request(this.axios, this.basePath));
3609
+ return (0, exports.PocketScoutApiFp)(this.configuration).conversationCreate(conversationCreateRequest, options).then((request) => request(this.axios, this.basePath));
3289
3610
  }
3290
3611
  /**
3291
3612
  *
3292
3613
  * @summary Deletes a schedule
3293
- * @param {string} id
3614
+ * @param {string} id id of entity to query
3294
3615
  * @param {*} [options] Override http request option.
3295
3616
  * @throws {RequiredError}
3296
- * @memberof Scout9Api
3617
+ * @memberof PocketScoutApi
3297
3618
  */
3298
3619
  conversationDelete(id, options) {
3299
- return (0, exports.Scout9ApiFp)(this.configuration).conversationDelete(id, options).then((request) => request(this.axios, this.basePath));
3620
+ return (0, exports.PocketScoutApiFp)(this.configuration).conversationDelete(id, options).then((request) => request(this.axios, this.basePath));
3300
3621
  }
3301
3622
  /**
3302
3623
  *
@@ -3304,21 +3625,21 @@ class Scout9Api extends base_1.BaseAPI {
3304
3625
  * @param {ConversationUpdateRequest} conversationUpdateRequest
3305
3626
  * @param {*} [options] Override http request option.
3306
3627
  * @throws {RequiredError}
3307
- * @memberof Scout9Api
3628
+ * @memberof PocketScoutApi
3308
3629
  */
3309
3630
  conversationUpdate(conversationUpdateRequest, options) {
3310
- return (0, exports.Scout9ApiFp)(this.configuration).conversationUpdate(conversationUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3631
+ return (0, exports.PocketScoutApiFp)(this.configuration).conversationUpdate(conversationUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3311
3632
  }
3312
3633
  /**
3313
3634
  *
3314
3635
  * @summary Gets a customer
3315
- * @param {string} id
3636
+ * @param {string} id id of entity to query
3316
3637
  * @param {*} [options] Override http request option.
3317
3638
  * @throws {RequiredError}
3318
- * @memberof Scout9Api
3639
+ * @memberof PocketScoutApi
3319
3640
  */
3320
3641
  customer(id, options) {
3321
- return (0, exports.Scout9ApiFp)(this.configuration).customer(id, options).then((request) => request(this.axios, this.basePath));
3642
+ return (0, exports.PocketScoutApiFp)(this.configuration).customer(id, options).then((request) => request(this.axios, this.basePath));
3322
3643
  }
3323
3644
  /**
3324
3645
  *
@@ -3326,32 +3647,32 @@ class Scout9Api extends base_1.BaseAPI {
3326
3647
  * @param {CreateCustomerRequest} createCustomerRequest
3327
3648
  * @param {*} [options] Override http request option.
3328
3649
  * @throws {RequiredError}
3329
- * @memberof Scout9Api
3650
+ * @memberof PocketScoutApi
3330
3651
  */
3331
3652
  customerCreate(createCustomerRequest, options) {
3332
- return (0, exports.Scout9ApiFp)(this.configuration).customerCreate(createCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3653
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerCreate(createCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3333
3654
  }
3334
3655
  /**
3335
3656
  *
3336
3657
  * @summary Deletes a customer
3337
- * @param {string} id
3658
+ * @param {string} id id of entity to query
3338
3659
  * @param {*} [options] Override http request option.
3339
3660
  * @throws {RequiredError}
3340
- * @memberof Scout9Api
3661
+ * @memberof PocketScoutApi
3341
3662
  */
3342
3663
  customerDelete(id, options) {
3343
- return (0, exports.Scout9ApiFp)(this.configuration).customerDelete(id, options).then((request) => request(this.axios, this.basePath));
3664
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerDelete(id, options).then((request) => request(this.axios, this.basePath));
3344
3665
  }
3345
3666
  /**
3346
3667
  *
3347
3668
  * @summary Gets a customer group
3348
- * @param {string} id
3669
+ * @param {string} id id of entity to query
3349
3670
  * @param {*} [options] Override http request option.
3350
3671
  * @throws {RequiredError}
3351
- * @memberof Scout9Api
3672
+ * @memberof PocketScoutApi
3352
3673
  */
3353
3674
  customerGroup(id, options) {
3354
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroup(id, options).then((request) => request(this.axios, this.basePath));
3675
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroup(id, options).then((request) => request(this.axios, this.basePath));
3355
3676
  }
3356
3677
  /**
3357
3678
  *
@@ -3359,21 +3680,21 @@ class Scout9Api extends base_1.BaseAPI {
3359
3680
  * @param {CreateCustomerGroupRequest} createCustomerGroupRequest
3360
3681
  * @param {*} [options] Override http request option.
3361
3682
  * @throws {RequiredError}
3362
- * @memberof Scout9Api
3683
+ * @memberof PocketScoutApi
3363
3684
  */
3364
3685
  customerGroupCreate(createCustomerGroupRequest, options) {
3365
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
3686
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupCreate(createCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
3366
3687
  }
3367
3688
  /**
3368
3689
  *
3369
3690
  * @summary Deletes a customer group
3370
- * @param {string} id
3691
+ * @param {string} id id of entity to query
3371
3692
  * @param {*} [options] Override http request option.
3372
3693
  * @throws {RequiredError}
3373
- * @memberof Scout9Api
3694
+ * @memberof PocketScoutApi
3374
3695
  */
3375
3696
  customerGroupDelete(id, options) {
3376
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
3697
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
3377
3698
  }
3378
3699
  /**
3379
3700
  *
@@ -3381,22 +3702,22 @@ class Scout9Api extends base_1.BaseAPI {
3381
3702
  * @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
3382
3703
  * @param {*} [options] Override http request option.
3383
3704
  * @throws {RequiredError}
3384
- * @memberof Scout9Api
3705
+ * @memberof PocketScoutApi
3385
3706
  */
3386
3707
  customerGroupUpdate(updateCustomerGroupRequest, options) {
3387
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
3708
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupUpdate(updateCustomerGroupRequest, options).then((request) => request(this.axios, this.basePath));
3388
3709
  }
3389
3710
  /**
3390
3711
  *
3391
3712
  * @summary Gets all or specific set of customer groups
3392
3713
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3393
- * @param {Array<string>} [id]
3714
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3394
3715
  * @param {*} [options] Override http request option.
3395
3716
  * @throws {RequiredError}
3396
- * @memberof Scout9Api
3717
+ * @memberof PocketScoutApi
3397
3718
  */
3398
3719
  customerGroups(q, id, options) {
3399
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroups(q, id, options).then((request) => request(this.axios, this.basePath));
3720
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroups(q, id, options).then((request) => request(this.axios, this.basePath));
3400
3721
  }
3401
3722
  /**
3402
3723
  *
@@ -3404,21 +3725,21 @@ class Scout9Api extends base_1.BaseAPI {
3404
3725
  * @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
3405
3726
  * @param {*} [options] Override http request option.
3406
3727
  * @throws {RequiredError}
3407
- * @memberof Scout9Api
3728
+ * @memberof PocketScoutApi
3408
3729
  */
3409
3730
  customerGroupsCreate(createCustomerGroupsRequest, options) {
3410
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
3731
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupsCreate(createCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
3411
3732
  }
3412
3733
  /**
3413
3734
  *
3414
3735
  * @summary Deletes multiple customer groups
3415
- * @param {Array<string>} [id]
3736
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3416
3737
  * @param {*} [options] Override http request option.
3417
3738
  * @throws {RequiredError}
3418
- * @memberof Scout9Api
3739
+ * @memberof PocketScoutApi
3419
3740
  */
3420
3741
  customerGroupsDelete(id, options) {
3421
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupsDelete(id, options).then((request) => request(this.axios, this.basePath));
3742
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupsDelete(id, options).then((request) => request(this.axios, this.basePath));
3422
3743
  }
3423
3744
  /**
3424
3745
  *
@@ -3426,10 +3747,10 @@ class Scout9Api extends base_1.BaseAPI {
3426
3747
  * @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
3427
3748
  * @param {*} [options] Override http request option.
3428
3749
  * @throws {RequiredError}
3429
- * @memberof Scout9Api
3750
+ * @memberof PocketScoutApi
3430
3751
  */
3431
3752
  customerGroupsUpdate(updateCustomerGroupsRequest, options) {
3432
- return (0, exports.Scout9ApiFp)(this.configuration).customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
3753
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerGroupsUpdate(updateCustomerGroupsRequest, options).then((request) => request(this.axios, this.basePath));
3433
3754
  }
3434
3755
  /**
3435
3756
  *
@@ -3437,22 +3758,22 @@ class Scout9Api extends base_1.BaseAPI {
3437
3758
  * @param {UpdateCustomerRequest} updateCustomerRequest
3438
3759
  * @param {*} [options] Override http request option.
3439
3760
  * @throws {RequiredError}
3440
- * @memberof Scout9Api
3761
+ * @memberof PocketScoutApi
3441
3762
  */
3442
3763
  customerUpdate(updateCustomerRequest, options) {
3443
- return (0, exports.Scout9ApiFp)(this.configuration).customerUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3764
+ return (0, exports.PocketScoutApiFp)(this.configuration).customerUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3444
3765
  }
3445
3766
  /**
3446
3767
  *
3447
3768
  * @summary Gets all or specific set of customers
3448
3769
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3449
- * @param {Array<string>} [id]
3770
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3450
3771
  * @param {*} [options] Override http request option.
3451
3772
  * @throws {RequiredError}
3452
- * @memberof Scout9Api
3773
+ * @memberof PocketScoutApi
3453
3774
  */
3454
3775
  customers(q, id, options) {
3455
- return (0, exports.Scout9ApiFp)(this.configuration).customers(q, id, options).then((request) => request(this.axios, this.basePath));
3776
+ return (0, exports.PocketScoutApiFp)(this.configuration).customers(q, id, options).then((request) => request(this.axios, this.basePath));
3456
3777
  }
3457
3778
  /**
3458
3779
  *
@@ -3460,21 +3781,21 @@ class Scout9Api extends base_1.BaseAPI {
3460
3781
  * @param {CreateCustomersRequest} createCustomersRequest
3461
3782
  * @param {*} [options] Override http request option.
3462
3783
  * @throws {RequiredError}
3463
- * @memberof Scout9Api
3784
+ * @memberof PocketScoutApi
3464
3785
  */
3465
3786
  customersCreate(createCustomersRequest, options) {
3466
- return (0, exports.Scout9ApiFp)(this.configuration).customersCreate(createCustomersRequest, options).then((request) => request(this.axios, this.basePath));
3787
+ return (0, exports.PocketScoutApiFp)(this.configuration).customersCreate(createCustomersRequest, options).then((request) => request(this.axios, this.basePath));
3467
3788
  }
3468
3789
  /**
3469
3790
  *
3470
3791
  * @summary Deletes multiple customers
3471
- * @param {Array<string>} [id]
3792
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3472
3793
  * @param {*} [options] Override http request option.
3473
3794
  * @throws {RequiredError}
3474
- * @memberof Scout9Api
3795
+ * @memberof PocketScoutApi
3475
3796
  */
3476
3797
  customersDelete(id, options) {
3477
- return (0, exports.Scout9ApiFp)(this.configuration).customersDelete(id, options).then((request) => request(this.axios, this.basePath));
3798
+ return (0, exports.PocketScoutApiFp)(this.configuration).customersDelete(id, options).then((request) => request(this.axios, this.basePath));
3478
3799
  }
3479
3800
  /**
3480
3801
  *
@@ -3482,10 +3803,65 @@ class Scout9Api extends base_1.BaseAPI {
3482
3803
  * @param {UpdateCustomerRequest} updateCustomerRequest
3483
3804
  * @param {*} [options] Override http request option.
3484
3805
  * @throws {RequiredError}
3485
- * @memberof Scout9Api
3806
+ * @memberof PocketScoutApi
3486
3807
  */
3487
3808
  customersUpdate(updateCustomerRequest, options) {
3488
- return (0, exports.Scout9ApiFp)(this.configuration).customersUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3809
+ return (0, exports.PocketScoutApiFp)(this.configuration).customersUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
3810
+ }
3811
+ /**
3812
+ *
3813
+ * @summary Returns information about a specific file.
3814
+ * @param {string} fileId The ID of the file to use for this request
3815
+ * @param {*} [options] Override http request option.
3816
+ * @throws {RequiredError}
3817
+ * @memberof PocketScoutApi
3818
+ */
3819
+ file(fileId, options) {
3820
+ return (0, exports.PocketScoutApiFp)(this.configuration).file(fileId, options).then((request) => request(this.axios, this.basePath));
3821
+ }
3822
+ /**
3823
+ *
3824
+ * @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.
3825
+ * @param {File} file
3826
+ * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
3827
+ * @param {*} [options] Override http request option.
3828
+ * @throws {RequiredError}
3829
+ * @memberof PocketScoutApi
3830
+ */
3831
+ fileCreate(file, purpose, options) {
3832
+ return (0, exports.PocketScoutApiFp)(this.configuration).fileCreate(file, purpose, options).then((request) => request(this.axios, this.basePath));
3833
+ }
3834
+ /**
3835
+ *
3836
+ * @summary Delete a file.
3837
+ * @param {string} fileId The ID of the file to use for this request
3838
+ * @param {*} [options] Override http request option.
3839
+ * @throws {RequiredError}
3840
+ * @memberof PocketScoutApi
3841
+ */
3842
+ fileDelete(fileId, options) {
3843
+ return (0, exports.PocketScoutApiFp)(this.configuration).fileDelete(fileId, options).then((request) => request(this.axios, this.basePath));
3844
+ }
3845
+ /**
3846
+ *
3847
+ * @summary Returns the contents of the specified file
3848
+ * @param {string} fileId The ID of the file to use for this request
3849
+ * @param {*} [options] Override http request option.
3850
+ * @throws {RequiredError}
3851
+ * @memberof PocketScoutApi
3852
+ */
3853
+ fileDownload(fileId, options) {
3854
+ return (0, exports.PocketScoutApiFp)(this.configuration).fileDownload(fileId, options).then((request) => request(this.axios, this.basePath));
3855
+ }
3856
+ /**
3857
+ *
3858
+ * @summary Returns a list of files that belong to the user\'s organization.
3859
+ * @param {*} [options] Override http request option.
3860
+ * @throws {RequiredError}
3861
+ * @memberof PocketScoutApi
3862
+ */
3863
+ files(options) {
3864
+ return (0, exports.PocketScoutApiFp)(this.configuration).files(options).then((request) => request(this.axios, this.basePath));
3489
3865
  }
3490
3866
  /**
3491
3867
  * 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.
@@ -3493,10 +3869,10 @@ class Scout9Api extends base_1.BaseAPI {
3493
3869
  * @param {GenerateRequest} generateRequest
3494
3870
  * @param {*} [options] Override http request option.
3495
3871
  * @throws {RequiredError}
3496
- * @memberof Scout9Api
3872
+ * @memberof PocketScoutApi
3497
3873
  */
3498
3874
  generate(generateRequest, options) {
3499
- return (0, exports.Scout9ApiFp)(this.configuration).generate(generateRequest, options).then((request) => request(this.axios, this.basePath));
3875
+ return (0, exports.PocketScoutApiFp)(this.configuration).generate(generateRequest, options).then((request) => request(this.axios, this.basePath));
3500
3876
  }
3501
3877
  /**
3502
3878
  * Creates a new message and sends it to the conversation. If the conversation is scheduled, the message will be scheduled as well. @TODO does not support the ability to mute or delay send
@@ -3504,45 +3880,45 @@ class Scout9Api extends base_1.BaseAPI {
3504
3880
  * @param {MessageCreateRequest} messageCreateRequest
3505
3881
  * @param {*} [options] Override http request option.
3506
3882
  * @throws {RequiredError}
3507
- * @memberof Scout9Api
3883
+ * @memberof PocketScoutApi
3508
3884
  */
3509
3885
  message(messageCreateRequest, options) {
3510
- return (0, exports.Scout9ApiFp)(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
3886
+ return (0, exports.PocketScoutApiFp)(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
3511
3887
  }
3512
3888
  /**
3513
3889
  *
3514
3890
  * @summary Get all messages from a conversation
3891
+ * @param {string} id id of entity to query
3515
3892
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3516
- * @param {Array<string>} [id]
3517
3893
  * @param {*} [options] Override http request option.
3518
3894
  * @throws {RequiredError}
3519
- * @memberof Scout9Api
3895
+ * @memberof PocketScoutApi
3520
3896
  */
3521
- messages(q, id, options) {
3522
- return (0, exports.Scout9ApiFp)(this.configuration).messages(q, id, options).then((request) => request(this.axios, this.basePath));
3897
+ messages(id, q, options) {
3898
+ return (0, exports.PocketScoutApiFp)(this.configuration).messages(id, q, options).then((request) => request(this.axios, this.basePath));
3523
3899
  }
3524
3900
  /**
3525
3901
  *
3526
3902
  * @summary Get the results of a bulk API operation
3527
- * @param {string} id
3903
+ * @param {string} id id of entity to query
3528
3904
  * @param {*} [options] Override http request option.
3529
3905
  * @throws {RequiredError}
3530
- * @memberof Scout9Api
3906
+ * @memberof PocketScoutApi
3531
3907
  */
3532
3908
  operation(id, options) {
3533
- return (0, exports.Scout9ApiFp)(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
3909
+ return (0, exports.PocketScoutApiFp)(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
3534
3910
  }
3535
3911
  /**
3536
3912
  *
3537
3913
  * @summary Gets all or specific set of bulk API operations
3538
3914
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3539
- * @param {Array<string>} [id]
3915
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3540
3916
  * @param {*} [options] Override http request option.
3541
3917
  * @throws {RequiredError}
3542
- * @memberof Scout9Api
3918
+ * @memberof PocketScoutApi
3543
3919
  */
3544
3920
  operations(q, id, options) {
3545
- return (0, exports.Scout9ApiFp)(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
3921
+ return (0, exports.PocketScoutApiFp)(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
3546
3922
  }
3547
3923
  /**
3548
3924
  *
@@ -3550,21 +3926,21 @@ class Scout9Api extends base_1.BaseAPI {
3550
3926
  * @param {ScheduleCreateRequest} scheduleCreateRequest
3551
3927
  * @param {*} [options] Override http request option.
3552
3928
  * @throws {RequiredError}
3553
- * @memberof Scout9Api
3929
+ * @memberof PocketScoutApi
3554
3930
  */
3555
- scheduleCreate(scheduleCreateRequest, options) {
3556
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleCreate(scheduleCreateRequest, options).then((request) => request(this.axios, this.basePath));
3931
+ scheduleConversation(scheduleCreateRequest, options) {
3932
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleConversation(scheduleCreateRequest, options).then((request) => request(this.axios, this.basePath));
3557
3933
  }
3558
3934
  /**
3559
3935
  *
3560
3936
  * @summary Deletes a schedule
3561
- * @param {string} id
3937
+ * @param {string} id id of entity to query
3562
3938
  * @param {*} [options] Override http request option.
3563
3939
  * @throws {RequiredError}
3564
- * @memberof Scout9Api
3940
+ * @memberof PocketScoutApi
3565
3941
  */
3566
3942
  scheduleDelete(id, options) {
3567
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleDelete(id, options).then((request) => request(this.axios, this.basePath));
3943
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleDelete(id, options).then((request) => request(this.axios, this.basePath));
3568
3944
  }
3569
3945
  /**
3570
3946
  *
@@ -3572,32 +3948,32 @@ class Scout9Api extends base_1.BaseAPI {
3572
3948
  * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
3573
3949
  * @param {*} [options] Override http request option.
3574
3950
  * @throws {RequiredError}
3575
- * @memberof Scout9Api
3951
+ * @memberof PocketScoutApi
3576
3952
  */
3577
3953
  scheduleGroupCreate(scheduleGroupCreateRequest, options) {
3578
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(this.axios, this.basePath));
3954
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(this.axios, this.basePath));
3579
3955
  }
3580
3956
  /**
3581
3957
  *
3582
3958
  * @summary Deletes and cancels a schedule group
3583
- * @param {string} id
3959
+ * @param {string} id id of entity to query
3584
3960
  * @param {*} [options] Override http request option.
3585
3961
  * @throws {RequiredError}
3586
- * @memberof Scout9Api
3962
+ * @memberof PocketScoutApi
3587
3963
  */
3588
3964
  scheduleGroupDelete(id, options) {
3589
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
3965
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
3590
3966
  }
3591
3967
  /**
3592
3968
  *
3593
3969
  * @summary Gets a schedule group
3594
- * @param {string} id
3970
+ * @param {string} id id of entity to query
3595
3971
  * @param {*} [options] Override http request option.
3596
3972
  * @throws {RequiredError}
3597
- * @memberof Scout9Api
3973
+ * @memberof PocketScoutApi
3598
3974
  */
3599
3975
  scheduleGroupRetrieve(id, options) {
3600
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupRetrieve(id, options).then((request) => request(this.axios, this.basePath));
3976
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleGroupRetrieve(id, options).then((request) => request(this.axios, this.basePath));
3601
3977
  }
3602
3978
  /**
3603
3979
  *
@@ -3605,21 +3981,21 @@ class Scout9Api extends base_1.BaseAPI {
3605
3981
  * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
3606
3982
  * @param {*} [options] Override http request option.
3607
3983
  * @throws {RequiredError}
3608
- * @memberof Scout9Api
3984
+ * @memberof PocketScoutApi
3609
3985
  */
3610
3986
  scheduleGroupUpdate(scheduleGroupUpdateRequest, options) {
3611
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3987
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3612
3988
  }
3613
3989
  /**
3614
3990
  *
3615
3991
  * @summary Gets a schedule
3616
- * @param {string} id
3992
+ * @param {string} id id of entity to query
3617
3993
  * @param {*} [options] Override http request option.
3618
3994
  * @throws {RequiredError}
3619
- * @memberof Scout9Api
3995
+ * @memberof PocketScoutApi
3620
3996
  */
3621
3997
  scheduleRetrieve(id, options) {
3622
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleRetrieve(id, options).then((request) => request(this.axios, this.basePath));
3998
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleRetrieve(id, options).then((request) => request(this.axios, this.basePath));
3623
3999
  }
3624
4000
  /**
3625
4001
  *
@@ -3627,21 +4003,21 @@ class Scout9Api extends base_1.BaseAPI {
3627
4003
  * @param {ScheduleUpdateRequest} scheduleUpdateRequest
3628
4004
  * @param {*} [options] Override http request option.
3629
4005
  * @throws {RequiredError}
3630
- * @memberof Scout9Api
4006
+ * @memberof PocketScoutApi
3631
4007
  */
3632
4008
  scheduleUpdate(scheduleUpdateRequest, options) {
3633
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(this.axios, this.basePath));
4009
+ return (0, exports.PocketScoutApiFp)(this.configuration).scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(this.axios, this.basePath));
3634
4010
  }
3635
4011
  /**
3636
4012
  *
3637
4013
  * @summary Gets a workflow
3638
- * @param {string} id
4014
+ * @param {string} id id of entity to query
3639
4015
  * @param {*} [options] Override http request option.
3640
4016
  * @throws {RequiredError}
3641
- * @memberof Scout9Api
4017
+ * @memberof PocketScoutApi
3642
4018
  */
3643
4019
  workflow(id, options) {
3644
- return (0, exports.Scout9ApiFp)(this.configuration).workflow(id, options).then((request) => request(this.axios, this.basePath));
4020
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflow(id, options).then((request) => request(this.axios, this.basePath));
3645
4021
  }
3646
4022
  /**
3647
4023
  *
@@ -3649,21 +4025,21 @@ class Scout9Api extends base_1.BaseAPI {
3649
4025
  * @param {CreateWorkflowRequest} createWorkflowRequest
3650
4026
  * @param {*} [options] Override http request option.
3651
4027
  * @throws {RequiredError}
3652
- * @memberof Scout9Api
4028
+ * @memberof PocketScoutApi
3653
4029
  */
3654
4030
  workflowCreate(createWorkflowRequest, options) {
3655
- return (0, exports.Scout9ApiFp)(this.configuration).workflowCreate(createWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4031
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowCreate(createWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
3656
4032
  }
3657
4033
  /**
3658
4034
  *
3659
4035
  * @summary Deletes a workflow
3660
- * @param {string} id
4036
+ * @param {string} id id of entity to query
3661
4037
  * @param {*} [options] Override http request option.
3662
4038
  * @throws {RequiredError}
3663
- * @memberof Scout9Api
4039
+ * @memberof PocketScoutApi
3664
4040
  */
3665
4041
  workflowDelete(id, options) {
3666
- return (0, exports.Scout9ApiFp)(this.configuration).workflowDelete(id, options).then((request) => request(this.axios, this.basePath));
4042
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowDelete(id, options).then((request) => request(this.axios, this.basePath));
3667
4043
  }
3668
4044
  /**
3669
4045
  *
@@ -3671,22 +4047,22 @@ class Scout9Api extends base_1.BaseAPI {
3671
4047
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
3672
4048
  * @param {*} [options] Override http request option.
3673
4049
  * @throws {RequiredError}
3674
- * @memberof Scout9Api
4050
+ * @memberof PocketScoutApi
3675
4051
  */
3676
4052
  workflowUpdate(updateWorkflowRequest, options) {
3677
- return (0, exports.Scout9ApiFp)(this.configuration).workflowUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4053
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
3678
4054
  }
3679
4055
  /**
3680
4056
  *
3681
4057
  * @summary Gets all or specific set of workflows
3682
4058
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3683
- * @param {Array<string>} [id]
4059
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3684
4060
  * @param {*} [options] Override http request option.
3685
4061
  * @throws {RequiredError}
3686
- * @memberof Scout9Api
4062
+ * @memberof PocketScoutApi
3687
4063
  */
3688
4064
  workflows(q, id, options) {
3689
- return (0, exports.Scout9ApiFp)(this.configuration).workflows(q, id, options).then((request) => request(this.axios, this.basePath));
4065
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflows(q, id, options).then((request) => request(this.axios, this.basePath));
3690
4066
  }
3691
4067
  /**
3692
4068
  *
@@ -3694,21 +4070,21 @@ class Scout9Api extends base_1.BaseAPI {
3694
4070
  * @param {CreateWorkflowsRequest} createWorkflowsRequest
3695
4071
  * @param {*} [options] Override http request option.
3696
4072
  * @throws {RequiredError}
3697
- * @memberof Scout9Api
4073
+ * @memberof PocketScoutApi
3698
4074
  */
3699
4075
  workflowsCreate(createWorkflowsRequest, options) {
3700
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsCreate(createWorkflowsRequest, options).then((request) => request(this.axios, this.basePath));
4076
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowsCreate(createWorkflowsRequest, options).then((request) => request(this.axios, this.basePath));
3701
4077
  }
3702
4078
  /**
3703
4079
  *
3704
4080
  * @summary Deletes multiple workflows
3705
- * @param {Array<string>} [id]
4081
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3706
4082
  * @param {*} [options] Override http request option.
3707
4083
  * @throws {RequiredError}
3708
- * @memberof Scout9Api
4084
+ * @memberof PocketScoutApi
3709
4085
  */
3710
4086
  workflowsDelete(id, options) {
3711
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsDelete(id, options).then((request) => request(this.axios, this.basePath));
4087
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowsDelete(id, options).then((request) => request(this.axios, this.basePath));
3712
4088
  }
3713
4089
  /**
3714
4090
  *
@@ -3716,10 +4092,10 @@ class Scout9Api extends base_1.BaseAPI {
3716
4092
  * @param {UpdateWorkflowRequest} updateWorkflowRequest
3717
4093
  * @param {*} [options] Override http request option.
3718
4094
  * @throws {RequiredError}
3719
- * @memberof Scout9Api
4095
+ * @memberof PocketScoutApi
3720
4096
  */
3721
4097
  workflowsUpdate(updateWorkflowRequest, options) {
3722
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4098
+ return (0, exports.PocketScoutApiFp)(this.configuration).workflowsUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
3723
4099
  }
3724
4100
  }
3725
- exports.Scout9Api = Scout9Api;
4101
+ exports.PocketScoutApi = PocketScoutApi;