@scout9/admin 1.0.0-alpha.0.0.7 → 1.0.0-alpha.0.0.70

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
@@ -5,7 +5,7 @@
5
5
  * Scout9 API
6
6
  * Scout9 APIs for managing Scout9 users and conversations with your Scout9 agents
7
7
  *
8
- * The version of the OpenAPI document: 1.0.0
8
+ * The version of the OpenAPI document: 1.0.0-alpha.0.0.9
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,18 +16,14 @@ 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.CustomContextApi = exports.CustomContextApiFactory = exports.CustomContextApiFp = exports.CustomContextApiAxiosParamCreator = 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;
19
+ exports.LlmConfigOneOf6AllOfEngineEnum = exports.LlmConfigOneOf6ModelEnum = exports.LlmConfigOneOf6EngineEnum = exports.LlmConfigOneOf5AllOfModelEnum = exports.LlmConfigOneOf5AllOfEngineEnum = exports.LlmConfigOneOf5ModelEnum = exports.LlmConfigOneOf5EngineEnum = exports.LlmConfigOneOf4AllOfModelEnum = exports.LlmConfigOneOf4AllOfEngineEnum = exports.LlmConfigOneOf4ModelEnum = exports.LlmConfigOneOf4EngineEnum = exports.LlmConfigOneOf3AllOfModelEnum = exports.LlmConfigOneOf3AllOfEngineEnum = exports.LlmConfigOneOf3ModelEnum = exports.LlmConfigOneOf3EngineEnum = exports.LlmConfigOneOf2AllOfModelEnum = exports.LlmConfigOneOf2AllOfEngineEnum = exports.LlmConfigOneOf2ModelEnum = exports.LlmConfigOneOf2EngineEnum = exports.LlmConfigOneOf1AllOfModelEnum = exports.LlmConfigOneOf1AllOfEngineEnum = exports.LlmConfigOneOf1ModelEnum = exports.LlmConfigOneOf1EngineEnum = exports.LlmConfigOneOfModelEnum = exports.LlmConfigOneOfEngineEnum = exports.ListConversationsResponseInnerIngressEnum = exports.ListConversationsResponseInnerLockCodeEnum = exports.ListApiOperationsResponseInnerMethodEnum = exports.GetApiOperationResponseMethodEnum = exports.ForwardRequestLatestMessageRoleEnum = exports.ForwardRequestForwardOneOfModeEnum = exports.ExistenceOperator = exports.EqualityOperator = exports.ConversationWithIdIngressEnum = exports.ConversationWithIdLockCodeEnum = exports.ConversationUpdateRequestIngressEnum = exports.ConversationUpdateRequestLockCodeEnum = exports.ConversationGetResponseIngressEnum = exports.ConversationGetResponseLockCodeEnum = exports.ConversationCreateRequestIngressEnum = exports.ConversationCreateRequestLockCodeEnum = exports.ConversationContextFieldConditionOperatorEnum = exports.ConversationChannelPropsChannelResolutionPathEnum = exports.ConversationChannel = exports.ConversationBaseIngressEnum = exports.ConversationBaseLockCodeEnum = exports.ConversationAnticipateTypeEnum = exports.ConversationIngressEnum = exports.ConversationLockCodeEnum = exports.ApiOperationMethodEnum = void 0;
20
+ exports.Scout9Api = exports.Scout9ApiGenerated = exports.Scout9ApiFactory = exports.Scout9ApiFp = exports.Scout9ApiAxiosParamCreator = exports.NoopApi = exports.NoopApiFactory = exports.NoopApiFp = exports.NoopApiAxiosParamCreator = exports.WorkflowResponseSlotForwardOneOfModeEnum = exports.ScheduledConversationGroupIngressEnum = exports.ScheduledConversationGroupLockCodeEnum = exports.ScheduledConversationIngressEnum = exports.ScheduledConversationLockCodeEnum = exports.ScheduleUpdateRequestIngressEnum = exports.ScheduleUpdateRequestLockCodeEnum = exports.ScheduleGroupUpdateRequestIngressEnum = exports.ScheduleGroupUpdateRequestLockCodeEnum = exports.ScheduleGroupGetResponseIngressEnum = exports.ScheduleGroupGetResponseLockCodeEnum = exports.ScheduleGroupCreateRequestIngressEnum = exports.ScheduleGroupCreateRequestLockCodeEnum = exports.ScheduleGetResponseIngressEnum = exports.ScheduleGetResponseLockCodeEnum = exports.ScheduleCreateRequestIngressEnum = exports.ScheduleCreateRequestLockCodeEnum = exports.PurposeEnum = exports.PmtTransformResponseTypeEnum = exports.PmtConfigModelEnum = exports.PmtConfigEngineEnum = exports.MessageGetResponseInnerRoleEnum = exports.MessageCreateRequestRoleEnum = exports.MessageBaseRoleEnum = exports.MessageRoleEnum = exports.MacroResultTypeEnum = exports.MacroDoesResultTypeEnum = exports.MacroDoesInputRoleEnum = exports.MacroDidResultTypeEnum = exports.MacroContextResultTypeEnum = exports.LlmConfigOneOfAllOfModelEnum = exports.LlmConfigOneOfAllOfEngineEnum = exports.LlmConfigOneOf7AllOfEngineEnum = exports.LlmConfigOneOf7EngineEnum = exports.LlmConfigOneOf6AllOfModelEnum = void 0;
20
21
  const axios_1 = __importDefault(require("axios"));
21
22
  // Some imports not used depending on template conditions
22
23
  // @ts-ignore
23
24
  const common_1 = require("./common");
24
25
  // @ts-ignore
25
26
  const base_1 = require("./base");
