@quantcdn/quant-client 4.2.1 → 4.3.0

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/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * QuantCDN API
5
5
  * Unified API for QuantCDN Admin and QuantCloud Platform services
6
6
  *
7
- * The version of the OpenAPI document: 4.2.1
7
+ * The version of the OpenAPI document: 4.3.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,6 +34,21 @@ export const ApplicationImageReferenceTypeEnum = {
34
34
  Internal: 'internal',
35
35
  External: 'external'
36
36
  };
37
+ export const ChatInference200ResponseFinishReasonEnum = {
38
+ Stop: 'stop',
39
+ Length: 'length',
40
+ ContentFilter: 'content_filter',
41
+ ToolUse: 'tool_use'
42
+ };
43
+ export const ChatInference200ResponseResponseRoleEnum = {
44
+ Assistant: 'assistant'
45
+ };
46
+ export const ChatInference200ResponseResponseToolUseOneOfStatusEnum = {
47
+ Pending: 'pending',
48
+ Running: 'running',
49
+ Complete: 'complete',
50
+ Failed: 'failed'
51
+ };
37
52
  export const ChatInferenceRequestMessagesInnerRoleEnum = {
38
53
  User: 'user',
39
54
  Assistant: 'assistant',
@@ -105,6 +120,12 @@ export const EmbeddingsRequestDimensionsEnum = {
105
120
  NUMBER_1024: 1024,
106
121
  NUMBER_8192: 8192
107
122
  };
123
+ export const GetToolExecutionStatus200ResponseStatusEnum = {
124
+ Pending: 'pending',
125
+ Running: 'running',
126
+ Complete: 'complete',
127
+ Failed: 'failed'
128
+ };
108
129
  export const ImageGenerationRequestTaskTypeEnum = {
109
130
  TextImage: 'TEXT_IMAGE',
110
131
  ColorGuidedGeneration: 'COLOR_GUIDED_GENERATION',
@@ -141,311 +162,31 @@ export const ImageGenerationRequestTextToImageParamsControlModeEnum = {
141
162
  CannyEdge: 'CANNY_EDGE',
142
163
  Segmentation: 'SEGMENTATION'
143
164
  };
165
+ export const ListToolExecutions200ResponseExecutionsInnerStatusEnum = {
166
+ Pending: 'pending',
167
+ Running: 'running',
168
+ Complete: 'complete',
169
+ Failed: 'failed'
170
+ };
144
171
  export const ScalingPolicyMetricEnum = {
145
172
  CpuUtilization: 'CPUUtilization',
146
173
  MemoryUtilization: 'MemoryUtilization',
147
174
  Rps: 'RPS'
148
175
  };
176
+ export const SpotConfigurationStrategyEnum = {
177
+ Off: 'off',
178
+ SpotOnly: 'spot-only',
179
+ MixedSafe: 'mixed-safe',
180
+ MixedAggressive: 'mixed-aggressive'
181
+ };
149
182
  export const V1TransitionStateEnum = {
150
183
  Published: 'published',
151
184
  Unpublished: 'unpublished'
152
185
  };
153
- export const V2CrawlerModeEnum = {
154
- Report: 'report',
155
- Block: 'block'
156
- };
157
- export const V2CrawlerRequestModeEnum = {
158
- Report: 'report',
159
- Block: 'block'
160
- };
161
- export const V2CrawlerScheduleModeEnum = {
162
- Report: 'report',
163
- Block: 'block'
164
- };
165
- export const V2CrawlerScheduleRequestModeEnum = {
166
- Report: 'report',
167
- Block: 'block'
168
- };
169
- export const V2DomainModeEnum = {
170
- Report: 'report',
171
- Block: 'block'
172
- };
173
- export const V2DomainRequestModeEnum = {
174
- Report: 'report',
175
- Block: 'block'
176
- };
177
- export const V2OrganizationModeEnum = {
178
- Report: 'report',
179
- Block: 'block'
180
- };
181
- export const V2OrganizationRequestModeEnum = {
182
- Report: 'report',
183
- Block: 'block'
184
- };
185
- export const V2ProjectModeEnum = {
186
- Report: 'report',
187
- Block: 'block'
188
- };
189
- export const V2ProjectRequestModeEnum = {
190
- Report: 'report',
191
- Block: 'block'
192
- };
193
- export const V2RuleModeEnum = {
194
- Report: 'report',
195
- Block: 'block'
196
- };
197
- export const V2RuleAuthModeEnum = {
198
- Report: 'report',
199
- Block: 'block'
200
- };
201
- export const V2RuleAuthNotifyEnum = {
202
- None: 'none',
203
- Slack: 'slack'
204
- };
205
- export const V2RuleAuthActionModeEnum = {
206
- Report: 'report',
207
- Block: 'block'
208
- };
209
- export const V2RuleAuthActionNotifyEnum = {
210
- None: 'none',
211
- Slack: 'slack'
212
- };
213
- export const V2RuleAuthRequestModeEnum = {
214
- Report: 'report',
215
- Block: 'block'
216
- };
217
- export const V2RuleAuthRequestNotifyEnum = {
218
- None: 'none',
219
- Slack: 'slack'
220
- };
221
- export const V2RuleBotChallengeModeEnum = {
222
- Report: 'report',
223
- Block: 'block'
224
- };
225
- export const V2RuleBotChallengeNotifyEnum = {
226
- None: 'none',
227
- Slack: 'slack'
228
- };
229
- export const V2RuleBotChallengeActionModeEnum = {
230
- Report: 'report',
231
- Block: 'block'
232
- };
233
- export const V2RuleBotChallengeActionNotifyEnum = {
234
- None: 'none',
235
- Slack: 'slack'
236
- };
237
- export const V2RuleBotChallengeRequestModeEnum = {
238
- Report: 'report',
239
- Block: 'block'
240
- };
241
- export const V2RuleBotChallengeRequestNotifyEnum = {
242
- None: 'none',
243
- Slack: 'slack'
244
- };
245
- export const V2RuleContentFilterModeEnum = {
246
- Report: 'report',
247
- Block: 'block'
248
- };
249
- export const V2RuleContentFilterNotifyEnum = {
250
- None: 'none',
251
- Slack: 'slack'
252
- };
253
- export const V2RuleContentFilterActionModeEnum = {
254
- Report: 'report',
255
- Block: 'block'
256
- };
257
- export const V2RuleContentFilterActionNotifyEnum = {
258
- None: 'none',
259
- Slack: 'slack'
260
- };
261
- export const V2RuleContentFilterRequestModeEnum = {
262
- Report: 'report',
263
- Block: 'block'
264
- };
265
- export const V2RuleContentFilterRequestNotifyEnum = {
266
- None: 'none',
267
- Slack: 'slack'
268
- };
269
- export const V2RuleCustomResponseModeEnum = {
270
- Report: 'report',
271
- Block: 'block'
272
- };
273
- export const V2RuleCustomResponseNotifyEnum = {
274
- None: 'none',
275
- Slack: 'slack'
276
- };
277
- export const V2RuleCustomResponseActionModeEnum = {
278
- Report: 'report',
279
- Block: 'block'
280
- };
281
- export const V2RuleCustomResponseActionNotifyEnum = {
282
- None: 'none',
283
- Slack: 'slack'
284
- };
285
- export const V2RuleCustomResponseRequestModeEnum = {
286
- Report: 'report',
287
- Block: 'block'
288
- };
289
- export const V2RuleCustomResponseRequestNotifyEnum = {
290
- None: 'none',
291
- Slack: 'slack'
292
- };
293
- export const V2RuleFunctionModeEnum = {
294
- Report: 'report',
295
- Block: 'block'
296
- };
297
- export const V2RuleFunctionNotifyEnum = {
298
- None: 'none',
299
- Slack: 'slack'
300
- };
301
- export const V2RuleFunctionActionModeEnum = {
302
- Report: 'report',
303
- Block: 'block'
304
- };
305
- export const V2RuleFunctionActionNotifyEnum = {
306
- None: 'none',
307
- Slack: 'slack'
308
- };
309
- export const V2RuleFunctionRequestModeEnum = {
310
- Report: 'report',
311
- Block: 'block'
312
- };
313
- export const V2RuleFunctionRequestNotifyEnum = {
314
- None: 'none',
315
- Slack: 'slack'
316
- };
317
- export const V2RuleHeaderModeEnum = {
318
- Report: 'report',
319
- Block: 'block'
320
- };
321
- export const V2RuleHeaderNotifyEnum = {
322
- None: 'none',
323
- Slack: 'slack'
324
- };
325
- export const V2RuleHeaderActionModeEnum = {
326
- Report: 'report',
327
- Block: 'block'
328
- };
329
- export const V2RuleHeaderActionNotifyEnum = {
330
- None: 'none',
331
- Slack: 'slack'
332
- };
333
- export const V2RuleHeaderRequestModeEnum = {
334
- Report: 'report',
335
- Block: 'block'
336
- };
337
- export const V2RuleHeaderRequestNotifyEnum = {
338
- None: 'none',
339
- Slack: 'slack'
340
- };
341
- export const V2RuleProxyModeEnum = {
342
- Report: 'report',
343
- Block: 'block'
344
- };
345
- export const V2RuleProxyNotifyEnum = {
346
- None: 'none',
347
- Slack: 'slack'
348
- };
349
- export const V2RuleProxyActionModeEnum = {
350
- Report: 'report',
351
- Block: 'block'
352
- };
353
186
  export const V2RuleProxyActionNotifyEnum = {
354
187
  None: 'none',
355
188
  Slack: 'slack'
356
189
  };
357
- export const V2RuleProxyRequestModeEnum = {
358
- Report: 'report',
359
- Block: 'block'
360
- };
361
- export const V2RuleProxyRequestNotifyEnum = {
362
- None: 'none',
363
- Slack: 'slack'
364
- };
365
- export const V2RuleRedirectModeEnum = {
366
- Report: 'report',
367
- Block: 'block'
368
- };
369
- export const V2RuleRedirectNotifyEnum = {
370
- None: 'none',
371
- Slack: 'slack'
372
- };
373
- export const V2RuleRedirectActionModeEnum = {
374
- Report: 'report',
375
- Block: 'block'
376
- };
377
- export const V2RuleRedirectActionNotifyEnum = {
378
- None: 'none',
379
- Slack: 'slack'
380
- };
381
- export const V2RuleRedirectRequestModeEnum = {
382
- Report: 'report',
383
- Block: 'block'
384
- };
385
- export const V2RuleRedirectRequestNotifyEnum = {
386
- None: 'none',
387
- Slack: 'slack'
388
- };
389
- export const V2RuleRequestModeEnum = {
390
- Report: 'report',
391
- Block: 'block'
392
- };
393
- export const V2RuleServeStaticModeEnum = {
394
- Report: 'report',
395
- Block: 'block'
396
- };
397
- export const V2RuleServeStaticNotifyEnum = {
398
- None: 'none',
399
- Slack: 'slack'
400
- };
401
- export const V2RuleServeStaticActionModeEnum = {
402
- Report: 'report',
403
- Block: 'block'
404
- };
405
- export const V2RuleServeStaticActionNotifyEnum = {
406
- None: 'none',
407
- Slack: 'slack'
408
- };
409
- export const V2RuleServeStaticRequestModeEnum = {
410
- Report: 'report',
411
- Block: 'block'
412
- };
413
- export const V2RuleServeStaticRequestNotifyEnum = {
414
- None: 'none',
415
- Slack: 'slack'
416
- };
417
- export const V2SecretStoreModeEnum = {
418
- Report: 'report',
419
- Block: 'block'
420
- };
421
- export const V2SecretStoreRequestModeEnum = {
422
- Report: 'report',
423
- Block: 'block'
424
- };
425
- export const V2StoreModeEnum = {
426
- Report: 'report',
427
- Block: 'block'
428
- };
429
- export const V2StoreItemModeEnum = {
430
- Report: 'report',
431
- Block: 'block'
432
- };
433
- export const V2StoreItemRequestModeEnum = {
434
- Report: 'report',
435
- Block: 'block'
436
- };
437
- export const V2StoreItemUpdateRequestModeEnum = {
438
- Report: 'report',
439
- Block: 'block'
440
- };
441
- export const V2StoreItemsListResponseModeEnum = {
442
- Report: 'report',
443
- Block: 'block'
444
- };
445
- export const V2StoreRequestModeEnum = {
446
- Report: 'report',
447
- Block: 'block'
448
- };
449
190
  export const WafConfigModeEnum = {
450
191
  Report: 'report',
451
192
  Block: 'block'
@@ -467,7 +208,7 @@ export const WafConfigThresholdsInnerModeEnum = {
467
208
  export const AIServicesApiAxiosParamCreator = function (configuration) {
468
209
  return {
469
210
  /**
470
- * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size
211
+ * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size * * **Response Patterns:** * - **Text-only**: Returns simple text response when no tools requested * - **Single tool**: Returns `toolUse` object when AI requests one tool * - **Multiple tools**: Returns `toolUse` array when AI requests multiple tools * - **Auto-execute sync**: Automatically executes tool and returns final text response * - **Auto-execute async**: Returns toolUse with `executionId` and `status` for polling
471
212
  * @summary Chat inference via API Gateway (buffered responses) with multimodal support
472
213
  * @param {string} organisation The organisation ID
473
214
  * @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
@@ -726,10 +467,159 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
726
467
  * @param {*} [options] Override http request option.
727
468
  * @throws {RequiredError}
728
469
  */
729
- getAIUsageStats: (organisation, month, options = {}) => __awaiter(this, void 0, void 0, function* () {
470
+ getAIUsageStats: (organisation, month, options = {}) => __awaiter(this, void 0, void 0, function* () {
471
+ // verify required parameter 'organisation' is not null or undefined
472
+ assertParamExists('getAIUsageStats', 'organisation', organisation);
473
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/usage`
474
+ .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
475
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
476
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
477
+ let baseOptions;
478
+ if (configuration) {
479
+ baseOptions = configuration.baseOptions;
480
+ }
481
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
482
+ const localVarHeaderParameter = {};
483
+ const localVarQueryParameter = {};
484
+ // authentication BearerAuth required
485
+ // http bearer authentication required
486
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
487
+ if (month !== undefined) {
488
+ localVarQueryParameter['month'] = month;
489
+ }
490
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
491
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
492
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
493
+ return {
494
+ url: toPathString(localVarUrlObj),
495
+ options: localVarRequestOptions,
496
+ };
497
+ }),
498
+ /**
499
+ * Retrieves the status and result of an async tool execution. Used for polling long-running tools like image generation. * * **Async Tool Execution Pattern:** * This endpoint enables a polling pattern for long-running tools that would otherwise hit API Gateway\'s 30-second timeout. * * **Flow:** * 1. AI requests tool use (e.g., `generate_image`) * 2. Chat API returns `toolUse` with execution tracking info * 3. Client starts polling this endpoint with the `executionId` * 4. When `status === \'complete\'`, retrieve `result` and send back to AI * 5. AI incorporates result into final response * * **Status Values:** * - `pending`: Tool execution queued, not yet started * - `running`: Tool is currently executing * - `complete`: Tool execution finished successfully, `result` available * - `failed`: Tool execution failed, `error` available * * **Polling Recommendations:** * - Poll every 2-3 seconds for image generation * - Exponential backoff for other tools (start 1s, max 5s) * - Stop polling after 5 minutes (consider failed) * - Auto-cleanup after 24 hours (TTL) * * **Use Cases:** * - Image generation (10-15s typical runtime) * - Video processing * - Large file uploads/downloads * - Complex database queries * - External API calls with high latency
500
+ * @summary Get async tool execution status and result
501
+ * @param {string} organisation The organisation ID
502
+ * @param {string} executionId Tool execution identifier
503
+ * @param {*} [options] Override http request option.
504
+ * @throws {RequiredError}
505
+ */
506
+ getToolExecutionStatus: (organisation, executionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
507
+ // verify required parameter 'organisation' is not null or undefined
508
+ assertParamExists('getToolExecutionStatus', 'organisation', organisation);
509
+ // verify required parameter 'executionId' is not null or undefined
510
+ assertParamExists('getToolExecutionStatus', 'executionId', executionId);
511
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/executions/{executionId}`
512
+ .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
513
+ .replace(`{${"executionId"}}`, encodeURIComponent(String(executionId)));
514
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
515
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
516
+ let baseOptions;
517
+ if (configuration) {
518
+ baseOptions = configuration.baseOptions;
519
+ }
520
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
521
+ const localVarHeaderParameter = {};
522
+ const localVarQueryParameter = {};
523
+ // authentication BearerAuth required
524
+ // http bearer authentication required
525
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
526
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
527
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
528
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
529
+ return {
530
+ url: toPathString(localVarUrlObj),
531
+ options: localVarRequestOptions,
532
+ };
533
+ }),
534
+ /**
535
+ * Generates images using Amazon Nova Canvas image generation model. * * **Region Restriction:** Nova Canvas is ONLY available in: * - `us-east-1` (US East, N. Virginia) * - `ap-northeast-1` (Asia Pacific, Tokyo) * - `eu-west-1` (Europe, Ireland) * ❌ NOT available in `ap-southeast-2` (Sydney) * * **Supported Task Types:** * - **TEXT_IMAGE**: Basic text-to-image generation * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge detection or segmentation * - **COLOR_GUIDED_GENERATION**: Generate images with specific color palettes * - **IMAGE_VARIATION**: Create variations of existing images * - **INPAINTING**: Fill masked areas in images * - **OUTPAINTING**: Extend images beyond their borders * - **BACKGROUND_REMOVAL**: Remove backgrounds from images * - **VIRTUAL_TRY_ON**: Try on garments/objects on people * * **Quality Options:** * - **standard**: Faster generation, lower cost * - **premium**: Higher quality, slower generation * * **Timeout:** Image generation can take up to 5 minutes
536
+ * @summary Generate images with Amazon Nova Canvas
537
+ * @param {string} organisation The organisation ID
538
+ * @param {ImageGenerationRequest} imageGenerationRequest Image generation request
539
+ * @param {*} [options] Override http request option.
540
+ * @throws {RequiredError}
541
+ */
542
+ imageGeneration: (organisation, imageGenerationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
543
+ // verify required parameter 'organisation' is not null or undefined
544
+ assertParamExists('imageGeneration', 'organisation', organisation);
545
+ // verify required parameter 'imageGenerationRequest' is not null or undefined
546
+ assertParamExists('imageGeneration', 'imageGenerationRequest', imageGenerationRequest);
547
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/image-generation`
548
+ .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
549
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
550
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
551
+ let baseOptions;
552
+ if (configuration) {
553
+ baseOptions = configuration.baseOptions;
554
+ }
555
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
556
+ const localVarHeaderParameter = {};
557
+ const localVarQueryParameter = {};
558
+ // authentication BearerAuth required
559
+ // http bearer authentication required
560
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
561
+ localVarHeaderParameter['Content-Type'] = 'application/json';
562
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
563
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
564
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
565
+ localVarRequestOptions.data = serializeDataIfNeeded(imageGenerationRequest, localVarRequestOptions, configuration);
566
+ return {
567
+ url: toPathString(localVarUrlObj),
568
+ options: localVarRequestOptions,
569
+ };
570
+ }),
571
+ /**
572
+ *
573
+ * @summary List available AI models for an organization
574
+ * @param {string} organisation The organisation ID
575
+ * @param {ListAIModelsFeatureEnum} [feature] Filter models by supported feature
576
+ * @param {*} [options] Override http request option.
577
+ * @throws {RequiredError}
578
+ */
579
+ listAIModels: (organisation, feature, options = {}) => __awaiter(this, void 0, void 0, function* () {
580
+ // verify required parameter 'organisation' is not null or undefined
581
+ assertParamExists('listAIModels', 'organisation', organisation);
582
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/models`
583
+ .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
584
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
585
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
586
+ let baseOptions;
587
+ if (configuration) {
588
+ baseOptions = configuration.baseOptions;
589
+ }
590
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
591
+ const localVarHeaderParameter = {};
592
+ const localVarQueryParameter = {};
593
+ // authentication BearerAuth required
594
+ // http bearer authentication required
595
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
596
+ if (feature !== undefined) {
597
+ localVarQueryParameter['feature'] = feature;
598
+ }
599
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
600
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
601
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
602
+ return {
603
+ url: toPathString(localVarUrlObj),
604
+ options: localVarRequestOptions,
605
+ };
606
+ }),
607
+ /**
608
+ * Lists active sessions for an organization with flexible filtering options. * * **Query Combinations:** * 1. By Organization (default): Returns all sessions in the organization * 2. By Organization + Group: `?sessionGroup=drupal-prod` - Sessions in a specific group * 3. By User: `?userId=user-123` - All sessions for a user * 4. By User + Group: `?userId=user-123&sessionGroup=drupal-prod` - User\'s sessions in a specific group * * **Use Cases:** * - List user\'s conversations in a specific app/environment * - Admin view of all sessions in a customer/tenant group * - User profile showing all AI conversations across apps
609
+ * @summary List chat sessions with multi-tenant filtering
610
+ * @param {string} organisation The organisation ID
611
+ * @param {string} [userId] Filter sessions by user ID
612
+ * @param {string} [sessionGroup] Filter by session group. Returns only sessions matching the specified group.
613
+ * @param {number} [limit] Maximum number of sessions to return (default 50, max 100)
614
+ * @param {number} [offset] Offset for pagination
615
+ * @param {string} [model] Filter by model ID
616
+ * @param {*} [options] Override http request option.
617
+ * @throws {RequiredError}
618
+ */
619
+ listAISessions: (organisation, userId, sessionGroup, limit, offset, model, options = {}) => __awaiter(this, void 0, void 0, function* () {
730
620
  // verify required parameter 'organisation' is not null or undefined
731
- assertParamExists('getAIUsageStats', 'organisation', organisation);
732
- const localVarPath = `/api/v3/organizations/{organisation}/ai/usage`
621
+ assertParamExists('listAISessions', 'organisation', organisation);
622
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/sessions`
733
623
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
734
624
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
735
625
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -743,8 +633,20 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
743
633
  // authentication BearerAuth required
744
634
  // http bearer authentication required
745
635
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
746
- if (month !== undefined) {
747
- localVarQueryParameter['month'] = month;
636
+ if (userId !== undefined) {
637
+ localVarQueryParameter['userId'] = userId;
638
+ }
639
+ if (sessionGroup !== undefined) {
640
+ localVarQueryParameter['sessionGroup'] = sessionGroup;
641
+ }
642
+ if (limit !== undefined) {
643
+ localVarQueryParameter['limit'] = limit;
644
+ }
645
+ if (offset !== undefined) {
646
+ localVarQueryParameter['offset'] = offset;
647
+ }
648
+ if (model !== undefined) {
649
+ localVarQueryParameter['model'] = model;
748
650
  }
749
651
  setSearchParams(localVarUrlObj, localVarQueryParameter);
750
652
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -755,19 +657,16 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
755
657
  };
756
658
  }),
757
659
  /**
758
- * Generates images using Amazon Nova Canvas image generation model. * * **Region Restriction:** Nova Canvas is ONLY available in: * - `us-east-1` (US East, N. Virginia) * - `ap-northeast-1` (Asia Pacific, Tokyo) * - `eu-west-1` (Europe, Ireland) * ❌ NOT available in `ap-southeast-2` (Sydney) * * **Supported Task Types:** * - **TEXT_IMAGE**: Basic text-to-image generation * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge detection or segmentation * - **COLOR_GUIDED_GENERATION**: Generate images with specific color palettes * - **IMAGE_VARIATION**: Create variations of existing images * - **INPAINTING**: Fill masked areas in images * - **OUTPAINTING**: Extend images beyond their borders * - **BACKGROUND_REMOVAL**: Remove backgrounds from images * - **VIRTUAL_TRY_ON**: Try on garments/objects on people * * **Quality Options:** * - **standard**: Faster generation, lower cost * - **premium**: Higher quality, slower generation * * **Timeout:** Image generation can take up to 5 minutes
759
- * @summary Generate images with Amazon Nova Canvas
660
+ * Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
661
+ * @summary List tool names only (lightweight response)
760
662
  * @param {string} organisation The organisation ID
761
- * @param {ImageGenerationRequest} imageGenerationRequest Image generation request
762
663
  * @param {*} [options] Override http request option.
763
664
  * @throws {RequiredError}
764
665
  */
765
- imageGeneration: (organisation, imageGenerationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
666
+ listAIToolNames: (organisation, options = {}) => __awaiter(this, void 0, void 0, function* () {
766
667
  // verify required parameter 'organisation' is not null or undefined
767
- assertParamExists('imageGeneration', 'organisation', organisation);
768
- // verify required parameter 'imageGenerationRequest' is not null or undefined
769
- assertParamExists('imageGeneration', 'imageGenerationRequest', imageGenerationRequest);
770
- const localVarPath = `/api/v3/organizations/{organisation}/ai/image-generation`
668
+ assertParamExists('listAIToolNames', 'organisation', organisation);
669
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/names`
771
670
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
772
671
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
773
672
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -775,34 +674,31 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
775
674
  if (configuration) {
776
675
  baseOptions = configuration.baseOptions;
777
676
  }
778
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
677
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
779
678
  const localVarHeaderParameter = {};
780
679
  const localVarQueryParameter = {};
781
680
  // authentication BearerAuth required
782
681
  // http bearer authentication required
783
682
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
784
- localVarHeaderParameter['Content-Type'] = 'application/json';
785
683
  setSearchParams(localVarUrlObj, localVarQueryParameter);
786
684
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
787
685
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
788
- localVarRequestOptions.data = serializeDataIfNeeded(imageGenerationRequest, localVarRequestOptions, configuration);
789
686
  return {
790
687
  url: toPathString(localVarUrlObj),
791
688
  options: localVarRequestOptions,
792
689
  };
793
690
  }),
794
691
  /**
795
- *
796
- * @summary List available AI models for an organization
692
+ * Retrieves all available built-in tools that can be used with function calling. These tools can be included in `toolConfig` when making AI inference requests. * * **Available Built-in Tools:** * - `get_weather`: Get current weather for a location using Open-Meteo API * - `calculate`: Perform basic mathematical calculations (add, subtract, multiply, divide) * - `search_web`: Search the web for information (mock implementation) * - `generate_image`: Generate images with Amazon Nova Canvas (async execution, 10-15s typical runtime) * * **Use Cases:** * - Discover available tools dynamically without hardcoding * - Get complete tool specifications including input schemas * - Build UI for tool selection * - Validate tool names before sending requests * * **Dynamic Tool Discovery:** * This endpoint enables clients to: * 1. Fetch all available tools on page load * 2. Display tool capabilities to users * 3. Filter tools based on user permissions * 4. Use `allowedTools` whitelist for security * * **Alternative Endpoint:** * - `GET /ai/tools/names` - Returns only tool names (faster, lighter response)
693
+ * @summary List available built-in tools for function calling
797
694
  * @param {string} organisation The organisation ID
798
- * @param {ListAIModelsFeatureEnum} [feature] Filter models by supported feature
799
695
  * @param {*} [options] Override http request option.
800
696
  * @throws {RequiredError}
801
697
  */
802
- listAIModels: (organisation, feature, options = {}) => __awaiter(this, void 0, void 0, function* () {
698
+ listAITools: (organisation, options = {}) => __awaiter(this, void 0, void 0, function* () {
803
699
  // verify required parameter 'organisation' is not null or undefined
804
- assertParamExists('listAIModels', 'organisation', organisation);
805
- const localVarPath = `/api/v3/organizations/{organisation}/ai/models`
700
+ assertParamExists('listAITools', 'organisation', organisation);
701
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/tools`
806
702
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
807
703
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
808
704
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -816,9 +712,6 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
816
712
  // authentication BearerAuth required
817
713
  // http bearer authentication required
818
714
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
819
- if (feature !== undefined) {
820
- localVarQueryParameter['feature'] = feature;
821
- }
822
715
  setSearchParams(localVarUrlObj, localVarQueryParameter);
823
716
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
824
717
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -828,21 +721,18 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
828
721
  };
829
722
  }),
830
723
  /**
831
- * Lists active sessions for an organization with flexible filtering options. * * **Query Combinations:** * 1. By Organization (default): Returns all sessions in the organization * 2. By Organization + Group: `?sessionGroup=drupal-prod` - Sessions in a specific group * 3. By User: `?userId=user-123` - All sessions for a user * 4. By User + Group: `?userId=user-123&sessionGroup=drupal-prod` - User\'s sessions in a specific group * * **Use Cases:** * - List user\'s conversations in a specific app/environment * - Admin view of all sessions in a customer/tenant group * - User profile showing all AI conversations across apps
832
- * @summary List chat sessions with multi-tenant filtering
724
+ * Lists recent async tool executions for an organization. Useful for debugging, monitoring, and building admin UIs. * * **Query Patterns:** * - All recent executions: `GET /ai/tools/executions` * - Filter by status: `GET /ai/tools/executions?status=running` * - Limit results: `GET /ai/tools/executions?limit=20` * * **Results:** * - Ordered by creation time (newest first) * - Limited to 50 by default (configurable via `limit` parameter) * - Only shows executions not yet expired (24h TTL) * * **Use Cases:** * - Monitor all active tool executions * - Debug failed executions * - Build admin dashboards * - Track tool usage patterns * - Audit async operations
725
+ * @summary List tool executions for monitoring and debugging
833
726
  * @param {string} organisation The organisation ID
834
- * @param {string} [userId] Filter sessions by user ID
835
- * @param {string} [sessionGroup] Filter by session group. Returns only sessions matching the specified group.
836
- * @param {number} [limit] Maximum number of sessions to return (default 50, max 100)
837
- * @param {number} [offset] Offset for pagination
838
- * @param {string} [model] Filter by model ID
727
+ * @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
728
+ * @param {number} [limit] Maximum number of executions to return
839
729
  * @param {*} [options] Override http request option.
840
730
  * @throws {RequiredError}
841
731
  */
842
- listAISessions: (organisation, userId, sessionGroup, limit, offset, model, options = {}) => __awaiter(this, void 0, void 0, function* () {
732
+ listToolExecutions: (organisation, status, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
843
733
  // verify required parameter 'organisation' is not null or undefined
844
- assertParamExists('listAISessions', 'organisation', organisation);
845
- const localVarPath = `/api/v3/organizations/{organisation}/ai/sessions`
734
+ assertParamExists('listToolExecutions', 'organisation', organisation);
735
+ const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/executions`
846
736
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
847
737
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
848
738
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -856,21 +746,12 @@ export const AIServicesApiAxiosParamCreator = function (configuration) {
856
746
  // authentication BearerAuth required
857
747
  // http bearer authentication required
858
748
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
859
- if (userId !== undefined) {
860
- localVarQueryParameter['userId'] = userId;
861
- }
862
- if (sessionGroup !== undefined) {
863
- localVarQueryParameter['sessionGroup'] = sessionGroup;
749
+ if (status !== undefined) {
750
+ localVarQueryParameter['status'] = status;
864
751
  }
865
752
  if (limit !== undefined) {
866
753
  localVarQueryParameter['limit'] = limit;
867
754
  }
868
- if (offset !== undefined) {
869
- localVarQueryParameter['offset'] = offset;
870
- }
871
- if (model !== undefined) {
872
- localVarQueryParameter['model'] = model;
873
- }
874
755
  setSearchParams(localVarUrlObj, localVarQueryParameter);
875
756
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
876
757
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -926,7 +807,7 @@ export const AIServicesApiFp = function (configuration) {
926
807
  const localVarAxiosParamCreator = AIServicesApiAxiosParamCreator(configuration);
927
808
  return {
928
809
  /**
929
- * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size
810
+ * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size * * **Response Patterns:** * - **Text-only**: Returns simple text response when no tools requested * - **Single tool**: Returns `toolUse` object when AI requests one tool * - **Multiple tools**: Returns `toolUse` array when AI requests multiple tools * - **Auto-execute sync**: Automatically executes tool and returns final text response * - **Auto-execute async**: Returns toolUse with `executionId` and `status` for polling
930
811
  * @summary Chat inference via API Gateway (buffered responses) with multimodal support
931
812
  * @param {string} organisation The organisation ID
932
813
  * @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
@@ -1060,6 +941,23 @@ export const AIServicesApiFp = function (configuration) {
1060
941
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1061
942
  });
1062
943
  },
944
+ /**
945
+ * Retrieves the status and result of an async tool execution. Used for polling long-running tools like image generation. * * **Async Tool Execution Pattern:** * This endpoint enables a polling pattern for long-running tools that would otherwise hit API Gateway\'s 30-second timeout. * * **Flow:** * 1. AI requests tool use (e.g., `generate_image`) * 2. Chat API returns `toolUse` with execution tracking info * 3. Client starts polling this endpoint with the `executionId` * 4. When `status === \'complete\'`, retrieve `result` and send back to AI * 5. AI incorporates result into final response * * **Status Values:** * - `pending`: Tool execution queued, not yet started * - `running`: Tool is currently executing * - `complete`: Tool execution finished successfully, `result` available * - `failed`: Tool execution failed, `error` available * * **Polling Recommendations:** * - Poll every 2-3 seconds for image generation * - Exponential backoff for other tools (start 1s, max 5s) * - Stop polling after 5 minutes (consider failed) * - Auto-cleanup after 24 hours (TTL) * * **Use Cases:** * - Image generation (10-15s typical runtime) * - Video processing * - Large file uploads/downloads * - Complex database queries * - External API calls with high latency
946
+ * @summary Get async tool execution status and result
947
+ * @param {string} organisation The organisation ID
948
+ * @param {string} executionId Tool execution identifier
949
+ * @param {*} [options] Override http request option.
950
+ * @throws {RequiredError}
951
+ */
952
+ getToolExecutionStatus(organisation, executionId, options) {
953
+ var _a, _b, _c;
954
+ return __awaiter(this, void 0, void 0, function* () {
955
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getToolExecutionStatus(organisation, executionId, options);
956
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
957
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIServicesApi.getToolExecutionStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
958
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
959
+ });
960
+ },
1063
961
  /**
1064
962
  * Generates images using Amazon Nova Canvas image generation model. * * **Region Restriction:** Nova Canvas is ONLY available in: * - `us-east-1` (US East, N. Virginia) * - `ap-northeast-1` (Asia Pacific, Tokyo) * - `eu-west-1` (Europe, Ireland) * ❌ NOT available in `ap-southeast-2` (Sydney) * * **Supported Task Types:** * - **TEXT_IMAGE**: Basic text-to-image generation * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge detection or segmentation * - **COLOR_GUIDED_GENERATION**: Generate images with specific color palettes * - **IMAGE_VARIATION**: Create variations of existing images * - **INPAINTING**: Fill masked areas in images * - **OUTPAINTING**: Extend images beyond their borders * - **BACKGROUND_REMOVAL**: Remove backgrounds from images * - **VIRTUAL_TRY_ON**: Try on garments/objects on people * * **Quality Options:** * - **standard**: Faster generation, lower cost * - **premium**: Higher quality, slower generation * * **Timeout:** Image generation can take up to 5 minutes
1065
963
  * @summary Generate images with Amazon Nova Canvas
@@ -1115,6 +1013,56 @@ export const AIServicesApiFp = function (configuration) {
1115
1013
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1116
1014
  });
1117
1015
  },
1016
+ /**
1017
+ * Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
1018
+ * @summary List tool names only (lightweight response)
1019
+ * @param {string} organisation The organisation ID
1020
+ * @param {*} [options] Override http request option.
1021
+ * @throws {RequiredError}
1022
+ */
1023
+ listAIToolNames(organisation, options) {
1024
+ var _a, _b, _c;
1025
+ return __awaiter(this, void 0, void 0, function* () {
1026
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listAIToolNames(organisation, options);
1027
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1028
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIServicesApi.listAIToolNames']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1029
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1030
+ });
1031
+ },
1032
+ /**
1033
+ * Retrieves all available built-in tools that can be used with function calling. These tools can be included in `toolConfig` when making AI inference requests. * * **Available Built-in Tools:** * - `get_weather`: Get current weather for a location using Open-Meteo API * - `calculate`: Perform basic mathematical calculations (add, subtract, multiply, divide) * - `search_web`: Search the web for information (mock implementation) * - `generate_image`: Generate images with Amazon Nova Canvas (async execution, 10-15s typical runtime) * * **Use Cases:** * - Discover available tools dynamically without hardcoding * - Get complete tool specifications including input schemas * - Build UI for tool selection * - Validate tool names before sending requests * * **Dynamic Tool Discovery:** * This endpoint enables clients to: * 1. Fetch all available tools on page load * 2. Display tool capabilities to users * 3. Filter tools based on user permissions * 4. Use `allowedTools` whitelist for security * * **Alternative Endpoint:** * - `GET /ai/tools/names` - Returns only tool names (faster, lighter response)
1034
+ * @summary List available built-in tools for function calling
1035
+ * @param {string} organisation The organisation ID
1036
+ * @param {*} [options] Override http request option.
1037
+ * @throws {RequiredError}
1038
+ */
1039
+ listAITools(organisation, options) {
1040
+ var _a, _b, _c;
1041
+ return __awaiter(this, void 0, void 0, function* () {
1042
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listAITools(organisation, options);
1043
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1044
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIServicesApi.listAITools']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1045
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1046
+ });
1047
+ },
1048
+ /**
1049
+ * Lists recent async tool executions for an organization. Useful for debugging, monitoring, and building admin UIs. * * **Query Patterns:** * - All recent executions: `GET /ai/tools/executions` * - Filter by status: `GET /ai/tools/executions?status=running` * - Limit results: `GET /ai/tools/executions?limit=20` * * **Results:** * - Ordered by creation time (newest first) * - Limited to 50 by default (configurable via `limit` parameter) * - Only shows executions not yet expired (24h TTL) * * **Use Cases:** * - Monitor all active tool executions * - Debug failed executions * - Build admin dashboards * - Track tool usage patterns * - Audit async operations
1050
+ * @summary List tool executions for monitoring and debugging
1051
+ * @param {string} organisation The organisation ID
1052
+ * @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
1053
+ * @param {number} [limit] Maximum number of executions to return
1054
+ * @param {*} [options] Override http request option.
1055
+ * @throws {RequiredError}
1056
+ */
1057
+ listToolExecutions(organisation, status, limit, options) {
1058
+ var _a, _b, _c;
1059
+ return __awaiter(this, void 0, void 0, function* () {
1060
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listToolExecutions(organisation, status, limit, options);
1061
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1062
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIServicesApi.listToolExecutions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1063
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1064
+ });
1065
+ },
1118
1066
  /**
1119
1067
  *
1120
1068
  * @summary Update AI configuration for an organization
@@ -1142,7 +1090,7 @@ export const AIServicesApiFactory = function (configuration, basePath, axios) {
1142
1090
  const localVarFp = AIServicesApiFp(configuration);
1143
1091
  return {
1144
1092
  /**
1145
- * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size
1093
+ * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size * * **Response Patterns:** * - **Text-only**: Returns simple text response when no tools requested * - **Single tool**: Returns `toolUse` object when AI requests one tool * - **Multiple tools**: Returns `toolUse` array when AI requests multiple tools * - **Auto-execute sync**: Automatically executes tool and returns final text response * - **Auto-execute async**: Returns toolUse with `executionId` and `status` for polling
1146
1094
  * @summary Chat inference via API Gateway (buffered responses) with multimodal support
1147
1095
  * @param {string} organisation The organisation ID
1148
1096
  * @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
@@ -1228,6 +1176,17 @@ export const AIServicesApiFactory = function (configuration, basePath, axios) {
1228
1176
  getAIUsageStats(organisation, month, options) {
1229
1177
  return localVarFp.getAIUsageStats(organisation, month, options).then((request) => request(axios, basePath));
1230
1178
  },
1179
+ /**
1180
+ * Retrieves the status and result of an async tool execution. Used for polling long-running tools like image generation. * * **Async Tool Execution Pattern:** * This endpoint enables a polling pattern for long-running tools that would otherwise hit API Gateway\'s 30-second timeout. * * **Flow:** * 1. AI requests tool use (e.g., `generate_image`) * 2. Chat API returns `toolUse` with execution tracking info * 3. Client starts polling this endpoint with the `executionId` * 4. When `status === \'complete\'`, retrieve `result` and send back to AI * 5. AI incorporates result into final response * * **Status Values:** * - `pending`: Tool execution queued, not yet started * - `running`: Tool is currently executing * - `complete`: Tool execution finished successfully, `result` available * - `failed`: Tool execution failed, `error` available * * **Polling Recommendations:** * - Poll every 2-3 seconds for image generation * - Exponential backoff for other tools (start 1s, max 5s) * - Stop polling after 5 minutes (consider failed) * - Auto-cleanup after 24 hours (TTL) * * **Use Cases:** * - Image generation (10-15s typical runtime) * - Video processing * - Large file uploads/downloads * - Complex database queries * - External API calls with high latency
1181
+ * @summary Get async tool execution status and result
1182
+ * @param {string} organisation The organisation ID
1183
+ * @param {string} executionId Tool execution identifier
1184
+ * @param {*} [options] Override http request option.
1185
+ * @throws {RequiredError}
1186
+ */
1187
+ getToolExecutionStatus(organisation, executionId, options) {
1188
+ return localVarFp.getToolExecutionStatus(organisation, executionId, options).then((request) => request(axios, basePath));
1189
+ },
1231
1190
  /**
1232
1191
  * Generates images using Amazon Nova Canvas image generation model. * * **Region Restriction:** Nova Canvas is ONLY available in: * - `us-east-1` (US East, N. Virginia) * - `ap-northeast-1` (Asia Pacific, Tokyo) * - `eu-west-1` (Europe, Ireland) * ❌ NOT available in `ap-southeast-2` (Sydney) * * **Supported Task Types:** * - **TEXT_IMAGE**: Basic text-to-image generation * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge detection or segmentation * - **COLOR_GUIDED_GENERATION**: Generate images with specific color palettes * - **IMAGE_VARIATION**: Create variations of existing images * - **INPAINTING**: Fill masked areas in images * - **OUTPAINTING**: Extend images beyond their borders * - **BACKGROUND_REMOVAL**: Remove backgrounds from images * - **VIRTUAL_TRY_ON**: Try on garments/objects on people * * **Quality Options:** * - **standard**: Faster generation, lower cost * - **premium**: Higher quality, slower generation * * **Timeout:** Image generation can take up to 5 minutes
1233
1192
  * @summary Generate images with Amazon Nova Canvas
@@ -1265,6 +1224,38 @@ export const AIServicesApiFactory = function (configuration, basePath, axios) {
1265
1224
  listAISessions(organisation, userId, sessionGroup, limit, offset, model, options) {
1266
1225
  return localVarFp.listAISessions(organisation, userId, sessionGroup, limit, offset, model, options).then((request) => request(axios, basePath));
1267
1226
  },
1227
+ /**
1228
+ * Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
1229
+ * @summary List tool names only (lightweight response)
1230
+ * @param {string} organisation The organisation ID
1231
+ * @param {*} [options] Override http request option.
1232
+ * @throws {RequiredError}
1233
+ */
1234
+ listAIToolNames(organisation, options) {
1235
+ return localVarFp.listAIToolNames(organisation, options).then((request) => request(axios, basePath));
1236
+ },
1237
+ /**
1238
+ * Retrieves all available built-in tools that can be used with function calling. These tools can be included in `toolConfig` when making AI inference requests. * * **Available Built-in Tools:** * - `get_weather`: Get current weather for a location using Open-Meteo API * - `calculate`: Perform basic mathematical calculations (add, subtract, multiply, divide) * - `search_web`: Search the web for information (mock implementation) * - `generate_image`: Generate images with Amazon Nova Canvas (async execution, 10-15s typical runtime) * * **Use Cases:** * - Discover available tools dynamically without hardcoding * - Get complete tool specifications including input schemas * - Build UI for tool selection * - Validate tool names before sending requests * * **Dynamic Tool Discovery:** * This endpoint enables clients to: * 1. Fetch all available tools on page load * 2. Display tool capabilities to users * 3. Filter tools based on user permissions * 4. Use `allowedTools` whitelist for security * * **Alternative Endpoint:** * - `GET /ai/tools/names` - Returns only tool names (faster, lighter response)
1239
+ * @summary List available built-in tools for function calling
1240
+ * @param {string} organisation The organisation ID
1241
+ * @param {*} [options] Override http request option.
1242
+ * @throws {RequiredError}
1243
+ */
1244
+ listAITools(organisation, options) {
1245
+ return localVarFp.listAITools(organisation, options).then((request) => request(axios, basePath));
1246
+ },
1247
+ /**
1248
+ * Lists recent async tool executions for an organization. Useful for debugging, monitoring, and building admin UIs. * * **Query Patterns:** * - All recent executions: `GET /ai/tools/executions` * - Filter by status: `GET /ai/tools/executions?status=running` * - Limit results: `GET /ai/tools/executions?limit=20` * * **Results:** * - Ordered by creation time (newest first) * - Limited to 50 by default (configurable via `limit` parameter) * - Only shows executions not yet expired (24h TTL) * * **Use Cases:** * - Monitor all active tool executions * - Debug failed executions * - Build admin dashboards * - Track tool usage patterns * - Audit async operations
1249
+ * @summary List tool executions for monitoring and debugging
1250
+ * @param {string} organisation The organisation ID
1251
+ * @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
1252
+ * @param {number} [limit] Maximum number of executions to return
1253
+ * @param {*} [options] Override http request option.
1254
+ * @throws {RequiredError}
1255
+ */
1256
+ listToolExecutions(organisation, status, limit, options) {
1257
+ return localVarFp.listToolExecutions(organisation, status, limit, options).then((request) => request(axios, basePath));
1258
+ },
1268
1259
  /**
1269
1260
  *
1270
1261
  * @summary Update AI configuration for an organization
@@ -1286,7 +1277,7 @@ export const AIServicesApiFactory = function (configuration, basePath, axios) {
1286
1277
  */
1287
1278
  export class AIServicesApi extends BaseAPI {
1288
1279
  /**
1289
- * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size
1280
+ * Sends requests to the AI API Gateway endpoint which buffers responses. Supports text, images, videos, and documents via base64 encoding. * * **Multimodal Support:** * - **Text**: Simple string content * - **Images**: Base64-encoded PNG, JPEG, GIF, WebP (up to 25MB) * - **Videos**: Base64-encoded MP4, MOV, WebM, etc. (up to 25MB) * - **Documents**: Base64-encoded PDF, DOCX, CSV, etc. (up to 25MB) * * **Supported Models:** * - Amazon Nova Lite, Micro, Pro (all support multimodal) * - Claude models (text only) * * **Usage Tips:** * - Use base64 encoding for images/videos < 5-10MB * - Place media before text prompts for best results * - Label multiple media files (e.g., \'Image 1:\', \'Image 2:\') * - Maximum 25MB total payload size * * **Response Patterns:** * - **Text-only**: Returns simple text response when no tools requested * - **Single tool**: Returns `toolUse` object when AI requests one tool * - **Multiple tools**: Returns `toolUse` array when AI requests multiple tools * - **Auto-execute sync**: Automatically executes tool and returns final text response * - **Auto-execute async**: Returns toolUse with `executionId` and `status` for polling
1290
1281
  * @summary Chat inference via API Gateway (buffered responses) with multimodal support
1291
1282
  * @param {string} organisation The organisation ID
1292
1283
  * @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
@@ -1380,6 +1371,18 @@ export class AIServicesApi extends BaseAPI {
1380
1371
  getAIUsageStats(organisation, month, options) {
1381
1372
  return AIServicesApiFp(this.configuration).getAIUsageStats(organisation, month, options).then((request) => request(this.axios, this.basePath));
1382
1373
  }
1374
+ /**
1375
+ * Retrieves the status and result of an async tool execution. Used for polling long-running tools like image generation. * * **Async Tool Execution Pattern:** * This endpoint enables a polling pattern for long-running tools that would otherwise hit API Gateway\'s 30-second timeout. * * **Flow:** * 1. AI requests tool use (e.g., `generate_image`) * 2. Chat API returns `toolUse` with execution tracking info * 3. Client starts polling this endpoint with the `executionId` * 4. When `status === \'complete\'`, retrieve `result` and send back to AI * 5. AI incorporates result into final response * * **Status Values:** * - `pending`: Tool execution queued, not yet started * - `running`: Tool is currently executing * - `complete`: Tool execution finished successfully, `result` available * - `failed`: Tool execution failed, `error` available * * **Polling Recommendations:** * - Poll every 2-3 seconds for image generation * - Exponential backoff for other tools (start 1s, max 5s) * - Stop polling after 5 minutes (consider failed) * - Auto-cleanup after 24 hours (TTL) * * **Use Cases:** * - Image generation (10-15s typical runtime) * - Video processing * - Large file uploads/downloads * - Complex database queries * - External API calls with high latency
1376
+ * @summary Get async tool execution status and result
1377
+ * @param {string} organisation The organisation ID
1378
+ * @param {string} executionId Tool execution identifier
1379
+ * @param {*} [options] Override http request option.
1380
+ * @throws {RequiredError}
1381
+ * @memberof AIServicesApi
1382
+ */
1383
+ getToolExecutionStatus(organisation, executionId, options) {
1384
+ return AIServicesApiFp(this.configuration).getToolExecutionStatus(organisation, executionId, options).then((request) => request(this.axios, this.basePath));
1385
+ }
1383
1386
  /**
1384
1387
  * Generates images using Amazon Nova Canvas image generation model. * * **Region Restriction:** Nova Canvas is ONLY available in: * - `us-east-1` (US East, N. Virginia) * - `ap-northeast-1` (Asia Pacific, Tokyo) * - `eu-west-1` (Europe, Ireland) * ❌ NOT available in `ap-southeast-2` (Sydney) * * **Supported Task Types:** * - **TEXT_IMAGE**: Basic text-to-image generation * - **TEXT_IMAGE with Conditioning**: Layout-guided generation using edge detection or segmentation * - **COLOR_GUIDED_GENERATION**: Generate images with specific color palettes * - **IMAGE_VARIATION**: Create variations of existing images * - **INPAINTING**: Fill masked areas in images * - **OUTPAINTING**: Extend images beyond their borders * - **BACKGROUND_REMOVAL**: Remove backgrounds from images * - **VIRTUAL_TRY_ON**: Try on garments/objects on people * * **Quality Options:** * - **standard**: Faster generation, lower cost * - **premium**: Higher quality, slower generation * * **Timeout:** Image generation can take up to 5 minutes
1385
1388
  * @summary Generate images with Amazon Nova Canvas
@@ -1420,6 +1423,41 @@ export class AIServicesApi extends BaseAPI {
1420
1423
  listAISessions(organisation, userId, sessionGroup, limit, offset, model, options) {
1421
1424
  return AIServicesApiFp(this.configuration).listAISessions(organisation, userId, sessionGroup, limit, offset, model, options).then((request) => request(this.axios, this.basePath));
1422
1425
  }
1426
+ /**
1427
+ * Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
1428
+ * @summary List tool names only (lightweight response)
1429
+ * @param {string} organisation The organisation ID
1430
+ * @param {*} [options] Override http request option.
1431
+ * @throws {RequiredError}
1432
+ * @memberof AIServicesApi
1433
+ */
1434
+ listAIToolNames(organisation, options) {
1435
+ return AIServicesApiFp(this.configuration).listAIToolNames(organisation, options).then((request) => request(this.axios, this.basePath));
1436
+ }
1437
+ /**
1438
+ * Retrieves all available built-in tools that can be used with function calling. These tools can be included in `toolConfig` when making AI inference requests. * * **Available Built-in Tools:** * - `get_weather`: Get current weather for a location using Open-Meteo API * - `calculate`: Perform basic mathematical calculations (add, subtract, multiply, divide) * - `search_web`: Search the web for information (mock implementation) * - `generate_image`: Generate images with Amazon Nova Canvas (async execution, 10-15s typical runtime) * * **Use Cases:** * - Discover available tools dynamically without hardcoding * - Get complete tool specifications including input schemas * - Build UI for tool selection * - Validate tool names before sending requests * * **Dynamic Tool Discovery:** * This endpoint enables clients to: * 1. Fetch all available tools on page load * 2. Display tool capabilities to users * 3. Filter tools based on user permissions * 4. Use `allowedTools` whitelist for security * * **Alternative Endpoint:** * - `GET /ai/tools/names` - Returns only tool names (faster, lighter response)
1439
+ * @summary List available built-in tools for function calling
1440
+ * @param {string} organisation The organisation ID
1441
+ * @param {*} [options] Override http request option.
1442
+ * @throws {RequiredError}
1443
+ * @memberof AIServicesApi
1444
+ */
1445
+ listAITools(organisation, options) {
1446
+ return AIServicesApiFp(this.configuration).listAITools(organisation, options).then((request) => request(this.axios, this.basePath));
1447
+ }
1448
+ /**
1449
+ * Lists recent async tool executions for an organization. Useful for debugging, monitoring, and building admin UIs. * * **Query Patterns:** * - All recent executions: `GET /ai/tools/executions` * - Filter by status: `GET /ai/tools/executions?status=running` * - Limit results: `GET /ai/tools/executions?limit=20` * * **Results:** * - Ordered by creation time (newest first) * - Limited to 50 by default (configurable via `limit` parameter) * - Only shows executions not yet expired (24h TTL) * * **Use Cases:** * - Monitor all active tool executions * - Debug failed executions * - Build admin dashboards * - Track tool usage patterns * - Audit async operations
1450
+ * @summary List tool executions for monitoring and debugging
1451
+ * @param {string} organisation The organisation ID
1452
+ * @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
1453
+ * @param {number} [limit] Maximum number of executions to return
1454
+ * @param {*} [options] Override http request option.
1455
+ * @throws {RequiredError}
1456
+ * @memberof AIServicesApi
1457
+ */
1458
+ listToolExecutions(organisation, status, limit, options) {
1459
+ return AIServicesApiFp(this.configuration).listToolExecutions(organisation, status, limit, options).then((request) => request(this.axios, this.basePath));
1460
+ }
1423
1461
  /**
1424
1462
  *
1425
1463
  * @summary Update AI configuration for an organization
@@ -1443,6 +1481,15 @@ export const ListAIModelsFeatureEnum = {
1443
1481
  Streaming: 'streaming',
1444
1482
  All: 'all'
1445
1483
  };
1484
+ /**
1485
+ * @export
1486
+ */
1487
+ export const ListToolExecutionsStatusEnum = {
1488
+ Pending: 'pending',
1489
+ Running: 'running',
1490
+ Complete: 'complete',
1491
+ Failed: 'failed'
1492
+ };
1446
1493
  /**
1447
1494
  * ApplicationsApi - axios parameter creator
1448
1495
  * @export
@@ -2646,7 +2693,7 @@ export const ComposeApiAxiosParamCreator = function (configuration) {
2646
2693
  assertParamExists('getEnvironmentCompose', 'application', application);
2647
2694
  // verify required parameter 'environment' is not null or undefined
2648
2695
  assertParamExists('getEnvironmentCompose', 'environment', environment);
2649
- const localVarPath = `/api/v3/organizations/{organisation}/environments/{environment}/compose`
2696
+ const localVarPath = `/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose`
2650
2697
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
2651
2698
  .replace(`{${"application"}}`, encodeURIComponent(String(application)))
2652
2699
  .replace(`{${"environment"}}`, encodeURIComponent(String(environment)));
@@ -2671,7 +2718,7 @@ export const ComposeApiAxiosParamCreator = function (configuration) {
2671
2718
  };
2672
2719
  }),
2673
2720
  /**
2674
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2721
+ * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2675
2722
  * @summary Validate a compose file
2676
2723
  * @param {string} organisation The organisation ID
2677
2724
  * @param {ValidateComposeRequest} validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
@@ -2739,7 +2786,7 @@ export const ComposeApiFp = function (configuration) {
2739
2786
  });
2740
2787
  },
2741
2788
  /**
2742
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2789
+ * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2743
2790
  * @summary Validate a compose file
2744
2791
  * @param {string} organisation The organisation ID
2745
2792
  * @param {ValidateComposeRequest} validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
@@ -2778,7 +2825,7 @@ export const ComposeApiFactory = function (configuration, basePath, axios) {
2778
2825
  return localVarFp.getEnvironmentCompose(organisation, application, environment, options).then((request) => request(axios, basePath));
2779
2826
  },
2780
2827
  /**
2781
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2828
+ * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2782
2829
  * @summary Validate a compose file
2783
2830
  * @param {string} organisation The organisation ID
2784
2831
  * @param {ValidateComposeRequest} validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
@@ -2812,7 +2859,7 @@ export class ComposeApi extends BaseAPI {
2812
2859
  return ComposeApiFp(this.configuration).getEnvironmentCompose(organisation, application, environment, options).then((request) => request(this.axios, this.basePath));
2813
2860
  }
2814
2861
  /**
2815
- * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2862
+ * Accepts a docker-compose.yml file content, translates it into the internal compose definition format, and validates it. Quant Cloud provides comprehensive support for standard Docker Compose features including commands, entrypoints, health checks, dependencies, volume mounts, resource limits, and more. For detailed documentation on supported features and examples, see: https://docs.quantcdn.io/introduction-to-quant-cloud/importing-docker-compose/. Supports image tag suffixing via the imageSuffix query parameter or by sending a JSON wrapper with yamlContent and imageSuffix fields. When provided, internal image tags are transformed to {containerName}-{suffix} format (e.g., \'nginx-feature-xyz\').
2816
2863
  * @summary Validate a compose file
2817
2864
  * @param {string} organisation The organisation ID
2818
2865
  * @param {ValidateComposeRequest} validateComposeRequest The docker-compose.yml file content. Can be sent as raw YAML string or as a JSON wrapper containing both yamlContent (string) and imageSuffix (string) fields. Query parameter imageSuffix takes precedence if both are provided.
@@ -3110,7 +3157,7 @@ export const CrawlerSchedulesApiAxiosParamCreator = function (configuration) {
3110
3157
  assertParamExists('crawlerSchedulesDelete', 'crawler', crawler);
3111
3158
  // verify required parameter 'crawlerSchedule' is not null or undefined
3112
3159
  assertParamExists('crawlerSchedulesDelete', 'crawlerSchedule', crawlerSchedule);
3113
- const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules`
3160
+ const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}`
3114
3161
  .replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
3115
3162
  .replace(`{${"project"}}`, encodeURIComponent(String(project)))
3116
3163
  .replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)))
@@ -3141,23 +3188,27 @@ export const CrawlerSchedulesApiAxiosParamCreator = function (configuration) {
3141
3188
  * @param {string} organization Organization identifier
3142
3189
  * @param {string} project Project identifier
3143
3190
  * @param {string} crawler Crawler identifier
3191
+ * @param {string} crawlerSchedule Crawler schedule identifier
3144
3192
  * @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
3145
3193
  * @param {*} [options] Override http request option.
3146
3194
  * @throws {RequiredError}
3147
3195
  */
3148
- crawlerSchedulesEdit: (organization, project, crawler, v2CrawlerScheduleRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
3196
+ crawlerSchedulesEdit: (organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
3149
3197
  // verify required parameter 'organization' is not null or undefined
3150
3198
  assertParamExists('crawlerSchedulesEdit', 'organization', organization);
3151
3199
  // verify required parameter 'project' is not null or undefined
3152
3200
  assertParamExists('crawlerSchedulesEdit', 'project', project);
3153
3201
  // verify required parameter 'crawler' is not null or undefined
3154
3202
  assertParamExists('crawlerSchedulesEdit', 'crawler', crawler);
3203
+ // verify required parameter 'crawlerSchedule' is not null or undefined
3204
+ assertParamExists('crawlerSchedulesEdit', 'crawlerSchedule', crawlerSchedule);
3155
3205
  // verify required parameter 'v2CrawlerScheduleRequest' is not null or undefined
3156
3206
  assertParamExists('crawlerSchedulesEdit', 'v2CrawlerScheduleRequest', v2CrawlerScheduleRequest);
3157
- const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules`
3207
+ const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}`
3158
3208
  .replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
3159
3209
  .replace(`{${"project"}}`, encodeURIComponent(String(project)))
3160
- .replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)));
3210
+ .replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)))
3211
+ .replace(`{${"crawler_schedule"}}`, encodeURIComponent(String(crawlerSchedule)));
3161
3212
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
3162
3213
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3163
3214
  let baseOptions;
@@ -3317,14 +3368,15 @@ export const CrawlerSchedulesApiFp = function (configuration) {
3317
3368
  * @param {string} organization Organization identifier
3318
3369
  * @param {string} project Project identifier
3319
3370
  * @param {string} crawler Crawler identifier
3371
+ * @param {string} crawlerSchedule Crawler schedule identifier
3320
3372
  * @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
3321
3373
  * @param {*} [options] Override http request option.
3322
3374
  * @throws {RequiredError}
3323
3375
  */
3324
- crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
3376
+ crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
3325
3377
  var _a, _b, _c;
3326
3378
  return __awaiter(this, void 0, void 0, function* () {
3327
- const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options);
3379
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options);
3328
3380
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3329
3381
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CrawlerSchedulesApi.crawlerSchedulesEdit']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3330
3382
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3408,12 +3460,13 @@ export const CrawlerSchedulesApiFactory = function (configuration, basePath, axi
3408
3460
  * @param {string} organization Organization identifier
3409
3461
  * @param {string} project Project identifier
3410
3462
  * @param {string} crawler Crawler identifier
3463
+ * @param {string} crawlerSchedule Crawler schedule identifier
3411
3464
  * @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
3412
3465
  * @param {*} [options] Override http request option.
3413
3466
  * @throws {RequiredError}
3414
3467
  */
3415
- crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
3416
- return localVarFp.crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options).then((request) => request(axios, basePath));
3468
+ crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
3469
+ return localVarFp.crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options).then((request) => request(axios, basePath));
3417
3470
  },
3418
3471
  /**
3419
3472
  *
@@ -3483,13 +3536,14 @@ export class CrawlerSchedulesApi extends BaseAPI {
3483
3536
  * @param {string} organization Organization identifier
3484
3537
  * @param {string} project Project identifier
3485
3538
  * @param {string} crawler Crawler identifier
3539
+ * @param {string} crawlerSchedule Crawler schedule identifier
3486
3540
  * @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
3487
3541
  * @param {*} [options] Override http request option.
3488
3542
  * @throws {RequiredError}
3489
3543
  * @memberof CrawlerSchedulesApi
3490
3544
  */
3491
- crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
3492
- return CrawlerSchedulesApiFp(this.configuration).crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options).then((request) => request(this.axios, this.basePath));
3545
+ crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
3546
+ return CrawlerSchedulesApiFp(this.configuration).crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options).then((request) => request(this.axios, this.basePath));
3493
3547
  }
3494
3548
  /**
3495
3549
  *
@@ -3682,6 +3736,51 @@ export const CrawlersApiAxiosParamCreator = function (configuration) {
3682
3736
  options: localVarRequestOptions,
3683
3737
  };
3684
3738
  }),
3739
+ /**
3740
+ *
3741
+ * @summary Run a crawler
3742
+ * @param {string} organization Organization identifier
3743
+ * @param {string} project Project identifier
3744
+ * @param {string} crawler Crawler identifier
3745
+ * @param {CrawlersRunRequest} crawlersRunRequest
3746
+ * @param {*} [options] Override http request option.
3747
+ * @throws {RequiredError}
3748
+ */
3749
+ crawlersRun: (organization, project, crawler, crawlersRunRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
3750
+ // verify required parameter 'organization' is not null or undefined
3751
+ assertParamExists('crawlersRun', 'organization', organization);
3752
+ // verify required parameter 'project' is not null or undefined
3753
+ assertParamExists('crawlersRun', 'project', project);
3754
+ // verify required parameter 'crawler' is not null or undefined
3755
+ assertParamExists('crawlersRun', 'crawler', crawler);
3756
+ // verify required parameter 'crawlersRunRequest' is not null or undefined
3757
+ assertParamExists('crawlersRun', 'crawlersRunRequest', crawlersRunRequest);
3758
+ const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run`
3759
+ .replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
3760
+ .replace(`{${"project"}}`, encodeURIComponent(String(project)))
3761
+ .replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)));
3762
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3763
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3764
+ let baseOptions;
3765
+ if (configuration) {
3766
+ baseOptions = configuration.baseOptions;
3767
+ }
3768
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
3769
+ const localVarHeaderParameter = {};
3770
+ const localVarQueryParameter = {};
3771
+ // authentication BearerAuth required
3772
+ // http bearer authentication required
3773
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
3774
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3775
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3776
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3777
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
3778
+ localVarRequestOptions.data = serializeDataIfNeeded(crawlersRunRequest, localVarRequestOptions, configuration);
3779
+ return {
3780
+ url: toPathString(localVarUrlObj),
3781
+ options: localVarRequestOptions,
3782
+ };
3783
+ }),
3685
3784
  /**
3686
3785
  *
3687
3786
  * @summary Update a crawler
@@ -3807,6 +3906,25 @@ export const CrawlersApiFp = function (configuration) {
3807
3906
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3808
3907
  });
3809
3908
  },
3909
+ /**
3910
+ *
3911
+ * @summary Run a crawler
3912
+ * @param {string} organization Organization identifier
3913
+ * @param {string} project Project identifier
3914
+ * @param {string} crawler Crawler identifier
3915
+ * @param {CrawlersRunRequest} crawlersRunRequest
3916
+ * @param {*} [options] Override http request option.
3917
+ * @throws {RequiredError}
3918
+ */
3919
+ crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
3920
+ var _a, _b, _c;
3921
+ return __awaiter(this, void 0, void 0, function* () {
3922
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlersRun(organization, project, crawler, crawlersRunRequest, options);
3923
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3924
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CrawlersApi.crawlersRun']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3925
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3926
+ });
3927
+ },
3810
3928
  /**
3811
3929
  *
3812
3930
  * @summary Update a crawler
@@ -3882,6 +4000,19 @@ export const CrawlersApiFactory = function (configuration, basePath, axios) {
3882
4000
  crawlersRead(organization, project, crawler, options) {
3883
4001
  return localVarFp.crawlersRead(organization, project, crawler, options).then((request) => request(axios, basePath));
3884
4002
  },
4003
+ /**
4004
+ *
4005
+ * @summary Run a crawler
4006
+ * @param {string} organization Organization identifier
4007
+ * @param {string} project Project identifier
4008
+ * @param {string} crawler Crawler identifier
4009
+ * @param {CrawlersRunRequest} crawlersRunRequest
4010
+ * @param {*} [options] Override http request option.
4011
+ * @throws {RequiredError}
4012
+ */
4013
+ crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
4014
+ return localVarFp.crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(axios, basePath));
4015
+ },
3885
4016
  /**
3886
4017
  *
3887
4018
  * @summary Update a crawler
@@ -3955,6 +4086,20 @@ export class CrawlersApi extends BaseAPI {
3955
4086
  crawlersRead(organization, project, crawler, options) {
3956
4087
  return CrawlersApiFp(this.configuration).crawlersRead(organization, project, crawler, options).then((request) => request(this.axios, this.basePath));
3957
4088
  }
4089
+ /**
4090
+ *
4091
+ * @summary Run a crawler
4092
+ * @param {string} organization Organization identifier
4093
+ * @param {string} project Project identifier
4094
+ * @param {string} crawler Crawler identifier
4095
+ * @param {CrawlersRunRequest} crawlersRunRequest
4096
+ * @param {*} [options] Override http request option.
4097
+ * @throws {RequiredError}
4098
+ * @memberof CrawlersApi
4099
+ */
4100
+ crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
4101
+ return CrawlersApiFp(this.configuration).crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(this.axios, this.basePath));
4102
+ }
3958
4103
  /**
3959
4104
  *
3960
4105
  * @summary Update a crawler
@@ -6536,10 +6681,11 @@ export const KVApiAxiosParamCreator = function (configuration) {
6536
6681
  * @param {string} [cursor] Cursor for pagination
6537
6682
  * @param {number} [limit] Number of items to return
6538
6683
  * @param {string} [search] Search filter for keys
6684
+ * @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \&#39;[ENCRYPTED]\&#39; for security.
6539
6685
  * @param {*} [options] Override http request option.
6540
6686
  * @throws {RequiredError}
6541
6687
  */
6542
- kVItemsList: (organization, project, storeId, cursor, limit, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
6688
+ kVItemsList: (organization, project, storeId, cursor, limit, search, includeValues, options = {}) => __awaiter(this, void 0, void 0, function* () {
6543
6689
  // verify required parameter 'organization' is not null or undefined
6544
6690
  assertParamExists('kVItemsList', 'organization', organization);
6545
6691
  // verify required parameter 'project' is not null or undefined
@@ -6571,6 +6717,9 @@ export const KVApiAxiosParamCreator = function (configuration) {
6571
6717
  if (search !== undefined) {
6572
6718
  localVarQueryParameter['search'] = search;
6573
6719
  }
6720
+ if (includeValues !== undefined) {
6721
+ localVarQueryParameter['include_values'] = includeValues;
6722
+ }
6574
6723
  setSearchParams(localVarUrlObj, localVarQueryParameter);
6575
6724
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6576
6725
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -6580,7 +6729,7 @@ export const KVApiAxiosParamCreator = function (configuration) {
6580
6729
  };
6581
6730
  }),
6582
6731
  /**
6583
- *
6732
+ * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.
6584
6733
  * @summary Get an item from a kv store
6585
6734
  * @param {string} organization
6586
6735
  * @param {string} project
@@ -6840,20 +6989,21 @@ export const KVApiFp = function (configuration) {
6840
6989
  * @param {string} [cursor] Cursor for pagination
6841
6990
  * @param {number} [limit] Number of items to return
6842
6991
  * @param {string} [search] Search filter for keys
6992
+ * @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \&#39;[ENCRYPTED]\&#39; for security.
6843
6993
  * @param {*} [options] Override http request option.
6844
6994
  * @throws {RequiredError}
6845
6995
  */
6846
- kVItemsList(organization, project, storeId, cursor, limit, search, options) {
6996
+ kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
6847
6997
  var _a, _b, _c;
6848
6998
  return __awaiter(this, void 0, void 0, function* () {
6849
- const localVarAxiosArgs = yield localVarAxiosParamCreator.kVItemsList(organization, project, storeId, cursor, limit, search, options);
6999
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options);
6850
7000
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
6851
7001
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KVApi.kVItemsList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
6852
7002
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6853
7003
  });
6854
7004
  },
6855
7005
  /**
6856
- *
7006
+ * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.
6857
7007
  * @summary Get an item from a kv store
6858
7008
  * @param {string} organization
6859
7009
  * @param {string} project
@@ -6994,14 +7144,15 @@ export const KVApiFactory = function (configuration, basePath, axios) {
6994
7144
  * @param {string} [cursor] Cursor for pagination
6995
7145
  * @param {number} [limit] Number of items to return
6996
7146
  * @param {string} [search] Search filter for keys
7147
+ * @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \&#39;[ENCRYPTED]\&#39; for security.
6997
7148
  * @param {*} [options] Override http request option.
6998
7149
  * @throws {RequiredError}
6999
7150
  */
7000
- kVItemsList(organization, project, storeId, cursor, limit, search, options) {
7001
- return localVarFp.kVItemsList(organization, project, storeId, cursor, limit, search, options).then((request) => request(axios, basePath));
7151
+ kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
7152
+ return localVarFp.kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options).then((request) => request(axios, basePath));
7002
7153
  },
7003
7154
  /**
7004
- *
7155
+ * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.
7005
7156
  * @summary Get an item from a kv store
7006
7157
  * @param {string} organization
7007
7158
  * @param {string} project
@@ -7122,15 +7273,16 @@ export class KVApi extends BaseAPI {
7122
7273
  * @param {string} [cursor] Cursor for pagination
7123
7274
  * @param {number} [limit] Number of items to return
7124
7275
  * @param {string} [search] Search filter for keys
7276
+ * @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \&#39;[ENCRYPTED]\&#39; for security.
7125
7277
  * @param {*} [options] Override http request option.
7126
7278
  * @throws {RequiredError}
7127
7279
  * @memberof KVApi
7128
7280
  */
7129
- kVItemsList(organization, project, storeId, cursor, limit, search, options) {
7130
- return KVApiFp(this.configuration).kVItemsList(organization, project, storeId, cursor, limit, search, options).then((request) => request(this.axios, this.basePath));
7281
+ kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
7282
+ return KVApiFp(this.configuration).kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options).then((request) => request(this.axios, this.basePath));
7131
7283
  }
7132
7284
  /**
7133
- *
7285
+ * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction.
7134
7286
  * @summary Get an item from a kv store
7135
7287
  * @param {string} organization
7136
7288
  * @param {string} project
@@ -12502,16 +12654,19 @@ export const VolumesApiAxiosParamCreator = function (configuration) {
12502
12654
  * @param {string} organisation The organisation ID
12503
12655
  * @param {string} application The application ID
12504
12656
  * @param {string} environment The environment ID
12657
+ * @param {CreateVolumeRequest} createVolumeRequest
12505
12658
  * @param {*} [options] Override http request option.
12506
12659
  * @throws {RequiredError}
12507
12660
  */
12508
- createVolume: (organisation, application, environment, options = {}) => __awaiter(this, void 0, void 0, function* () {
12661
+ createVolume: (organisation, application, environment, createVolumeRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
12509
12662
  // verify required parameter 'organisation' is not null or undefined
12510
12663
  assertParamExists('createVolume', 'organisation', organisation);
12511
12664
  // verify required parameter 'application' is not null or undefined
12512
12665
  assertParamExists('createVolume', 'application', application);
12513
12666
  // verify required parameter 'environment' is not null or undefined
12514
12667
  assertParamExists('createVolume', 'environment', environment);
12668
+ // verify required parameter 'createVolumeRequest' is not null or undefined
12669
+ assertParamExists('createVolume', 'createVolumeRequest', createVolumeRequest);
12515
12670
  const localVarPath = `/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes`
12516
12671
  .replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
12517
12672
  .replace(`{${"application"}}`, encodeURIComponent(String(application)))
@@ -12528,9 +12683,11 @@ export const VolumesApiAxiosParamCreator = function (configuration) {
12528
12683
  // authentication BearerAuth required
12529
12684
  // http bearer authentication required
12530
12685
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
12686
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12531
12687
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12532
12688
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12533
12689
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
12690
+ localVarRequestOptions.data = serializeDataIfNeeded(createVolumeRequest, localVarRequestOptions, configuration);
12534
12691
  return {
12535
12692
  url: toPathString(localVarUrlObj),
12536
12693
  options: localVarRequestOptions,
@@ -12679,13 +12836,14 @@ export const VolumesApiFp = function (configuration) {
12679
12836
  * @param {string} organisation The organisation ID
12680
12837
  * @param {string} application The application ID
12681
12838
  * @param {string} environment The environment ID
12839
+ * @param {CreateVolumeRequest} createVolumeRequest
12682
12840
  * @param {*} [options] Override http request option.
12683
12841
  * @throws {RequiredError}
12684
12842
  */
12685
- createVolume(organisation, application, environment, options) {
12843
+ createVolume(organisation, application, environment, createVolumeRequest, options) {
12686
12844
  var _a, _b, _c;
12687
12845
  return __awaiter(this, void 0, void 0, function* () {
12688
- const localVarAxiosArgs = yield localVarAxiosParamCreator.createVolume(organisation, application, environment, options);
12846
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createVolume(organisation, application, environment, createVolumeRequest, options);
12689
12847
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
12690
12848
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['VolumesApi.createVolume']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
12691
12849
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -12762,11 +12920,12 @@ export const VolumesApiFactory = function (configuration, basePath, axios) {
12762
12920
  * @param {string} organisation The organisation ID
12763
12921
  * @param {string} application The application ID
12764
12922
  * @param {string} environment The environment ID
12923
+ * @param {CreateVolumeRequest} createVolumeRequest
12765
12924
  * @param {*} [options] Override http request option.
12766
12925
  * @throws {RequiredError}
12767
12926
  */
12768
- createVolume(organisation, application, environment, options) {
12769
- return localVarFp.createVolume(organisation, application, environment, options).then((request) => request(axios, basePath));
12927
+ createVolume(organisation, application, environment, createVolumeRequest, options) {
12928
+ return localVarFp.createVolume(organisation, application, environment, createVolumeRequest, options).then((request) => request(axios, basePath));
12770
12929
  },
12771
12930
  /**
12772
12931
  *
@@ -12821,12 +12980,13 @@ export class VolumesApi extends BaseAPI {
12821
12980
  * @param {string} organisation The organisation ID
12822
12981
  * @param {string} application The application ID
12823
12982
  * @param {string} environment The environment ID
12983
+ * @param {CreateVolumeRequest} createVolumeRequest
12824
12984
  * @param {*} [options] Override http request option.
12825
12985
  * @throws {RequiredError}
12826
12986
  * @memberof VolumesApi
12827
12987
  */
12828
- createVolume(organisation, application, environment, options) {
12829
- return VolumesApiFp(this.configuration).createVolume(organisation, application, environment, options).then((request) => request(this.axios, this.basePath));
12988
+ createVolume(organisation, application, environment, createVolumeRequest, options) {
12989
+ return VolumesApiFp(this.configuration).createVolume(organisation, application, environment, createVolumeRequest, options).then((request) => request(this.axios, this.basePath));
12830
12990
  }
12831
12991
  /**
12832
12992
  *