26
- exports.AgentModelEnum = {
27
- Scout9: 'Scout9',
28
- Bard: 'bard',
29
- Null: 'null'
30
- };
31
27
  exports.ApiOperationMethodEnum = {
32
28
  Get: 'get',
33
29
  Post: 'post',
@@ -35,6 +31,59 @@ exports.ApiOperationMethodEnum = {
35
31
  Delete: 'delete',
36
32
  Patch: 'patch'
37
33
  };
34
+ exports.ConversationLockCodeEnum = {
35
+ WorkflowStagnation: 'workflow_stagnation',
36
+ MaxLockAttempts: 'max_lock_attempts',
37
+ RuntimeError: 'runtime_error',
38
+ ManualMode: 'manual_mode',
39
+ PolicyBlock: 'policy_block'
40
+ };
41
+ exports.ConversationIngressEnum = {
42
+ Auto: 'auto',
43
+ Manual: 'manual',
44
+ App: 'app',
45
+ Webhook: 'webhook'
46
+ };
47
+ exports.ConversationAnticipateTypeEnum = {
48
+ Did: 'did',
49
+ Literal: 'literal',
50
+ Context: 'context'
51
+ };
52
+ exports.ConversationBaseLockCodeEnum = {
53
+ WorkflowStagnation: 'workflow_stagnation',
54
+ MaxLockAttempts: 'max_lock_attempts',
55
+ RuntimeError: 'runtime_error',
56
+ ManualMode: 'manual_mode',
57
+ PolicyBlock: 'policy_block'
58
+ };
59
+ exports.ConversationBaseIngressEnum = {
60
+ Auto: 'auto',
61
+ Manual: 'manual',
62
+ App: 'app',
63
+ Webhook: 'webhook'
64
+ };
65
+ /**
66
+ * Canonical channel that initiated and should continue the customer conversation.
67
+ * @export
68
+ * @enum {string}
69
+ */
70
+ exports.ConversationChannel = {
71
+ Web: 'web',
72
+ DemoPhoneTest: 'demo_phone_test',
73
+ SmsPhone: 'sms_phone',
74
+ Outlook: 'outlook',
75
+ Gmail: 'gmail',
76
+ Iphone: 'iphone',
77
+ Android: 'android',
78
+ Teams: 'teams',
79
+ Discord: 'discord',
80
+ Whatsapp: 'whatsapp'
81
+ };
82
+ exports.ConversationChannelPropsChannelResolutionPathEnum = {
83
+ Production: 'twilio_production',
84
+ LegacyPmt: 'twilio_legacy_pmt',
85
+ FreeBridge: 'twilio_free_bridge'
86
+ };
38
87
  exports.ConversationContextFieldConditionOperatorEnum = {
39
88
  Eq: 'eq',
40
89
  Equal: 'equal',
@@ -59,35 +108,97 @@ exports.ConversationContextFieldConditionOperatorEnum = {
59
108
  StartsWith: 'startsWith',
60
109
  EndsWith: 'endsWith'
61
110
  };
111
+ exports.ConversationCreateRequestLockCodeEnum = {
112
+ WorkflowStagnation: 'workflow_stagnation',
113
+ MaxLockAttempts: 'max_lock_attempts',
114
+ RuntimeError: 'runtime_error',
115
+ ManualMode: 'manual_mode',
116
+ PolicyBlock: 'policy_block'
117
+ };
118
+ exports.ConversationCreateRequestIngressEnum = {
119
+ Auto: 'auto',
120
+ Manual: 'manual',
121
+ App: 'app',
122
+ Webhook: 'webhook'
123
+ };
124
+ exports.ConversationGetResponseLockCodeEnum = {
125
+ WorkflowStagnation: 'workflow_stagnation',
126
+ MaxLockAttempts: 'max_lock_attempts',
127
+ RuntimeError: 'runtime_error',
128
+ ManualMode: 'manual_mode',
129
+ PolicyBlock: 'policy_block'
130
+ };
131
+ exports.ConversationGetResponseIngressEnum = {
132
+ Auto: 'auto',
133
+ Manual: 'manual',
134
+ App: 'app',
135
+ Webhook: 'webhook'
136
+ };
137
+ exports.ConversationUpdateRequestLockCodeEnum = {
138
+ WorkflowStagnation: 'workflow_stagnation',
139
+ MaxLockAttempts: 'max_lock_attempts',
140
+ RuntimeError: 'runtime_error',
141
+ ManualMode: 'manual_mode',
142
+ PolicyBlock: 'policy_block'
143
+ };
144
+ exports.ConversationUpdateRequestIngressEnum = {
145
+ Auto: 'auto',
146
+ Manual: 'manual',
147
+ App: 'app',
148
+ Webhook: 'webhook'
149
+ };
150
+ exports.ConversationWithIdLockCodeEnum = {
151
+ WorkflowStagnation: 'workflow_stagnation',
152
+ MaxLockAttempts: 'max_lock_attempts',
153
+ RuntimeError: 'runtime_error',
154
+ ManualMode: 'manual_mode',
155
+ PolicyBlock: 'policy_block'
156
+ };
157
+ exports.ConversationWithIdIngressEnum = {
158
+ Auto: 'auto',
159
+ Manual: 'manual',
160
+ App: 'app',
161
+ Webhook: 'webhook'
162
+ };
62
163
  /**
63
- * Environment this conversation is in (phone, web, or email) - this determines which device to send messages to
164
+ *
64
165
  * @export
65
166
  * @enum {string}
66
167
  */
67
- exports.ConversationEnvironment = {
68
- Phone: 'phone',
69
- Web: 'web',
70
- Email: 'email'
168
+ exports.EqualityOperator = {
169
+ Eq: 'eq',
170
+ Neq: 'neq',
171
+ Gt: 'gt',
172
+ Gte: 'gte',
173
+ Lt: 'lt',
174
+ Lte: 'lte',
175
+ In: 'in',
176
+ Nin: 'nin',
177
+ Contains: 'contains',
178
+ NotContains: 'notContains',
179
+ StartsWith: 'startsWith',
180
+ EndsWith: 'endsWith',
181
+ ArrayContainsAny: 'arrayContainsAny',
182
+ ArrayContains: 'arrayContains'
71
183
  };
72
- exports.CreateAgentRequestModelEnum = {
73
- Scout9: 'Scout9',
74
- Bard: 'bard',
75
- Null: 'null'
184
+ /**
185
+ *
186
+ * @export
187
+ * @enum {string}
188
+ */
189
+ exports.ExistenceOperator = {
190
+ Exists: 'exists',
191
+ NotExists: 'notExists'
76
192
  };
77
- exports.CreateAgentsRequestAgentsInnerModelEnum = {
78
- Scout9: 'Scout9',
79
- Bard: 'bard',
80
- Null: 'null'
193
+ exports.ForwardRequestForwardOneOfModeEnum = {
194
+ AfterReply: 'after-reply',
195
+ Immediately: 'immediately'
81
196
  };
82
- exports.GenerateResponseRoleEnum = {
197
+ exports.ForwardRequestLatestMessageRoleEnum = {
83
198
  Customer: 'customer',
84
199
  Agent: 'agent',
85
- Context: 'context'
86
- };
87
- exports.GetAgentResponseModelEnum = {
88
- Scout9: 'Scout9',
89
- Bard: 'bard',
90
- Null: 'null'
200
+ System: 'system',
201
+ Tool: 'tool'
91
202
  };
92
203
  exports.GetApiOperationResponseMethodEnum = {
93
204
  Get: 'get',
@@ -96,11 +207,6 @@ exports.GetApiOperationResponseMethodEnum = {
96
207
  Delete: 'delete',
97
208
  Patch: 'patch'
98
209
  };
99
- exports.ListAgentsResponseInnerModelEnum = {
100
- Scout9: 'Scout9',
101
- Bard: 'bard',
102
- Null: 'null'
103
- };
104
210
  exports.ListApiOperationsResponseInnerMethodEnum = {
105
211
  Get: 'get',
106
212
  Post: 'post',
@@ -108,15 +214,159 @@ exports.ListApiOperationsResponseInnerMethodEnum = {
108
214
  Delete: 'delete',
109
215
  Patch: 'patch'
110
216
  };
217
+ exports.ListConversationsResponseInnerLockCodeEnum = {
218
+ WorkflowStagnation: 'workflow_stagnation',
219
+ MaxLockAttempts: 'max_lock_attempts',
220
+ RuntimeError: 'runtime_error',
221
+ ManualMode: 'manual_mode',
222
+ PolicyBlock: 'policy_block'
223
+ };
224
+ exports.ListConversationsResponseInnerIngressEnum = {
225
+ Auto: 'auto',
226
+ Manual: 'manual',
227
+ App: 'app',
228
+ Webhook: 'webhook'
229
+ };
230
+ exports.LlmConfigOneOfEngineEnum = {
231
+ Openai: 'openai'
232
+ };
233
+ exports.LlmConfigOneOfModelEnum = {
234
+ _41106Preview: 'gpt-4-1106-preview',
235
+ _4VisionPreview: 'gpt-4-vision-preview',
236
+ _4: 'gpt-4',
237
+ _35Turbo: 'gpt-3.5-turbo',
238
+ _35Turbo16k: 'gpt-3.5-turbo-16k'
239
+ };
240
+ exports.LlmConfigOneOf1EngineEnum = {
241
+ Anthropic: 'anthropic'
242
+ };
243
+ exports.LlmConfigOneOf1ModelEnum = {
244
+ _3Opus20240229: 'claude-3-opus-20240229',
245
+ _3Sonnet20240229: 'claude-3-sonnet-20240229',
246
+ _21: 'claude-2.1',
247
+ Instant12: 'claude-instant-1.2'
248
+ };
249
+ exports.LlmConfigOneOf1AllOfEngineEnum = {
250
+ Anthropic: 'anthropic'
251
+ };
252
+ exports.LlmConfigOneOf1AllOfModelEnum = {
253
+ _3Opus20240229: 'claude-3-opus-20240229',
254
+ _3Sonnet20240229: 'claude-3-sonnet-20240229',
255
+ _21: 'claude-2.1',
256
+ Instant12: 'claude-instant-1.2'
257
+ };
258
+ exports.LlmConfigOneOf2EngineEnum = {
259
+ Meta: 'meta'
260
+ };
261
+ exports.LlmConfigOneOf2ModelEnum = {
262
+ _270bChat: 'llama-2-70b-chat',
263
+ _370bInstruct: 'llama-3-70b-instruct',
264
+ _38bInstruct: 'llama-3-8b-instruct'
265
+ };
266
+ exports.LlmConfigOneOf2AllOfEngineEnum = {
267
+ Meta: 'meta'
268
+ };
269
+ exports.LlmConfigOneOf2AllOfModelEnum = {
270
+ _270bChat: 'llama-2-70b-chat',
271
+ _370bInstruct: 'llama-3-70b-instruct',
272
+ _38bInstruct: 'llama-3-8b-instruct'
273
+ };
274
+ exports.LlmConfigOneOf3EngineEnum = {
275
+ Deepseek: 'deepseek'
276
+ };
277
+ exports.LlmConfigOneOf3ModelEnum = {
278
+ Chat: 'deepseek-chat',
279
+ Coder: 'deepseek-coder'
280
+ };
281
+ exports.LlmConfigOneOf3AllOfEngineEnum = {
282
+ Deepseek: 'deepseek'
283
+ };
284
+ exports.LlmConfigOneOf3AllOfModelEnum = {
285
+ Chat: 'deepseek-chat',
286
+ Coder: 'deepseek-coder'
287
+ };
288
+ exports.LlmConfigOneOf4EngineEnum = {
289
+ Grok: 'grok'
290
+ };
291
+ exports.LlmConfigOneOf4ModelEnum = {
292
+ Grok1: 'grok-1'
293
+ };
294
+ exports.LlmConfigOneOf4AllOfEngineEnum = {
295
+ Grok: 'grok'
296
+ };
297
+ exports.LlmConfigOneOf4AllOfModelEnum = {
298
+ Grok1: 'grok-1'
299
+ };
300
+ exports.LlmConfigOneOf5EngineEnum = {
301
+ Mistral: 'mistral'
302
+ };
303
+ exports.LlmConfigOneOf5ModelEnum = {
304
+ Mistral7bInstruct: 'mistral-7b-instruct',
305
+ Mixtral8x7bInstruct: 'mixtral-8x7b-instruct'
306
+ };
307
+ exports.LlmConfigOneOf5AllOfEngineEnum = {
308
+ Mistral: 'mistral'
309
+ };
310
+ exports.LlmConfigOneOf5AllOfModelEnum = {
311
+ Mistral7bInstruct: 'mistral-7b-instruct',
312
+ Mixtral8x7bInstruct: 'mixtral-8x7b-instruct'
313
+ };
314
+ exports.LlmConfigOneOf6EngineEnum = {
315
+ Cohere: 'cohere'
316
+ };
317
+ exports.LlmConfigOneOf6ModelEnum = {
318
+ CommandRPlus: 'command-r-plus'
319
+ };
320
+ exports.LlmConfigOneOf6AllOfEngineEnum = {
321
+ Cohere: 'cohere'
322
+ };
323
+ exports.LlmConfigOneOf6AllOfModelEnum = {
324
+ CommandRPlus: 'command-r-plus'
325
+ };
326
+ exports.LlmConfigOneOf7EngineEnum = {
327
+ Bard: 'bard'
328
+ };
329
+ exports.LlmConfigOneOf7AllOfEngineEnum = {
330
+ Bard: 'bard'
331
+ };
332
+ exports.LlmConfigOneOfAllOfEngineEnum = {
333
+ Openai: 'openai'
334
+ };
335
+ exports.LlmConfigOneOfAllOfModelEnum = {
336
+ _41106Preview: 'gpt-4-1106-preview',
337
+ _4VisionPreview: 'gpt-4-vision-preview',
338
+ _4: 'gpt-4',
339
+ _35Turbo: 'gpt-3.5-turbo',
340
+ _35Turbo16k: 'gpt-3.5-turbo-16k'
341
+ };
342
+ exports.MacroContextResultTypeEnum = {
343
+ Context: 'context'
344
+ };
345
+ exports.MacroDidResultTypeEnum = {
346
+ Did: 'did'
347
+ };
348
+ exports.MacroDoesInputRoleEnum = {
349
+ Customer: 'customer',
350
+ Agent: 'agent'
351
+ };
352
+ exports.MacroDoesResultTypeEnum = {
353
+ Does: 'does'
354
+ };
355
+ exports.MacroResultTypeEnum = {
356
+ Did: 'did',
357
+ Context: 'context'
358
+ };
111
359
  exports.MessageRoleEnum = {
112
360
  Customer: 'customer',
113
361
  Agent: 'agent',
114
- Context: 'context'
362
+ System: 'system',
363
+ Tool: 'tool'
115
364
  };
116
365
  exports.MessageBaseRoleEnum = {
117
366
  Customer: 'customer',
118
367
  Agent: 'agent',
119
- Context: 'context'
368
+ System: 'system',
369
+ Tool: 'tool'
120
370
  };
121
371
  exports.MessageCreateRequestRoleEnum = {
122
372
  Agent: 'agent',
@@ -126,58 +376,160 @@ exports.MessageCreateRequestRoleEnum = {
126
376
  exports.MessageGetResponseInnerRoleEnum = {
127
377
  Customer: 'customer',
128
378
  Agent: 'agent',
129
- Context: 'context'
379
+ System: 'system',
380
+ Tool: 'tool'
381
+ };
382
+ exports.PmtConfigEngineEnum = {
383
+ Scout9: 'scout9',
384
+ Opp: 'opp'
385
+ };
386
+ exports.PmtConfigModelEnum = {
387
+ _10Alpha: 'orin-1.0-alpha',
388
+ _11Alpha: 'orin-1.1-alpha',
389
+ Latest: 'orin-latest',
390
+ _20Preview: 'orin-2.0-preview'
391
+ };
392
+ exports.PmtTransformResponseTypeEnum = {
393
+ Question: 'question',
394
+ Statement: 'statement',
395
+ Exclamation: 'exclamation',
396
+ Other: 'other'
130
397
  };
131
398
  /**
132
- * The operator of the condition or query
399
+ *
133
400
  * @export
134
401
  * @enum {string}
135
402
  */
136
- exports.Operator = {
137
- Eq: 'eq',
138
- Equal: 'equal',
139
- Ne: 'ne',
140
- NotEquals: 'not-equals',
141
- Gt: 'gt',
142
- GreaterThan: 'greater-than',
143
- Gte: 'gte',
144
- GreaterThanEquals: 'greater-than-equals',
145
- Lt: 'lt',
146
- LessThan: 'less-than',
147
- Lte: 'lte',
148
- LessThanEquals: 'less-than-equals',
149
- ArrayContains: 'array-contains',
150
- In: 'in',
151
- ArrayContainsAny: 'array-contains-any',
152
- NotIn: 'not-in'
403
+ exports.PurposeEnum = {
404
+ Context: 'context',
405
+ AgentAudio: 'agent-audio',
406
+ AgentTranscript: 'agent-transcript'
407
+ };
408
+ exports.ScheduleCreateRequestLockCodeEnum = {
409
+ WorkflowStagnation: 'workflow_stagnation',
410
+ MaxLockAttempts: 'max_lock_attempts',
411
+ RuntimeError: 'runtime_error',
412
+ ManualMode: 'manual_mode',
413
+ PolicyBlock: 'policy_block'
414
+ };
415
+ exports.ScheduleCreateRequestIngressEnum = {
416
+ Auto: 'auto',
417
+ Manual: 'manual',
418
+ App: 'app',
419
+ Webhook: 'webhook'
420
+ };
421
+ exports.ScheduleGetResponseLockCodeEnum = {
422
+ WorkflowStagnation: 'workflow_stagnation',
423
+ MaxLockAttempts: 'max_lock_attempts',
424
+ RuntimeError: 'runtime_error',
425
+ ManualMode: 'manual_mode',
426
+ PolicyBlock: 'policy_block'
427
+ };
428
+ exports.ScheduleGetResponseIngressEnum = {
429
+ Auto: 'auto',
430
+ Manual: 'manual',
431
+ App: 'app',
432
+ Webhook: 'webhook'
433
+ };
434
+ exports.ScheduleGroupCreateRequestLockCodeEnum = {
435
+ WorkflowStagnation: 'workflow_stagnation',
436
+ MaxLockAttempts: 'max_lock_attempts',
437
+ RuntimeError: 'runtime_error',
438
+ ManualMode: 'manual_mode',
439
+ PolicyBlock: 'policy_block'
440
+ };
441
+ exports.ScheduleGroupCreateRequestIngressEnum = {
442
+ Auto: 'auto',
443
+ Manual: 'manual',
444
+ App: 'app',
445
+ Webhook: 'webhook'
446
+ };
447
+ exports.ScheduleGroupGetResponseLockCodeEnum = {
448
+ WorkflowStagnation: 'workflow_stagnation',
449
+ MaxLockAttempts: 'max_lock_attempts',
450
+ RuntimeError: 'runtime_error',
451
+ ManualMode: 'manual_mode',
452
+ PolicyBlock: 'policy_block'
453
+ };
454
+ exports.ScheduleGroupGetResponseIngressEnum = {
455
+ Auto: 'auto',
456
+ Manual: 'manual',
457
+ App: 'app',
458
+ Webhook: 'webhook'
153
459
  };
154
- exports.UpdateAgentRequestModelEnum = {
155
- Scout9: 'Scout9',
156
- Bard: 'bard',
157
- Null: 'null'
460
+ exports.ScheduleGroupUpdateRequestLockCodeEnum = {
461
+ WorkflowStagnation: 'workflow_stagnation',
462
+ MaxLockAttempts: 'max_lock_attempts',
463
+ RuntimeError: 'runtime_error',
464
+ ManualMode: 'manual_mode',
465
+ PolicyBlock: 'policy_block'
158
466
  };
159
- exports.UpdateAgentsRequestAgentsInnerModelEnum = {
160
- Scout9: 'Scout9',
161
- Bard: 'bard',
162
- Null: 'null'
467
+ exports.ScheduleGroupUpdateRequestIngressEnum = {
468
+ Auto: 'auto',
469
+ Manual: 'manual',
470
+ App: 'app',
471
+ Webhook: 'webhook'
472
+ };
473
+ exports.ScheduleUpdateRequestLockCodeEnum = {
474
+ WorkflowStagnation: 'workflow_stagnation',
475
+ MaxLockAttempts: 'max_lock_attempts',
476
+ RuntimeError: 'runtime_error',
477
+ ManualMode: 'manual_mode',
478
+ PolicyBlock: 'policy_block'
479
+ };
480
+ exports.ScheduleUpdateRequestIngressEnum = {
481
+ Auto: 'auto',
482
+ Manual: 'manual',
483
+ App: 'app',
484
+ Webhook: 'webhook'
485
+ };
486
+ exports.ScheduledConversationLockCodeEnum = {
487
+ WorkflowStagnation: 'workflow_stagnation',
488
+ MaxLockAttempts: 'max_lock_attempts',
489
+ RuntimeError: 'runtime_error',
490
+ ManualMode: 'manual_mode',
491
+ PolicyBlock: 'policy_block'
492
+ };
493
+ exports.ScheduledConversationIngressEnum = {
494
+ Auto: 'auto',
495
+ Manual: 'manual',
496
+ App: 'app',
497
+ Webhook: 'webhook'
498
+ };
499
+ exports.ScheduledConversationGroupLockCodeEnum = {
500
+ WorkflowStagnation: 'workflow_stagnation',
501
+ MaxLockAttempts: 'max_lock_attempts',
502
+ RuntimeError: 'runtime_error',
503
+ ManualMode: 'manual_mode',
504
+ PolicyBlock: 'policy_block'
505
+ };
506
+ exports.ScheduledConversationGroupIngressEnum = {
507
+ Auto: 'auto',
508
+ Manual: 'manual',
509
+ App: 'app',
510
+ Webhook: 'webhook'
511
+ };
512
+ exports.WorkflowResponseSlotForwardOneOfModeEnum = {
513
+ AfterReply: 'after-reply',
514
+ Immediately: 'immediately'
163
515
  };
164
516
  /**
165
- * CustomContextApi - axios parameter creator
517
+ * NoopApi - axios parameter creator
166
518
  * @export
167
519
  */
168
- const CustomContextApiAxiosParamCreator = function (configuration) {
520
+ const NoopApiAxiosParamCreator = function (configuration) {
169
521
  return {
170
522
  /**
171
523
  *
172
- * @summary Test a custom context before training
173
- * @param {ContextTestRequest} contextTestRequest
524
+ * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
525
+ * @param {PingRequest} pingRequest
174
526
  * @param {*} [options] Override http request option.
175
527
  * @throws {RequiredError}
176
528
  */
177
- contextTest: async (contextTestRequest, options = {}) => {
178
- // verify required parameter 'contextTestRequest' is not null or undefined
179
- (0, common_1.assertParamExists)('contextTest', 'contextTestRequest', contextTestRequest);
180
- const localVarPath = `/v1-contextTest`;
529
+ ping: async (pingRequest, options = {}) => {
530
+ // verify required parameter 'pingRequest' is not null or undefined
531
+ (0, common_1.assertParamExists)('ping', 'pingRequest', pingRequest);
532
+ const localVarPath = `/v1-utils-ping`;
181
533
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
182
534
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
183
535
  let baseOptions;
@@ -191,7 +543,7 @@ const CustomContextApiAxiosParamCreator = function (configuration) {
191
543
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
192
544
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
193
545
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
194
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(contextTestRequest, localVarRequestOptions, configuration);
546
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(pingRequest, localVarRequestOptions, configuration);
195
547
  return {
196
548
  url: (0, common_1.toPathString)(localVarUrlObj),
197
549
  options: localVarRequestOptions,
@@ -199,74 +551,112 @@ const CustomContextApiAxiosParamCreator = function (configuration) {
199
551
  },
200
552
  };
201
553
  };
202
- exports.CustomContextApiAxiosParamCreator = CustomContextApiAxiosParamCreator;
554
+ exports.NoopApiAxiosParamCreator = NoopApiAxiosParamCreator;
203
555
  /**
204
- * CustomContextApi - functional programming interface
556
+ * NoopApi - functional programming interface
205
557
  * @export
206
558
  */
207
- const CustomContextApiFp = function (configuration) {
208
- const localVarAxiosParamCreator = (0, exports.CustomContextApiAxiosParamCreator)(configuration);
559
+ const NoopApiFp = function (configuration) {
560
+ const localVarAxiosParamCreator = (0, exports.NoopApiAxiosParamCreator)(configuration);
209
561
  return {
210
562
  /**
211
563
  *
212
- * @summary Test a custom context before training
213
- * @param {ContextTestRequest} contextTestRequest
564
+ * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
565
+ * @param {PingRequest} pingRequest
214
566
  * @param {*} [options] Override http request option.
215
567
  * @throws {RequiredError}
216
568
  */
217
- async contextTest(contextTestRequest, options) {
218
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextTest(contextTestRequest, options);
569
+ async ping(pingRequest, options) {
570
+ const localVarAxiosArgs = await localVarAxiosParamCreator.ping(pingRequest, options);
219
571
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
220
572
  },
221
573
  };
222
574
  };
223
- exports.CustomContextApiFp = CustomContextApiFp;
575
+ exports.NoopApiFp = NoopApiFp;
224
576
  /**
225
- * CustomContextApi - factory interface
577
+ * NoopApi - factory interface
226
578
  * @export
227
579
  */
228
- const CustomContextApiFactory = function (configuration, basePath, axios) {
229
- const localVarFp = (0, exports.CustomContextApiFp)(configuration);
580
+ const NoopApiFactory = function (configuration, basePath, axios) {
581
+ const localVarFp = (0, exports.NoopApiFp)(configuration);
230
582
  return {
231
583
  /**
232
584
  *
233
- * @summary Test a custom context before training
234
- * @param {ContextTestRequest} contextTestRequest
585
+ * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
586
+ * @param {PingRequest} pingRequest
235
587
  * @param {*} [options] Override http request option.
236
588
  * @throws {RequiredError}
237
589
  */
238
- contextTest(contextTestRequest, options) {
239
- return localVarFp.contextTest(contextTestRequest, options).then((request) => request(axios, basePath));
590
+ ping(pingRequest, options) {
591
+ return localVarFp.ping(pingRequest, options).then((request) => request(axios, basePath));
240
592
  },
241
593
  };
242
594
  };
243
- exports.CustomContextApiFactory = CustomContextApiFactory;
595
+ exports.NoopApiFactory = NoopApiFactory;
244
596
  /**
245
- * CustomContextApi - object-oriented interface
597
+ * NoopApi - object-oriented interface
246
598
  * @export
247
- * @class CustomContextApi
599
+ * @class NoopApi
248
600
  * @extends {BaseAPI}
249
601
  */
250
- class CustomContextApi extends base_1.BaseAPI {
602
+ class NoopApi extends base_1.BaseAPI {
251
603
  /**
252
604
  *
253
- * @summary Test a custom context before training
254
- * @param {ContextTestRequest} contextTestRequest
605
+ * @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
606
+ * @param {PingRequest} pingRequest
255
607
  * @param {*} [options] Override http request option.
256
608
  * @throws {RequiredError}
257
- * @memberof CustomContextApi
609
+ * @memberof NoopApi
258
610
  */
259
- contextTest(contextTestRequest, options) {
260
- return (0, exports.CustomContextApiFp)(this.configuration).contextTest(contextTestRequest, options).then((request) => request(this.axios, this.basePath));
611
+ ping(pingRequest, options) {
612
+ return (0, exports.NoopApiFp)(this.configuration).ping(pingRequest, options).then((request) => request(this.axios, this.basePath));
261
613
  }
262
614
  }
263
- exports.CustomContextApi = CustomContextApi;
615
+ exports.NoopApi = NoopApi;
264
616
  /**
265
617
  * Scout9Api - axios parameter creator
266
618
  * @export
267
619
  */
268
620
  const Scout9ApiAxiosParamCreator = function (configuration) {
269
621
  return {
622
+ /**
623
+ *
624
+ * @summary Create a new entity
625
+ * @param {string} type
626
+ * @param {string} id The unique identifier of the entity
627
+ * @param {EntityData} entityData
628
+ * @param {*} [options] Override http request option.
629
+ * @throws {RequiredError}
630
+ */
631
+ addEntity: async (type, id, entityData, options = {}) => {
632
+ // verify required parameter 'type' is not null or undefined
633
+ (0, common_1.assertParamExists)('addEntity', 'type', type);
634
+ // verify required parameter 'id' is not null or undefined
635
+ (0, common_1.assertParamExists)('addEntity', 'id', id);
636
+ // verify required parameter 'entityData' is not null or undefined
637
+ (0, common_1.assertParamExists)('addEntity', 'entityData', entityData);
638
+ const localVarPath = `/v1-entity/{type}/{id}`
639
+ .replace(`{${"type"}}`, encodeURIComponent(String(type)))
640
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
641
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
642
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
643
+ let baseOptions;
644
+ if (configuration) {
645
+ baseOptions = configuration.baseOptions;
646
+ }
647
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
648
+ const localVarHeaderParameter = {};
649
+ const localVarQueryParameter = {};
650
+ localVarHeaderParameter['Content-Type'] = 'application/json';
651
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
652
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
653
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
654
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(entityData, localVarRequestOptions, configuration);
655
+ return {
656
+ url: (0, common_1.toPathString)(localVarUrlObj),
657
+ options: localVarRequestOptions,
658
+ };
659
+ },
270
660
  /**
271
661
  *
272
662
  * @summary Gets a agent
@@ -513,30 +903,29 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
513
903
  },
514
904
  /**
515
905
  *
516
- * @summary Gets a context
517
- * @param {string} id id of entity to query
906
+ * @summary Natural language prompt to resolve a context value derived from the conversation.
907
+ * @param {MacroContextInput} macroContextInput
518
908
  * @param {*} [options] Override http request option.
519
909
  * @throws {RequiredError}
520
910
  */
521
- context: async (id, options = {}) => {
522
- // verify required parameter 'id' is not null or undefined
523
- (0, common_1.assertParamExists)('context', 'id', id);
524
- const localVarPath = `/v1-context`;
911
+ captureContext: async (macroContextInput, options = {}) => {
912
+ // verify required parameter 'macroContextInput' is not null or undefined
913
+ (0, common_1.assertParamExists)('captureContext', 'macroContextInput', macroContextInput);
914
+ const localVarPath = `/v1-utils-macros-context`;
525
915
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
526
916
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
527
917
  let baseOptions;
528
918
  if (configuration) {
529
919
  baseOptions = configuration.baseOptions;
530
920
  }
531
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
921
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
532
922
  const localVarHeaderParameter = {};
533
923
  const localVarQueryParameter = {};
534
- if (id !== undefined) {
535
- localVarQueryParameter['id'] = id;
536
- }
924
+ localVarHeaderParameter['Content-Type'] = 'application/json';
537
925
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
538
926
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
539
927
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
928
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(macroContextInput, localVarRequestOptions, configuration);
540
929
  return {
541
930
  url: (0, common_1.toPathString)(localVarUrlObj),
542
931
  options: localVarRequestOptions,
@@ -544,60 +933,54 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
544
933
  },
545
934
  /**
546
935
  *
547
- * @summary Create a new context
548
- * @param {CreateContextRequest} createContextRequest
936
+ * @summary Get the current project configuration
549
937
  * @param {*} [options] Override http request option.
550
938
  * @throws {RequiredError}
551
939
  */
552
- contextCreate: async (createContextRequest, options = {}) => {
553
- // verify required parameter 'createContextRequest' is not null or undefined
554
- (0, common_1.assertParamExists)('contextCreate', 'createContextRequest', createContextRequest);
555
- const localVarPath = `/v1-context`;
940
+ config: async (options = {}) => {
941
+ const localVarPath = `/v1-config`;
556
942
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
557
943
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
558
944
  let baseOptions;
559
945
  if (configuration) {
560
946
  baseOptions = configuration.baseOptions;
561
947
  }
562
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
948
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
563
949
  const localVarHeaderParameter = {};
564
950
  const localVarQueryParameter = {};
565
- localVarHeaderParameter['Content-Type'] = 'application/json';
566
951
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
567
952
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
568
953
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
569
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createContextRequest, localVarRequestOptions, configuration);
570
954
  return {
571
955
  url: (0, common_1.toPathString)(localVarUrlObj),
572
956
  options: localVarRequestOptions,
573
957
  };
574
958
  },
575
959
  /**
576
- *
577
- * @summary Gets context data
578
- * @param {string} id id of entity to query
960
+ * Runs contextualization on workflow event messages and returns contextualized messages.
961
+ * @summary Contextualize workflow event messages
962
+ * @param {ContextualizerRequest} contextualizerRequest
579
963
  * @param {*} [options] Override http request option.
580
964
  * @throws {RequiredError}
581
965
  */
582
- contextData: async (id, options = {}) => {
583
- // verify required parameter 'id' is not null or undefined
584
- (0, common_1.assertParamExists)('contextData', 'id', id);
585
- const localVarPath = `/v1-contextDatas`;
966
+ contextualize: async (contextualizerRequest, options = {}) => {
967
+ // verify required parameter 'contextualizerRequest' is not null or undefined
968
+ (0, common_1.assertParamExists)('contextualize', 'contextualizerRequest', contextualizerRequest);
969
+ const localVarPath = `/v1-contextualize`;
586
970
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
587
971
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
588
972
  let baseOptions;
589
973
  if (configuration) {
590
974
  baseOptions = configuration.baseOptions;
591
975
  }
592
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
976
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
593
977
  const localVarHeaderParameter = {};
594
978
  const localVarQueryParameter = {};
595
- if (id !== undefined) {
596
- localVarQueryParameter['id'] = id;
597
- }
979
+ localVarHeaderParameter['Content-Type'] = 'application/json';
598
980
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
599
981
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
600
982
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
983
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(contextualizerRequest, localVarRequestOptions, configuration);
601
984
  return {
602
985
  url: (0, common_1.toPathString)(localVarUrlObj),
603
986
  options: localVarRequestOptions,
@@ -605,29 +988,30 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
605
988
  },
606
989
  /**
607
990
  *
608
- * @summary Create a new context data
609
- * @param {CreateContextDataRequest} createContextDataRequest
991
+ * @summary Gets a conversation
992
+ * @param {string} id id of entity to query
610
993
  * @param {*} [options] Override http request option.
611
994
  * @throws {RequiredError}
612
995
  */
613
- contextDataCreate: async (createContextDataRequest, options = {}) => {
614
- // verify required parameter 'createContextDataRequest' is not null or undefined
615
- (0, common_1.assertParamExists)('contextDataCreate', 'createContextDataRequest', createContextDataRequest);
616
- const localVarPath = `/v1-contextDatas`;
996
+ conversation: async (id, options = {}) => {
997
+ // verify required parameter 'id' is not null or undefined
998
+ (0, common_1.assertParamExists)('conversation', 'id', id);
999
+ const localVarPath = `/v1-conversation`;
617
1000
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
618
1001
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
619
1002
  let baseOptions;
620
1003
  if (configuration) {
621
1004
  baseOptions = configuration.baseOptions;
622
1005
  }
623
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1006
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
624
1007
  const localVarHeaderParameter = {};
625
1008
  const localVarQueryParameter = {};
626
- localVarHeaderParameter['Content-Type'] = 'application/json';
1009
+ if (id !== undefined) {
1010
+ localVarQueryParameter['id'] = id;
1011
+ }
627
1012
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
628
1013
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
629
1014
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
630
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createContextDataRequest, localVarRequestOptions, configuration);
631
1015
  return {
632
1016
  url: (0, common_1.toPathString)(localVarUrlObj),
633
1017
  options: localVarRequestOptions,
@@ -635,22 +1019,22 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
635
1019
  },
636
1020
  /**
637
1021
  *
638
- * @summary Deletes a schedule
1022
+ * @summary Gets a conversation
639
1023
  * @param {string} id id of entity to query
640
1024
  * @param {*} [options] Override http request option.
641
1025
  * @throws {RequiredError}
642
1026
  */
643
- contextDataDelete: async (id, options = {}) => {
1027
+ conversationContext: async (id, options = {}) => {
644
1028
  // verify required parameter 'id' is not null or undefined
645
- (0, common_1.assertParamExists)('contextDataDelete', 'id', id);
646
- const localVarPath = `/v1-contextDatas`;
1029
+ (0, common_1.assertParamExists)('conversationContext', 'id', id);
1030
+ const localVarPath = `/v1-conversationContext`;
647
1031
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
648
1032
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
649
1033
  let baseOptions;
650
1034
  if (configuration) {
651
1035
  baseOptions = configuration.baseOptions;
652
1036
  }
653
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1037
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
654
1038
  const localVarHeaderParameter = {};
655
1039
  const localVarQueryParameter = {};
656
1040
  if (id !== undefined) {
@@ -666,15 +1050,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
666
1050
  },
667
1051
  /**
668
1052
  *
669
- * @summary Update a context data
670
- * @param {UpdateContextDataRequest} updateContextDataRequest
1053
+ * @summary Update a conversation
1054
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
671
1055
  * @param {*} [options] Override http request option.
672
1056
  * @throws {RequiredError}
673
1057
  */
674
- contextDataUpdate: async (updateContextDataRequest, options = {}) => {
675
- // verify required parameter 'updateContextDataRequest' is not null or undefined
676
- (0, common_1.assertParamExists)('contextDataUpdate', 'updateContextDataRequest', updateContextDataRequest);
677
- const localVarPath = `/v1-contextDatas`;
1058
+ conversationContextUpdate: async (conversationContextUpdateRequest, options = {}) => {
1059
+ // verify required parameter 'conversationContextUpdateRequest' is not null or undefined
1060
+ (0, common_1.assertParamExists)('conversationContextUpdate', 'conversationContextUpdateRequest', conversationContextUpdateRequest);
1061
+ const localVarPath = `/v1-conversationContext`;
678
1062
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
679
1063
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
680
1064
  let baseOptions;
@@ -688,7 +1072,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
688
1072
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
689
1073
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
690
1074
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
691
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateContextDataRequest, localVarRequestOptions, configuration);
1075
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(conversationContextUpdateRequest, localVarRequestOptions, configuration);
692
1076
  return {
693
1077
  url: (0, common_1.toPathString)(localVarUrlObj),
694
1078
  options: localVarRequestOptions,
@@ -696,30 +1080,29 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
696
1080
  },
697
1081
  /**
698
1082
  *
699
- * @summary Deletes a schedule
700
- * @param {string} id id of entity to query
1083
+ * @summary Create a new conversation
1084
+ * @param {ConversationCreateRequest} conversationCreateRequest
701
1085
  * @param {*} [options] Override http request option.
702
1086
  * @throws {RequiredError}
703
1087
  */
704
- contextDelete: async (id, options = {}) => {
705
- // verify required parameter 'id' is not null or undefined
706
- (0, common_1.assertParamExists)('contextDelete', 'id', id);
707
- const localVarPath = `/v1-context`;
1088
+ conversationCreate: async (conversationCreateRequest, options = {}) => {
1089
+ // verify required parameter 'conversationCreateRequest' is not null or undefined
1090
+ (0, common_1.assertParamExists)('conversationCreate', 'conversationCreateRequest', conversationCreateRequest);
1091
+ const localVarPath = `/v1-conversation`;
708
1092
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
709
1093
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
710
1094
  let baseOptions;
711
1095
  if (configuration) {
712
1096
  baseOptions = configuration.baseOptions;
713
1097
  }
714
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1098
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
715
1099
  const localVarHeaderParameter = {};
716
1100
  const localVarQueryParameter = {};
717
- if (id !== undefined) {
718
- localVarQueryParameter['id'] = id;
719
- }
1101
+ localVarHeaderParameter['Content-Type'] = 'application/json';
720
1102
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
721
1103
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
722
1104
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1105
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(conversationCreateRequest, localVarRequestOptions, configuration);
723
1106
  return {
724
1107
  url: (0, common_1.toPathString)(localVarUrlObj),
725
1108
  options: localVarRequestOptions,
@@ -727,29 +1110,30 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
727
1110
  },
728
1111
  /**
729
1112
  *
730
- * @summary Test a custom context before training
731
- * @param {ContextTestRequest} contextTestRequest
1113
+ * @summary Deletes a schedule
1114
+ * @param {string} id id of entity to query
732
1115
  * @param {*} [options] Override http request option.
733
1116
  * @throws {RequiredError}
734
1117
  */
735
- contextTest: async (contextTestRequest, options = {}) => {
736
- // verify required parameter 'contextTestRequest' is not null or undefined
737
- (0, common_1.assertParamExists)('contextTest', 'contextTestRequest', contextTestRequest);
738
- const localVarPath = `/v1-contextTest`;
1118
+ conversationDelete: async (id, options = {}) => {
1119
+ // verify required parameter 'id' is not null or undefined
1120
+ (0, common_1.assertParamExists)('conversationDelete', 'id', id);
1121
+ const localVarPath = `/v1-conversation`;
739
1122
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
740
1123
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
741
1124
  let baseOptions;
742
1125
  if (configuration) {
743
1126
  baseOptions = configuration.baseOptions;
744
1127
  }
745
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1128
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
746
1129
  const localVarHeaderParameter = {};
747
1130
  const localVarQueryParameter = {};
748
- localVarHeaderParameter['Content-Type'] = 'application/json';
1131
+ if (id !== undefined) {
1132
+ localVarQueryParameter['id'] = id;
1133
+ }
749
1134
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
750
1135
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
751
1136
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
752
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(contextTestRequest, localVarRequestOptions, configuration);
753
1137
  return {
754
1138
  url: (0, common_1.toPathString)(localVarUrlObj),
755
1139
  options: localVarRequestOptions,
@@ -757,15 +1141,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
757
1141
  },
758
1142
  /**
759
1143
  *
760
- * @summary Update a context
761
- * @param {UpdateContextRequest} updateContextRequest
1144
+ * @summary Update a conversation
1145
+ * @param {ConversationUpdateRequest} conversationUpdateRequest
762
1146
  * @param {*} [options] Override http request option.
763
1147
  * @throws {RequiredError}
764
1148
  */
765
- contextUpdate: async (updateContextRequest, options = {}) => {
766
- // verify required parameter 'updateContextRequest' is not null or undefined
767
- (0, common_1.assertParamExists)('contextUpdate', 'updateContextRequest', updateContextRequest);
768
- const localVarPath = `/v1-context`;
1149
+ conversationUpdate: async (conversationUpdateRequest, options = {}) => {
1150
+ // verify required parameter 'conversationUpdateRequest' is not null or undefined
1151
+ (0, common_1.assertParamExists)('conversationUpdate', 'conversationUpdateRequest', conversationUpdateRequest);
1152
+ const localVarPath = `/v1-conversation`;
769
1153
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
770
1154
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
771
1155
  let baseOptions;
@@ -779,7 +1163,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
779
1163
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
780
1164
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
781
1165
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
782
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateContextRequest, localVarRequestOptions, configuration);
1166
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(conversationUpdateRequest, localVarRequestOptions, configuration);
783
1167
  return {
784
1168
  url: (0, common_1.toPathString)(localVarUrlObj),
785
1169
  options: localVarRequestOptions,
@@ -787,14 +1171,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
787
1171
  },
788
1172
  /**
789
1173
  *
790
- * @summary Gets all or specific set of contexts
1174
+ * @summary Gets all or specific set of conversations
791
1175
  * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
792
1176
  * @param {Array<string>} [id] ids for the entities this id belongs to
793
1177
  * @param {*} [options] Override http request option.
794
1178
  * @throws {RequiredError}
795
1179
  */
796
- contexts: async (q, id, options = {}) => {
797
- const localVarPath = `/v1-contexts`;
1180
+ conversations: async (q, id, options = {}) => {
1181
+ const localVarPath = `/v1-conversations`;
798
1182
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
799
1183
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
800
1184
  let baseOptions;
@@ -820,29 +1204,34 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
820
1204
  },
821
1205
  /**
822
1206
  *
823
- * @summary Creates new contexts
824
- * @param {CreateContextsRequest} createContextsRequest
1207
+ * @summary Gets a customer
1208
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
1209
+ * @param {boolean} [resolve] If a email or phone is provided and the customer doesn\&#39;t exist, it will automatically create one
825
1210
  * @param {*} [options] Override http request option.
826
1211
  * @throws {RequiredError}
827
1212
  */
828
- contextsCreate: async (createContextsRequest, options = {}) => {
829
- // verify required parameter 'createContextsRequest' is not null or undefined
830
- (0, common_1.assertParamExists)('contextsCreate', 'createContextsRequest', createContextsRequest);
831
- const localVarPath = `/v1-contexts`;
1213
+ customer: async (idOrEmailOrPhone, resolve, options = {}) => {
1214
+ // verify required parameter 'idOrEmailOrPhone' is not null or undefined
1215
+ (0, common_1.assertParamExists)('customer', 'idOrEmailOrPhone', idOrEmailOrPhone);
1216
+ const localVarPath = `/v1-customer`;
832
1217
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
833
1218
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
834
1219
  let baseOptions;
835
1220
  if (configuration) {
836
1221
  baseOptions = configuration.baseOptions;
837
1222
  }
838
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1223
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
839
1224
  const localVarHeaderParameter = {};
840
1225
  const localVarQueryParameter = {};
841
- localVarHeaderParameter['Content-Type'] = 'application/json';
1226
+ if (idOrEmailOrPhone !== undefined) {
1227
+ localVarQueryParameter['idOrEmailOrPhone'] = idOrEmailOrPhone;
1228
+ }
1229
+ if (resolve !== undefined) {
1230
+ localVarQueryParameter['resolve'] = resolve;
1231
+ }
842
1232
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
843
1233
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
844
1234
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
845
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createContextsRequest, localVarRequestOptions, configuration);
846
1235
  return {
847
1236
  url: (0, common_1.toPathString)(localVarUrlObj),
848
1237
  options: localVarRequestOptions,
@@ -850,28 +1239,29 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
850
1239
  },
851
1240
  /**
852
1241
  *
853
- * @summary Deletes multiple contexts
854
- * @param {Array<string>} [id] ids for the entities this id belongs to
1242
+ * @summary Creates a new customer
1243
+ * @param {Customer} body
855
1244
  * @param {*} [options] Override http request option.
856
1245
  * @throws {RequiredError}
857
1246
  */
858
- contextsDelete: async (id, options = {}) => {
859
- const localVarPath = `/v1-contexts`;
1247
+ customerCreate: async (body, options = {}) => {
1248
+ // verify required parameter 'body' is not null or undefined
1249
+ (0, common_1.assertParamExists)('customerCreate', 'body', body);
1250
+ const localVarPath = `/v1-customer`;
860
1251
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
861
1252
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
862
1253
  let baseOptions;
863
1254
  if (configuration) {
864
1255
  baseOptions = configuration.baseOptions;
865
1256
  }
866
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1257
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
867
1258
  const localVarHeaderParameter = {};
868
1259
  const localVarQueryParameter = {};
869
- if (id) {
870
- localVarQueryParameter['id'] = id;
871
- }
1260
+ localVarHeaderParameter['Content-Type'] = 'application/json';
872
1261
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
873
1262
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
874
1263
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1264
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
875
1265
  return {
876
1266
  url: (0, common_1.toPathString)(localVarUrlObj),
877
1267
  options: localVarRequestOptions,
@@ -879,29 +1269,30 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
879
1269
  },
880
1270
  /**
881
1271
  *
882
- * @summary Updates multiple contexts
883
- * @param {UpdateContextRequest} updateContextRequest
1272
+ * @summary Deletes a customer
1273
+ * @param {string} id id of entity to query
884
1274
  * @param {*} [options] Override http request option.
885
1275
  * @throws {RequiredError}
886
1276
  */
887
- contextsUpdate: async (updateContextRequest, options = {}) => {
888
- // verify required parameter 'updateContextRequest' is not null or undefined
889
- (0, common_1.assertParamExists)('contextsUpdate', 'updateContextRequest', updateContextRequest);
890
- const localVarPath = `/v1-contexts`;
1277
+ customerDelete: async (id, options = {}) => {
1278
+ // verify required parameter 'id' is not null or undefined
1279
+ (0, common_1.assertParamExists)('customerDelete', 'id', id);
1280
+ const localVarPath = `/v1-customer`;
891
1281
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
892
1282
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
893
1283
  let baseOptions;
894
1284
  if (configuration) {
895
1285
  baseOptions = configuration.baseOptions;
896
1286
  }
897
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1287
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
898
1288
  const localVarHeaderParameter = {};
899
1289
  const localVarQueryParameter = {};
900
- localVarHeaderParameter['Content-Type'] = 'application/json';
1290
+ if (id !== undefined) {
1291
+ localVarQueryParameter['id'] = id;
1292
+ }
901
1293
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
902
1294
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
903
1295
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
904
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateContextRequest, localVarRequestOptions, configuration);
905
1296
  return {
906
1297
  url: (0, common_1.toPathString)(localVarUrlObj),
907
1298
  options: localVarRequestOptions,
@@ -909,229 +1300,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
909
1300
  },
910
1301
  /**
911
1302
  *
912
- * @summary Gets a conversation
1303
+ * @summary Gets a customer group
913
1304
  * @param {string} id id of entity to query
914
1305
  * @param {*} [options] Override http request option.
915
1306
  * @throws {RequiredError}
916
1307
  */
917
- conversation: async (id, options = {}) => {
1308
+ customerGroup: async (id, options = {}) => {
918
1309
  // verify required parameter 'id' is not null or undefined
919
- (0, common_1.assertParamExists)('conversation', 'id', id);
920
- const localVarPath = `/v1-conversation`;
921
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
922
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
923
- let baseOptions;
924
- if (configuration) {
925
- baseOptions = configuration.baseOptions;
926
- }
927
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
928
- const localVarHeaderParameter = {};
929
- const localVarQueryParameter = {};
930
- if (id !== undefined) {
931
- localVarQueryParameter['id'] = id;
932
- }
933
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
934
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
935
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
936
- return {
937
- url: (0, common_1.toPathString)(localVarUrlObj),
938
- options: localVarRequestOptions,
939
- };
940
- },
941
- /**
942
- *
943
- * @summary Create a new conversation
944
- * @param {ConversationCreateRequest} conversationCreateRequest
945
- * @param {*} [options] Override http request option.
946
- * @throws {RequiredError}
947
- */
948
- conversationCreate: async (conversationCreateRequest, options = {}) => {
949
- // verify required parameter 'conversationCreateRequest' is not null or undefined
950
- (0, common_1.assertParamExists)('conversationCreate', 'conversationCreateRequest', conversationCreateRequest);
951
- const localVarPath = `/v1-conversation`;
952
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
953
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
954
- let baseOptions;
955
- if (configuration) {
956
- baseOptions = configuration.baseOptions;
957
- }
958
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
959
- const localVarHeaderParameter = {};
960
- const localVarQueryParameter = {};
961
- localVarHeaderParameter['Content-Type'] = 'application/json';
962
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
963
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
964
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
965
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(conversationCreateRequest, localVarRequestOptions, configuration);
966
- return {
967
- url: (0, common_1.toPathString)(localVarUrlObj),
968
- options: localVarRequestOptions,
969
- };
970
- },
971
- /**
972
- *
973
- * @summary Deletes a schedule
974
- * @param {string} id id of entity to query
975
- * @param {*} [options] Override http request option.
976
- * @throws {RequiredError}
977
- */
978
- conversationDelete: async (id, options = {}) => {
979
- // verify required parameter 'id' is not null or undefined
980
- (0, common_1.assertParamExists)('conversationDelete', 'id', id);
981
- const localVarPath = `/v1-conversation`;
982
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
983
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
984
- let baseOptions;
985
- if (configuration) {
986
- baseOptions = configuration.baseOptions;
987
- }
988
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
989
- const localVarHeaderParameter = {};
990
- const localVarQueryParameter = {};
991
- if (id !== undefined) {
992
- localVarQueryParameter['id'] = id;
993
- }
994
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
995
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
996
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
997
- return {
998
- url: (0, common_1.toPathString)(localVarUrlObj),
999
- options: localVarRequestOptions,
1000
- };
1001
- },
1002
- /**
1003
- *
1004
- * @summary Update a conversation
1005
- * @param {ConversationUpdateRequest} conversationUpdateRequest
1006
- * @param {*} [options] Override http request option.
1007
- * @throws {RequiredError}
1008
- */
1009
- conversationUpdate: async (conversationUpdateRequest, options = {}) => {
1010
- // verify required parameter 'conversationUpdateRequest' is not null or undefined
1011
- (0, common_1.assertParamExists)('conversationUpdate', 'conversationUpdateRequest', conversationUpdateRequest);
1012
- const localVarPath = `/v1-conversation`;
1013
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1014
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1015
- let baseOptions;
1016
- if (configuration) {
1017
- baseOptions = configuration.baseOptions;
1018
- }
1019
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
1020
- const localVarHeaderParameter = {};
1021
- const localVarQueryParameter = {};
1022
- localVarHeaderParameter['Content-Type'] = 'application/json';
1023
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1024
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1025
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1026
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(conversationUpdateRequest, localVarRequestOptions, configuration);
1027
- return {
1028
- url: (0, common_1.toPathString)(localVarUrlObj),
1029
- options: localVarRequestOptions,
1030
- };
1031
- },
1032
- /**
1033
- *
1034
- * @summary Gets a customer
1035
- * @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
1036
- * @param {*} [options] Override http request option.
1037
- * @throws {RequiredError}
1038
- */
1039
- customer: async (idOrEmailOrPhone, options = {}) => {
1040
- // verify required parameter 'idOrEmailOrPhone' is not null or undefined
1041
- (0, common_1.assertParamExists)('customer', 'idOrEmailOrPhone', idOrEmailOrPhone);
1042
- const localVarPath = `/v1-customer`;
1043
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1044
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1045
- let baseOptions;
1046
- if (configuration) {
1047
- baseOptions = configuration.baseOptions;
1048
- }
1049
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1050
- const localVarHeaderParameter = {};
1051
- const localVarQueryParameter = {};
1052
- if (idOrEmailOrPhone !== undefined) {
1053
- localVarQueryParameter['idOrEmailOrPhone'] = idOrEmailOrPhone;
1054
- }
1055
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1056
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1057
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1058
- return {
1059
- url: (0, common_1.toPathString)(localVarUrlObj),
1060
- options: localVarRequestOptions,
1061
- };
1062
- },
1063
- /**
1064
- *
1065
- * @summary Creates a new customer
1066
- * @param {CreateCustomerRequest} createCustomerRequest
1067
- * @param {*} [options] Override http request option.
1068
- * @throws {RequiredError}
1069
- */
1070
- customerCreate: async (createCustomerRequest, options = {}) => {
1071
- // verify required parameter 'createCustomerRequest' is not null or undefined
1072
- (0, common_1.assertParamExists)('customerCreate', 'createCustomerRequest', createCustomerRequest);
1073
- const localVarPath = `/v1-customer`;
1074
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1075
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1076
- let baseOptions;
1077
- if (configuration) {
1078
- baseOptions = configuration.baseOptions;
1079
- }
1080
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1081
- const localVarHeaderParameter = {};
1082
- const localVarQueryParameter = {};
1083
- localVarHeaderParameter['Content-Type'] = 'application/json';
1084
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1085
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1086
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1087
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createCustomerRequest, localVarRequestOptions, configuration);
1088
- return {
1089
- url: (0, common_1.toPathString)(localVarUrlObj),
1090
- options: localVarRequestOptions,
1091
- };
1092
- },
1093
- /**
1094
- *
1095
- * @summary Deletes a customer
1096
- * @param {string} id id of entity to query
1097
- * @param {*} [options] Override http request option.
1098
- * @throws {RequiredError}
1099
- */
1100
- customerDelete: async (id, options = {}) => {
1101
- // verify required parameter 'id' is not null or undefined
1102
- (0, common_1.assertParamExists)('customerDelete', 'id', id);
1103
- const localVarPath = `/v1-customer`;
1104
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1105
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1106
- let baseOptions;
1107
- if (configuration) {
1108
- baseOptions = configuration.baseOptions;
1109
- }
1110
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1111
- const localVarHeaderParameter = {};
1112
- const localVarQueryParameter = {};
1113
- if (id !== undefined) {
1114
- localVarQueryParameter['id'] = id;
1115
- }
1116
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1117
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1118
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1119
- return {
1120
- url: (0, common_1.toPathString)(localVarUrlObj),
1121
- options: localVarRequestOptions,
1122
- };
1123
- },
1124
- /**
1125
- *
1126
- * @summary Gets a customer group
1127
- * @param {string} id id of entity to query
1128
- * @param {*} [options] Override http request option.
1129
- * @throws {RequiredError}
1130
- */
1131
- customerGroup: async (id, options = {}) => {
1132
- // verify required parameter 'id' is not null or undefined
1133
- (0, common_1.assertParamExists)('customerGroup', 'id', id);
1134
- const localVarPath = `/v1-customerGroup`;
1310
+ (0, common_1.assertParamExists)('customerGroup', 'id', id);
1311
+ const localVarPath = `/v1-customerGroup`;
1135
1312
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1136
1313
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1137
1314
  let baseOptions;
@@ -1490,13 +1667,13 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1490
1667
  /**
1491
1668
  *
1492
1669
  * @summary Updates multiple customers
1493
- * @param {UpdateCustomerRequest} updateCustomerRequest
1670
+ * @param {UpdateCustomersRequest} updateCustomersRequest
1494
1671
  * @param {*} [options] Override http request option.
1495
1672
  * @throws {RequiredError}
1496
1673
  */
1497
- customersUpdate: async (updateCustomerRequest, options = {}) => {
1498
- // verify required parameter 'updateCustomerRequest' is not null or undefined
1499
- (0, common_1.assertParamExists)('customersUpdate', 'updateCustomerRequest', updateCustomerRequest);
1674
+ customersUpdate: async (updateCustomersRequest, options = {}) => {
1675
+ // verify required parameter 'updateCustomersRequest' is not null or undefined
1676
+ (0, common_1.assertParamExists)('customersUpdate', 'updateCustomersRequest', updateCustomersRequest);
1500
1677
  const localVarPath = `/v1-customers`;
1501
1678
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1502
1679
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1511,31 +1688,35 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1511
1688
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1512
1689
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1513
1690
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1514
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateCustomerRequest, localVarRequestOptions, configuration);
1691
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateCustomersRequest, localVarRequestOptions, configuration);
1515
1692
  return {
1516
1693
  url: (0, common_1.toPathString)(localVarUrlObj),
1517
1694
  options: localVarRequestOptions,
1518
1695
  };
1519
1696
  },
1520
1697
  /**
1521
- *
1522
- * @summary Returns information about a specific file.
1523
- * @param {string} fileId The ID of the file to use for this request
1698
+ * Deletes an entity with the specified type and ID.
1699
+ * @summary Delete an entity
1700
+ * @param {string} type
1701
+ * @param {string} id
1524
1702
  * @param {*} [options] Override http request option.
1525
1703
  * @throws {RequiredError}
1526
1704
  */
1527
- file: async (fileId, options = {}) => {
1528
- // verify required parameter 'fileId' is not null or undefined
1529
- (0, common_1.assertParamExists)('file', 'fileId', fileId);
1530
- const localVarPath = `/files/{file_id}`
1531
- .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1705
+ deleteEntity: async (type, id, options = {}) => {
1706
+ // verify required parameter 'type' is not null or undefined
1707
+ (0, common_1.assertParamExists)('deleteEntity', 'type', type);
1708
+ // verify required parameter 'id' is not null or undefined
1709
+ (0, common_1.assertParamExists)('deleteEntity', 'id', id);
1710
+ const localVarPath = `/v1-entity/{type}/{id}`
1711
+ .replace(`{${"type"}}`, encodeURIComponent(String(type)))
1712
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1532
1713
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1533
1714
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1534
1715
  let baseOptions;
1535
1716
  if (configuration) {
1536
1717
  baseOptions = configuration.baseOptions;
1537
1718
  }
1538
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1719
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1539
1720
  const localVarHeaderParameter = {};
1540
1721
  const localVarQueryParameter = {};
1541
1722
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -1548,16 +1729,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1548
1729
  },
1549
1730
  /**
1550
1731
  *
1551
- * @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.
1552
- * @param {File} file
1553
- * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
1732
+ * @summary Natural language prompt to resolve to a boolean value.
1733
+ * @param {MacroDidInput} macroDidInput
1554
1734
  * @param {*} [options] Override http request option.
1555
1735
  * @throws {RequiredError}
1556
1736
  */
1557
- fileCreate: async (file, purpose, options = {}) => {
1558
- // verify required parameter 'file' is not null or undefined
1559
- (0, common_1.assertParamExists)('fileCreate', 'file', file);
1560
- const localVarPath = `/v1-utils-files`;
1737
+ did: async (macroDidInput, options = {}) => {
1738
+ // verify required parameter 'macroDidInput' is not null or undefined
1739
+ (0, common_1.assertParamExists)('did', 'macroDidInput', macroDidInput);
1740
+ const localVarPath = `/v1-utils-macros-did`;
1561
1741
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1562
1742
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1563
1743
  let baseOptions;
@@ -1567,18 +1747,11 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1567
1747
  const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1568
1748
  const localVarHeaderParameter = {};
1569
1749
  const localVarQueryParameter = {};
1570
- const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
1571
- if (file !== undefined) {
1572
- localVarFormParams.append('file', file);
1573
- }
1574
- if (purpose !== undefined) {
1575
- localVarFormParams.append('purpose', purpose);
1576
- }
1577
- localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
1750
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1578
1751
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1579
1752
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1580
1753
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1581
- localVarRequestOptions.data = localVarFormParams;
1754
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(macroDidInput, localVarRequestOptions, configuration);
1582
1755
  return {
1583
1756
  url: (0, common_1.toPathString)(localVarUrlObj),
1584
1757
  options: localVarRequestOptions,
@@ -1586,28 +1759,29 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1586
1759
  },
1587
1760
  /**
1588
1761
  *
1589
- * @summary Delete a file.
1590
- * @param {string} fileId The ID of the file to use for this request
1762
+ * @summary Natural language prompt to resolve to a boolean value in relation to the given immediate message.
1763
+ * @param {MacroDoesInput} macroDoesInput
1591
1764
  * @param {*} [options] Override http request option.
1592
1765
  * @throws {RequiredError}
1593
1766
  */
1594
- fileDelete: async (fileId, options = {}) => {
1595
- // verify required parameter 'fileId' is not null or undefined
1596
- (0, common_1.assertParamExists)('fileDelete', 'fileId', fileId);
1597
- const localVarPath = `/files/{file_id}`
1598
- .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1767
+ does: async (macroDoesInput, options = {}) => {
1768
+ // verify required parameter 'macroDoesInput' is not null or undefined
1769
+ (0, common_1.assertParamExists)('does', 'macroDoesInput', macroDoesInput);
1770
+ const localVarPath = `/v1-utils-macros-does`;
1599
1771
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1600
1772
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1601
1773
  let baseOptions;
1602
1774
  if (configuration) {
1603
1775
  baseOptions = configuration.baseOptions;
1604
1776
  }
1605
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1777
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1606
1778
  const localVarHeaderParameter = {};
1607
1779
  const localVarQueryParameter = {};
1780
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1608
1781
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1609
1782
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1610
1783
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1784
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(macroDoesInput, localVarRequestOptions, configuration);
1611
1785
  return {
1612
1786
  url: (0, common_1.toPathString)(localVarUrlObj),
1613
1787
  options: localVarRequestOptions,
@@ -1615,16 +1789,20 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1615
1789
  },
1616
1790
  /**
1617
1791
  *
1618
- * @summary Returns the contents of the specified file
1619
- * @param {string} fileId The ID of the file to use for this request
1792
+ * @summary Get an entity by type and ID
1793
+ * @param {string} type The type of the entity to fetch
1794
+ * @param {string} id The unique identifier of the entity
1620
1795
  * @param {*} [options] Override http request option.
1621
1796
  * @throws {RequiredError}
1622
1797
  */
1623
- fileDownload: async (fileId, options = {}) => {
1624
- // verify required parameter 'fileId' is not null or undefined
1625
- (0, common_1.assertParamExists)('fileDownload', 'fileId', fileId);
1626
- const localVarPath = `/files/{file_id}/content`
1627
- .replace(`{${"file_id"}}`, encodeURIComponent(String(fileId)));
1798
+ entity: async (type, id, options = {}) => {
1799
+ // verify required parameter 'type' is not null or undefined
1800
+ (0, common_1.assertParamExists)('entity', 'type', type);
1801
+ // verify required parameter 'id' is not null or undefined
1802
+ (0, common_1.assertParamExists)('entity', 'id', id);
1803
+ const localVarPath = `/v1-entity/{type}/{id}`
1804
+ .replace(`{${"type"}}`, encodeURIComponent(String(type)))
1805
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1628
1806
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1629
1807
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1630
1808
  let baseOptions;
@@ -1644,12 +1822,17 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1644
1822
  },
1645
1823
  /**
1646
1824
  *
1647
- * @summary Returns a list of files that belong to the user\'s organization.
1825
+ * @summary Returns a file
1826
+ * @param {string} purpose File categorical purpose
1827
+ * @param {string} [entity] File entity id
1828
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
1648
1829
  * @param {*} [options] Override http request option.
1649
1830
  * @throws {RequiredError}
1650
1831
  */
1651
- files: async (options = {}) => {
1652
- const localVarPath = `/v1-utils-files`;
1832
+ file: async (purpose, entity, agent, options = {}) => {
1833
+ // verify required parameter 'purpose' is not null or undefined
1834
+ (0, common_1.assertParamExists)('file', 'purpose', purpose);
1835
+ const localVarPath = `/v1-utils-file`;
1653
1836
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1654
1837
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1655
1838
  let baseOptions;
@@ -1659,6 +1842,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1659
1842
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1660
1843
  const localVarHeaderParameter = {};
1661
1844
  const localVarQueryParameter = {};
1845
+ if (purpose !== undefined) {
1846
+ localVarQueryParameter['purpose'] = purpose;
1847
+ }
1848
+ if (entity !== undefined) {
1849
+ localVarQueryParameter['entity'] = entity;
1850
+ }
1851
+ if (agent !== undefined) {
1852
+ localVarQueryParameter['agent'] = agent;
1853
+ }
1662
1854
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1663
1855
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1664
1856
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -1668,60 +1860,41 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1668
1860
  };
1669
1861
  },
1670
1862
  /**
1671
- * 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.
1672
- * @summary Generate a message from conversation
1673
- * @param {GenerateRequest} generateRequest
1863
+ *
1864
+ * @summary Remove a file
1865
+ * @param {string} purpose File categorical purpose
1866
+ * @param {string} entity File entity id
1867
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
1674
1868
  * @param {*} [options] Override http request option.
1675
1869
  * @throws {RequiredError}
1676
1870
  */
1677
- generate: async (generateRequest, options = {}) => {
1678
- // verify required parameter 'generateRequest' is not null or undefined
1679
- (0, common_1.assertParamExists)('generate', 'generateRequest', generateRequest);
1680
- const localVarPath = `/v1-generate`;
1871
+ fileRemove: async (purpose, entity, agent, options = {}) => {
1872
+ // verify required parameter 'purpose' is not null or undefined
1873
+ (0, common_1.assertParamExists)('fileRemove', 'purpose', purpose);
1874
+ // verify required parameter 'entity' is not null or undefined
1875
+ (0, common_1.assertParamExists)('fileRemove', 'entity', entity);
1876
+ const localVarPath = `/v1-utils-file`;
1681
1877
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1682
1878
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1683
1879
  let baseOptions;
1684
1880
  if (configuration) {
1685
1881
  baseOptions = configuration.baseOptions;
1686
1882
  }
1687
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1883
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
1688
1884
  const localVarHeaderParameter = {};
1689
1885
  const localVarQueryParameter = {};
1690
- localVarHeaderParameter['Content-Type'] = 'application/json';
1886
+ if (purpose !== undefined) {
1887
+ localVarQueryParameter['purpose'] = purpose;
1888
+ }
1889
+ if (entity !== undefined) {
1890
+ localVarQueryParameter['entity'] = entity;
1891
+ }
1892
+ if (agent !== undefined) {
1893
+ localVarQueryParameter['agent'] = agent;
1894
+ }
1691
1895
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1692
1896
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1693
1897
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1694
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateRequest, localVarRequestOptions, configuration);
1695
- return {
1696
- url: (0, common_1.toPathString)(localVarUrlObj),
1697
- options: localVarRequestOptions,
1698
- };
1699
- },
1700
- /**
1701
- * 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
1702
- * @summary Create and send message
1703
- * @param {MessageCreateRequest} messageCreateRequest
1704
- * @param {*} [options] Override http request option.
1705
- * @throws {RequiredError}
1706
- */
1707
- message: async (messageCreateRequest, options = {}) => {
1708
- // verify required parameter 'messageCreateRequest' is not null or undefined
1709
- (0, common_1.assertParamExists)('message', 'messageCreateRequest', messageCreateRequest);
1710
- const localVarPath = `/v1-messages`;
1711
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1712
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1713
- let baseOptions;
1714
- if (configuration) {
1715
- baseOptions = configuration.baseOptions;
1716
- }
1717
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1718
- const localVarHeaderParameter = {};
1719
- const localVarQueryParameter = {};
1720
- localVarHeaderParameter['Content-Type'] = 'application/json';
1721
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1722
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1723
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1724
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(messageCreateRequest, localVarRequestOptions, configuration);
1725
1898
  return {
1726
1899
  url: (0, common_1.toPathString)(localVarUrlObj),
1727
1900
  options: localVarRequestOptions,
@@ -1729,34 +1902,49 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1729
1902
  },
1730
1903
  /**
1731
1904
  *
1732
- * @summary Get all messages from a conversation
1733
- * @param {string} id id of entity to query
1734
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1905
+ * @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.
1906
+ * @param {File} file
1907
+ * @param {PurposeEnum} [purpose]
1908
+ * @param {string} [context] Additional information about this file
1909
+ * @param {string} [entity] The entity id, if not provided the entity id becomes the provided file name
1910
+ * @param {string} [$agent] The agent that this file belongs to. Only used for entity.audio and entity.transcript files.
1735
1911
  * @param {*} [options] Override http request option.
1736
1912
  * @throws {RequiredError}
1737
1913
  */
1738
- messages: async (id, q, options = {}) => {
1739
- // verify required parameter 'id' is not null or undefined
1740
- (0, common_1.assertParamExists)('messages', 'id', id);
1741
- const localVarPath = `/v1-messages`;
1914
+ fileUpload: async (file, purpose, context, entity, $agent, options = {}) => {
1915
+ // verify required parameter 'file' is not null or undefined
1916
+ (0, common_1.assertParamExists)('fileUpload', 'file', file);
1917
+ const localVarPath = `/v1-utils-file`;
1742
1918
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1743
1919
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1744
1920
  let baseOptions;
1745
1921
  if (configuration) {
1746
1922
  baseOptions = configuration.baseOptions;
1747
1923
  }
1748
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1924
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1749
1925
  const localVarHeaderParameter = {};
1750
1926
  const localVarQueryParameter = {};
1751
- if (id !== undefined) {
1752
- localVarQueryParameter['id'] = id;
1927
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
1928
+ if (file !== undefined) {
1929
+ localVarFormParams.append('file', file);
1753
1930
  }
1754
- if (q !== undefined) {
1755
- localVarQueryParameter['q'] = q;
1931
+ if (purpose !== undefined) {
1932
+ localVarFormParams.append('purpose', new Blob([JSON.stringify(purpose)], { type: "application/json", }));
1933
+ }
1934
+ if (context !== undefined) {
1935
+ localVarFormParams.append('context', context);
1936
+ }
1937
+ if (entity !== undefined) {
1938
+ localVarFormParams.append('entity', entity);
1756
1939
  }
1940
+ if ($agent !== undefined) {
1941
+ localVarFormParams.append('$agent', $agent);
1942
+ }
1943
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
1757
1944
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1758
1945
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1759
1946
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1947
+ localVarRequestOptions.data = localVarFormParams;
1760
1948
  return {
1761
1949
  url: (0, common_1.toPathString)(localVarUrlObj),
1762
1950
  options: localVarRequestOptions,
@@ -1764,15 +1952,16 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1764
1952
  },
1765
1953
  /**
1766
1954
  *
1767
- * @summary Get the results of a bulk API operation
1768
- * @param {string} id id of entity to query
1955
+ * @summary Returns a list of files that belong to the user\'s organization.
1956
+ * @param {string} purpose File categorical purpose
1957
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
1769
1958
  * @param {*} [options] Override http request option.
1770
1959
  * @throws {RequiredError}
1771
1960
  */
1772
- operation: async (id, options = {}) => {
1773
- // verify required parameter 'id' is not null or undefined
1774
- (0, common_1.assertParamExists)('operation', 'id', id);
1775
- const localVarPath = `/v1-utils-operation`;
1961
+ files: async (purpose, agent, options = {}) => {
1962
+ // verify required parameter 'purpose' is not null or undefined
1963
+ (0, common_1.assertParamExists)('files', 'purpose', purpose);
1964
+ const localVarPath = `/v1-utils-files`;
1776
1965
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1777
1966
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1778
1967
  let baseOptions;
@@ -1782,8 +1971,11 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1782
1971
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1783
1972
  const localVarHeaderParameter = {};
1784
1973
  const localVarQueryParameter = {};
1785
- if (id !== undefined) {
1786
- localVarQueryParameter['id'] = id;
1974
+ if (purpose !== undefined) {
1975
+ localVarQueryParameter['purpose'] = purpose;
1976
+ }
1977
+ if (agent !== undefined) {
1978
+ localVarQueryParameter['agent'] = agent;
1787
1979
  }
1788
1980
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1789
1981
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1794,49 +1986,47 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1794
1986
  };
1795
1987
  },
1796
1988
  /**
1797
- *
1798
- * @summary Gets all or specific set of bulk API operations
1799
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1800
- * @param {Array<string>} [id] ids for the entities this id belongs to
1989
+ * Forwards a locked conversation to agent
1990
+ * @summary forwards a locked conversation to agent
1991
+ * @param {ForwardRequest} forwardRequest
1801
1992
  * @param {*} [options] Override http request option.
1802
1993
  * @throws {RequiredError}
1803
1994
  */
1804
- operations: async (q, id, options = {}) => {
1805
- const localVarPath = `/v1-utils-operations`;
1995
+ forward: async (forwardRequest, options = {}) => {
1996
+ // verify required parameter 'forwardRequest' is not null or undefined
1997
+ (0, common_1.assertParamExists)('forward', 'forwardRequest', forwardRequest);
1998
+ const localVarPath = `/v1-forward`;
1806
1999
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1807
2000
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1808
2001
  let baseOptions;
1809
2002
  if (configuration) {
1810
2003
  baseOptions = configuration.baseOptions;
1811
2004
  }
1812
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2005
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1813
2006
  const localVarHeaderParameter = {};
1814
2007
  const localVarQueryParameter = {};
1815
- if (q !== undefined) {
1816
- localVarQueryParameter['q'] = q;
1817
- }
1818
- if (id) {
1819
- localVarQueryParameter['id'] = id;
1820
- }
2008
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1821
2009
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1822
2010
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1823
2011
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2012
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(forwardRequest, localVarRequestOptions, configuration);
1824
2013
  return {
1825
2014
  url: (0, common_1.toPathString)(localVarUrlObj),
1826
2015
  options: localVarRequestOptions,
1827
2016
  };
1828
2017
  },
1829
2018
  /**
1830
- *
1831
- * @summary Creates a new scheduled conversation
1832
- * @param {ScheduleCreateRequest} scheduleCreateRequest
2019
+ * 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.
2020
+ * @summary Generate a message from conversation
2021
+ * @param {GenerateRequest} generateRequest
2022
+ * @param {string} [convo] In relation to which conversation
1833
2023
  * @param {*} [options] Override http request option.
1834
2024
  * @throws {RequiredError}
1835
2025
  */
1836
- scheduleConversation: async (scheduleCreateRequest, options = {}) => {
1837
- // verify required parameter 'scheduleCreateRequest' is not null or undefined
1838
- (0, common_1.assertParamExists)('scheduleConversation', 'scheduleCreateRequest', scheduleCreateRequest);
1839
- const localVarPath = `/v1-schedule`;
2026
+ generate: async (generateRequest, convo, options = {}) => {
2027
+ // verify required parameter 'generateRequest' is not null or undefined
2028
+ (0, common_1.assertParamExists)('generate', 'generateRequest', generateRequest);
2029
+ const localVarPath = `/v1-generate`;
1840
2030
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1841
2031
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1842
2032
  let baseOptions;
@@ -1846,38 +2036,43 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1846
2036
  const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1847
2037
  const localVarHeaderParameter = {};
1848
2038
  const localVarQueryParameter = {};
2039
+ if (convo !== undefined) {
2040
+ localVarQueryParameter['convo'] = convo;
2041
+ }
1849
2042
  localVarHeaderParameter['Content-Type'] = 'application/json';
1850
2043
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1851
2044
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1852
2045
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1853
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(scheduleCreateRequest, localVarRequestOptions, configuration);
2046
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateRequest, localVarRequestOptions, configuration);
1854
2047
  return {
1855
2048
  url: (0, common_1.toPathString)(localVarUrlObj),
1856
2049
  options: localVarRequestOptions,
1857
2050
  };
1858
2051
  },
1859
2052
  /**
1860
- *
1861
- * @summary Deletes a schedule
1862
- * @param {string} id id of entity to query
2053
+ * Returns log data for a given range, specified by start and end Unix timestamps.
2054
+ * @summary Retrieve platform run time logs
2055
+ * @param {number} [start]
2056
+ * @param {number} [end]
1863
2057
  * @param {*} [options] Override http request option.
1864
2058
  * @throws {RequiredError}
1865
2059
  */
1866
- scheduleDelete: async (id, options = {}) => {
1867
- // verify required parameter 'id' is not null or undefined
1868
- (0, common_1.assertParamExists)('scheduleDelete', 'id', id);
1869
- const localVarPath = `/v1-schedule`;
2060
+ logs: async (start, end, options = {}) => {
2061
+ const localVarPath = `/v1-utils-platform-logs`;
1870
2062
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1871
2063
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1872
2064
  let baseOptions;
1873
2065
  if (configuration) {
1874
2066
  baseOptions = configuration.baseOptions;
1875
2067
  }
1876
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
2068
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1877
2069
  const localVarHeaderParameter = {};
1878
2070
  const localVarQueryParameter = {};
1879
- if (id !== undefined) {
1880
- localVarQueryParameter['id'] = id;
2071
+ if (start !== undefined) {
2072
+ localVarQueryParameter['start'] = start;
2073
+ }
2074
+ if (end !== undefined) {
2075
+ localVarQueryParameter['end'] = end;
1881
2076
  }
1882
2077
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1883
2078
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1888,16 +2083,16 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1888
2083
  };
1889
2084
  },
1890
2085
  /**
1891
- *
1892
- * @summary Creates a new schedule group
1893
- * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
2086
+ * 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
2087
+ * @summary Create and send message
2088
+ * @param {MessageCreateRequest} messageCreateRequest
1894
2089
  * @param {*} [options] Override http request option.
1895
2090
  * @throws {RequiredError}
1896
2091
  */
1897
- scheduleGroupCreate: async (scheduleGroupCreateRequest, options = {}) => {
1898
- // verify required parameter 'scheduleGroupCreateRequest' is not null or undefined
1899
- (0, common_1.assertParamExists)('scheduleGroupCreate', 'scheduleGroupCreateRequest', scheduleGroupCreateRequest);
1900
- const localVarPath = `/v1-scheduleGroup`;
2092
+ message: async (messageCreateRequest, options = {}) => {
2093
+ // verify required parameter 'messageCreateRequest' is not null or undefined
2094
+ (0, common_1.assertParamExists)('message', 'messageCreateRequest', messageCreateRequest);
2095
+ const localVarPath = `/v1-messages`;
1901
2096
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1902
2097
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1903
2098
  let baseOptions;
@@ -1911,7 +2106,7 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1911
2106
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1912
2107
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1913
2108
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1914
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(scheduleGroupCreateRequest, localVarRequestOptions, configuration);
2109
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(messageCreateRequest, localVarRequestOptions, configuration);
1915
2110
  return {
1916
2111
  url: (0, common_1.toPathString)(localVarUrlObj),
1917
2112
  options: localVarRequestOptions,
@@ -1919,27 +2114,31 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1919
2114
  },
1920
2115
  /**
1921
2116
  *
1922
- * @summary Deletes and cancels a schedule group
2117
+ * @summary Get all messages from a conversation
1923
2118
  * @param {string} id id of entity to query
2119
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
1924
2120
  * @param {*} [options] Override http request option.
1925
2121
  * @throws {RequiredError}
1926
2122
  */
1927
- scheduleGroupDelete: async (id, options = {}) => {
2123
+ messages: async (id, q, options = {}) => {
1928
2124
  // verify required parameter 'id' is not null or undefined
1929
- (0, common_1.assertParamExists)('scheduleGroupDelete', 'id', id);
1930
- const localVarPath = `/v1-scheduleGroup`;
2125
+ (0, common_1.assertParamExists)('messages', 'id', id);
2126
+ const localVarPath = `/v1-messages`;
1931
2127
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1932
2128
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1933
2129
  let baseOptions;
1934
2130
  if (configuration) {
1935
2131
  baseOptions = configuration.baseOptions;
1936
2132
  }
1937
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
2133
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1938
2134
  const localVarHeaderParameter = {};
1939
2135
  const localVarQueryParameter = {};
1940
2136
  if (id !== undefined) {
1941
2137
  localVarQueryParameter['id'] = id;
1942
2138
  }
2139
+ if (q !== undefined) {
2140
+ localVarQueryParameter['q'] = q;
2141
+ }
1943
2142
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1944
2143
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1945
2144
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -1950,15 +2149,15 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1950
2149
  },
1951
2150
  /**
1952
2151
  *
1953
- * @summary Gets a schedule group
2152
+ * @summary Get the results of a bulk API operation
1954
2153
  * @param {string} id id of entity to query
1955
2154
  * @param {*} [options] Override http request option.
1956
2155
  * @throws {RequiredError}
1957
2156
  */
1958
- scheduleGroupRetrieve: async (id, options = {}) => {
2157
+ operation: async (id, options = {}) => {
1959
2158
  // verify required parameter 'id' is not null or undefined
1960
- (0, common_1.assertParamExists)('scheduleGroupRetrieve', 'id', id);
1961
- const localVarPath = `/v1-scheduleGroup`;
2159
+ (0, common_1.assertParamExists)('operation', 'id', id);
2160
+ const localVarPath = `/v1-utils-operation`;
1962
2161
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1963
2162
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1964
2163
  let baseOptions;
@@ -1981,45 +2180,14 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
1981
2180
  },
1982
2181
  /**
1983
2182
  *
1984
- * @summary Updates a schedule group
1985
- * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
1986
- * @param {*} [options] Override http request option.
1987
- * @throws {RequiredError}
1988
- */
1989
- scheduleGroupUpdate: async (scheduleGroupUpdateRequest, options = {}) => {
1990
- // verify required parameter 'scheduleGroupUpdateRequest' is not null or undefined
1991
- (0, common_1.assertParamExists)('scheduleGroupUpdate', 'scheduleGroupUpdateRequest', scheduleGroupUpdateRequest);
1992
- const localVarPath = `/v1-scheduleGroup`;
1993
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1994
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1995
- let baseOptions;
1996
- if (configuration) {
1997
- baseOptions = configuration.baseOptions;
1998
- }
1999
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
2000
- const localVarHeaderParameter = {};
2001
- const localVarQueryParameter = {};
2002
- localVarHeaderParameter['Content-Type'] = 'application/json';
2003
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2004
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2005
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2006
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(scheduleGroupUpdateRequest, localVarRequestOptions, configuration);
2007
- return {
2008
- url: (0, common_1.toPathString)(localVarUrlObj),
2009
- options: localVarRequestOptions,
2010
- };
2011
- },
2012
- /**
2013
- *
2014
- * @summary Gets a schedule
2015
- * @param {string} id id of entity to query
2183
+ * @summary Gets all or specific set of bulk API operations
2184
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2185
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2016
2186
  * @param {*} [options] Override http request option.
2017
2187
  * @throws {RequiredError}
2018
2188
  */
2019
- scheduleRetrieve: async (id, options = {}) => {
2020
- // verify required parameter 'id' is not null or undefined
2021
- (0, common_1.assertParamExists)('scheduleRetrieve', 'id', id);
2022
- const localVarPath = `/v1-schedule`;
2189
+ operations: async (q, id, options = {}) => {
2190
+ const localVarPath = `/v1-utils-operations`;
2023
2191
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2024
2192
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2025
2193
  let baseOptions;
@@ -2029,7 +2197,10 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2029
2197
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2030
2198
  const localVarHeaderParameter = {};
2031
2199
  const localVarQueryParameter = {};
2032
- if (id !== undefined) {
2200
+ if (q !== undefined) {
2201
+ localVarQueryParameter['q'] = q;
2202
+ }
2203
+ if (id) {
2033
2204
  localVarQueryParameter['id'] = id;
2034
2205
  }
2035
2206
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -2041,30 +2212,30 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2041
2212
  };
2042
2213
  },
2043
2214
  /**
2044
- *
2045
- * @summary Updates a schedule
2046
- * @param {ScheduleUpdateRequest} scheduleUpdateRequest
2215
+ * Parses a message\'s custom context relevant to your organization. This is useful for extracting information from a message to drive your auto reply workflows.
2216
+ * @summary Parse a message\'s custom context relevant to your organization
2217
+ * @param {ParseRequest} parseRequest
2047
2218
  * @param {*} [options] Override http request option.
2048
2219
  * @throws {RequiredError}
2049
2220
  */
2050
- scheduleUpdate: async (scheduleUpdateRequest, options = {}) => {
2051
- // verify required parameter 'scheduleUpdateRequest' is not null or undefined
2052
- (0, common_1.assertParamExists)('scheduleUpdate', 'scheduleUpdateRequest', scheduleUpdateRequest);
2053
- const localVarPath = `/v1-schedule`;
2221
+ parse: async (parseRequest, options = {}) => {
2222
+ // verify required parameter 'parseRequest' is not null or undefined
2223
+ (0, common_1.assertParamExists)('parse', 'parseRequest', parseRequest);
2224
+ const localVarPath = `/v1-parse`;
2054
2225
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2055
2226
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2056
2227
  let baseOptions;
2057
2228
  if (configuration) {
2058
2229
  baseOptions = configuration.baseOptions;
2059
2230
  }
2060
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
2231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2061
2232
  const localVarHeaderParameter = {};
2062
2233
  const localVarQueryParameter = {};
2063
2234
  localVarHeaderParameter['Content-Type'] = 'application/json';
2064
2235
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2065
2236
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2066
2237
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2067
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(scheduleUpdateRequest, localVarRequestOptions, configuration);
2238
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(parseRequest, localVarRequestOptions, configuration);
2068
2239
  return {
2069
2240
  url: (0, common_1.toPathString)(localVarUrlObj),
2070
2241
  options: localVarRequestOptions,
@@ -2072,60 +2243,65 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2072
2243
  },
2073
2244
  /**
2074
2245
  *
2075
- * @summary Gets a workflow
2076
- * @param {string} id id of entity to query
2246
+ * @summary Purchase phone for a given agent.
2247
+ * @param {PurchasePhoneRequest} [purchasePhoneRequest] If no agent id is provided, the phone will be purchased for the owner of the API key.
2077
2248
  * @param {*} [options] Override http request option.
2078
2249
  * @throws {RequiredError}
2079
2250
  */
2080
- workflow: async (id, options = {}) => {
2081
- // verify required parameter 'id' is not null or undefined
2082
- (0, common_1.assertParamExists)('workflow', 'id', id);
2083
- const localVarPath = `/v1-workflow`;
2251
+ purchasePhone: async (purchasePhoneRequest, options = {}) => {
2252
+ const localVarPath = `/v1-purchases-phone`;
2084
2253
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2085
2254
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2086
2255
  let baseOptions;
2087
2256
  if (configuration) {
2088
2257
  baseOptions = configuration.baseOptions;
2089
2258
  }
2090
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2259
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2091
2260
  const localVarHeaderParameter = {};
2092
2261
  const localVarQueryParameter = {};
2093
- if (id !== undefined) {
2094
- localVarQueryParameter['id'] = id;
2095
- }
2262
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2096
2263
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2097
2264
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2098
2265
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2266
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(purchasePhoneRequest, localVarRequestOptions, configuration);
2099
2267
  return {
2100
2268
  url: (0, common_1.toPathString)(localVarUrlObj),
2101
2269
  options: localVarRequestOptions,
2102
2270
  };
2103
2271
  },
2104
2272
  /**
2105
- *
2106
- * @summary Create a new workflow
2107
- * @param {CreateWorkflowRequest} createWorkflowRequest
2273
+ * Replaces an existing entity with the specified type and ID with a new entity.
2274
+ * @summary Replace an existing entity
2275
+ * @param {string} type
2276
+ * @param {string} id
2277
+ * @param {EntityData} entityData
2108
2278
  * @param {*} [options] Override http request option.
2109
2279
  * @throws {RequiredError}
2110
2280
  */
2111
- workflowCreate: async (createWorkflowRequest, options = {}) => {
2112
- // verify required parameter 'createWorkflowRequest' is not null or undefined
2113
- (0, common_1.assertParamExists)('workflowCreate', 'createWorkflowRequest', createWorkflowRequest);
2114
- const localVarPath = `/v1-workflow`;
2281
+ replaceEntity: async (type, id, entityData, options = {}) => {
2282
+ // verify required parameter 'type' is not null or undefined
2283
+ (0, common_1.assertParamExists)('replaceEntity', 'type', type);
2284
+ // verify required parameter 'id' is not null or undefined
2285
+ (0, common_1.assertParamExists)('replaceEntity', 'id', id);
2286
+ // verify required parameter 'entityData' is not null or undefined
2287
+ (0, common_1.assertParamExists)('replaceEntity', 'entityData', entityData);
2288
+ const localVarPath = `/v1-entity/{type}/{id}`
2289
+ .replace(`{${"type"}}`, encodeURIComponent(String(type)))
2290
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2115
2291
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2116
2292
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2117
2293
  let baseOptions;
2118
2294
  if (configuration) {
2119
2295
  baseOptions = configuration.baseOptions;
2120
2296
  }
2121
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2297
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
2122
2298
  const localVarHeaderParameter = {};
2123
2299
  const localVarQueryParameter = {};
2124
2300
  localVarHeaderParameter['Content-Type'] = 'application/json';
2125
2301
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2126
2302
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2127
2303
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2128
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createWorkflowRequest, localVarRequestOptions, configuration);
2304
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(entityData, localVarRequestOptions, configuration);
2129
2305
  return {
2130
2306
  url: (0, common_1.toPathString)(localVarUrlObj),
2131
2307
  options: localVarRequestOptions,
@@ -2133,30 +2309,29 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2133
2309
  },
2134
2310
  /**
2135
2311
  *
2136
- * @summary Deletes a workflow
2137
- * @param {string} id id of entity to query
2312
+ * @summary Runs your auto-reply app on the Scout9 platform.
2313
+ * @param {WorkflowEvent} workflowEvent
2138
2314
  * @param {*} [options] Override http request option.
2139
2315
  * @throws {RequiredError}
2140
2316
  */
2141
- workflowDelete: async (id, options = {}) => {
2142
- // verify required parameter 'id' is not null or undefined
2143
- (0, common_1.assertParamExists)('workflowDelete', 'id', id);
2144
- const localVarPath = `/v1-workflow`;
2317
+ runPlatform: async (workflowEvent, options = {}) => {
2318
+ // verify required parameter 'workflowEvent' is not null or undefined
2319
+ (0, common_1.assertParamExists)('runPlatform', 'workflowEvent', workflowEvent);
2320
+ const localVarPath = `/v1-utils-platform-run`;
2145
2321
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2146
2322
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2147
2323
  let baseOptions;
2148
2324
  if (configuration) {
2149
2325
  baseOptions = configuration.baseOptions;
2150
2326
  }
2151
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
2327
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2152
2328
  const localVarHeaderParameter = {};
2153
2329
  const localVarQueryParameter = {};
2154
- if (id !== undefined) {
2155
- localVarQueryParameter['id'] = id;
2156
- }
2330
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2157
2331
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2158
2332
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2159
2333
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2334
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(workflowEvent, localVarRequestOptions, configuration);
2160
2335
  return {
2161
2336
  url: (0, common_1.toPathString)(localVarUrlObj),
2162
2337
  options: localVarRequestOptions,
@@ -2164,78 +2339,74 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2164
2339
  },
2165
2340
  /**
2166
2341
  *
2167
- * @summary Update a workflow
2168
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
2342
+ * @summary Returns the platform run config
2169
2343
  * @param {*} [options] Override http request option.
2170
2344
  * @throws {RequiredError}
2171
2345
  */
2172
- workflowUpdate: async (updateWorkflowRequest, options = {}) => {
2173
- // verify required parameter 'updateWorkflowRequest' is not null or undefined
2174
- (0, common_1.assertParamExists)('workflowUpdate', 'updateWorkflowRequest', updateWorkflowRequest);
2175
- const localVarPath = `/v1-workflow`;
2346
+ runPlatformConfig: async (options = {}) => {
2347
+ const localVarPath = `/v1-utils-platform-run`;
2176
2348
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2177
2349
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2178
2350
  let baseOptions;
2179
2351
  if (configuration) {
2180
2352
  baseOptions = configuration.baseOptions;
2181
2353
  }
2182
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
2354
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2183
2355
  const localVarHeaderParameter = {};
2184
2356
  const localVarQueryParameter = {};
2185
- localVarHeaderParameter['Content-Type'] = 'application/json';
2186
2357
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2187
2358
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2188
2359
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2189
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateWorkflowRequest, localVarRequestOptions, configuration);
2190
2360
  return {
2191
2361
  url: (0, common_1.toPathString)(localVarUrlObj),
2192
2362
  options: localVarRequestOptions,
2193
2363
  };
2194
2364
  },
2195
2365
  /**
2196
- *
2197
- * @summary Gets all or specific set of workflows
2198
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2199
- * @param {Array<string>} [id] ids for the entities this id belongs to
2366
+ * xxx
2367
+ * @summary xxx
2368
+ * @param {GenerateRequest} generateRequest
2369
+ * @param {string} [convo] xxx
2200
2370
  * @param {*} [options] Override http request option.
2201
2371
  * @throws {RequiredError}
2202
2372
  */
2203
- workflows: async (q, id, options = {}) => {
2204
- const localVarPath = `/v1-workflows`;
2373
+ temp: async (generateRequest, convo, options = {}) => {
2374
+ // verify required parameter 'generateRequest' is not null or undefined
2375
+ (0, common_1.assertParamExists)('temp', 'generateRequest', generateRequest);
2376
+ const localVarPath = `/v1-temp`;
2205
2377
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2206
2378
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2207
2379
  let baseOptions;
2208
2380
  if (configuration) {
2209
2381
  baseOptions = configuration.baseOptions;
2210
2382
  }
2211
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2383
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2212
2384
  const localVarHeaderParameter = {};
2213
2385
  const localVarQueryParameter = {};
2214
- if (q !== undefined) {
2215
- localVarQueryParameter['q'] = q;
2216
- }
2217
- if (id) {
2218
- localVarQueryParameter['id'] = id;
2386
+ if (convo !== undefined) {
2387
+ localVarQueryParameter['convo'] = convo;
2219
2388
  }
2389
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2220
2390
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2221
2391
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2222
2392
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2393
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateRequest, localVarRequestOptions, configuration);
2223
2394
  return {
2224
2395
  url: (0, common_1.toPathString)(localVarUrlObj),
2225
2396
  options: localVarRequestOptions,
2226
2397
  };
2227
2398
  },
2228
2399
  /**
2229
- *
2230
- * @summary Creates new workflows
2231
- * @param {CreateWorkflowsRequest} createWorkflowsRequest
2400
+ * Trains a PMT model based on the uploaded transcripts provided (Will include the ability to add more transcripts)
2401
+ * @summary Trains a given or default persona\'s PMT model
2402
+ * @param {PmtTrainRequest} pmtTrainRequest
2232
2403
  * @param {*} [options] Override http request option.
2233
2404
  * @throws {RequiredError}
2234
2405
  */
2235
- workflowsCreate: async (createWorkflowsRequest, options = {}) => {
2236
- // verify required parameter 'createWorkflowsRequest' is not null or undefined
2237
- (0, common_1.assertParamExists)('workflowsCreate', 'createWorkflowsRequest', createWorkflowsRequest);
2238
- const localVarPath = `/v1-workflows`;
2406
+ train: async (pmtTrainRequest, options = {}) => {
2407
+ // verify required parameter 'pmtTrainRequest' is not null or undefined
2408
+ (0, common_1.assertParamExists)('train', 'pmtTrainRequest', pmtTrainRequest);
2409
+ const localVarPath = `/v1-pmt-train`;
2239
2410
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2240
2411
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2241
2412
  let baseOptions;
@@ -2249,323 +2420,255 @@ const Scout9ApiAxiosParamCreator = function (configuration) {
2249
2420
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2250
2421
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2251
2422
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2252
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createWorkflowsRequest, localVarRequestOptions, configuration);
2423
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(pmtTrainRequest, localVarRequestOptions, configuration);
2253
2424
  return {
2254
2425
  url: (0, common_1.toPathString)(localVarUrlObj),
2255
2426
  options: localVarRequestOptions,
2256
2427
  };
2257
2428
  },
2258
2429
  /**
2259
- *
2260
- * @summary Deletes multiple workflows
2261
- * @param {Array<string>} [id] ids for the entities this id belongs to
2430
+ * Transforms a given message and context into the owners own words. Failure to transform would be a lack of transcription data or the message detected as not applicable to the owners intended use.
2431
+ * @summary Transforms a given message and context into the owners own words
2432
+ * @param {PmtTransformRequest} pmtTransformRequest
2262
2433
  * @param {*} [options] Override http request option.
2263
2434
  * @throws {RequiredError}
2264
2435
  */
2265
- workflowsDelete: async (id, options = {}) => {
2266
- const localVarPath = `/v1-workflows`;
2436
+ transform: async (pmtTransformRequest, options = {}) => {
2437
+ // verify required parameter 'pmtTransformRequest' is not null or undefined
2438
+ (0, common_1.assertParamExists)('transform', 'pmtTransformRequest', pmtTransformRequest);
2439
+ const localVarPath = `/v1-pmt-transform`;
2267
2440
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2268
2441
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2269
2442
  let baseOptions;
2270
2443
  if (configuration) {
2271
2444
  baseOptions = configuration.baseOptions;
2272
2445
  }
2273
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
2446
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2274
2447
  const localVarHeaderParameter = {};
2275
2448
  const localVarQueryParameter = {};
2276
- if (id) {
2277
- localVarQueryParameter['id'] = id;
2278
- }
2449
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2279
2450
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2280
2451
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2281
2452
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2453
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(pmtTransformRequest, localVarRequestOptions, configuration);
2282
2454
  return {
2283
2455
  url: (0, common_1.toPathString)(localVarUrlObj),
2284
2456
  options: localVarRequestOptions,
2285
2457
  };
2286
2458
  },
2287
2459
  /**
2288
- *
2289
- * @summary Updates multiple workflows
2290
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
2460
+ * Updates an existing entity with the specified type and ID.
2461
+ * @summary Update an existing entity
2462
+ * @param {string} type
2463
+ * @param {string} id
2464
+ * @param {EntityData} entityData
2291
2465
  * @param {*} [options] Override http request option.
2292
2466
  * @throws {RequiredError}
2293
2467
  */
2294
- workflowsUpdate: async (updateWorkflowRequest, options = {}) => {
2295
- // verify required parameter 'updateWorkflowRequest' is not null or undefined
2296
- (0, common_1.assertParamExists)('workflowsUpdate', 'updateWorkflowRequest', updateWorkflowRequest);
2297
- const localVarPath = `/v1-workflows`;
2468
+ updateEntity: async (type, id, entityData, options = {}) => {
2469
+ // verify required parameter 'type' is not null or undefined
2470
+ (0, common_1.assertParamExists)('updateEntity', 'type', type);
2471
+ // verify required parameter 'id' is not null or undefined
2472
+ (0, common_1.assertParamExists)('updateEntity', 'id', id);
2473
+ // verify required parameter 'entityData' is not null or undefined
2474
+ (0, common_1.assertParamExists)('updateEntity', 'entityData', entityData);
2475
+ const localVarPath = `/v1-entity/{type}/{id}`
2476
+ .replace(`{${"type"}}`, encodeURIComponent(String(type)))
2477
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2298
2478
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2299
2479
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2300
2480
  let baseOptions;
2301
2481
  if (configuration) {
2302
2482
  baseOptions = configuration.baseOptions;
2303
2483
  }
2304
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
2484
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options };
2305
2485
  const localVarHeaderParameter = {};
2306
2486
  const localVarQueryParameter = {};
2307
2487
  localVarHeaderParameter['Content-Type'] = 'application/json';
2308
2488
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2309
2489
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2310
2490
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2311
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateWorkflowRequest, localVarRequestOptions, configuration);
2491
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(entityData, localVarRequestOptions, configuration);
2312
2492
  return {
2313
2493
  url: (0, common_1.toPathString)(localVarUrlObj),
2314
2494
  options: localVarRequestOptions,
2315
2495
  };
2316
2496
  },
2317
- };
2318
- };
2319
- exports.Scout9ApiAxiosParamCreator = Scout9ApiAxiosParamCreator;
2320
- /**
2321
- * Scout9Api - functional programming interface
2322
- * @export
2323
- */
2324
- const Scout9ApiFp = function (configuration) {
2325
- const localVarAxiosParamCreator = (0, exports.Scout9ApiAxiosParamCreator)(configuration);
2326
- return {
2327
- /**
2328
- *
2329
- * @summary Gets a agent
2330
- * @param {string} id id of entity to query
2331
- * @param {*} [options] Override http request option.
2332
- * @throws {RequiredError}
2333
- */
2334
- async agent(id, options) {
2335
- const localVarAxiosArgs = await localVarAxiosParamCreator.agent(id, options);
2336
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2337
- },
2338
- /**
2339
- *
2340
- * @summary Deletes a agent
2341
- * @param {string} id id of entity to query
2342
- * @param {*} [options] Override http request option.
2343
- * @throws {RequiredError}
2344
- */
2345
- async agentDelete(id, options) {
2346
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
2347
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2348
- },
2349
- /**
2350
- *
2351
- * @summary Registers a new agent
2352
- * @param {CreateAgentRequest} createAgentRequest
2353
- * @param {*} [options] Override http request option.
2354
- * @throws {RequiredError}
2355
- */
2356
- async agentRegister(createAgentRequest, options) {
2357
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentRegister(createAgentRequest, options);
2358
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2359
- },
2360
- /**
2361
- *
2362
- * @summary Update a agent
2363
- * @param {UpdateAgentRequest} updateAgentRequest
2364
- * @param {*} [options] Override http request option.
2365
- * @throws {RequiredError}
2366
- */
2367
- async agentUpdate(updateAgentRequest, options) {
2368
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentUpdate(updateAgentRequest, options);
2369
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2370
- },
2371
- /**
2372
- *
2373
- * @summary Gets all or specific set of agents
2374
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2375
- * @param {Array<string>} [id] ids for the entities this id belongs to
2376
- * @param {*} [options] Override http request option.
2377
- * @throws {RequiredError}
2378
- */
2379
- async agents(q, id, options) {
2380
- const localVarAxiosArgs = await localVarAxiosParamCreator.agents(q, id, options);
2381
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2382
- },
2383
- /**
2384
- *
2385
- * @summary Creates new agents
2386
- * @param {CreateAgentsRequest} createAgentsRequest
2387
- * @param {*} [options] Override http request option.
2388
- * @throws {RequiredError}
2389
- */
2390
- async agentsCreate(createAgentsRequest, options) {
2391
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentsCreate(createAgentsRequest, options);
2392
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2393
- },
2394
- /**
2395
- *
2396
- * @summary Deletes multiple agents
2397
- * @param {Array<string>} [id] ids for the entities this id belongs to
2398
- * @param {*} [options] Override http request option.
2399
- * @throws {RequiredError}
2400
- */
2401
- async agentsDelete(id, options) {
2402
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentsDelete(id, options);
2403
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2404
- },
2497
+ };
2498
+ };
2499
+ exports.Scout9ApiAxiosParamCreator = Scout9ApiAxiosParamCreator;
2500
+ /**
2501
+ * Scout9Api - functional programming interface
2502
+ * @export
2503
+ */
2504
+ const Scout9ApiFp = function (configuration) {
2505
+ const localVarAxiosParamCreator = (0, exports.Scout9ApiAxiosParamCreator)(configuration);
2506
+ return {
2405
2507
  /**
2406
2508
  *
2407
- * @summary Updates multiple agents
2408
- * @param {UpdateAgentsRequest} updateAgentsRequest
2509
+ * @summary Create a new entity
2510
+ * @param {string} type
2511
+ * @param {string} id The unique identifier of the entity
2512
+ * @param {EntityData} entityData
2409
2513
  * @param {*} [options] Override http request option.
2410
2514
  * @throws {RequiredError}
2411
2515
  */
2412
- async agentsUpdate(updateAgentsRequest, options) {
2413
- const localVarAxiosArgs = await localVarAxiosParamCreator.agentsUpdate(updateAgentsRequest, options);
2516
+ async addEntity(type, id, entityData, options) {
2517
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addEntity(type, id, entityData, options);
2414
2518
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2415
2519
  },
2416
2520
  /**
2417
2521
  *
2418
- * @summary Gets a context
2522
+ * @summary Gets a agent
2419
2523
  * @param {string} id id of entity to query
2420
2524
  * @param {*} [options] Override http request option.
2421
2525
  * @throws {RequiredError}
2422
2526
  */
2423
- async context(id, options) {
2424
- const localVarAxiosArgs = await localVarAxiosParamCreator.context(id, options);
2527
+ async agent(id, options) {
2528
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agent(id, options);
2425
2529
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2426
2530
  },
2427
2531
  /**
2428
2532
  *
2429
- * @summary Create a new context
2430
- * @param {CreateContextRequest} createContextRequest
2533
+ * @summary Deletes a agent
2534
+ * @param {string} id id of entity to query
2431
2535
  * @param {*} [options] Override http request option.
2432
2536
  * @throws {RequiredError}
2433
2537
  */
2434
- async contextCreate(createContextRequest, options) {
2435
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextCreate(createContextRequest, options);
2538
+ async agentDelete(id, options) {
2539
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentDelete(id, options);
2436
2540
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2437
2541
  },
2438
2542
  /**
2439
2543
  *
2440
- * @summary Gets context data
2441
- * @param {string} id id of entity to query
2544
+ * @summary Registers a new agent
2545
+ * @param {CreateAgentRequest} createAgentRequest
2442
2546
  * @param {*} [options] Override http request option.
2443
2547
  * @throws {RequiredError}
2444
2548
  */
2445
- async contextData(id, options) {
2446
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextData(id, options);
2549
+ async agentRegister(createAgentRequest, options) {
2550
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentRegister(createAgentRequest, options);
2447
2551
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2448
2552
  },
2449
2553
  /**
2450
2554
  *
2451
- * @summary Create a new context data
2452
- * @param {CreateContextDataRequest} createContextDataRequest
2555
+ * @summary Update a agent
2556
+ * @param {UpdateAgentRequest} updateAgentRequest
2453
2557
  * @param {*} [options] Override http request option.
2454
2558
  * @throws {RequiredError}
2455
2559
  */
2456
- async contextDataCreate(createContextDataRequest, options) {
2457
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextDataCreate(createContextDataRequest, options);
2560
+ async agentUpdate(updateAgentRequest, options) {
2561
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentUpdate(updateAgentRequest, options);
2458
2562
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2459
2563
  },
2460
2564
  /**
2461
2565
  *
2462
- * @summary Deletes a schedule
2463
- * @param {string} id id of entity to query
2566
+ * @summary Gets all or specific set of agents
2567
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2568
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2464
2569
  * @param {*} [options] Override http request option.
2465
2570
  * @throws {RequiredError}
2466
2571
  */
2467
- async contextDataDelete(id, options) {
2468
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextDataDelete(id, options);
2572
+ async agents(q, id, options) {
2573
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agents(q, id, options);
2469
2574
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2470
2575
  },
2471
2576
  /**
2472
2577
  *
2473
- * @summary Update a context data
2474
- * @param {UpdateContextDataRequest} updateContextDataRequest
2578
+ * @summary Creates new agents
2579
+ * @param {CreateAgentsRequest} createAgentsRequest
2475
2580
  * @param {*} [options] Override http request option.
2476
2581
  * @throws {RequiredError}
2477
2582
  */
2478
- async contextDataUpdate(updateContextDataRequest, options) {
2479
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextDataUpdate(updateContextDataRequest, options);
2583
+ async agentsCreate(createAgentsRequest, options) {
2584
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentsCreate(createAgentsRequest, options);
2480
2585
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2481
2586
  },
2482
2587
  /**
2483
2588
  *
2484
- * @summary Deletes a schedule
2485
- * @param {string} id id of entity to query
2589
+ * @summary Deletes multiple agents
2590
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2486
2591
  * @param {*} [options] Override http request option.
2487
2592
  * @throws {RequiredError}
2488
2593
  */
2489
- async contextDelete(id, options) {
2490
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextDelete(id, options);
2594
+ async agentsDelete(id, options) {
2595
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentsDelete(id, options);
2491
2596
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2492
2597
  },
2493
2598
  /**
2494
2599
  *
2495
- * @summary Test a custom context before training
2496
- * @param {ContextTestRequest} contextTestRequest
2600
+ * @summary Updates multiple agents
2601
+ * @param {UpdateAgentsRequest} updateAgentsRequest
2497
2602
  * @param {*} [options] Override http request option.
2498
2603
  * @throws {RequiredError}
2499
2604
  */
2500
- async contextTest(contextTestRequest, options) {
2501
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextTest(contextTestRequest, options);
2605
+ async agentsUpdate(updateAgentsRequest, options) {
2606
+ const localVarAxiosArgs = await localVarAxiosParamCreator.agentsUpdate(updateAgentsRequest, options);
2502
2607
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2503
2608
  },
2504
2609
  /**
2505
2610
  *
2506
- * @summary Update a context
2507
- * @param {UpdateContextRequest} updateContextRequest
2611
+ * @summary Natural language prompt to resolve a context value derived from the conversation.
2612
+ * @param {MacroContextInput} macroContextInput
2508
2613
  * @param {*} [options] Override http request option.
2509
2614
  * @throws {RequiredError}
2510
2615
  */
2511
- async contextUpdate(updateContextRequest, options) {
2512
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextUpdate(updateContextRequest, options);
2616
+ async captureContext(macroContextInput, options) {
2617
+ const localVarAxiosArgs = await localVarAxiosParamCreator.captureContext(macroContextInput, options);
2513
2618
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2514
2619
  },
2515
2620
  /**
2516
2621
  *
2517
- * @summary Gets all or specific set of contexts
2518
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2519
- * @param {Array<string>} [id] ids for the entities this id belongs to
2622
+ * @summary Get the current project configuration
2520
2623
  * @param {*} [options] Override http request option.
2521
2624
  * @throws {RequiredError}
2522
2625
  */
2523
- async contexts(q, id, options) {
2524
- const localVarAxiosArgs = await localVarAxiosParamCreator.contexts(q, id, options);
2626
+ async config(options) {
2627
+ const localVarAxiosArgs = await localVarAxiosParamCreator.config(options);
2525
2628
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2526
2629
  },
2527
2630
  /**
2528
- *
2529
- * @summary Creates new contexts
2530
- * @param {CreateContextsRequest} createContextsRequest
2631
+ * Runs contextualization on workflow event messages and returns contextualized messages.
2632
+ * @summary Contextualize workflow event messages
2633
+ * @param {ContextualizerRequest} contextualizerRequest
2531
2634
  * @param {*} [options] Override http request option.
2532
2635
  * @throws {RequiredError}
2533
2636
  */
2534
- async contextsCreate(createContextsRequest, options) {
2535
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextsCreate(createContextsRequest, options);
2637
+ async contextualize(contextualizerRequest, options) {
2638
+ const localVarAxiosArgs = await localVarAxiosParamCreator.contextualize(contextualizerRequest, options);
2536
2639
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2537
2640
  },
2538
2641
  /**
2539
2642
  *
2540
- * @summary Deletes multiple contexts
2541
- * @param {Array<string>} [id] ids for the entities this id belongs to
2643
+ * @summary Gets a conversation
2644
+ * @param {string} id id of entity to query
2542
2645
  * @param {*} [options] Override http request option.
2543
2646
  * @throws {RequiredError}
2544
2647
  */
2545
- async contextsDelete(id, options) {
2546
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextsDelete(id, options);
2648
+ async conversation(id, options) {
2649
+ const localVarAxiosArgs = await localVarAxiosParamCreator.conversation(id, options);
2547
2650
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2548
2651
  },
2549
2652
  /**
2550
2653
  *
2551
- * @summary Updates multiple contexts
2552
- * @param {UpdateContextRequest} updateContextRequest
2654
+ * @summary Gets a conversation
2655
+ * @param {string} id id of entity to query
2553
2656
  * @param {*} [options] Override http request option.
2554
2657
  * @throws {RequiredError}
2555
2658
  */
2556
- async contextsUpdate(updateContextRequest, options) {
2557
- const localVarAxiosArgs = await localVarAxiosParamCreator.contextsUpdate(updateContextRequest, options);
2659
+ async conversationContext(id, options) {
2660
+ const localVarAxiosArgs = await localVarAxiosParamCreator.conversationContext(id, options);
2558
2661
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2559
2662
  },
2560
2663
  /**
2561
2664
  *
2562
- * @summary Gets a conversation
2563
- * @param {string} id id of entity to query
2665
+ * @summary Update a conversation
2666
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
2564
2667
  * @param {*} [options] Override http request option.
2565
2668
  * @throws {RequiredError}
2566
2669
  */
2567
- async conversation(id, options) {
2568
- const localVarAxiosArgs = await localVarAxiosParamCreator.conversation(id, options);
2670
+ async conversationContextUpdate(conversationContextUpdateRequest, options) {
2671
+ const localVarAxiosArgs = await localVarAxiosParamCreator.conversationContextUpdate(conversationContextUpdateRequest, options);
2569
2672
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2570
2673
  },
2571
2674
  /**
@@ -2601,26 +2704,39 @@ const Scout9ApiFp = function (configuration) {
2601
2704
  const localVarAxiosArgs = await localVarAxiosParamCreator.conversationUpdate(conversationUpdateRequest, options);
2602
2705
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2603
2706
  },
2707
+ /**
2708
+ *
2709
+ * @summary Gets all or specific set of conversations
2710
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2711
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2712
+ * @param {*} [options] Override http request option.
2713
+ * @throws {RequiredError}
2714
+ */
2715
+ async conversations(q, id, options) {
2716
+ const localVarAxiosArgs = await localVarAxiosParamCreator.conversations(q, id, options);
2717
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2718
+ },
2604
2719
  /**
2605
2720
  *
2606
2721
  * @summary Gets a customer
2607
- * @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
2722
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
2723
+ * @param {boolean} [resolve] If a email or phone is provided and the customer doesn\&#39;t exist, it will automatically create one
2608
2724
  * @param {*} [options] Override http request option.
2609
2725
  * @throws {RequiredError}
2610
2726
  */
2611
- async customer(idOrEmailOrPhone, options) {
2612
- const localVarAxiosArgs = await localVarAxiosParamCreator.customer(idOrEmailOrPhone, options);
2727
+ async customer(idOrEmailOrPhone, resolve, options) {
2728
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customer(idOrEmailOrPhone, resolve, options);
2613
2729
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2614
2730
  },
2615
2731
  /**
2616
2732
  *
2617
2733
  * @summary Creates a new customer
2618
- * @param {CreateCustomerRequest} createCustomerRequest
2734
+ * @param {Customer} body
2619
2735
  * @param {*} [options] Override http request option.
2620
2736
  * @throws {RequiredError}
2621
2737
  */
2622
- async customerCreate(createCustomerRequest, options) {
2623
- const localVarAxiosArgs = await localVarAxiosParamCreator.customerCreate(createCustomerRequest, options);
2738
+ async customerCreate(body, options) {
2739
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customerCreate(body, options);
2624
2740
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2625
2741
  },
2626
2742
  /**
@@ -2771,301 +2887,295 @@ const Scout9ApiFp = function (configuration) {
2771
2887
  /**
2772
2888
  *
2773
2889
  * @summary Updates multiple customers
2774
- * @param {UpdateCustomerRequest} updateCustomerRequest
2890
+ * @param {UpdateCustomersRequest} updateCustomersRequest
2775
2891
  * @param {*} [options] Override http request option.
2776
2892
  * @throws {RequiredError}
2777
2893
  */
2778
- async customersUpdate(updateCustomerRequest, options) {
2779
- const localVarAxiosArgs = await localVarAxiosParamCreator.customersUpdate(updateCustomerRequest, options);
2894
+ async customersUpdate(updateCustomersRequest, options) {
2895
+ const localVarAxiosArgs = await localVarAxiosParamCreator.customersUpdate(updateCustomersRequest, options);
2780
2896
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2781
2897
  },
2782
2898
  /**
2783
- *
2784
- * @summary Returns information about a specific file.
2785
- * @param {string} fileId The ID of the file to use for this request
2899
+ * Deletes an entity with the specified type and ID.
2900
+ * @summary Delete an entity
2901
+ * @param {string} type
2902
+ * @param {string} id
2786
2903
  * @param {*} [options] Override http request option.
2787
2904
  * @throws {RequiredError}
2788
2905
  */
2789
- async file(fileId, options) {
2790
- const localVarAxiosArgs = await localVarAxiosParamCreator.file(fileId, options);
2906
+ async deleteEntity(type, id, options) {
2907
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteEntity(type, id, options);
2791
2908
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2792
2909
  },
2793
2910
  /**
2794
2911
  *
2795
- * @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.
2796
- * @param {File} file
2797
- * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
2912
+ * @summary Natural language prompt to resolve to a boolean value.
2913
+ * @param {MacroDidInput} macroDidInput
2798
2914
  * @param {*} [options] Override http request option.
2799
2915
  * @throws {RequiredError}
2800
2916
  */
2801
- async fileCreate(file, purpose, options) {
2802
- const localVarAxiosArgs = await localVarAxiosParamCreator.fileCreate(file, purpose, options);
2917
+ async did(macroDidInput, options) {
2918
+ const localVarAxiosArgs = await localVarAxiosParamCreator.did(macroDidInput, options);
2803
2919
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2804
2920
  },
2805
2921
  /**
2806
2922
  *
2807
- * @summary Delete a file.
2808
- * @param {string} fileId The ID of the file to use for this request
2923
+ * @summary Natural language prompt to resolve to a boolean value in relation to the given immediate message.
2924
+ * @param {MacroDoesInput} macroDoesInput
2809
2925
  * @param {*} [options] Override http request option.
2810
2926
  * @throws {RequiredError}
2811
2927
  */
2812
- async fileDelete(fileId, options) {
2813
- const localVarAxiosArgs = await localVarAxiosParamCreator.fileDelete(fileId, options);
2928
+ async does(macroDoesInput, options) {
2929
+ const localVarAxiosArgs = await localVarAxiosParamCreator.does(macroDoesInput, options);
2814
2930
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2815
2931
  },
2816
2932
  /**
2817
2933
  *
2818
- * @summary Returns the contents of the specified file
2819
- * @param {string} fileId The ID of the file to use for this request
2934
+ * @summary Get an entity by type and ID
2935
+ * @param {string} type The type of the entity to fetch
2936
+ * @param {string} id The unique identifier of the entity
2820
2937
  * @param {*} [options] Override http request option.
2821
2938
  * @throws {RequiredError}
2822
2939
  */
2823
- async fileDownload(fileId, options) {
2824
- const localVarAxiosArgs = await localVarAxiosParamCreator.fileDownload(fileId, options);
2940
+ async entity(type, id, options) {
2941
+ const localVarAxiosArgs = await localVarAxiosParamCreator.entity(type, id, options);
2825
2942
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2826
2943
  },
2827
2944
  /**
2828
2945
  *
2829
- * @summary Returns a list of files that belong to the user\'s organization.
2830
- * @param {*} [options] Override http request option.
2831
- * @throws {RequiredError}
2832
- */
2833
- async files(options) {
2834
- const localVarAxiosArgs = await localVarAxiosParamCreator.files(options);
2835
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2836
- },
2837
- /**
2838
- * 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.
2839
- * @summary Generate a message from conversation
2840
- * @param {GenerateRequest} generateRequest
2841
- * @param {*} [options] Override http request option.
2842
- * @throws {RequiredError}
2843
- */
2844
- async generate(generateRequest, options) {
2845
- const localVarAxiosArgs = await localVarAxiosParamCreator.generate(generateRequest, options);
2846
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2847
- },
2848
- /**
2849
- * 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
2850
- * @summary Create and send message
2851
- * @param {MessageCreateRequest} messageCreateRequest
2946
+ * @summary Returns a file
2947
+ * @param {string} purpose File categorical purpose
2948
+ * @param {string} [entity] File entity id
2949
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
2852
2950
  * @param {*} [options] Override http request option.
2853
2951
  * @throws {RequiredError}
2854
2952
  */
2855
- async message(messageCreateRequest, options) {
2856
- const localVarAxiosArgs = await localVarAxiosParamCreator.message(messageCreateRequest, options);
2953
+ async file(purpose, entity, agent, options) {
2954
+ const localVarAxiosArgs = await localVarAxiosParamCreator.file(purpose, entity, agent, options);
2857
2955
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2858
2956
  },
2859
2957
  /**
2860
2958
  *
2861
- * @summary Get all messages from a conversation
2862
- * @param {string} id id of entity to query
2863
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2959
+ * @summary Remove a file
2960
+ * @param {string} purpose File categorical purpose
2961
+ * @param {string} entity File entity id
2962
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
2864
2963
  * @param {*} [options] Override http request option.
2865
2964
  * @throws {RequiredError}
2866
2965
  */
2867
- async messages(id, q, options) {
2868
- const localVarAxiosArgs = await localVarAxiosParamCreator.messages(id, q, options);
2966
+ async fileRemove(purpose, entity, agent, options) {
2967
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileRemove(purpose, entity, agent, options);
2869
2968
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2870
2969
  },
2871
2970
  /**
2872
2971
  *
2873
- * @summary Get the results of a bulk API operation
2874
- * @param {string} id id of entity to query
2972
+ * @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.
2973
+ * @param {File} file
2974
+ * @param {PurposeEnum} [purpose]
2975
+ * @param {string} [context] Additional information about this file
2976
+ * @param {string} [entity] The entity id, if not provided the entity id becomes the provided file name
2977
+ * @param {string} [$agent] The agent that this file belongs to. Only used for entity.audio and entity.transcript files.
2875
2978
  * @param {*} [options] Override http request option.
2876
2979
  * @throws {RequiredError}
2877
2980
  */
2878
- async operation(id, options) {
2879
- const localVarAxiosArgs = await localVarAxiosParamCreator.operation(id, options);
2981
+ async fileUpload(file, purpose, context, entity, $agent, options) {
2982
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileUpload(file, purpose, context, entity, $agent, options);
2880
2983
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2881
2984
  },
2882
2985
  /**
2883
2986
  *
2884
- * @summary Gets all or specific set of bulk API operations
2885
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2886
- * @param {Array<string>} [id] ids for the entities this id belongs to
2987
+ * @summary Returns a list of files that belong to the user\'s organization.
2988
+ * @param {string} purpose File categorical purpose
2989
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
2887
2990
  * @param {*} [options] Override http request option.
2888
2991
  * @throws {RequiredError}
2889
2992
  */
2890
- async operations(q, id, options) {
2891
- const localVarAxiosArgs = await localVarAxiosParamCreator.operations(q, id, options);
2993
+ async files(purpose, agent, options) {
2994
+ const localVarAxiosArgs = await localVarAxiosParamCreator.files(purpose, agent, options);
2892
2995
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2893
2996
  },
2894
2997
  /**
2895
- *
2896
- * @summary Creates a new scheduled conversation
2897
- * @param {ScheduleCreateRequest} scheduleCreateRequest
2998
+ * Forwards a locked conversation to agent
2999
+ * @summary forwards a locked conversation to agent
3000
+ * @param {ForwardRequest} forwardRequest
2898
3001
  * @param {*} [options] Override http request option.
2899
3002
  * @throws {RequiredError}
2900
3003
  */
2901
- async scheduleConversation(scheduleCreateRequest, options) {
2902
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleConversation(scheduleCreateRequest, options);
3004
+ async forward(forwardRequest, options) {
3005
+ const localVarAxiosArgs = await localVarAxiosParamCreator.forward(forwardRequest, options);
2903
3006
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2904
3007
  },
2905
3008
  /**
2906
- *
2907
- * @summary Deletes a schedule
2908
- * @param {string} id id of entity to query
3009
+ * 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.
3010
+ * @summary Generate a message from conversation
3011
+ * @param {GenerateRequest} generateRequest
3012
+ * @param {string} [convo] In relation to which conversation
2909
3013
  * @param {*} [options] Override http request option.
2910
3014
  * @throws {RequiredError}
2911
3015
  */
2912
- async scheduleDelete(id, options) {
2913
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleDelete(id, options);
3016
+ async generate(generateRequest, convo, options) {
3017
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generate(generateRequest, convo, options);
2914
3018
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2915
3019
  },
2916
3020
  /**
2917
- *
2918
- * @summary Creates a new schedule group
2919
- * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
3021
+ * Returns log data for a given range, specified by start and end Unix timestamps.
3022
+ * @summary Retrieve platform run time logs
3023
+ * @param {number} [start]
3024
+ * @param {number} [end]
2920
3025
  * @param {*} [options] Override http request option.
2921
3026
  * @throws {RequiredError}
2922
3027
  */
2923
- async scheduleGroupCreate(scheduleGroupCreateRequest, options) {
2924
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleGroupCreate(scheduleGroupCreateRequest, options);
3028
+ async logs(start, end, options) {
3029
+ const localVarAxiosArgs = await localVarAxiosParamCreator.logs(start, end, options);
2925
3030
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2926
3031
  },
2927
3032
  /**
2928
- *
2929
- * @summary Deletes and cancels a schedule group
2930
- * @param {string} id id of entity to query
3033
+ * 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
3034
+ * @summary Create and send message
3035
+ * @param {MessageCreateRequest} messageCreateRequest
2931
3036
  * @param {*} [options] Override http request option.
2932
3037
  * @throws {RequiredError}
2933
3038
  */
2934
- async scheduleGroupDelete(id, options) {
2935
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleGroupDelete(id, options);
3039
+ async message(messageCreateRequest, options) {
3040
+ const localVarAxiosArgs = await localVarAxiosParamCreator.message(messageCreateRequest, options);
2936
3041
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2937
3042
  },
2938
3043
  /**
2939
3044
  *
2940
- * @summary Gets a schedule group
3045
+ * @summary Get all messages from a conversation
2941
3046
  * @param {string} id id of entity to query
3047
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
2942
3048
  * @param {*} [options] Override http request option.
2943
3049
  * @throws {RequiredError}
2944
3050
  */
2945
- async scheduleGroupRetrieve(id, options) {
2946
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleGroupRetrieve(id, options);
3051
+ async messages(id, q, options) {
3052
+ const localVarAxiosArgs = await localVarAxiosParamCreator.messages(id, q, options);
2947
3053
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2948
3054
  },
2949
3055
  /**
2950
3056
  *
2951
- * @summary Updates a schedule group
2952
- * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
3057
+ * @summary Get the results of a bulk API operation
3058
+ * @param {string} id id of entity to query
2953
3059
  * @param {*} [options] Override http request option.
2954
3060
  * @throws {RequiredError}
2955
3061
  */
2956
- async scheduleGroupUpdate(scheduleGroupUpdateRequest, options) {
2957
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleGroupUpdate(scheduleGroupUpdateRequest, options);
3062
+ async operation(id, options) {
3063
+ const localVarAxiosArgs = await localVarAxiosParamCreator.operation(id, options);
2958
3064
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2959
3065
  },
2960
3066
  /**
2961
3067
  *
2962
- * @summary Gets a schedule
2963
- * @param {string} id id of entity to query
3068
+ * @summary Gets all or specific set of bulk API operations
3069
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3070
+ * @param {Array<string>} [id] ids for the entities this id belongs to
2964
3071
  * @param {*} [options] Override http request option.
2965
3072
  * @throws {RequiredError}
2966
3073
  */
2967
- async scheduleRetrieve(id, options) {
2968
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleRetrieve(id, options);
3074
+ async operations(q, id, options) {
3075
+ const localVarAxiosArgs = await localVarAxiosParamCreator.operations(q, id, options);
2969
3076
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2970
3077
  },
2971
3078
  /**
2972
- *
2973
- * @summary Updates a schedule
2974
- * @param {ScheduleUpdateRequest} scheduleUpdateRequest
3079
+ * Parses a message\'s custom context relevant to your organization. This is useful for extracting information from a message to drive your auto reply workflows.
3080
+ * @summary Parse a message\'s custom context relevant to your organization
3081
+ * @param {ParseRequest} parseRequest
2975
3082
  * @param {*} [options] Override http request option.
2976
3083
  * @throws {RequiredError}
2977
3084
  */
2978
- async scheduleUpdate(scheduleUpdateRequest, options) {
2979
- const localVarAxiosArgs = await localVarAxiosParamCreator.scheduleUpdate(scheduleUpdateRequest, options);
3085
+ async parse(parseRequest, options) {
3086
+ const localVarAxiosArgs = await localVarAxiosParamCreator.parse(parseRequest, options);
2980
3087
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2981
3088
  },
2982
3089
  /**
2983
3090
  *
2984
- * @summary Gets a workflow
2985
- * @param {string} id id of entity to query
3091
+ * @summary Purchase phone for a given agent.
3092
+ * @param {PurchasePhoneRequest} [purchasePhoneRequest] If no agent id is provided, the phone will be purchased for the owner of the API key.
2986
3093
  * @param {*} [options] Override http request option.
2987
3094
  * @throws {RequiredError}
2988
3095
  */
2989
- async workflow(id, options) {
2990
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflow(id, options);
3096
+ async purchasePhone(purchasePhoneRequest, options) {
3097
+ const localVarAxiosArgs = await localVarAxiosParamCreator.purchasePhone(purchasePhoneRequest, options);
2991
3098
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2992
3099
  },
2993
3100
  /**
2994
- *
2995
- * @summary Create a new workflow
2996
- * @param {CreateWorkflowRequest} createWorkflowRequest
3101
+ * Replaces an existing entity with the specified type and ID with a new entity.
3102
+ * @summary Replace an existing entity
3103
+ * @param {string} type
3104
+ * @param {string} id
3105
+ * @param {EntityData} entityData
2997
3106
  * @param {*} [options] Override http request option.
2998
3107
  * @throws {RequiredError}
2999
3108
  */
3000
- async workflowCreate(createWorkflowRequest, options) {
3001
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowCreate(createWorkflowRequest, options);
3109
+ async replaceEntity(type, id, entityData, options) {
3110
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceEntity(type, id, entityData, options);
3002
3111
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3003
3112
  },
3004
3113
  /**
3005
3114
  *
3006
- * @summary Deletes a workflow
3007
- * @param {string} id id of entity to query
3115
+ * @summary Runs your auto-reply app on the Scout9 platform.
3116
+ * @param {WorkflowEvent} workflowEvent
3008
3117
  * @param {*} [options] Override http request option.
3009
3118
  * @throws {RequiredError}
3010
3119
  */
3011
- async workflowDelete(id, options) {
3012
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowDelete(id, options);
3120
+ async runPlatform(workflowEvent, options) {
3121
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runPlatform(workflowEvent, options);
3013
3122
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3014
3123
  },
3015
3124
  /**
3016
3125
  *
3017
- * @summary Update a workflow
3018
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
3126
+ * @summary Returns the platform run config
3019
3127
  * @param {*} [options] Override http request option.
3020
3128
  * @throws {RequiredError}
3021
3129
  */
3022
- async workflowUpdate(updateWorkflowRequest, options) {
3023
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowUpdate(updateWorkflowRequest, options);
3130
+ async runPlatformConfig(options) {
3131
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runPlatformConfig(options);
3024
3132
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3025
3133
  },
3026
3134
  /**
3027
- *
3028
- * @summary Gets all or specific set of workflows
3029
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3030
- * @param {Array<string>} [id] ids for the entities this id belongs to
3135
+ * xxx
3136
+ * @summary xxx
3137
+ * @param {GenerateRequest} generateRequest
3138
+ * @param {string} [convo] xxx
3031
3139
  * @param {*} [options] Override http request option.
3032
3140
  * @throws {RequiredError}
3033
3141
  */
3034
- async workflows(q, id, options) {
3035
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflows(q, id, options);
3142
+ async temp(generateRequest, convo, options) {
3143
+ const localVarAxiosArgs = await localVarAxiosParamCreator.temp(generateRequest, convo, options);
3036
3144
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3037
3145
  },
3038
3146
  /**
3039
- *
3040
- * @summary Creates new workflows
3041
- * @param {CreateWorkflowsRequest} createWorkflowsRequest
3147
+ * Trains a PMT model based on the uploaded transcripts provided (Will include the ability to add more transcripts)
3148
+ * @summary Trains a given or default persona\'s PMT model
3149
+ * @param {PmtTrainRequest} pmtTrainRequest
3042
3150
  * @param {*} [options] Override http request option.
3043
3151
  * @throws {RequiredError}
3044
3152
  */
3045
- async workflowsCreate(createWorkflowsRequest, options) {
3046
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowsCreate(createWorkflowsRequest, options);
3153
+ async train(pmtTrainRequest, options) {
3154
+ const localVarAxiosArgs = await localVarAxiosParamCreator.train(pmtTrainRequest, options);
3047
3155
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3048
3156
  },
3049
3157
  /**
3050
- *
3051
- * @summary Deletes multiple workflows
3052
- * @param {Array<string>} [id] ids for the entities this id belongs to
3158
+ * Transforms a given message and context into the owners own words. Failure to transform would be a lack of transcription data or the message detected as not applicable to the owners intended use.
3159
+ * @summary Transforms a given message and context into the owners own words
3160
+ * @param {PmtTransformRequest} pmtTransformRequest
3053
3161
  * @param {*} [options] Override http request option.
3054
3162
  * @throws {RequiredError}
3055
3163
  */
3056
- async workflowsDelete(id, options) {
3057
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowsDelete(id, options);
3164
+ async transform(pmtTransformRequest, options) {
3165
+ const localVarAxiosArgs = await localVarAxiosParamCreator.transform(pmtTransformRequest, options);
3058
3166
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3059
3167
  },
3060
3168
  /**
3061
- *
3062
- * @summary Updates multiple workflows
3063
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
3169
+ * Updates an existing entity with the specified type and ID.
3170
+ * @summary Update an existing entity
3171
+ * @param {string} type
3172
+ * @param {string} id
3173
+ * @param {EntityData} entityData
3064
3174
  * @param {*} [options] Override http request option.
3065
3175
  * @throws {RequiredError}
3066
3176
  */
3067
- async workflowsUpdate(updateWorkflowRequest, options) {
3068
- const localVarAxiosArgs = await localVarAxiosParamCreator.workflowsUpdate(updateWorkflowRequest, options);
3177
+ async updateEntity(type, id, entityData, options) {
3178
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntity(type, id, entityData, options);
3069
3179
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
3070
3180
  },
3071
3181
  };
@@ -3078,6 +3188,18 @@ exports.Scout9ApiFp = Scout9ApiFp;
3078
3188
  const Scout9ApiFactory = function (configuration, basePath, axios) {
3079
3189
  const localVarFp = (0, exports.Scout9ApiFp)(configuration);
3080
3190
  return {
3191
+ /**
3192
+ *
3193
+ * @summary Create a new entity
3194
+ * @param {string} type
3195
+ * @param {string} id The unique identifier of the entity
3196
+ * @param {EntityData} entityData
3197
+ * @param {*} [options] Override http request option.
3198
+ * @throws {RequiredError}
3199
+ */
3200
+ addEntity(type, id, entityData, options) {
3201
+ return localVarFp.addEntity(type, id, entityData, options).then((request) => request(axios, basePath));
3202
+ },
3081
3203
  /**
3082
3204
  *
3083
3205
  * @summary Gets a agent
@@ -3161,144 +3283,62 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3161
3283
  },
3162
3284
  /**
3163
3285
  *
3164
- * @summary Gets a context
3165
- * @param {string} id id of entity to query
3166
- * @param {*} [options] Override http request option.
3167
- * @throws {RequiredError}
3168
- */
3169
- context(id, options) {
3170
- return localVarFp.context(id, options).then((request) => request(axios, basePath));
3171
- },
3172
- /**
3173
- *
3174
- * @summary Create a new context
3175
- * @param {CreateContextRequest} createContextRequest
3286
+ * @summary Natural language prompt to resolve a context value derived from the conversation.
3287
+ * @param {MacroContextInput} macroContextInput
3176
3288
  * @param {*} [options] Override http request option.
3177
3289
  * @throws {RequiredError}
3178
3290
  */
3179
- contextCreate(createContextRequest, options) {
3180
- return localVarFp.contextCreate(createContextRequest, options).then((request) => request(axios, basePath));
3291
+ captureContext(macroContextInput, options) {
3292
+ return localVarFp.captureContext(macroContextInput, options).then((request) => request(axios, basePath));
3181
3293
  },
3182
3294
  /**
3183
3295
  *
3184
- * @summary Gets context data
3185
- * @param {string} id id of entity to query
3296
+ * @summary Get the current project configuration
3186
3297
  * @param {*} [options] Override http request option.
3187
3298
  * @throws {RequiredError}
3188
3299
  */
3189
- contextData(id, options) {
3190
- return localVarFp.contextData(id, options).then((request) => request(axios, basePath));
3300
+ config(options) {
3301
+ return localVarFp.config(options).then((request) => request(axios, basePath));
3191
3302
  },
3192
3303
  /**
3193
- *
3194
- * @summary Create a new context data
3195
- * @param {CreateContextDataRequest} createContextDataRequest
3304
+ * Runs contextualization on workflow event messages and returns contextualized messages.
3305
+ * @summary Contextualize workflow event messages
3306
+ * @param {ContextualizerRequest} contextualizerRequest
3196
3307
  * @param {*} [options] Override http request option.
3197
3308
  * @throws {RequiredError}
3198
3309
  */
3199
- contextDataCreate(createContextDataRequest, options) {
3200
- return localVarFp.contextDataCreate(createContextDataRequest, options).then((request) => request(axios, basePath));
3310
+ contextualize(contextualizerRequest, options) {
3311
+ return localVarFp.contextualize(contextualizerRequest, options).then((request) => request(axios, basePath));
3201
3312
  },
3202
3313
  /**
3203
3314
  *
3204
- * @summary Deletes a schedule
3315
+ * @summary Gets a conversation
3205
3316
  * @param {string} id id of entity to query
3206
3317
  * @param {*} [options] Override http request option.
3207
3318
  * @throws {RequiredError}
3208
3319
  */
3209
- contextDataDelete(id, options) {
3210
- return localVarFp.contextDataDelete(id, options).then((request) => request(axios, basePath));
3211
- },
3212
- /**
3213
- *
3214
- * @summary Update a context data
3215
- * @param {UpdateContextDataRequest} updateContextDataRequest
3216
- * @param {*} [options] Override http request option.
3217
- * @throws {RequiredError}
3218
- */
3219
- contextDataUpdate(updateContextDataRequest, options) {
3220
- return localVarFp.contextDataUpdate(updateContextDataRequest, options).then((request) => request(axios, basePath));
3320
+ conversation(id, options) {
3321
+ return localVarFp.conversation(id, options).then((request) => request(axios, basePath));
3221
3322
  },
3222
3323
  /**
3223
3324
  *
3224
- * @summary Deletes a schedule
3325
+ * @summary Gets a conversation
3225
3326
  * @param {string} id id of entity to query
3226
3327
  * @param {*} [options] Override http request option.
3227
3328
  * @throws {RequiredError}
3228
3329
  */
3229
- contextDelete(id, options) {
3230
- return localVarFp.contextDelete(id, options).then((request) => request(axios, basePath));
3231
- },
3232
- /**
3233
- *
3234
- * @summary Test a custom context before training
3235
- * @param {ContextTestRequest} contextTestRequest
3236
- * @param {*} [options] Override http request option.
3237
- * @throws {RequiredError}
3238
- */
3239
- contextTest(contextTestRequest, options) {
3240
- return localVarFp.contextTest(contextTestRequest, options).then((request) => request(axios, basePath));
3241
- },
3242
- /**
3243
- *
3244
- * @summary Update a context
3245
- * @param {UpdateContextRequest} updateContextRequest
3246
- * @param {*} [options] Override http request option.
3247
- * @throws {RequiredError}
3248
- */
3249
- contextUpdate(updateContextRequest, options) {
3250
- return localVarFp.contextUpdate(updateContextRequest, options).then((request) => request(axios, basePath));
3251
- },
3252
- /**
3253
- *
3254
- * @summary Gets all or specific set of contexts
3255
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3256
- * @param {Array<string>} [id] ids for the entities this id belongs to
3257
- * @param {*} [options] Override http request option.
3258
- * @throws {RequiredError}
3259
- */
3260
- contexts(q, id, options) {
3261
- return localVarFp.contexts(q, id, options).then((request) => request(axios, basePath));
3262
- },
3263
- /**
3264
- *
3265
- * @summary Creates new contexts
3266
- * @param {CreateContextsRequest} createContextsRequest
3267
- * @param {*} [options] Override http request option.
3268
- * @throws {RequiredError}
3269
- */
3270
- contextsCreate(createContextsRequest, options) {
3271
- return localVarFp.contextsCreate(createContextsRequest, options).then((request) => request(axios, basePath));
3272
- },
3273
- /**
3274
- *
3275
- * @summary Deletes multiple contexts
3276
- * @param {Array<string>} [id] ids for the entities this id belongs to
3277
- * @param {*} [options] Override http request option.
3278
- * @throws {RequiredError}
3279
- */
3280
- contextsDelete(id, options) {
3281
- return localVarFp.contextsDelete(id, options).then((request) => request(axios, basePath));
3282
- },
3283
- /**
3284
- *
3285
- * @summary Updates multiple contexts
3286
- * @param {UpdateContextRequest} updateContextRequest
3287
- * @param {*} [options] Override http request option.
3288
- * @throws {RequiredError}
3289
- */
3290
- contextsUpdate(updateContextRequest, options) {
3291
- return localVarFp.contextsUpdate(updateContextRequest, options).then((request) => request(axios, basePath));
3330
+ conversationContext(id, options) {
3331
+ return localVarFp.conversationContext(id, options).then((request) => request(axios, basePath));
3292
3332
  },
3293
3333
  /**
3294
3334
  *
3295
- * @summary Gets a conversation
3296
- * @param {string} id id of entity to query
3335
+ * @summary Update a conversation
3336
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
3297
3337
  * @param {*} [options] Override http request option.
3298
3338
  * @throws {RequiredError}
3299
3339
  */
3300
- conversation(id, options) {
3301
- return localVarFp.conversation(id, options).then((request) => request(axios, basePath));
3340
+ conversationContextUpdate(conversationContextUpdateRequest, options) {
3341
+ return localVarFp.conversationContextUpdate(conversationContextUpdateRequest, options).then((request) => request(axios, basePath));
3302
3342
  },
3303
3343
  /**
3304
3344
  *
@@ -3330,25 +3370,37 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3330
3370
  conversationUpdate(conversationUpdateRequest, options) {
3331
3371
  return localVarFp.conversationUpdate(conversationUpdateRequest, options).then((request) => request(axios, basePath));
3332
3372
  },
3373
+ /**
3374
+ *
3375
+ * @summary Gets all or specific set of conversations
3376
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3377
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3378
+ * @param {*} [options] Override http request option.
3379
+ * @throws {RequiredError}
3380
+ */
3381
+ conversations(q, id, options) {
3382
+ return localVarFp.conversations(q, id, options).then((request) => request(axios, basePath));
3383
+ },
3333
3384
  /**
3334
3385
  *
3335
3386
  * @summary Gets a customer
3336
- * @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
3387
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
3388
+ * @param {boolean} [resolve] If a email or phone is provided and the customer doesn\&#39;t exist, it will automatically create one
3337
3389
  * @param {*} [options] Override http request option.
3338
3390
  * @throws {RequiredError}
3339
3391
  */
3340
- customer(idOrEmailOrPhone, options) {
3341
- return localVarFp.customer(idOrEmailOrPhone, options).then((request) => request(axios, basePath));
3392
+ customer(idOrEmailOrPhone, resolve, options) {
3393
+ return localVarFp.customer(idOrEmailOrPhone, resolve, options).then((request) => request(axios, basePath));
3342
3394
  },
3343
3395
  /**
3344
3396
  *
3345
3397
  * @summary Creates a new customer
3346
- * @param {CreateCustomerRequest} createCustomerRequest
3398
+ * @param {Customer} body
3347
3399
  * @param {*} [options] Override http request option.
3348
3400
  * @throws {RequiredError}
3349
3401
  */
3350
- customerCreate(createCustomerRequest, options) {
3351
- return localVarFp.customerCreate(createCustomerRequest, options).then((request) => request(axios, basePath));
3402
+ customerCreate(body, options) {
3403
+ return localVarFp.customerCreate(body, options).then((request) => request(axios, basePath));
3352
3404
  },
3353
3405
  /**
3354
3406
  *
@@ -3485,286 +3537,295 @@ const Scout9ApiFactory = function (configuration, basePath, axios) {
3485
3537
  /**
3486
3538
  *
3487
3539
  * @summary Updates multiple customers
3488
- * @param {UpdateCustomerRequest} updateCustomerRequest
3489
- * @param {*} [options] Override http request option.
3490
- * @throws {RequiredError}
3491
- */
3492
- customersUpdate(updateCustomerRequest, options) {
3493
- return localVarFp.customersUpdate(updateCustomerRequest, options).then((request) => request(axios, basePath));
3494
- },
3495
- /**
3496
- *
3497
- * @summary Returns information about a specific file.
3498
- * @param {string} fileId The ID of the file to use for this request
3540
+ * @param {UpdateCustomersRequest} updateCustomersRequest
3499
3541
  * @param {*} [options] Override http request option.
3500
3542
  * @throws {RequiredError}
3501
3543
  */
3502
- file(fileId, options) {
3503
- return localVarFp.file(fileId, options).then((request) => request(axios, basePath));
3544
+ customersUpdate(updateCustomersRequest, options) {
3545
+ return localVarFp.customersUpdate(updateCustomersRequest, options).then((request) => request(axios, basePath));
3504
3546
  },
3505
3547
  /**
3506
- *
3507
- * @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.
3508
- * @param {File} file
3509
- * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
3548
+ * Deletes an entity with the specified type and ID.
3549
+ * @summary Delete an entity
3550
+ * @param {string} type
3551
+ * @param {string} id
3510
3552
  * @param {*} [options] Override http request option.
3511
3553
  * @throws {RequiredError}
3512
3554
  */
3513
- fileCreate(file, purpose, options) {
3514
- return localVarFp.fileCreate(file, purpose, options).then((request) => request(axios, basePath));
3555
+ deleteEntity(type, id, options) {
3556
+ return localVarFp.deleteEntity(type, id, options).then((request) => request(axios, basePath));
3515
3557
  },
3516
3558
  /**
3517
3559
  *
3518
- * @summary Delete a file.
3519
- * @param {string} fileId The ID of the file to use for this request
3560
+ * @summary Natural language prompt to resolve to a boolean value.
3561
+ * @param {MacroDidInput} macroDidInput
3520
3562
  * @param {*} [options] Override http request option.
3521
3563
  * @throws {RequiredError}
3522
3564
  */
3523
- fileDelete(fileId, options) {
3524
- return localVarFp.fileDelete(fileId, options).then((request) => request(axios, basePath));
3565
+ did(macroDidInput, options) {
3566
+ return localVarFp.did(macroDidInput, options).then((request) => request(axios, basePath));
3525
3567
  },
3526
3568
  /**
3527
3569
  *
3528
- * @summary Returns the contents of the specified file
3529
- * @param {string} fileId The ID of the file to use for this request
3570
+ * @summary Natural language prompt to resolve to a boolean value in relation to the given immediate message.
3571
+ * @param {MacroDoesInput} macroDoesInput
3530
3572
  * @param {*} [options] Override http request option.
3531
3573
  * @throws {RequiredError}
3532
3574
  */
3533
- fileDownload(fileId, options) {
3534
- return localVarFp.fileDownload(fileId, options).then((request) => request(axios, basePath));
3575
+ does(macroDoesInput, options) {
3576
+ return localVarFp.does(macroDoesInput, options).then((request) => request(axios, basePath));
3535
3577
  },
3536
3578
  /**
3537
3579
  *
3538
- * @summary Returns a list of files that belong to the user\'s organization.
3539
- * @param {*} [options] Override http request option.
3540
- * @throws {RequiredError}
3541
- */
3542
- files(options) {
3543
- return localVarFp.files(options).then((request) => request(axios, basePath));
3544
- },
3545
- /**
3546
- * 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.
3547
- * @summary Generate a message from conversation
3548
- * @param {GenerateRequest} generateRequest
3580
+ * @summary Get an entity by type and ID
3581
+ * @param {string} type The type of the entity to fetch
3582
+ * @param {string} id The unique identifier of the entity
3549
3583
  * @param {*} [options] Override http request option.
3550
3584
  * @throws {RequiredError}
3551
3585
  */
3552
- generate(generateRequest, options) {
3553
- return localVarFp.generate(generateRequest, options).then((request) => request(axios, basePath));
3586
+ entity(type, id, options) {
3587
+ return localVarFp.entity(type, id, options).then((request) => request(axios, basePath));
3554
3588
  },
3555
3589
  /**
3556
- * 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
3557
- * @summary Create and send message
3558
- * @param {MessageCreateRequest} messageCreateRequest
3590
+ *
3591
+ * @summary Returns a file
3592
+ * @param {string} purpose File categorical purpose
3593
+ * @param {string} [entity] File entity id
3594
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
3559
3595
  * @param {*} [options] Override http request option.
3560
3596
  * @throws {RequiredError}
3561
3597
  */
3562
- message(messageCreateRequest, options) {
3563
- return localVarFp.message(messageCreateRequest, options).then((request) => request(axios, basePath));
3598
+ file(purpose, entity, agent, options) {
3599
+ return localVarFp.file(purpose, entity, agent, options).then((request) => request(axios, basePath));
3564
3600
  },
3565
3601
  /**
3566
3602
  *
3567
- * @summary Get all messages from a conversation
3568
- * @param {string} id id of entity to query
3569
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3603
+ * @summary Remove a file
3604
+ * @param {string} purpose File categorical purpose
3605
+ * @param {string} entity File entity id
3606
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
3570
3607
  * @param {*} [options] Override http request option.
3571
3608
  * @throws {RequiredError}
3572
3609
  */
3573
- messages(id, q, options) {
3574
- return localVarFp.messages(id, q, options).then((request) => request(axios, basePath));
3610
+ fileRemove(purpose, entity, agent, options) {
3611
+ return localVarFp.fileRemove(purpose, entity, agent, options).then((request) => request(axios, basePath));
3575
3612
  },
3576
3613
  /**
3577
3614
  *
3578
- * @summary Get the results of a bulk API operation
3579
- * @param {string} id id of entity to query
3615
+ * @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.
3616
+ * @param {File} file
3617
+ * @param {PurposeEnum} [purpose]
3618
+ * @param {string} [context] Additional information about this file
3619
+ * @param {string} [entity] The entity id, if not provided the entity id becomes the provided file name
3620
+ * @param {string} [$agent] The agent that this file belongs to. Only used for entity.audio and entity.transcript files.
3580
3621
  * @param {*} [options] Override http request option.
3581
3622
  * @throws {RequiredError}
3582
3623
  */
3583
- operation(id, options) {
3584
- return localVarFp.operation(id, options).then((request) => request(axios, basePath));
3624
+ fileUpload(file, purpose, context, entity, $agent, options) {
3625
+ return localVarFp.fileUpload(file, purpose, context, entity, $agent, options).then((request) => request(axios, basePath));
3585
3626
  },
3586
3627
  /**
3587
3628
  *
3588
- * @summary Gets all or specific set of bulk API operations
3589
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3590
- * @param {Array<string>} [id] ids for the entities this id belongs to
3629
+ * @summary Returns a list of files that belong to the user\'s organization.
3630
+ * @param {string} purpose File categorical purpose
3631
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
3591
3632
  * @param {*} [options] Override http request option.
3592
3633
  * @throws {RequiredError}
3593
3634
  */
3594
- operations(q, id, options) {
3595
- return localVarFp.operations(q, id, options).then((request) => request(axios, basePath));
3635
+ files(purpose, agent, options) {
3636
+ return localVarFp.files(purpose, agent, options).then((request) => request(axios, basePath));
3596
3637
  },
3597
3638
  /**
3598
- *
3599
- * @summary Creates a new scheduled conversation
3600
- * @param {ScheduleCreateRequest} scheduleCreateRequest
3639
+ * Forwards a locked conversation to agent
3640
+ * @summary forwards a locked conversation to agent
3641
+ * @param {ForwardRequest} forwardRequest
3601
3642
  * @param {*} [options] Override http request option.
3602
3643
  * @throws {RequiredError}
3603
3644
  */
3604
- scheduleConversation(scheduleCreateRequest, options) {
3605
- return localVarFp.scheduleConversation(scheduleCreateRequest, options).then((request) => request(axios, basePath));
3645
+ forward(forwardRequest, options) {
3646
+ return localVarFp.forward(forwardRequest, options).then((request) => request(axios, basePath));
3606
3647
  },
3607
3648
  /**
3608
- *
3609
- * @summary Deletes a schedule
3610
- * @param {string} id id of entity to query
3649
+ * 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.
3650
+ * @summary Generate a message from conversation
3651
+ * @param {GenerateRequest} generateRequest
3652
+ * @param {string} [convo] In relation to which conversation
3611
3653
  * @param {*} [options] Override http request option.
3612
3654
  * @throws {RequiredError}
3613
3655
  */
3614
- scheduleDelete(id, options) {
3615
- return localVarFp.scheduleDelete(id, options).then((request) => request(axios, basePath));
3656
+ generate(generateRequest, convo, options) {
3657
+ return localVarFp.generate(generateRequest, convo, options).then((request) => request(axios, basePath));
3616
3658
  },
3617
3659
  /**
3618
- *
3619
- * @summary Creates a new schedule group
3620
- * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
3660
+ * Returns log data for a given range, specified by start and end Unix timestamps.
3661
+ * @summary Retrieve platform run time logs
3662
+ * @param {number} [start]
3663
+ * @param {number} [end]
3621
3664
  * @param {*} [options] Override http request option.
3622
3665
  * @throws {RequiredError}
3623
3666
  */
3624
- scheduleGroupCreate(scheduleGroupCreateRequest, options) {
3625
- return localVarFp.scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(axios, basePath));
3667
+ logs(start, end, options) {
3668
+ return localVarFp.logs(start, end, options).then((request) => request(axios, basePath));
3626
3669
  },
3627
3670
  /**
3628
- *
3629
- * @summary Deletes and cancels a schedule group
3630
- * @param {string} id id of entity to query
3671
+ * 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
3672
+ * @summary Create and send message
3673
+ * @param {MessageCreateRequest} messageCreateRequest
3631
3674
  * @param {*} [options] Override http request option.
3632
3675
  * @throws {RequiredError}
3633
3676
  */
3634
- scheduleGroupDelete(id, options) {
3635
- return localVarFp.scheduleGroupDelete(id, options).then((request) => request(axios, basePath));
3677
+ message(messageCreateRequest, options) {
3678
+ return localVarFp.message(messageCreateRequest, options).then((request) => request(axios, basePath));
3636
3679
  },
3637
3680
  /**
3638
3681
  *
3639
- * @summary Gets a schedule group
3682
+ * @summary Get all messages from a conversation
3640
3683
  * @param {string} id id of entity to query
3684
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3641
3685
  * @param {*} [options] Override http request option.
3642
3686
  * @throws {RequiredError}
3643
3687
  */
3644
- scheduleGroupRetrieve(id, options) {
3645
- return localVarFp.scheduleGroupRetrieve(id, options).then((request) => request(axios, basePath));
3688
+ messages(id, q, options) {
3689
+ return localVarFp.messages(id, q, options).then((request) => request(axios, basePath));
3646
3690
  },
3647
3691
  /**
3648
3692
  *
3649
- * @summary Updates a schedule group
3650
- * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
3693
+ * @summary Get the results of a bulk API operation
3694
+ * @param {string} id id of entity to query
3651
3695
  * @param {*} [options] Override http request option.
3652
3696
  * @throws {RequiredError}
3653
3697
  */
3654
- scheduleGroupUpdate(scheduleGroupUpdateRequest, options) {
3655
- return localVarFp.scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(axios, basePath));
3698
+ operation(id, options) {
3699
+ return localVarFp.operation(id, options).then((request) => request(axios, basePath));
3656
3700
  },
3657
3701
  /**
3658
3702
  *
3659
- * @summary Gets a schedule
3660
- * @param {string} id id of entity to query
3703
+ * @summary Gets all or specific set of bulk API operations
3704
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3705
+ * @param {Array<string>} [id] ids for the entities this id belongs to
3661
3706
  * @param {*} [options] Override http request option.
3662
3707
  * @throws {RequiredError}
3663
3708
  */
3664
- scheduleRetrieve(id, options) {
3665
- return localVarFp.scheduleRetrieve(id, options).then((request) => request(axios, basePath));
3709
+ operations(q, id, options) {
3710
+ return localVarFp.operations(q, id, options).then((request) => request(axios, basePath));
3666
3711
  },
3667
3712
  /**
3668
- *
3669
- * @summary Updates a schedule
3670
- * @param {ScheduleUpdateRequest} scheduleUpdateRequest
3713
+ * Parses a message\'s custom context relevant to your organization. This is useful for extracting information from a message to drive your auto reply workflows.
3714
+ * @summary Parse a message\'s custom context relevant to your organization
3715
+ * @param {ParseRequest} parseRequest
3671
3716
  * @param {*} [options] Override http request option.
3672
3717
  * @throws {RequiredError}
3673
3718
  */
3674
- scheduleUpdate(scheduleUpdateRequest, options) {
3675
- return localVarFp.scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(axios, basePath));
3719
+ parse(parseRequest, options) {
3720
+ return localVarFp.parse(parseRequest, options).then((request) => request(axios, basePath));
3676
3721
  },
3677
3722
  /**
3678
3723
  *
3679
- * @summary Gets a workflow
3680
- * @param {string} id id of entity to query
3724
+ * @summary Purchase phone for a given agent.
3725
+ * @param {PurchasePhoneRequest} [purchasePhoneRequest] If no agent id is provided, the phone will be purchased for the owner of the API key.
3681
3726
  * @param {*} [options] Override http request option.
3682
3727
  * @throws {RequiredError}
3683
3728
  */
3684
- workflow(id, options) {
3685
- return localVarFp.workflow(id, options).then((request) => request(axios, basePath));
3729
+ purchasePhone(purchasePhoneRequest, options) {
3730
+ return localVarFp.purchasePhone(purchasePhoneRequest, options).then((request) => request(axios, basePath));
3686
3731
  },
3687
3732
  /**
3688
- *
3689
- * @summary Create a new workflow
3690
- * @param {CreateWorkflowRequest} createWorkflowRequest
3733
+ * Replaces an existing entity with the specified type and ID with a new entity.
3734
+ * @summary Replace an existing entity
3735
+ * @param {string} type
3736
+ * @param {string} id
3737
+ * @param {EntityData} entityData
3691
3738
  * @param {*} [options] Override http request option.
3692
3739
  * @throws {RequiredError}
3693
3740
  */
3694
- workflowCreate(createWorkflowRequest, options) {
3695
- return localVarFp.workflowCreate(createWorkflowRequest, options).then((request) => request(axios, basePath));
3741
+ replaceEntity(type, id, entityData, options) {
3742
+ return localVarFp.replaceEntity(type, id, entityData, options).then((request) => request(axios, basePath));
3696
3743
  },
3697
3744
  /**
3698
3745
  *
3699
- * @summary Deletes a workflow
3700
- * @param {string} id id of entity to query
3746
+ * @summary Runs your auto-reply app on the Scout9 platform.
3747
+ * @param {WorkflowEvent} workflowEvent
3701
3748
  * @param {*} [options] Override http request option.
3702
3749
  * @throws {RequiredError}
3703
3750
  */
3704
- workflowDelete(id, options) {
3705
- return localVarFp.workflowDelete(id, options).then((request) => request(axios, basePath));
3751
+ runPlatform(workflowEvent, options) {
3752
+ return localVarFp.runPlatform(workflowEvent, options).then((request) => request(axios, basePath));
3706
3753
  },
3707
3754
  /**
3708
3755
  *
3709
- * @summary Update a workflow
3710
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
3756
+ * @summary Returns the platform run config
3711
3757
  * @param {*} [options] Override http request option.
3712
3758
  * @throws {RequiredError}
3713
3759
  */
3714
- workflowUpdate(updateWorkflowRequest, options) {
3715
- return localVarFp.workflowUpdate(updateWorkflowRequest, options).then((request) => request(axios, basePath));
3760
+ runPlatformConfig(options) {
3761
+ return localVarFp.runPlatformConfig(options).then((request) => request(axios, basePath));
3716
3762
  },
3717
3763
  /**
3718
- *
3719
- * @summary Gets all or specific set of workflows
3720
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3721
- * @param {Array<string>} [id] ids for the entities this id belongs to
3764
+ * xxx
3765
+ * @summary xxx
3766
+ * @param {GenerateRequest} generateRequest
3767
+ * @param {string} [convo] xxx
3722
3768
  * @param {*} [options] Override http request option.
3723
3769
  * @throws {RequiredError}
3724
3770
  */
3725
- workflows(q, id, options) {
3726
- return localVarFp.workflows(q, id, options).then((request) => request(axios, basePath));
3771
+ temp(generateRequest, convo, options) {
3772
+ return localVarFp.temp(generateRequest, convo, options).then((request) => request(axios, basePath));
3727
3773
  },
3728
3774
  /**
3729
- *
3730
- * @summary Creates new workflows
3731
- * @param {CreateWorkflowsRequest} createWorkflowsRequest
3775
+ * Trains a PMT model based on the uploaded transcripts provided (Will include the ability to add more transcripts)
3776
+ * @summary Trains a given or default persona\'s PMT model
3777
+ * @param {PmtTrainRequest} pmtTrainRequest
3732
3778
  * @param {*} [options] Override http request option.
3733
3779
  * @throws {RequiredError}
3734
3780
  */
3735
- workflowsCreate(createWorkflowsRequest, options) {
3736
- return localVarFp.workflowsCreate(createWorkflowsRequest, options).then((request) => request(axios, basePath));
3781
+ train(pmtTrainRequest, options) {
3782
+ return localVarFp.train(pmtTrainRequest, options).then((request) => request(axios, basePath));
3737
3783
  },
3738
3784
  /**
3739
- *
3740
- * @summary Deletes multiple workflows
3741
- * @param {Array<string>} [id] ids for the entities this id belongs to
3785
+ * Transforms a given message and context into the owners own words. Failure to transform would be a lack of transcription data or the message detected as not applicable to the owners intended use.
3786
+ * @summary Transforms a given message and context into the owners own words
3787
+ * @param {PmtTransformRequest} pmtTransformRequest
3742
3788
  * @param {*} [options] Override http request option.
3743
3789
  * @throws {RequiredError}
3744
3790
  */
3745
- workflowsDelete(id, options) {
3746
- return localVarFp.workflowsDelete(id, options).then((request) => request(axios, basePath));
3791
+ transform(pmtTransformRequest, options) {
3792
+ return localVarFp.transform(pmtTransformRequest, options).then((request) => request(axios, basePath));
3747
3793
  },
3748
3794
  /**
3749
- *
3750
- * @summary Updates multiple workflows
3751
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
3795
+ * Updates an existing entity with the specified type and ID.
3796
+ * @summary Update an existing entity
3797
+ * @param {string} type
3798
+ * @param {string} id
3799
+ * @param {EntityData} entityData
3752
3800
  * @param {*} [options] Override http request option.
3753
3801
  * @throws {RequiredError}
3754
3802
  */
3755
- workflowsUpdate(updateWorkflowRequest, options) {
3756
- return localVarFp.workflowsUpdate(updateWorkflowRequest, options).then((request) => request(axios, basePath));
3803
+ updateEntity(type, id, entityData, options) {
3804
+ return localVarFp.updateEntity(type, id, entityData, options).then((request) => request(axios, basePath));
3757
3805
  },
3758
3806
  };
3759
3807
  };
3760
3808
  exports.Scout9ApiFactory = Scout9ApiFactory;
3761
3809
  /**
3762
- * Scout9Api - object-oriented interface
3810
+ * Scout9ApiGenerated - object-oriented interface
3763
3811
  * @export
3764
- * @class Scout9Api
3812
+ * @class Scout9ApiGenerated
3765
3813
  * @extends {BaseAPI}
3766
3814
  */
3767
- class Scout9Api extends base_1.BaseAPI {
3815
+ class Scout9ApiGenerated extends base_1.BaseAPI {
3816
+ /**
3817
+ *
3818
+ * @summary Create a new entity
3819
+ * @param {string} type
3820
+ * @param {string} id The unique identifier of the entity
3821
+ * @param {EntityData} entityData
3822
+ * @param {*} [options] Override http request option.
3823
+ * @throws {RequiredError}
3824
+ * @memberof Scout9Api
3825
+ */
3826
+ addEntity(type, id, entityData, options) {
3827
+ return (0, exports.Scout9ApiFp)(this.configuration).addEntity(type, id, entityData, options).then((request) => request(this.axios, this.basePath));
3828
+ }
3768
3829
  /**
3769
3830
  *
3770
3831
  * @summary Gets a agent
@@ -3856,158 +3917,68 @@ class Scout9Api extends base_1.BaseAPI {
3856
3917
  }
3857
3918
  /**
3858
3919
  *
3859
- * @summary Gets a context
3860
- * @param {string} id id of entity to query
3861
- * @param {*} [options] Override http request option.
3862
- * @throws {RequiredError}
3863
- * @memberof Scout9Api
3864
- */
3865
- context(id, options) {
3866
- return (0, exports.Scout9ApiFp)(this.configuration).context(id, options).then((request) => request(this.axios, this.basePath));
3867
- }
3868
- /**
3869
- *
3870
- * @summary Create a new context
3871
- * @param {CreateContextRequest} createContextRequest
3920
+ * @summary Natural language prompt to resolve a context value derived from the conversation.
3921
+ * @param {MacroContextInput} macroContextInput
3872
3922
  * @param {*} [options] Override http request option.
3873
3923
  * @throws {RequiredError}
3874
3924
  * @memberof Scout9Api
3875
3925
  */
3876
- contextCreate(createContextRequest, options) {
3877
- return (0, exports.Scout9ApiFp)(this.configuration).contextCreate(createContextRequest, options).then((request) => request(this.axios, this.basePath));
3926
+ captureContext(macroContextInput, options) {
3927
+ return (0, exports.Scout9ApiFp)(this.configuration).captureContext(macroContextInput, options).then((request) => request(this.axios, this.basePath));
3878
3928
  }
3879
3929
  /**
3880
3930
  *
3881
- * @summary Gets context data
3882
- * @param {string} id id of entity to query
3931
+ * @summary Get the current project configuration
3883
3932
  * @param {*} [options] Override http request option.
3884
3933
  * @throws {RequiredError}
3885
3934
  * @memberof Scout9Api
3886
3935
  */
3887
- contextData(id, options) {
3888
- return (0, exports.Scout9ApiFp)(this.configuration).contextData(id, options).then((request) => request(this.axios, this.basePath));
3936
+ config(options) {
3937
+ return (0, exports.Scout9ApiFp)(this.configuration).config(options).then((request) => request(this.axios, this.basePath));
3889
3938
  }
3890
3939
  /**
3891
- *
3892
- * @summary Create a new context data
3893
- * @param {CreateContextDataRequest} createContextDataRequest
3940
+ * Runs contextualization on workflow event messages and returns contextualized messages.
3941
+ * @summary Contextualize workflow event messages
3942
+ * @param {ContextualizerRequest} contextualizerRequest
3894
3943
  * @param {*} [options] Override http request option.
3895
3944
  * @throws {RequiredError}
3896
3945
  * @memberof Scout9Api
3897
3946
  */
3898
- contextDataCreate(createContextDataRequest, options) {
3899
- return (0, exports.Scout9ApiFp)(this.configuration).contextDataCreate(createContextDataRequest, options).then((request) => request(this.axios, this.basePath));
3947
+ contextualize(contextualizerRequest, options) {
3948
+ return (0, exports.Scout9ApiFp)(this.configuration).contextualize(contextualizerRequest, options).then((request) => request(this.axios, this.basePath));
3900
3949
  }
3901
3950
  /**
3902
3951
  *
3903
- * @summary Deletes a schedule
3952
+ * @summary Gets a conversation
3904
3953
  * @param {string} id id of entity to query
3905
3954
  * @param {*} [options] Override http request option.
3906
3955
  * @throws {RequiredError}
3907
3956
  * @memberof Scout9Api
3908
3957
  */
3909
- contextDataDelete(id, options) {
3910
- return (0, exports.Scout9ApiFp)(this.configuration).contextDataDelete(id, options).then((request) => request(this.axios, this.basePath));
3911
- }
3912
- /**
3913
- *
3914
- * @summary Update a context data
3915
- * @param {UpdateContextDataRequest} updateContextDataRequest
3916
- * @param {*} [options] Override http request option.
3917
- * @throws {RequiredError}
3918
- * @memberof Scout9Api
3919
- */
3920
- contextDataUpdate(updateContextDataRequest, options) {
3921
- return (0, exports.Scout9ApiFp)(this.configuration).contextDataUpdate(updateContextDataRequest, options).then((request) => request(this.axios, this.basePath));
3958
+ conversation(id, options) {
3959
+ return (0, exports.Scout9ApiFp)(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
3922
3960
  }
3923
3961
  /**
3924
3962
  *
3925
- * @summary Deletes a schedule
3963
+ * @summary Gets a conversation
3926
3964
  * @param {string} id id of entity to query
3927
3965
  * @param {*} [options] Override http request option.
3928
3966
  * @throws {RequiredError}
3929
3967
  * @memberof Scout9Api
3930
3968
  */
3931
- contextDelete(id, options) {
3932
- return (0, exports.Scout9ApiFp)(this.configuration).contextDelete(id, options).then((request) => request(this.axios, this.basePath));
3933
- }
3934
- /**
3935
- *
3936
- * @summary Test a custom context before training
3937
- * @param {ContextTestRequest} contextTestRequest
3938
- * @param {*} [options] Override http request option.
3939
- * @throws {RequiredError}
3940
- * @memberof Scout9Api
3941
- */
3942
- contextTest(contextTestRequest, options) {
3943
- return (0, exports.Scout9ApiFp)(this.configuration).contextTest(contextTestRequest, options).then((request) => request(this.axios, this.basePath));
3944
- }
3945
- /**
3946
- *
3947
- * @summary Update a context
3948
- * @param {UpdateContextRequest} updateContextRequest
3949
- * @param {*} [options] Override http request option.
3950
- * @throws {RequiredError}
3951
- * @memberof Scout9Api
3952
- */
3953
- contextUpdate(updateContextRequest, options) {
3954
- return (0, exports.Scout9ApiFp)(this.configuration).contextUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3955
- }
3956
- /**
3957
- *
3958
- * @summary Gets all or specific set of contexts
3959
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
3960
- * @param {Array<string>} [id] ids for the entities this id belongs to
3961
- * @param {*} [options] Override http request option.
3962
- * @throws {RequiredError}
3963
- * @memberof Scout9Api
3964
- */
3965
- contexts(q, id, options) {
3966
- return (0, exports.Scout9ApiFp)(this.configuration).contexts(q, id, options).then((request) => request(this.axios, this.basePath));
3967
- }
3968
- /**
3969
- *
3970
- * @summary Creates new contexts
3971
- * @param {CreateContextsRequest} createContextsRequest
3972
- * @param {*} [options] Override http request option.
3973
- * @throws {RequiredError}
3974
- * @memberof Scout9Api
3975
- */
3976
- contextsCreate(createContextsRequest, options) {
3977
- return (0, exports.Scout9ApiFp)(this.configuration).contextsCreate(createContextsRequest, options).then((request) => request(this.axios, this.basePath));
3978
- }
3979
- /**
3980
- *
3981
- * @summary Deletes multiple contexts
3982
- * @param {Array<string>} [id] ids for the entities this id belongs to
3983
- * @param {*} [options] Override http request option.
3984
- * @throws {RequiredError}
3985
- * @memberof Scout9Api
3986
- */
3987
- contextsDelete(id, options) {
3988
- return (0, exports.Scout9ApiFp)(this.configuration).contextsDelete(id, options).then((request) => request(this.axios, this.basePath));
3989
- }
3990
- /**
3991
- *
3992
- * @summary Updates multiple contexts
3993
- * @param {UpdateContextRequest} updateContextRequest
3994
- * @param {*} [options] Override http request option.
3995
- * @throws {RequiredError}
3996
- * @memberof Scout9Api
3997
- */
3998
- contextsUpdate(updateContextRequest, options) {
3999
- return (0, exports.Scout9ApiFp)(this.configuration).contextsUpdate(updateContextRequest, options).then((request) => request(this.axios, this.basePath));
3969
+ conversationContext(id, options) {
3970
+ return (0, exports.Scout9ApiFp)(this.configuration).conversationContext(id, options).then((request) => request(this.axios, this.basePath));
4000
3971
  }
4001
3972
  /**
4002
3973
  *
4003
- * @summary Gets a conversation
4004
- * @param {string} id id of entity to query
3974
+ * @summary Update a conversation
3975
+ * @param {ConversationContextUpdateRequest} conversationContextUpdateRequest
4005
3976
  * @param {*} [options] Override http request option.
4006
3977
  * @throws {RequiredError}
4007
3978
  * @memberof Scout9Api
4008
3979
  */
4009
- conversation(id, options) {
4010
- return (0, exports.Scout9ApiFp)(this.configuration).conversation(id, options).then((request) => request(this.axios, this.basePath));
3980
+ conversationContextUpdate(conversationContextUpdateRequest, options) {
3981
+ return (0, exports.Scout9ApiFp)(this.configuration).conversationContextUpdate(conversationContextUpdateRequest, options).then((request) => request(this.axios, this.basePath));
4011
3982
  }
4012
3983
  /**
4013
3984
  *
@@ -4042,27 +4013,40 @@ class Scout9Api extends base_1.BaseAPI {
4042
4013
  conversationUpdate(conversationUpdateRequest, options) {
4043
4014
  return (0, exports.Scout9ApiFp)(this.configuration).conversationUpdate(conversationUpdateRequest, options).then((request) => request(this.axios, this.basePath));
4044
4015
  }
4016
+ /**
4017
+ *
4018
+ * @summary Gets all or specific set of conversations
4019
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4020
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4021
+ * @param {*} [options] Override http request option.
4022
+ * @throws {RequiredError}
4023
+ * @memberof Scout9Api
4024
+ */
4025
+ conversations(q, id, options) {
4026
+ return (0, exports.Scout9ApiFp)(this.configuration).conversations(q, id, options).then((request) => request(this.axios, this.basePath));
4027
+ }
4045
4028
  /**
4046
4029
  *
4047
4030
  * @summary Gets a customer
4048
- * @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
4031
+ * @param {string} idOrEmailOrPhone Either customers id, phone number or email
4032
+ * @param {boolean} [resolve] If a email or phone is provided and the customer doesn\&#39;t exist, it will automatically create one
4049
4033
  * @param {*} [options] Override http request option.
4050
4034
  * @throws {RequiredError}
4051
4035
  * @memberof Scout9Api
4052
4036
  */
4053
- customer(idOrEmailOrPhone, options) {
4054
- return (0, exports.Scout9ApiFp)(this.configuration).customer(idOrEmailOrPhone, options).then((request) => request(this.axios, this.basePath));
4037
+ customer(idOrEmailOrPhone, resolve, options) {
4038
+ return (0, exports.Scout9ApiFp)(this.configuration).customer(idOrEmailOrPhone, resolve, options).then((request) => request(this.axios, this.basePath));
4055
4039
  }
4056
4040
  /**
4057
4041
  *
4058
4042
  * @summary Creates a new customer
4059
- * @param {CreateCustomerRequest} createCustomerRequest
4043
+ * @param {Customer} body
4060
4044
  * @param {*} [options] Override http request option.
4061
4045
  * @throws {RequiredError}
4062
4046
  * @memberof Scout9Api
4063
4047
  */
4064
- customerCreate(createCustomerRequest, options) {
4065
- return (0, exports.Scout9ApiFp)(this.configuration).customerCreate(createCustomerRequest, options).then((request) => request(this.axios, this.basePath));
4048
+ customerCreate(body, options) {
4049
+ return (0, exports.Scout9ApiFp)(this.configuration).customerCreate(body, options).then((request) => request(this.axios, this.basePath));
4066
4050
  }
4067
4051
  /**
4068
4052
  *
@@ -4212,302 +4196,437 @@ class Scout9Api extends base_1.BaseAPI {
4212
4196
  /**
4213
4197
  *
4214
4198
  * @summary Updates multiple customers
4215
- * @param {UpdateCustomerRequest} updateCustomerRequest
4199
+ * @param {UpdateCustomersRequest} updateCustomersRequest
4216
4200
  * @param {*} [options] Override http request option.
4217
4201
  * @throws {RequiredError}
4218
4202
  * @memberof Scout9Api
4219
4203
  */
4220
- customersUpdate(updateCustomerRequest, options) {
4221
- return (0, exports.Scout9ApiFp)(this.configuration).customersUpdate(updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
4204
+ customersUpdate(updateCustomersRequest, options) {
4205
+ return (0, exports.Scout9ApiFp)(this.configuration).customersUpdate(updateCustomersRequest, options).then((request) => request(this.axios, this.basePath));
4222
4206
  }
4223
4207
  /**
4224
- *
4225
- * @summary Returns information about a specific file.
4226
- * @param {string} fileId The ID of the file to use for this request
4208
+ * Deletes an entity with the specified type and ID.
4209
+ * @summary Delete an entity
4210
+ * @param {string} type
4211
+ * @param {string} id
4227
4212
  * @param {*} [options] Override http request option.
4228
4213
  * @throws {RequiredError}
4229
4214
  * @memberof Scout9Api
4230
4215
  */
4231
- file(fileId, options) {
4232
- return (0, exports.Scout9ApiFp)(this.configuration).file(fileId, options).then((request) => request(this.axios, this.basePath));
4216
+ deleteEntity(type, id, options) {
4217
+ return (0, exports.Scout9ApiFp)(this.configuration).deleteEntity(type, id, options).then((request) => request(this.axios, this.basePath));
4233
4218
  }
4234
4219
  /**
4235
4220
  *
4236
- * @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.
4237
- * @param {File} file
4238
- * @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
4221
+ * @summary Natural language prompt to resolve to a boolean value.
4222
+ * @param {MacroDidInput} macroDidInput
4239
4223
  * @param {*} [options] Override http request option.
4240
4224
  * @throws {RequiredError}
4241
4225
  * @memberof Scout9Api
4242
4226
  */
4243
- fileCreate(file, purpose, options) {
4244
- return (0, exports.Scout9ApiFp)(this.configuration).fileCreate(file, purpose, options).then((request) => request(this.axios, this.basePath));
4227
+ did(macroDidInput, options) {
4228
+ return (0, exports.Scout9ApiFp)(this.configuration).did(macroDidInput, options).then((request) => request(this.axios, this.basePath));
4245
4229
  }
4246
4230
  /**
4247
4231
  *
4248
- * @summary Delete a file.
4249
- * @param {string} fileId The ID of the file to use for this request
4232
+ * @summary Natural language prompt to resolve to a boolean value in relation to the given immediate message.
4233
+ * @param {MacroDoesInput} macroDoesInput
4250
4234
  * @param {*} [options] Override http request option.
4251
4235
  * @throws {RequiredError}
4252
4236
  * @memberof Scout9Api
4253
4237
  */
4254
- fileDelete(fileId, options) {
4255
- return (0, exports.Scout9ApiFp)(this.configuration).fileDelete(fileId, options).then((request) => request(this.axios, this.basePath));
4238
+ does(macroDoesInput, options) {
4239
+ return (0, exports.Scout9ApiFp)(this.configuration).does(macroDoesInput, options).then((request) => request(this.axios, this.basePath));
4256
4240
  }
4257
4241
  /**
4258
4242
  *
4259
- * @summary Returns the contents of the specified file
4260
- * @param {string} fileId The ID of the file to use for this request
4243
+ * @summary Get an entity by type and ID
4244
+ * @param {string} type The type of the entity to fetch
4245
+ * @param {string} id The unique identifier of the entity
4261
4246
  * @param {*} [options] Override http request option.
4262
4247
  * @throws {RequiredError}
4263
4248
  * @memberof Scout9Api
4264
4249
  */
4265
- fileDownload(fileId, options) {
4266
- return (0, exports.Scout9ApiFp)(this.configuration).fileDownload(fileId, options).then((request) => request(this.axios, this.basePath));
4250
+ entity(type, id, options) {
4251
+ return (0, exports.Scout9ApiFp)(this.configuration).entity(type, id, options).then((request) => request(this.axios, this.basePath));
4267
4252
  }
4268
4253
  /**
4269
4254
  *
4270
- * @summary Returns a list of files that belong to the user\'s organization.
4255
+ * @summary Returns a file
4256
+ * @param {string} purpose File categorical purpose
4257
+ * @param {string} [entity] File entity id
4258
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
4271
4259
  * @param {*} [options] Override http request option.
4272
4260
  * @throws {RequiredError}
4273
4261
  * @memberof Scout9Api
4274
4262
  */
4275
- files(options) {
4276
- return (0, exports.Scout9ApiFp)(this.configuration).files(options).then((request) => request(this.axios, this.basePath));
4263
+ file(purpose, entity, agent, options) {
4264
+ return (0, exports.Scout9ApiFp)(this.configuration).file(purpose, entity, agent, options).then((request) => request(this.axios, this.basePath));
4277
4265
  }
4278
4266
  /**
4279
- * 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.
4280
- * @summary Generate a message from conversation
4281
- * @param {GenerateRequest} generateRequest
4282
- * @param {*} [options] Override http request option.
4283
- * @throws {RequiredError}
4284
- * @memberof Scout9Api
4285
- */
4286
- generate(generateRequest, options) {
4287
- return (0, exports.Scout9ApiFp)(this.configuration).generate(generateRequest, options).then((request) => request(this.axios, this.basePath));
4288
- }
4289
- /**
4290
- * 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
4291
- * @summary Create and send message
4292
- * @param {MessageCreateRequest} messageCreateRequest
4267
+ *
4268
+ * @summary Remove a file
4269
+ * @param {string} purpose File categorical purpose
4270
+ * @param {string} entity File entity id
4271
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
4293
4272
  * @param {*} [options] Override http request option.
4294
4273
  * @throws {RequiredError}
4295
4274
  * @memberof Scout9Api
4296
4275
  */
4297
- message(messageCreateRequest, options) {
4298
- return (0, exports.Scout9ApiFp)(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
4276
+ fileRemove(purpose, entity, agent, options) {
4277
+ return (0, exports.Scout9ApiFp)(this.configuration).fileRemove(purpose, entity, agent, options).then((request) => request(this.axios, this.basePath));
4299
4278
  }
4300
4279
  /**
4301
4280
  *
4302
- * @summary Get all messages from a conversation
4303
- * @param {string} id id of entity to query
4304
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4281
+ * @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.
4282
+ * @param {File} file
4283
+ * @param {PurposeEnum} [purpose]
4284
+ * @param {string} [context] Additional information about this file
4285
+ * @param {string} [entity] The entity id, if not provided the entity id becomes the provided file name
4286
+ * @param {string} [$agent] The agent that this file belongs to. Only used for entity.audio and entity.transcript files.
4305
4287
  * @param {*} [options] Override http request option.
4306
4288
  * @throws {RequiredError}
4307
4289
  * @memberof Scout9Api
4308
4290
  */
4309
- messages(id, q, options) {
4310
- return (0, exports.Scout9ApiFp)(this.configuration).messages(id, q, options).then((request) => request(this.axios, this.basePath));
4291
+ fileUpload(file, purpose, context, entity, $agent, options) {
4292
+ return (0, exports.Scout9ApiFp)(this.configuration).fileUpload(file, purpose, context, entity, $agent, options).then((request) => request(this.axios, this.basePath));
4311
4293
  }
4312
4294
  /**
4313
4295
  *
4314
- * @summary Get the results of a bulk API operation
4315
- * @param {string} id id of entity to query
4296
+ * @summary Returns a list of files that belong to the user\'s organization.
4297
+ * @param {string} purpose File categorical purpose
4298
+ * @param {string} [agent] Agent id, only used if purpose is either agent-audio or agent-transcript
4316
4299
  * @param {*} [options] Override http request option.
4317
4300
  * @throws {RequiredError}
4318
4301
  * @memberof Scout9Api
4319
4302
  */
4320
- operation(id, options) {
4321
- return (0, exports.Scout9ApiFp)(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
4303
+ files(purpose, agent, options) {
4304
+ return (0, exports.Scout9ApiFp)(this.configuration).files(purpose, agent, options).then((request) => request(this.axios, this.basePath));
4322
4305
  }
4323
4306
  /**
4324
- *
4325
- * @summary Gets all or specific set of bulk API operations
4326
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4327
- * @param {Array<string>} [id] ids for the entities this id belongs to
4307
+ * Forwards a locked conversation to agent
4308
+ * @summary forwards a locked conversation to agent
4309
+ * @param {ForwardRequest} forwardRequest
4328
4310
  * @param {*} [options] Override http request option.
4329
4311
  * @throws {RequiredError}
4330
4312
  * @memberof Scout9Api
4331
4313
  */
4332
- operations(q, id, options) {
4333
- return (0, exports.Scout9ApiFp)(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
4314
+ forward(forwardRequest, options) {
4315
+ return (0, exports.Scout9ApiFp)(this.configuration).forward(forwardRequest, options).then((request) => request(this.axios, this.basePath));
4334
4316
  }
4335
4317
  /**
4336
- *
4337
- * @summary Creates a new scheduled conversation
4338
- * @param {ScheduleCreateRequest} scheduleCreateRequest
4318
+ * 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.
4319
+ * @summary Generate a message from conversation
4320
+ * @param {GenerateRequest} generateRequest
4321
+ * @param {string} [convo] In relation to which conversation
4339
4322
  * @param {*} [options] Override http request option.
4340
4323
  * @throws {RequiredError}
4341
4324
  * @memberof Scout9Api
4342
4325
  */
4343
- scheduleConversation(scheduleCreateRequest, options) {
4344
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleConversation(scheduleCreateRequest, options).then((request) => request(this.axios, this.basePath));
4326
+ generate(generateRequest, convo, options) {
4327
+ return (0, exports.Scout9ApiFp)(this.configuration).generate(generateRequest, convo, options).then((request) => request(this.axios, this.basePath));
4345
4328
  }
4346
4329
  /**
4347
- *
4348
- * @summary Deletes a schedule
4349
- * @param {string} id id of entity to query
4330
+ * Returns log data for a given range, specified by start and end Unix timestamps.
4331
+ * @summary Retrieve platform run time logs
4332
+ * @param {number} [start]
4333
+ * @param {number} [end]
4350
4334
  * @param {*} [options] Override http request option.
4351
4335
  * @throws {RequiredError}
4352
4336
  * @memberof Scout9Api
4353
4337
  */
4354
- scheduleDelete(id, options) {
4355
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleDelete(id, options).then((request) => request(this.axios, this.basePath));
4338
+ logs(start, end, options) {
4339
+ return (0, exports.Scout9ApiFp)(this.configuration).logs(start, end, options).then((request) => request(this.axios, this.basePath));
4356
4340
  }
4357
4341
  /**
4358
- *
4359
- * @summary Creates a new schedule group
4360
- * @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
4342
+ * 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
4343
+ * @summary Create and send message
4344
+ * @param {MessageCreateRequest} messageCreateRequest
4361
4345
  * @param {*} [options] Override http request option.
4362
4346
  * @throws {RequiredError}
4363
4347
  * @memberof Scout9Api
4364
4348
  */
4365
- scheduleGroupCreate(scheduleGroupCreateRequest, options) {
4366
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupCreate(scheduleGroupCreateRequest, options).then((request) => request(this.axios, this.basePath));
4349
+ message(messageCreateRequest, options) {
4350
+ return (0, exports.Scout9ApiFp)(this.configuration).message(messageCreateRequest, options).then((request) => request(this.axios, this.basePath));
4367
4351
  }
4368
4352
  /**
4369
4353
  *
4370
- * @summary Deletes and cancels a schedule group
4354
+ * @summary Get all messages from a conversation
4371
4355
  * @param {string} id id of entity to query
4356
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4372
4357
  * @param {*} [options] Override http request option.
4373
4358
  * @throws {RequiredError}
4374
4359
  * @memberof Scout9Api
4375
4360
  */
4376
- scheduleGroupDelete(id, options) {
4377
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupDelete(id, options).then((request) => request(this.axios, this.basePath));
4361
+ messages(id, q, options) {
4362
+ return (0, exports.Scout9ApiFp)(this.configuration).messages(id, q, options).then((request) => request(this.axios, this.basePath));
4378
4363
  }
4379
4364
  /**
4380
4365
  *
4381
- * @summary Gets a schedule group
4366
+ * @summary Get the results of a bulk API operation
4382
4367
  * @param {string} id id of entity to query
4383
4368
  * @param {*} [options] Override http request option.
4384
4369
  * @throws {RequiredError}
4385
4370
  * @memberof Scout9Api
4386
4371
  */
4387
- scheduleGroupRetrieve(id, options) {
4388
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupRetrieve(id, options).then((request) => request(this.axios, this.basePath));
4372
+ operation(id, options) {
4373
+ return (0, exports.Scout9ApiFp)(this.configuration).operation(id, options).then((request) => request(this.axios, this.basePath));
4389
4374
  }
4390
4375
  /**
4391
4376
  *
4392
- * @summary Updates a schedule group
4393
- * @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
4377
+ * @summary Gets all or specific set of bulk API operations
4378
+ * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4379
+ * @param {Array<string>} [id] ids for the entities this id belongs to
4394
4380
  * @param {*} [options] Override http request option.
4395
4381
  * @throws {RequiredError}
4396
4382
  * @memberof Scout9Api
4397
4383
  */
4398
- scheduleGroupUpdate(scheduleGroupUpdateRequest, options) {
4399
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleGroupUpdate(scheduleGroupUpdateRequest, options).then((request) => request(this.axios, this.basePath));
4384
+ operations(q, id, options) {
4385
+ return (0, exports.Scout9ApiFp)(this.configuration).operations(q, id, options).then((request) => request(this.axios, this.basePath));
4400
4386
  }
4401
4387
  /**
4402
- *
4403
- * @summary Gets a schedule
4404
- * @param {string} id id of entity to query
4388
+ * Parses a message\'s custom context relevant to your organization. This is useful for extracting information from a message to drive your auto reply workflows.
4389
+ * @summary Parse a message\'s custom context relevant to your organization
4390
+ * @param {ParseRequest} parseRequest
4405
4391
  * @param {*} [options] Override http request option.
4406
4392
  * @throws {RequiredError}
4407
4393
  * @memberof Scout9Api
4408
4394
  */
4409
- scheduleRetrieve(id, options) {
4410
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleRetrieve(id, options).then((request) => request(this.axios, this.basePath));
4395
+ parse(parseRequest, options) {
4396
+ return (0, exports.Scout9ApiFp)(this.configuration).parse(parseRequest, options).then((request) => request(this.axios, this.basePath));
4411
4397
  }
4412
4398
  /**
4413
4399
  *
4414
- * @summary Updates a schedule
4415
- * @param {ScheduleUpdateRequest} scheduleUpdateRequest
4400
+ * @summary Purchase phone for a given agent.
4401
+ * @param {PurchasePhoneRequest} [purchasePhoneRequest] If no agent id is provided, the phone will be purchased for the owner of the API key.
4416
4402
  * @param {*} [options] Override http request option.
4417
4403
  * @throws {RequiredError}
4418
4404
  * @memberof Scout9Api
4419
4405
  */
4420
- scheduleUpdate(scheduleUpdateRequest, options) {
4421
- return (0, exports.Scout9ApiFp)(this.configuration).scheduleUpdate(scheduleUpdateRequest, options).then((request) => request(this.axios, this.basePath));
4406
+ purchasePhone(purchasePhoneRequest, options) {
4407
+ return (0, exports.Scout9ApiFp)(this.configuration).purchasePhone(purchasePhoneRequest, options).then((request) => request(this.axios, this.basePath));
4422
4408
  }
4423
4409
  /**
4424
- *
4425
- * @summary Gets a workflow
4426
- * @param {string} id id of entity to query
4410
+ * Replaces an existing entity with the specified type and ID with a new entity.
4411
+ * @summary Replace an existing entity
4412
+ * @param {string} type
4413
+ * @param {string} id
4414
+ * @param {EntityData} entityData
4427
4415
  * @param {*} [options] Override http request option.
4428
4416
  * @throws {RequiredError}
4429
4417
  * @memberof Scout9Api
4430
4418
  */
4431
- workflow(id, options) {
4432
- return (0, exports.Scout9ApiFp)(this.configuration).workflow(id, options).then((request) => request(this.axios, this.basePath));
4419
+ replaceEntity(type, id, entityData, options) {
4420
+ return (0, exports.Scout9ApiFp)(this.configuration).replaceEntity(type, id, entityData, options).then((request) => request(this.axios, this.basePath));
4433
4421
  }
4434
4422
  /**
4435
4423
  *
4436
- * @summary Create a new workflow
4437
- * @param {CreateWorkflowRequest} createWorkflowRequest
4424
+ * @summary Runs your auto-reply app on the Scout9 platform.
4425
+ * @param {WorkflowEvent} workflowEvent
4438
4426
  * @param {*} [options] Override http request option.
4439
4427
  * @throws {RequiredError}
4440
4428
  * @memberof Scout9Api
4441
4429
  */
4442
- workflowCreate(createWorkflowRequest, options) {
4443
- return (0, exports.Scout9ApiFp)(this.configuration).workflowCreate(createWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4430
+ runPlatform(workflowEvent, options) {
4431
+ return (0, exports.Scout9ApiFp)(this.configuration).runPlatform(workflowEvent, options).then((request) => request(this.axios, this.basePath));
4444
4432
  }
4445
4433
  /**
4446
4434
  *
4447
- * @summary Deletes a workflow
4448
- * @param {string} id id of entity to query
4435
+ * @summary Returns the platform run config
4449
4436
  * @param {*} [options] Override http request option.
4450
4437
  * @throws {RequiredError}
4451
4438
  * @memberof Scout9Api
4452
4439
  */
4453
- workflowDelete(id, options) {
4454
- return (0, exports.Scout9ApiFp)(this.configuration).workflowDelete(id, options).then((request) => request(this.axios, this.basePath));
4440
+ runPlatformConfig(options) {
4441
+ return (0, exports.Scout9ApiFp)(this.configuration).runPlatformConfig(options).then((request) => request(this.axios, this.basePath));
4455
4442
  }
4456
4443
  /**
4457
- *
4458
- * @summary Update a workflow
4459
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
4444
+ * xxx
4445
+ * @summary xxx
4446
+ * @param {GenerateRequest} generateRequest
4447
+ * @param {string} [convo] xxx
4460
4448
  * @param {*} [options] Override http request option.
4461
4449
  * @throws {RequiredError}
4462
4450
  * @memberof Scout9Api
4463
4451
  */
4464
- workflowUpdate(updateWorkflowRequest, options) {
4465
- return (0, exports.Scout9ApiFp)(this.configuration).workflowUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4452
+ temp(generateRequest, convo, options) {
4453
+ return (0, exports.Scout9ApiFp)(this.configuration).temp(generateRequest, convo, options).then((request) => request(this.axios, this.basePath));
4466
4454
  }
4467
4455
  /**
4468
- *
4469
- * @summary Gets all or specific set of workflows
4470
- * @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
4471
- * @param {Array<string>} [id] ids for the entities this id belongs to
4456
+ * Trains a PMT model based on the uploaded transcripts provided (Will include the ability to add more transcripts)
4457
+ * @summary Trains a given or default persona\'s PMT model
4458
+ * @param {PmtTrainRequest} pmtTrainRequest
4472
4459
  * @param {*} [options] Override http request option.
4473
4460
  * @throws {RequiredError}
4474
4461
  * @memberof Scout9Api
4475
4462
  */
4476
- workflows(q, id, options) {
4477
- return (0, exports.Scout9ApiFp)(this.configuration).workflows(q, id, options).then((request) => request(this.axios, this.basePath));
4463
+ train(pmtTrainRequest, options) {
4464
+ return (0, exports.Scout9ApiFp)(this.configuration).train(pmtTrainRequest, options).then((request) => request(this.axios, this.basePath));
4478
4465
  }
4479
4466
  /**
4480
- *
4481
- * @summary Creates new workflows
4482
- * @param {CreateWorkflowsRequest} createWorkflowsRequest
4467
+ * Transforms a given message and context into the owners own words. Failure to transform would be a lack of transcription data or the message detected as not applicable to the owners intended use.
4468
+ * @summary Transforms a given message and context into the owners own words
4469
+ * @param {PmtTransformRequest} pmtTransformRequest
4483
4470
  * @param {*} [options] Override http request option.
4484
4471
  * @throws {RequiredError}
4485
4472
  * @memberof Scout9Api
4486
4473
  */
4487
- workflowsCreate(createWorkflowsRequest, options) {
4488
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsCreate(createWorkflowsRequest, options).then((request) => request(this.axios, this.basePath));
4474
+ transform(pmtTransformRequest, options) {
4475
+ return (0, exports.Scout9ApiFp)(this.configuration).transform(pmtTransformRequest, options).then((request) => request(this.axios, this.basePath));
4489
4476
  }
4490
4477
  /**
4491
- *
4492
- * @summary Deletes multiple workflows
4493
- * @param {Array<string>} [id] ids for the entities this id belongs to
4478
+ * Updates an existing entity with the specified type and ID.
4479
+ * @summary Update an existing entity
4480
+ * @param {string} type
4481
+ * @param {string} id
4482
+ * @param {EntityData} entityData
4494
4483
  * @param {*} [options] Override http request option.
4495
4484
  * @throws {RequiredError}
4496
4485
  * @memberof Scout9Api
4497
4486
  */
4498
- workflowsDelete(id, options) {
4499
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsDelete(id, options).then((request) => request(this.axios, this.basePath));
4487
+ updateEntity(type, id, entityData, options) {
4488
+ return (0, exports.Scout9ApiFp)(this.configuration).updateEntity(type, id, entityData, options).then((request) => request(this.axios, this.basePath));
4500
4489
  }
4501
- /**
4502
- *
4503
- * @summary Updates multiple workflows
4504
- * @param {UpdateWorkflowRequest} updateWorkflowRequest
4505
- * @param {*} [options] Override http request option.
4506
- * @throws {RequiredError}
4507
- * @memberof Scout9Api
4508
- */
4509
- workflowsUpdate(updateWorkflowRequest, options) {
4510
- return (0, exports.Scout9ApiFp)(this.configuration).workflowsUpdate(updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
4490
+ }
4491
+ exports.Scout9ApiGenerated = Scout9ApiGenerated;
4492
+ const stream_1 = require("stream");
4493
+ /**
4494
+ * Scout9Api - object-oriented interface
4495
+ * @export
4496
+ * @class Scout9Api
4497
+ * @extends {Scout9ApiGenerated}
4498
+ */
4499
+ class Scout9Api extends Scout9ApiGenerated {
4500
+ organizationLogo(file) {
4501
+ (0, common_1.assertParamExists)('organizationLogo', 'file', file);
4502
+ const formData = new ((this.configuration && this.configuration.formDataCtor) || FormData)();
4503
+ if (Buffer.isBuffer(file)) {
4504
+ // Convert Buffer to Blob
4505
+ file = new Blob([file], { type: 'application/octet-stream' });
4506
+ // Convert Blob to Stream
4507
+ const fileStream = stream_1.Readable.from(file.stream());
4508
+ formData.append('file', fileStream, 'logo');
4509
+ }
4510
+ else {
4511
+ formData.append('file', file, file?.name || 'logo');
4512
+ }
4513
+ return this.axios.request({
4514
+ method: 'POST',
4515
+ url: `${this.configuration?.basePath || base_1.BASE_PATH}/v1-organizationLogo`,
4516
+ data: formData,
4517
+ headers: {
4518
+ 'Content-Type': 'multipart/form-data',
4519
+ 'Authorization': 'Bearer ' + this.configuration?.apiKey || '',
4520
+ }
4521
+ });
4522
+ }
4523
+ organizationIcon(file) {
4524
+ (0, common_1.assertParamExists)('organizationLogo', 'file', file);
4525
+ const formData = new ((this.configuration && this.configuration.formDataCtor) || FormData)();
4526
+ if (Buffer.isBuffer(file)) {
4527
+ // Convert Buffer to Blob
4528
+ file = new Blob([file], { type: 'application/octet-stream' });
4529
+ // Convert Blob to Stream
4530
+ const fileStream = stream_1.Readable.from(file.stream());
4531
+ formData.append('file', fileStream, 'icon');
4532
+ }
4533
+ else {
4534
+ formData.append('file', file, file?.name || 'icon');
4535
+ }
4536
+ return this.axios.request({
4537
+ method: 'POST',
4538
+ url: `${this.configuration?.basePath || base_1.BASE_PATH}/v1-organizationIcon`,
4539
+ data: formData,
4540
+ headers: {
4541
+ 'Content-Type': 'multipart/form-data',
4542
+ 'Authorization': 'Bearer ' + this.configuration?.apiKey || '',
4543
+ }
4544
+ });
4545
+ }
4546
+ agentProfileUpload(agentId = '', file) {
4547
+ // assertParamExists('agentProfileUpload', 'agentId', agentId);
4548
+ (0, common_1.assertParamExists)('agentProfileUpload', 'file', file);
4549
+ const formData = new ((this.configuration && this.configuration.formDataCtor) || FormData)();
4550
+ if (Buffer.isBuffer(file)) {
4551
+ // Convert Buffer to Blob
4552
+ file = new Blob([file], { type: "application/octet-stream" });
4553
+ // Convert Blob to Stream
4554
+ const fileStream = stream_1.Readable.from(file.stream());
4555
+ formData.append('file', fileStream, 'profile');
4556
+ }
4557
+ else {
4558
+ formData.append('file', file, file?.name || 'profile');
4559
+ }
4560
+ if (agentId) {
4561
+ formData.append('agentId', agentId);
4562
+ }
4563
+ return this.axios.request({
4564
+ method: 'POST',
4565
+ url: `${this.configuration?.basePath || base_1.BASE_PATH}/v1-agentImg`,
4566
+ data: formData,
4567
+ headers: {
4568
+ 'Content-Type': 'multipart/form-data',
4569
+ 'Authorization': 'Bearer ' + this.configuration?.apiKey || '',
4570
+ }
4571
+ });
4572
+ }
4573
+ agentTranscriptUpload(agentId = '', transcripts) {
4574
+ // assertParamExists('agentProfileUpload', 'agentId', agentId);
4575
+ (0, common_1.assertParamExists)('agentProfileUpload', 'transcripts', transcripts);
4576
+ const formData = new ((this.configuration && this.configuration.formDataCtor) || FormData)();
4577
+ if (agentId) {
4578
+ formData.append('agentId', agentId);
4579
+ }
4580
+ transcripts.forEach((file, i) => {
4581
+ if (Buffer.isBuffer(file)) {
4582
+ // Convert Buffer to Blob
4583
+ file = new Blob([file], { type: "text/plain" });
4584
+ // Convert Blob to Stream
4585
+ const fileStream = stream_1.Readable.from(file.stream());
4586
+ formData.append(`transcripts[${i}]`, fileStream, file?.name || 'transcript' + i);
4587
+ }
4588
+ else {
4589
+ formData.append(`transcripts[${i}]`, file, file?.name || 'transcript' + i);
4590
+ }
4591
+ });
4592
+ return this.axios.request({
4593
+ method: 'POST',
4594
+ url: `${this.configuration?.basePath || base_1.BASE_PATH}/v1-agentTranscripts`,
4595
+ data: formData,
4596
+ headers: {
4597
+ 'Content-Type': 'multipart/form-data',
4598
+ 'Authorization': 'Bearer ' + this.configuration?.apiKey || '',
4599
+ }
4600
+ });
4601
+ }
4602
+ agentAudioUpload(agentId = '', audios) {
4603
+ // assertParamExists('agentProfileUpload', 'agentId', agentId);
4604
+ (0, common_1.assertParamExists)('agentProfileUpload', 'audios', audios);
4605
+ const formData = new ((this.configuration && this.configuration.formDataCtor) || FormData)();
4606
+ if (agentId) {
4607
+ formData.append('agentId', agentId);
4608
+ }
4609
+ audios.forEach((file, i) => {
4610
+ if (Buffer.isBuffer(file)) {
4611
+ // Convert Buffer to Blob
4612
+ file = new Blob([file], { type: "application/octet-stream" });
4613
+ // Convert Blob to Stream
4614
+ const fileStream = stream_1.Readable.from(file.stream());
4615
+ formData.append(`audios[${i}]`, fileStream, file?.name || 'audio' + i);
4616
+ }
4617
+ else {
4618
+ formData.append(`audios[${i}]`, file, file?.name || 'audio' + i);
4619
+ }
4620
+ });
4621
+ return this.axios.request({
4622
+ method: 'POST',
4623
+ url: `${this.configuration?.basePath || base_1.BASE_PATH}/v1-agentAudios`,
4624
+ data: formData,
4625
+ headers: {
4626
+ 'Content-Type': 'multipart/form-data',
4627
+ 'Authorization': 'Bearer ' + this.configuration?.apiKey || '',
4628
+ }
4629
+ });
4511
4630
  }
4512
4631
  }
4513
4632
  exports.Scout9Api = Scout9Api;