@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/api.ts +3425 -9811
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2896 -9418
- package/dist/api.js +539 -380
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +2896 -9418
- package/dist/esm/api.js +536 -376
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +7 -6
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* QuantCDN API
|
|
6
6
|
* Unified API for QuantCDN Admin and QuantCloud Platform services
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 4.
|
|
8
|
+
* The version of the OpenAPI document: 4.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,10 +22,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.VolumesApi = exports.VolumesApiFactory = exports.VolumesApiFp = exports.VolumesApiAxiosParamCreator = exports.VariablesApi = exports.VariablesApiFactory = exports.VariablesApiFp = exports.VariablesApiAxiosParamCreator = exports.ScalingPolicyApi = exports.ScalingPolicyApiFactory = exports.ScalingPolicyApiFp = exports.ScalingPolicyApiAxiosParamCreator = exports.SSHAccessApi = exports.SSHAccessApiFactory = exports.SSHAccessApiFp = exports.SSHAccessApiAxiosParamCreator = exports.RulesApi = exports.RulesApiFactory = exports.RulesApiFp = exports.RulesApiAxiosParamCreator = exports.PurgeApi = exports.PurgeApiFactory = exports.PurgeApiFp = exports.PurgeApiAxiosParamCreator = exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.KVApi = exports.KVApiFactory = exports.KVApiFp = exports.KVApiAxiosParamCreator = exports.HeadersApi = exports.HeadersApiFactory = exports.HeadersApiFp = exports.HeadersApiAxiosParamCreator = exports.SyncToEnvironmentTypeEnum = exports.ListSyncOperationsTypeEnum = exports.EnvironmentsApi = exports.EnvironmentsApiFactory = void 0;
|
|
25
|
+
exports.DeleteBackupTypeEnum = exports.CreateBackupTypeEnum = exports.BackupManagementApi = exports.BackupManagementApiFactory = exports.BackupManagementApiFp = exports.BackupManagementApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.ListToolExecutionsStatusEnum = exports.ListAIModelsFeatureEnum = exports.AIServicesApi = exports.AIServicesApiFactory = exports.AIServicesApiFp = exports.AIServicesApiAxiosParamCreator = exports.WafConfigThresholdsInnerModeEnum = exports.WafConfigThresholdsInnerTypeEnum = exports.WafConfigModeEnum = exports.V2RuleProxyActionNotifyEnum = exports.V1TransitionStateEnum = exports.SpotConfigurationStrategyEnum = exports.ScalingPolicyMetricEnum = exports.ListToolExecutions200ResponseExecutionsInnerStatusEnum = exports.ImageGenerationRequestTextToImageParamsControlModeEnum = exports.ImageGenerationRequestTextToImageParamsStyleEnum = exports.ImageGenerationRequestOutPaintingParamsOutPaintingModeEnum = exports.ImageGenerationRequestImageGenerationConfigQualityEnum = exports.ImageGenerationRequestRegionEnum = exports.ImageGenerationRequestTaskTypeEnum = exports.GetToolExecutionStatus200ResponseStatusEnum = exports.EmbeddingsRequestDimensionsEnum = exports.CronRunStatusEnum = exports.CronRunRunTypeEnum = exports.CreateApplicationRequestDatabaseEngineEnum = exports.CreateAISessionRequestInitialMessagesInnerRoleEnum = exports.CreateAISession201ResponseStatusEnum = exports.ContainerImageReferenceTypeEnum = exports.ContainerDependsOnInnerConditionEnum = exports.ChatInferenceStreamRequestMessagesInnerRoleEnum = exports.ChatInferenceRequestResponseFormatTypeEnum = exports.ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf3DocumentFormatEnum = exports.ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf2VideoFormatEnum = exports.ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf1ImageFormatEnum = exports.ChatInferenceRequestMessagesInnerRoleEnum = exports.ChatInference200ResponseResponseToolUseOneOfStatusEnum = exports.ChatInference200ResponseResponseRoleEnum = exports.ChatInference200ResponseFinishReasonEnum = exports.ApplicationImageReferenceTypeEnum = exports.ApplicationDatabaseRdsInstanceEngineEnum = void 0;
|
|
26
|
+
exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.KVApi = exports.KVApiFactory = exports.KVApiFp = exports.KVApiAxiosParamCreator = exports.HeadersApi = exports.HeadersApiFactory = exports.HeadersApiFp = exports.HeadersApiAxiosParamCreator = exports.SyncToEnvironmentTypeEnum = exports.ListSyncOperationsTypeEnum = exports.EnvironmentsApi = exports.EnvironmentsApiFactory = exports.EnvironmentsApiFp = exports.EnvironmentsApiAxiosParamCreator = exports.DomainsApi = exports.DomainsApiFactory = exports.DomainsApiFp = exports.DomainsApiAxiosParamCreator = exports.CronApi = exports.CronApiFactory = exports.CronApiFp = exports.CronApiAxiosParamCreator = exports.CrawlersApi = exports.CrawlersApiFactory = exports.CrawlersApiFp = exports.CrawlersApiAxiosParamCreator = exports.CrawlerSchedulesApi = exports.CrawlerSchedulesApiFactory = exports.CrawlerSchedulesApiFp = exports.CrawlerSchedulesApiAxiosParamCreator = exports.ContainersApi = exports.ContainersApiFactory = exports.ContainersApiFp = exports.ContainersApiAxiosParamCreator = exports.ComposeApi = exports.ComposeApiFactory = exports.ComposeApiFp = exports.ComposeApiAxiosParamCreator = exports.CommandsApi = exports.CommandsApiFactory = exports.CommandsApiFp = exports.CommandsApiAxiosParamCreator = exports.ListBackupsStatusEnum = exports.ListBackupsOrderEnum = exports.ListBackupsTypeEnum = exports.DownloadBackupTypeEnum = void 0;
|
|
27
|
+
exports.VolumesApi = exports.VolumesApiFactory = exports.VolumesApiFp = exports.VolumesApiAxiosParamCreator = exports.VariablesApi = exports.VariablesApiFactory = exports.VariablesApiFp = exports.VariablesApiAxiosParamCreator = exports.ScalingPolicyApi = exports.ScalingPolicyApiFactory = exports.ScalingPolicyApiFp = exports.ScalingPolicyApiAxiosParamCreator = exports.SSHAccessApi = exports.SSHAccessApiFactory = exports.SSHAccessApiFp = exports.SSHAccessApiAxiosParamCreator = exports.RulesApi = exports.RulesApiFactory = exports.RulesApiFp = exports.RulesApiAxiosParamCreator = exports.PurgeApi = exports.PurgeApiFactory = exports.PurgeApiFp = exports.PurgeApiAxiosParamCreator = exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = void 0;
|
|
29
28
|
const axios_1 = require("axios");
|
|
30
29
|
// Some imports not used depending on template conditions
|
|
31
30
|
// @ts-ignore
|
|
@@ -40,6 +39,21 @@ exports.ApplicationImageReferenceTypeEnum = {
|
|
|
40
39
|
Internal: 'internal',
|
|
41
40
|
External: 'external'
|
|
42
41
|
};
|
|
42
|
+
exports.ChatInference200ResponseFinishReasonEnum = {
|
|
43
|
+
Stop: 'stop',
|
|
44
|
+
Length: 'length',
|
|
45
|
+
ContentFilter: 'content_filter',
|
|
46
|
+
ToolUse: 'tool_use'
|
|
47
|
+
};
|
|
48
|
+
exports.ChatInference200ResponseResponseRoleEnum = {
|
|
49
|
+
Assistant: 'assistant'
|
|
50
|
+
};
|
|
51
|
+
exports.ChatInference200ResponseResponseToolUseOneOfStatusEnum = {
|
|
52
|
+
Pending: 'pending',
|
|
53
|
+
Running: 'running',
|
|
54
|
+
Complete: 'complete',
|
|
55
|
+
Failed: 'failed'
|
|
56
|
+
};
|
|
43
57
|
exports.ChatInferenceRequestMessagesInnerRoleEnum = {
|
|
44
58
|
User: 'user',
|
|
45
59
|
Assistant: 'assistant',
|
|
@@ -111,6 +125,12 @@ exports.EmbeddingsRequestDimensionsEnum = {
|
|
|
111
125
|
NUMBER_1024: 1024,
|
|
112
126
|
NUMBER_8192: 8192
|
|
113
127
|
};
|
|
128
|
+
exports.GetToolExecutionStatus200ResponseStatusEnum = {
|
|
129
|
+
Pending: 'pending',
|
|
130
|
+
Running: 'running',
|
|
131
|
+
Complete: 'complete',
|
|
132
|
+
Failed: 'failed'
|
|
133
|
+
};
|
|
114
134
|
exports.ImageGenerationRequestTaskTypeEnum = {
|
|
115
135
|
TextImage: 'TEXT_IMAGE',
|
|
116
136
|
ColorGuidedGeneration: 'COLOR_GUIDED_GENERATION',
|
|
@@ -147,311 +167,31 @@ exports.ImageGenerationRequestTextToImageParamsControlModeEnum = {
|
|
|
147
167
|
CannyEdge: 'CANNY_EDGE',
|
|
148
168
|
Segmentation: 'SEGMENTATION'
|
|
149
169
|
};
|
|
170
|
+
exports.ListToolExecutions200ResponseExecutionsInnerStatusEnum = {
|
|
171
|
+
Pending: 'pending',
|
|
172
|
+
Running: 'running',
|
|
173
|
+
Complete: 'complete',
|
|
174
|
+
Failed: 'failed'
|
|
175
|
+
};
|
|
150
176
|
exports.ScalingPolicyMetricEnum = {
|
|
151
177
|
CpuUtilization: 'CPUUtilization',
|
|
152
178
|
MemoryUtilization: 'MemoryUtilization',
|
|
153
179
|
Rps: 'RPS'
|
|
154
180
|
};
|
|
181
|
+
exports.SpotConfigurationStrategyEnum = {
|
|
182
|
+
Off: 'off',
|
|
183
|
+
SpotOnly: 'spot-only',
|
|
184
|
+
MixedSafe: 'mixed-safe',
|
|
185
|
+
MixedAggressive: 'mixed-aggressive'
|
|
186
|
+
};
|
|
155
187
|
exports.V1TransitionStateEnum = {
|
|
156
188
|
Published: 'published',
|
|
157
189
|
Unpublished: 'unpublished'
|
|
158
190
|
};
|
|
159
|
-
exports.V2CrawlerModeEnum = {
|
|
160
|
-
Report: 'report',
|
|
161
|
-
Block: 'block'
|
|
162
|
-
};
|
|
163
|
-
exports.V2CrawlerRequestModeEnum = {
|
|
164
|
-
Report: 'report',
|
|
165
|
-
Block: 'block'
|
|
166
|
-
};
|
|
167
|
-
exports.V2CrawlerScheduleModeEnum = {
|
|
168
|
-
Report: 'report',
|
|
169
|
-
Block: 'block'
|
|
170
|
-
};
|
|
171
|
-
exports.V2CrawlerScheduleRequestModeEnum = {
|
|
172
|
-
Report: 'report',
|
|
173
|
-
Block: 'block'
|
|
174
|
-
};
|
|
175
|
-
exports.V2DomainModeEnum = {
|
|
176
|
-
Report: 'report',
|
|
177
|
-
Block: 'block'
|
|
178
|
-
};
|
|
179
|
-
exports.V2DomainRequestModeEnum = {
|
|
180
|
-
Report: 'report',
|
|
181
|
-
Block: 'block'
|
|
182
|
-
};
|
|
183
|
-
exports.V2OrganizationModeEnum = {
|
|
184
|
-
Report: 'report',
|
|
185
|
-
Block: 'block'
|
|
186
|
-
};
|
|
187
|
-
exports.V2OrganizationRequestModeEnum = {
|
|
188
|
-
Report: 'report',
|
|
189
|
-
Block: 'block'
|
|
190
|
-
};
|
|
191
|
-
exports.V2ProjectModeEnum = {
|
|
192
|
-
Report: 'report',
|
|
193
|
-
Block: 'block'
|
|
194
|
-
};
|
|
195
|
-
exports.V2ProjectRequestModeEnum = {
|
|
196
|
-
Report: 'report',
|
|
197
|
-
Block: 'block'
|
|
198
|
-
};
|
|
199
|
-
exports.V2RuleModeEnum = {
|
|
200
|
-
Report: 'report',
|
|
201
|
-
Block: 'block'
|
|
202
|
-
};
|
|
203
|
-
exports.V2RuleAuthModeEnum = {
|
|
204
|
-
Report: 'report',
|
|
205
|
-
Block: 'block'
|
|
206
|
-
};
|
|
207
|
-
exports.V2RuleAuthNotifyEnum = {
|
|
208
|
-
None: 'none',
|
|
209
|
-
Slack: 'slack'
|
|
210
|
-
};
|
|
211
|
-
exports.V2RuleAuthActionModeEnum = {
|
|
212
|
-
Report: 'report',
|
|
213
|
-
Block: 'block'
|
|
214
|
-
};
|
|
215
|
-
exports.V2RuleAuthActionNotifyEnum = {
|
|
216
|
-
None: 'none',
|
|
217
|
-
Slack: 'slack'
|
|
218
|
-
};
|
|
219
|
-
exports.V2RuleAuthRequestModeEnum = {
|
|
220
|
-
Report: 'report',
|
|
221
|
-
Block: 'block'
|
|
222
|
-
};
|
|
223
|
-
exports.V2RuleAuthRequestNotifyEnum = {
|
|
224
|
-
None: 'none',
|
|
225
|
-
Slack: 'slack'
|
|
226
|
-
};
|
|
227
|
-
exports.V2RuleBotChallengeModeEnum = {
|
|
228
|
-
Report: 'report',
|
|
229
|
-
Block: 'block'
|
|
230
|
-
};
|
|
231
|
-
exports.V2RuleBotChallengeNotifyEnum = {
|
|
232
|
-
None: 'none',
|
|
233
|
-
Slack: 'slack'
|
|
234
|
-
};
|
|
235
|
-
exports.V2RuleBotChallengeActionModeEnum = {
|
|
236
|
-
Report: 'report',
|
|
237
|
-
Block: 'block'
|
|
238
|
-
};
|
|
239
|
-
exports.V2RuleBotChallengeActionNotifyEnum = {
|
|
240
|
-
None: 'none',
|
|
241
|
-
Slack: 'slack'
|
|
242
|
-
};
|
|
243
|
-
exports.V2RuleBotChallengeRequestModeEnum = {
|
|
244
|
-
Report: 'report',
|
|
245
|
-
Block: 'block'
|
|
246
|
-
};
|
|
247
|
-
exports.V2RuleBotChallengeRequestNotifyEnum = {
|
|
248
|
-
None: 'none',
|
|
249
|
-
Slack: 'slack'
|
|
250
|
-
};
|
|
251
|
-
exports.V2RuleContentFilterModeEnum = {
|
|
252
|
-
Report: 'report',
|
|
253
|
-
Block: 'block'
|
|
254
|
-
};
|
|
255
|
-
exports.V2RuleContentFilterNotifyEnum = {
|
|
256
|
-
None: 'none',
|
|
257
|
-
Slack: 'slack'
|
|
258
|
-
};
|
|
259
|
-
exports.V2RuleContentFilterActionModeEnum = {
|
|
260
|
-
Report: 'report',
|
|
261
|
-
Block: 'block'
|
|
262
|
-
};
|
|
263
|
-
exports.V2RuleContentFilterActionNotifyEnum = {
|
|
264
|
-
None: 'none',
|
|
265
|
-
Slack: 'slack'
|
|
266
|
-
};
|
|
267
|
-
exports.V2RuleContentFilterRequestModeEnum = {
|
|
268
|
-
Report: 'report',
|
|
269
|
-
Block: 'block'
|
|
270
|
-
};
|
|
271
|
-
exports.V2RuleContentFilterRequestNotifyEnum = {
|
|
272
|
-
None: 'none',
|
|
273
|
-
Slack: 'slack'
|
|
274
|
-
};
|
|
275
|
-
exports.V2RuleCustomResponseModeEnum = {
|
|
276
|
-
Report: 'report',
|
|
277
|
-
Block: 'block'
|
|
278
|
-
};
|
|
279
|
-
exports.V2RuleCustomResponseNotifyEnum = {
|
|
280
|
-
None: 'none',
|
|
281
|
-
Slack: 'slack'
|
|
282
|
-
};
|
|
283
|
-
exports.V2RuleCustomResponseActionModeEnum = {
|
|
284
|
-
Report: 'report',
|
|
285
|
-
Block: 'block'
|
|
286
|
-
};
|
|
287
|
-
exports.V2RuleCustomResponseActionNotifyEnum = {
|
|
288
|
-
None: 'none',
|
|
289
|
-
Slack: 'slack'
|
|
290
|
-
};
|
|
291
|
-
exports.V2RuleCustomResponseRequestModeEnum = {
|
|
292
|
-
Report: 'report',
|
|
293
|
-
Block: 'block'
|
|
294
|
-
};
|
|
295
|
-
exports.V2RuleCustomResponseRequestNotifyEnum = {
|
|
296
|
-
None: 'none',
|
|
297
|
-
Slack: 'slack'
|
|
298
|
-
};
|
|
299
|
-
exports.V2RuleFunctionModeEnum = {
|
|
300
|
-
Report: 'report',
|
|
301
|
-
Block: 'block'
|
|
302
|
-
};
|
|
303
|
-
exports.V2RuleFunctionNotifyEnum = {
|
|
304
|
-
None: 'none',
|
|
305
|
-
Slack: 'slack'
|
|
306
|
-
};
|
|
307
|
-
exports.V2RuleFunctionActionModeEnum = {
|
|
308
|
-
Report: 'report',
|
|
309
|
-
Block: 'block'
|
|
310
|
-
};
|
|
311
|
-
exports.V2RuleFunctionActionNotifyEnum = {
|
|
312
|
-
None: 'none',
|
|
313
|
-
Slack: 'slack'
|
|
314
|
-
};
|
|
315
|
-
exports.V2RuleFunctionRequestModeEnum = {
|
|
316
|
-
Report: 'report',
|
|
317
|
-
Block: 'block'
|
|
318
|
-
};
|
|
319
|
-
exports.V2RuleFunctionRequestNotifyEnum = {
|
|
320
|
-
None: 'none',
|
|
321
|
-
Slack: 'slack'
|
|
322
|
-
};
|
|
323
|
-
exports.V2RuleHeaderModeEnum = {
|
|
324
|
-
Report: 'report',
|
|
325
|
-
Block: 'block'
|
|
326
|
-
};
|
|
327
|
-
exports.V2RuleHeaderNotifyEnum = {
|
|
328
|
-
None: 'none',
|
|
329
|
-
Slack: 'slack'
|
|
330
|
-
};
|
|
331
|
-
exports.V2RuleHeaderActionModeEnum = {
|
|
332
|
-
Report: 'report',
|
|
333
|
-
Block: 'block'
|
|
334
|
-
};
|
|
335
|
-
exports.V2RuleHeaderActionNotifyEnum = {
|
|
336
|
-
None: 'none',
|
|
337
|
-
Slack: 'slack'
|
|
338
|
-
};
|
|
339
|
-
exports.V2RuleHeaderRequestModeEnum = {
|
|
340
|
-
Report: 'report',
|
|
341
|
-
Block: 'block'
|
|
342
|
-
};
|
|
343
|
-
exports.V2RuleHeaderRequestNotifyEnum = {
|
|
344
|
-
None: 'none',
|
|
345
|
-
Slack: 'slack'
|
|
346
|
-
};
|
|
347
|
-
exports.V2RuleProxyModeEnum = {
|
|
348
|
-
Report: 'report',
|
|
349
|
-
Block: 'block'
|
|
350
|
-
};
|
|
351
|
-
exports.V2RuleProxyNotifyEnum = {
|
|
352
|
-
None: 'none',
|
|
353
|
-
Slack: 'slack'
|
|
354
|
-
};
|
|
355
|
-
exports.V2RuleProxyActionModeEnum = {
|
|
356
|
-
Report: 'report',
|
|
357
|
-
Block: 'block'
|
|
358
|
-
};
|
|
359
191
|
exports.V2RuleProxyActionNotifyEnum = {
|
|
360
192
|
None: 'none',
|
|
361
193
|
Slack: 'slack'
|
|
362
194
|
};
|
|
363
|
-
exports.V2RuleProxyRequestModeEnum = {
|
|
364
|
-
Report: 'report',
|
|
365
|
-
Block: 'block'
|
|
366
|
-
};
|
|
367
|
-
exports.V2RuleProxyRequestNotifyEnum = {
|
|
368
|
-
None: 'none',
|
|
369
|
-
Slack: 'slack'
|
|
370
|
-
};
|
|
371
|
-
exports.V2RuleRedirectModeEnum = {
|
|
372
|
-
Report: 'report',
|
|
373
|
-
Block: 'block'
|
|
374
|
-
};
|
|
375
|
-
exports.V2RuleRedirectNotifyEnum = {
|
|
376
|
-
None: 'none',
|
|
377
|
-
Slack: 'slack'
|
|
378
|
-
};
|
|
379
|
-
exports.V2RuleRedirectActionModeEnum = {
|
|
380
|
-
Report: 'report',
|
|
381
|
-
Block: 'block'
|
|
382
|
-
};
|
|
383
|
-
exports.V2RuleRedirectActionNotifyEnum = {
|
|
384
|
-
None: 'none',
|
|
385
|
-
Slack: 'slack'
|
|
386
|
-
};
|
|
387
|
-
exports.V2RuleRedirectRequestModeEnum = {
|
|
388
|
-
Report: 'report',
|
|
389
|
-
Block: 'block'
|
|
390
|
-
};
|
|
391
|
-
exports.V2RuleRedirectRequestNotifyEnum = {
|
|
392
|
-
None: 'none',
|
|
393
|
-
Slack: 'slack'
|
|
394
|
-
};
|
|
395
|
-
exports.V2RuleRequestModeEnum = {
|
|
396
|
-
Report: 'report',
|
|
397
|
-
Block: 'block'
|
|
398
|
-
};
|
|
399
|
-
exports.V2RuleServeStaticModeEnum = {
|
|
400
|
-
Report: 'report',
|
|
401
|
-
Block: 'block'
|
|
402
|
-
};
|
|
403
|
-
exports.V2RuleServeStaticNotifyEnum = {
|
|
404
|
-
None: 'none',
|
|
405
|
-
Slack: 'slack'
|
|
406
|
-
};
|
|
407
|
-
exports.V2RuleServeStaticActionModeEnum = {
|
|
408
|
-
Report: 'report',
|
|
409
|
-
Block: 'block'
|
|
410
|
-
};
|
|
411
|
-
exports.V2RuleServeStaticActionNotifyEnum = {
|
|
412
|
-
None: 'none',
|
|
413
|
-
Slack: 'slack'
|
|
414
|
-
};
|
|
415
|
-
exports.V2RuleServeStaticRequestModeEnum = {
|
|
416
|
-
Report: 'report',
|
|
417
|
-
Block: 'block'
|
|
418
|
-
};
|
|
419
|
-
exports.V2RuleServeStaticRequestNotifyEnum = {
|
|
420
|
-
None: 'none',
|
|
421
|
-
Slack: 'slack'
|
|
422
|
-
};
|
|
423
|
-
exports.V2SecretStoreModeEnum = {
|
|
424
|
-
Report: 'report',
|
|
425
|
-
Block: 'block'
|
|
426
|
-
};
|
|
427
|
-
exports.V2SecretStoreRequestModeEnum = {
|
|
428
|
-
Report: 'report',
|
|
429
|
-
Block: 'block'
|
|
430
|
-
};
|
|
431
|
-
exports.V2StoreModeEnum = {
|
|
432
|
-
Report: 'report',
|
|
433
|
-
Block: 'block'
|
|
434
|
-
};
|
|
435
|
-
exports.V2StoreItemModeEnum = {
|
|
436
|
-
Report: 'report',
|
|
437
|
-
Block: 'block'
|
|
438
|
-
};
|
|
439
|
-
exports.V2StoreItemRequestModeEnum = {
|
|
440
|
-
Report: 'report',
|
|
441
|
-
Block: 'block'
|
|
442
|
-
};
|
|
443
|
-
exports.V2StoreItemUpdateRequestModeEnum = {
|
|
444
|
-
Report: 'report',
|
|
445
|
-
Block: 'block'
|
|
446
|
-
};
|
|
447
|
-
exports.V2StoreItemsListResponseModeEnum = {
|
|
448
|
-
Report: 'report',
|
|
449
|
-
Block: 'block'
|
|
450
|
-
};
|
|
451
|
-
exports.V2StoreRequestModeEnum = {
|
|
452
|
-
Report: 'report',
|
|
453
|
-
Block: 'block'
|
|
454
|
-
};
|
|
455
195
|
exports.WafConfigModeEnum = {
|
|
456
196
|
Report: 'report',
|
|
457
197
|
Block: 'block'
|
|
@@ -473,7 +213,7 @@ exports.WafConfigThresholdsInnerModeEnum = {
|
|
|
473
213
|
const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
474
214
|
return {
|
|
475
215
|
/**
|
|
476
|
-
* 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
|
|
216
|
+
* 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
|
|
477
217
|
* @summary Chat inference via API Gateway (buffered responses) with multimodal support
|
|
478
218
|
* @param {string} organisation The organisation ID
|
|
479
219
|
* @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
|
|
@@ -732,10 +472,159 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
732
472
|
* @param {*} [options] Override http request option.
|
|
733
473
|
* @throws {RequiredError}
|
|
734
474
|
*/
|
|
735
|
-
getAIUsageStats: (organisation, month, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
475
|
+
getAIUsageStats: (organisation, month, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
476
|
+
// verify required parameter 'organisation' is not null or undefined
|
|
477
|
+
(0, common_1.assertParamExists)('getAIUsageStats', 'organisation', organisation);
|
|
478
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/usage`
|
|
479
|
+
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
480
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
481
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
482
|
+
let baseOptions;
|
|
483
|
+
if (configuration) {
|
|
484
|
+
baseOptions = configuration.baseOptions;
|
|
485
|
+
}
|
|
486
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
487
|
+
const localVarHeaderParameter = {};
|
|
488
|
+
const localVarQueryParameter = {};
|
|
489
|
+
// authentication BearerAuth required
|
|
490
|
+
// http bearer authentication required
|
|
491
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
492
|
+
if (month !== undefined) {
|
|
493
|
+
localVarQueryParameter['month'] = month;
|
|
494
|
+
}
|
|
495
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
496
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
497
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
498
|
+
return {
|
|
499
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
500
|
+
options: localVarRequestOptions,
|
|
501
|
+
};
|
|
502
|
+
}),
|
|
503
|
+
/**
|
|
504
|
+
* 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
|
|
505
|
+
* @summary Get async tool execution status and result
|
|
506
|
+
* @param {string} organisation The organisation ID
|
|
507
|
+
* @param {string} executionId Tool execution identifier
|
|
508
|
+
* @param {*} [options] Override http request option.
|
|
509
|
+
* @throws {RequiredError}
|
|
510
|
+
*/
|
|
511
|
+
getToolExecutionStatus: (organisation, executionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
512
|
+
// verify required parameter 'organisation' is not null or undefined
|
|
513
|
+
(0, common_1.assertParamExists)('getToolExecutionStatus', 'organisation', organisation);
|
|
514
|
+
// verify required parameter 'executionId' is not null or undefined
|
|
515
|
+
(0, common_1.assertParamExists)('getToolExecutionStatus', 'executionId', executionId);
|
|
516
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/executions/{executionId}`
|
|
517
|
+
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
|
|
518
|
+
.replace(`{${"executionId"}}`, encodeURIComponent(String(executionId)));
|
|
519
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
520
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
521
|
+
let baseOptions;
|
|
522
|
+
if (configuration) {
|
|
523
|
+
baseOptions = configuration.baseOptions;
|
|
524
|
+
}
|
|
525
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
526
|
+
const localVarHeaderParameter = {};
|
|
527
|
+
const localVarQueryParameter = {};
|
|
528
|
+
// authentication BearerAuth required
|
|
529
|
+
// http bearer authentication required
|
|
530
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
531
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
532
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
533
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
534
|
+
return {
|
|
535
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
536
|
+
options: localVarRequestOptions,
|
|
537
|
+
};
|
|
538
|
+
}),
|
|
539
|
+
/**
|
|
540
|
+
* 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
|
|
541
|
+
* @summary Generate images with Amazon Nova Canvas
|
|
542
|
+
* @param {string} organisation The organisation ID
|
|
543
|
+
* @param {ImageGenerationRequest} imageGenerationRequest Image generation request
|
|
544
|
+
* @param {*} [options] Override http request option.
|
|
545
|
+
* @throws {RequiredError}
|
|
546
|
+
*/
|
|
547
|
+
imageGeneration: (organisation, imageGenerationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
548
|
+
// verify required parameter 'organisation' is not null or undefined
|
|
549
|
+
(0, common_1.assertParamExists)('imageGeneration', 'organisation', organisation);
|
|
550
|
+
// verify required parameter 'imageGenerationRequest' is not null or undefined
|
|
551
|
+
(0, common_1.assertParamExists)('imageGeneration', 'imageGenerationRequest', imageGenerationRequest);
|
|
552
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/image-generation`
|
|
553
|
+
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
554
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
555
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
556
|
+
let baseOptions;
|
|
557
|
+
if (configuration) {
|
|
558
|
+
baseOptions = configuration.baseOptions;
|
|
559
|
+
}
|
|
560
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
561
|
+
const localVarHeaderParameter = {};
|
|
562
|
+
const localVarQueryParameter = {};
|
|
563
|
+
// authentication BearerAuth required
|
|
564
|
+
// http bearer authentication required
|
|
565
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
566
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
567
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
568
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
569
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
570
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(imageGenerationRequest, localVarRequestOptions, configuration);
|
|
571
|
+
return {
|
|
572
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
573
|
+
options: localVarRequestOptions,
|
|
574
|
+
};
|
|
575
|
+
}),
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @summary List available AI models for an organization
|
|
579
|
+
* @param {string} organisation The organisation ID
|
|
580
|
+
* @param {ListAIModelsFeatureEnum} [feature] Filter models by supported feature
|
|
581
|
+
* @param {*} [options] Override http request option.
|
|
582
|
+
* @throws {RequiredError}
|
|
583
|
+
*/
|
|
584
|
+
listAIModels: (organisation, feature, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
585
|
+
// verify required parameter 'organisation' is not null or undefined
|
|
586
|
+
(0, common_1.assertParamExists)('listAIModels', 'organisation', organisation);
|
|
587
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/models`
|
|
588
|
+
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
589
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
590
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
591
|
+
let baseOptions;
|
|
592
|
+
if (configuration) {
|
|
593
|
+
baseOptions = configuration.baseOptions;
|
|
594
|
+
}
|
|
595
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
596
|
+
const localVarHeaderParameter = {};
|
|
597
|
+
const localVarQueryParameter = {};
|
|
598
|
+
// authentication BearerAuth required
|
|
599
|
+
// http bearer authentication required
|
|
600
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
601
|
+
if (feature !== undefined) {
|
|
602
|
+
localVarQueryParameter['feature'] = feature;
|
|
603
|
+
}
|
|
604
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
605
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
606
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
607
|
+
return {
|
|
608
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
609
|
+
options: localVarRequestOptions,
|
|
610
|
+
};
|
|
611
|
+
}),
|
|
612
|
+
/**
|
|
613
|
+
* 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
|
|
614
|
+
* @summary List chat sessions with multi-tenant filtering
|
|
615
|
+
* @param {string} organisation The organisation ID
|
|
616
|
+
* @param {string} [userId] Filter sessions by user ID
|
|
617
|
+
* @param {string} [sessionGroup] Filter by session group. Returns only sessions matching the specified group.
|
|
618
|
+
* @param {number} [limit] Maximum number of sessions to return (default 50, max 100)
|
|
619
|
+
* @param {number} [offset] Offset for pagination
|
|
620
|
+
* @param {string} [model] Filter by model ID
|
|
621
|
+
* @param {*} [options] Override http request option.
|
|
622
|
+
* @throws {RequiredError}
|
|
623
|
+
*/
|
|
624
|
+
listAISessions: (organisation, userId, sessionGroup, limit, offset, model, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
736
625
|
// verify required parameter 'organisation' is not null or undefined
|
|
737
|
-
(0, common_1.assertParamExists)('
|
|
738
|
-
const localVarPath = `/api/v3/organizations/{organisation}/ai/
|
|
626
|
+
(0, common_1.assertParamExists)('listAISessions', 'organisation', organisation);
|
|
627
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/sessions`
|
|
739
628
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
740
629
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
741
630
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -749,8 +638,20 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
749
638
|
// authentication BearerAuth required
|
|
750
639
|
// http bearer authentication required
|
|
751
640
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
752
|
-
if (
|
|
753
|
-
localVarQueryParameter['
|
|
641
|
+
if (userId !== undefined) {
|
|
642
|
+
localVarQueryParameter['userId'] = userId;
|
|
643
|
+
}
|
|
644
|
+
if (sessionGroup !== undefined) {
|
|
645
|
+
localVarQueryParameter['sessionGroup'] = sessionGroup;
|
|
646
|
+
}
|
|
647
|
+
if (limit !== undefined) {
|
|
648
|
+
localVarQueryParameter['limit'] = limit;
|
|
649
|
+
}
|
|
650
|
+
if (offset !== undefined) {
|
|
651
|
+
localVarQueryParameter['offset'] = offset;
|
|
652
|
+
}
|
|
653
|
+
if (model !== undefined) {
|
|
654
|
+
localVarQueryParameter['model'] = model;
|
|
754
655
|
}
|
|
755
656
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
756
657
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -761,19 +662,16 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
761
662
|
};
|
|
762
663
|
}),
|
|
763
664
|
/**
|
|
764
|
-
*
|
|
765
|
-
* @summary
|
|
665
|
+
* Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
|
|
666
|
+
* @summary List tool names only (lightweight response)
|
|
766
667
|
* @param {string} organisation The organisation ID
|
|
767
|
-
* @param {ImageGenerationRequest} imageGenerationRequest Image generation request
|
|
768
668
|
* @param {*} [options] Override http request option.
|
|
769
669
|
* @throws {RequiredError}
|
|
770
670
|
*/
|
|
771
|
-
|
|
671
|
+
listAIToolNames: (organisation, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
772
672
|
// verify required parameter 'organisation' is not null or undefined
|
|
773
|
-
(0, common_1.assertParamExists)('
|
|
774
|
-
|
|
775
|
-
(0, common_1.assertParamExists)('imageGeneration', 'imageGenerationRequest', imageGenerationRequest);
|
|
776
|
-
const localVarPath = `/api/v3/organizations/{organisation}/ai/image-generation`
|
|
673
|
+
(0, common_1.assertParamExists)('listAIToolNames', 'organisation', organisation);
|
|
674
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/names`
|
|
777
675
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
778
676
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
779
677
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -781,34 +679,31 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
781
679
|
if (configuration) {
|
|
782
680
|
baseOptions = configuration.baseOptions;
|
|
783
681
|
}
|
|
784
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
682
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
785
683
|
const localVarHeaderParameter = {};
|
|
786
684
|
const localVarQueryParameter = {};
|
|
787
685
|
// authentication BearerAuth required
|
|
788
686
|
// http bearer authentication required
|
|
789
687
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
790
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
791
688
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
792
689
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
793
690
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
794
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(imageGenerationRequest, localVarRequestOptions, configuration);
|
|
795
691
|
return {
|
|
796
692
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
797
693
|
options: localVarRequestOptions,
|
|
798
694
|
};
|
|
799
695
|
}),
|
|
800
696
|
/**
|
|
801
|
-
*
|
|
802
|
-
* @summary List available
|
|
697
|
+
* 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)
|
|
698
|
+
* @summary List available built-in tools for function calling
|
|
803
699
|
* @param {string} organisation The organisation ID
|
|
804
|
-
* @param {ListAIModelsFeatureEnum} [feature] Filter models by supported feature
|
|
805
700
|
* @param {*} [options] Override http request option.
|
|
806
701
|
* @throws {RequiredError}
|
|
807
702
|
*/
|
|
808
|
-
|
|
703
|
+
listAITools: (organisation, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
809
704
|
// verify required parameter 'organisation' is not null or undefined
|
|
810
|
-
(0, common_1.assertParamExists)('
|
|
811
|
-
const localVarPath = `/api/v3/organizations/{organisation}/ai/
|
|
705
|
+
(0, common_1.assertParamExists)('listAITools', 'organisation', organisation);
|
|
706
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/tools`
|
|
812
707
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
813
708
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
814
709
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -822,9 +717,6 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
822
717
|
// authentication BearerAuth required
|
|
823
718
|
// http bearer authentication required
|
|
824
719
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
825
|
-
if (feature !== undefined) {
|
|
826
|
-
localVarQueryParameter['feature'] = feature;
|
|
827
|
-
}
|
|
828
720
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
829
721
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
830
722
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -834,21 +726,18 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
834
726
|
};
|
|
835
727
|
}),
|
|
836
728
|
/**
|
|
837
|
-
* Lists
|
|
838
|
-
* @summary List
|
|
729
|
+
* 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
|
|
730
|
+
* @summary List tool executions for monitoring and debugging
|
|
839
731
|
* @param {string} organisation The organisation ID
|
|
840
|
-
* @param {
|
|
841
|
-
* @param {
|
|
842
|
-
* @param {number} [limit] Maximum number of sessions to return (default 50, max 100)
|
|
843
|
-
* @param {number} [offset] Offset for pagination
|
|
844
|
-
* @param {string} [model] Filter by model ID
|
|
732
|
+
* @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
|
|
733
|
+
* @param {number} [limit] Maximum number of executions to return
|
|
845
734
|
* @param {*} [options] Override http request option.
|
|
846
735
|
* @throws {RequiredError}
|
|
847
736
|
*/
|
|
848
|
-
|
|
737
|
+
listToolExecutions: (organisation, status, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
849
738
|
// verify required parameter 'organisation' is not null or undefined
|
|
850
|
-
(0, common_1.assertParamExists)('
|
|
851
|
-
const localVarPath = `/api/v3/organizations/{organisation}/ai/
|
|
739
|
+
(0, common_1.assertParamExists)('listToolExecutions', 'organisation', organisation);
|
|
740
|
+
const localVarPath = `/api/v3/organizations/{organisation}/ai/tools/executions`
|
|
852
741
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)));
|
|
853
742
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
854
743
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -862,21 +751,12 @@ const AIServicesApiAxiosParamCreator = function (configuration) {
|
|
|
862
751
|
// authentication BearerAuth required
|
|
863
752
|
// http bearer authentication required
|
|
864
753
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
865
|
-
if (
|
|
866
|
-
localVarQueryParameter['
|
|
867
|
-
}
|
|
868
|
-
if (sessionGroup !== undefined) {
|
|
869
|
-
localVarQueryParameter['sessionGroup'] = sessionGroup;
|
|
754
|
+
if (status !== undefined) {
|
|
755
|
+
localVarQueryParameter['status'] = status;
|
|
870
756
|
}
|
|
871
757
|
if (limit !== undefined) {
|
|
872
758
|
localVarQueryParameter['limit'] = limit;
|
|
873
759
|
}
|
|
874
|
-
if (offset !== undefined) {
|
|
875
|
-
localVarQueryParameter['offset'] = offset;
|
|
876
|
-
}
|
|
877
|
-
if (model !== undefined) {
|
|
878
|
-
localVarQueryParameter['model'] = model;
|
|
879
|
-
}
|
|
880
760
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
881
761
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
882
762
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -933,7 +813,7 @@ const AIServicesApiFp = function (configuration) {
|
|
|
933
813
|
const localVarAxiosParamCreator = (0, exports.AIServicesApiAxiosParamCreator)(configuration);
|
|
934
814
|
return {
|
|
935
815
|
/**
|
|
936
|
-
* 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
|
|
816
|
+
* 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
|
|
937
817
|
* @summary Chat inference via API Gateway (buffered responses) with multimodal support
|
|
938
818
|
* @param {string} organisation The organisation ID
|
|
939
819
|
* @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
|
|
@@ -1067,6 +947,23 @@ const AIServicesApiFp = function (configuration) {
|
|
|
1067
947
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1068
948
|
});
|
|
1069
949
|
},
|
|
950
|
+
/**
|
|
951
|
+
* 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
|
|
952
|
+
* @summary Get async tool execution status and result
|
|
953
|
+
* @param {string} organisation The organisation ID
|
|
954
|
+
* @param {string} executionId Tool execution identifier
|
|
955
|
+
* @param {*} [options] Override http request option.
|
|
956
|
+
* @throws {RequiredError}
|
|
957
|
+
*/
|
|
958
|
+
getToolExecutionStatus(organisation, executionId, options) {
|
|
959
|
+
var _a, _b, _c;
|
|
960
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
961
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getToolExecutionStatus(organisation, executionId, options);
|
|
962
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
963
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIServicesApi.getToolExecutionStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
964
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
965
|
+
});
|
|
966
|
+
},
|
|
1070
967
|
/**
|
|
1071
968
|
* 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
|
|
1072
969
|
* @summary Generate images with Amazon Nova Canvas
|
|
@@ -1122,6 +1019,56 @@ const AIServicesApiFp = function (configuration) {
|
|
|
1122
1019
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1123
1020
|
});
|
|
1124
1021
|
},
|
|
1022
|
+
/**
|
|
1023
|
+
* Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
|
|
1024
|
+
* @summary List tool names only (lightweight response)
|
|
1025
|
+
* @param {string} organisation The organisation ID
|
|
1026
|
+
* @param {*} [options] Override http request option.
|
|
1027
|
+
* @throws {RequiredError}
|
|
1028
|
+
*/
|
|
1029
|
+
listAIToolNames(organisation, options) {
|
|
1030
|
+
var _a, _b, _c;
|
|
1031
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1032
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAIToolNames(organisation, options);
|
|
1033
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1034
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIServicesApi.listAIToolNames']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1035
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1036
|
+
});
|
|
1037
|
+
},
|
|
1038
|
+
/**
|
|
1039
|
+
* 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)
|
|
1040
|
+
* @summary List available built-in tools for function calling
|
|
1041
|
+
* @param {string} organisation The organisation ID
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @throws {RequiredError}
|
|
1044
|
+
*/
|
|
1045
|
+
listAITools(organisation, options) {
|
|
1046
|
+
var _a, _b, _c;
|
|
1047
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1048
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listAITools(organisation, options);
|
|
1049
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1050
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIServicesApi.listAITools']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1051
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1052
|
+
});
|
|
1053
|
+
},
|
|
1054
|
+
/**
|
|
1055
|
+
* 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
|
|
1056
|
+
* @summary List tool executions for monitoring and debugging
|
|
1057
|
+
* @param {string} organisation The organisation ID
|
|
1058
|
+
* @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
|
|
1059
|
+
* @param {number} [limit] Maximum number of executions to return
|
|
1060
|
+
* @param {*} [options] Override http request option.
|
|
1061
|
+
* @throws {RequiredError}
|
|
1062
|
+
*/
|
|
1063
|
+
listToolExecutions(organisation, status, limit, options) {
|
|
1064
|
+
var _a, _b, _c;
|
|
1065
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1066
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listToolExecutions(organisation, status, limit, options);
|
|
1067
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1068
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIServicesApi.listToolExecutions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1069
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1070
|
+
});
|
|
1071
|
+
},
|
|
1125
1072
|
/**
|
|
1126
1073
|
*
|
|
1127
1074
|
* @summary Update AI configuration for an organization
|
|
@@ -1150,7 +1097,7 @@ const AIServicesApiFactory = function (configuration, basePath, axios) {
|
|
|
1150
1097
|
const localVarFp = (0, exports.AIServicesApiFp)(configuration);
|
|
1151
1098
|
return {
|
|
1152
1099
|
/**
|
|
1153
|
-
* 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
|
|
1100
|
+
* 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
|
|
1154
1101
|
* @summary Chat inference via API Gateway (buffered responses) with multimodal support
|
|
1155
1102
|
* @param {string} organisation The organisation ID
|
|
1156
1103
|
* @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
|
|
@@ -1236,6 +1183,17 @@ const AIServicesApiFactory = function (configuration, basePath, axios) {
|
|
|
1236
1183
|
getAIUsageStats(organisation, month, options) {
|
|
1237
1184
|
return localVarFp.getAIUsageStats(organisation, month, options).then((request) => request(axios, basePath));
|
|
1238
1185
|
},
|
|
1186
|
+
/**
|
|
1187
|
+
* 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
|
|
1188
|
+
* @summary Get async tool execution status and result
|
|
1189
|
+
* @param {string} organisation The organisation ID
|
|
1190
|
+
* @param {string} executionId Tool execution identifier
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
*/
|
|
1194
|
+
getToolExecutionStatus(organisation, executionId, options) {
|
|
1195
|
+
return localVarFp.getToolExecutionStatus(organisation, executionId, options).then((request) => request(axios, basePath));
|
|
1196
|
+
},
|
|
1239
1197
|
/**
|
|
1240
1198
|
* 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
|
|
1241
1199
|
* @summary Generate images with Amazon Nova Canvas
|
|
@@ -1273,6 +1231,38 @@ const AIServicesApiFactory = function (configuration, basePath, axios) {
|
|
|
1273
1231
|
listAISessions(organisation, userId, sessionGroup, limit, offset, model, options) {
|
|
1274
1232
|
return localVarFp.listAISessions(organisation, userId, sessionGroup, limit, offset, model, options).then((request) => request(axios, basePath));
|
|
1275
1233
|
},
|
|
1234
|
+
/**
|
|
1235
|
+
* Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
|
|
1236
|
+
* @summary List tool names only (lightweight response)
|
|
1237
|
+
* @param {string} organisation The organisation ID
|
|
1238
|
+
* @param {*} [options] Override http request option.
|
|
1239
|
+
* @throws {RequiredError}
|
|
1240
|
+
*/
|
|
1241
|
+
listAIToolNames(organisation, options) {
|
|
1242
|
+
return localVarFp.listAIToolNames(organisation, options).then((request) => request(axios, basePath));
|
|
1243
|
+
},
|
|
1244
|
+
/**
|
|
1245
|
+
* 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)
|
|
1246
|
+
* @summary List available built-in tools for function calling
|
|
1247
|
+
* @param {string} organisation The organisation ID
|
|
1248
|
+
* @param {*} [options] Override http request option.
|
|
1249
|
+
* @throws {RequiredError}
|
|
1250
|
+
*/
|
|
1251
|
+
listAITools(organisation, options) {
|
|
1252
|
+
return localVarFp.listAITools(organisation, options).then((request) => request(axios, basePath));
|
|
1253
|
+
},
|
|
1254
|
+
/**
|
|
1255
|
+
* 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
|
|
1256
|
+
* @summary List tool executions for monitoring and debugging
|
|
1257
|
+
* @param {string} organisation The organisation ID
|
|
1258
|
+
* @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
|
|
1259
|
+
* @param {number} [limit] Maximum number of executions to return
|
|
1260
|
+
* @param {*} [options] Override http request option.
|
|
1261
|
+
* @throws {RequiredError}
|
|
1262
|
+
*/
|
|
1263
|
+
listToolExecutions(organisation, status, limit, options) {
|
|
1264
|
+
return localVarFp.listToolExecutions(organisation, status, limit, options).then((request) => request(axios, basePath));
|
|
1265
|
+
},
|
|
1276
1266
|
/**
|
|
1277
1267
|
*
|
|
1278
1268
|
* @summary Update AI configuration for an organization
|
|
@@ -1295,7 +1285,7 @@ exports.AIServicesApiFactory = AIServicesApiFactory;
|
|
|
1295
1285
|
*/
|
|
1296
1286
|
class AIServicesApi extends base_1.BaseAPI {
|
|
1297
1287
|
/**
|
|
1298
|
-
* 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
|
|
1288
|
+
* 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
|
|
1299
1289
|
* @summary Chat inference via API Gateway (buffered responses) with multimodal support
|
|
1300
1290
|
* @param {string} organisation The organisation ID
|
|
1301
1291
|
* @param {ChatInferenceRequest} chatInferenceRequest Chat request with optional multimodal content blocks
|
|
@@ -1389,6 +1379,18 @@ class AIServicesApi extends base_1.BaseAPI {
|
|
|
1389
1379
|
getAIUsageStats(organisation, month, options) {
|
|
1390
1380
|
return (0, exports.AIServicesApiFp)(this.configuration).getAIUsageStats(organisation, month, options).then((request) => request(this.axios, this.basePath));
|
|
1391
1381
|
}
|
|
1382
|
+
/**
|
|
1383
|
+
* 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
|
|
1384
|
+
* @summary Get async tool execution status and result
|
|
1385
|
+
* @param {string} organisation The organisation ID
|
|
1386
|
+
* @param {string} executionId Tool execution identifier
|
|
1387
|
+
* @param {*} [options] Override http request option.
|
|
1388
|
+
* @throws {RequiredError}
|
|
1389
|
+
* @memberof AIServicesApi
|
|
1390
|
+
*/
|
|
1391
|
+
getToolExecutionStatus(organisation, executionId, options) {
|
|
1392
|
+
return (0, exports.AIServicesApiFp)(this.configuration).getToolExecutionStatus(organisation, executionId, options).then((request) => request(this.axios, this.basePath));
|
|
1393
|
+
}
|
|
1392
1394
|
/**
|
|
1393
1395
|
* 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
|
|
1394
1396
|
* @summary Generate images with Amazon Nova Canvas
|
|
@@ -1429,6 +1431,41 @@ class AIServicesApi extends base_1.BaseAPI {
|
|
|
1429
1431
|
listAISessions(organisation, userId, sessionGroup, limit, offset, model, options) {
|
|
1430
1432
|
return (0, exports.AIServicesApiFp)(this.configuration).listAISessions(organisation, userId, sessionGroup, limit, offset, model, options).then((request) => request(this.axios, this.basePath));
|
|
1431
1433
|
}
|
|
1434
|
+
/**
|
|
1435
|
+
* Retrieves just the names of available built-in tools. Useful for quick validation or UI dropdown population without the full tool specifications.
|
|
1436
|
+
* @summary List tool names only (lightweight response)
|
|
1437
|
+
* @param {string} organisation The organisation ID
|
|
1438
|
+
* @param {*} [options] Override http request option.
|
|
1439
|
+
* @throws {RequiredError}
|
|
1440
|
+
* @memberof AIServicesApi
|
|
1441
|
+
*/
|
|
1442
|
+
listAIToolNames(organisation, options) {
|
|
1443
|
+
return (0, exports.AIServicesApiFp)(this.configuration).listAIToolNames(organisation, options).then((request) => request(this.axios, this.basePath));
|
|
1444
|
+
}
|
|
1445
|
+
/**
|
|
1446
|
+
* 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)
|
|
1447
|
+
* @summary List available built-in tools for function calling
|
|
1448
|
+
* @param {string} organisation The organisation ID
|
|
1449
|
+
* @param {*} [options] Override http request option.
|
|
1450
|
+
* @throws {RequiredError}
|
|
1451
|
+
* @memberof AIServicesApi
|
|
1452
|
+
*/
|
|
1453
|
+
listAITools(organisation, options) {
|
|
1454
|
+
return (0, exports.AIServicesApiFp)(this.configuration).listAITools(organisation, options).then((request) => request(this.axios, this.basePath));
|
|
1455
|
+
}
|
|
1456
|
+
/**
|
|
1457
|
+
* 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
|
|
1458
|
+
* @summary List tool executions for monitoring and debugging
|
|
1459
|
+
* @param {string} organisation The organisation ID
|
|
1460
|
+
* @param {ListToolExecutionsStatusEnum} [status] Filter by execution status
|
|
1461
|
+
* @param {number} [limit] Maximum number of executions to return
|
|
1462
|
+
* @param {*} [options] Override http request option.
|
|
1463
|
+
* @throws {RequiredError}
|
|
1464
|
+
* @memberof AIServicesApi
|
|
1465
|
+
*/
|
|
1466
|
+
listToolExecutions(organisation, status, limit, options) {
|
|
1467
|
+
return (0, exports.AIServicesApiFp)(this.configuration).listToolExecutions(organisation, status, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1468
|
+
}
|
|
1432
1469
|
/**
|
|
1433
1470
|
*
|
|
1434
1471
|
* @summary Update AI configuration for an organization
|
|
@@ -1453,6 +1490,15 @@ exports.ListAIModelsFeatureEnum = {
|
|
|
1453
1490
|
Streaming: 'streaming',
|
|
1454
1491
|
All: 'all'
|
|
1455
1492
|
};
|
|
1493
|
+
/**
|
|
1494
|
+
* @export
|
|
1495
|
+
*/
|
|
1496
|
+
exports.ListToolExecutionsStatusEnum = {
|
|
1497
|
+
Pending: 'pending',
|
|
1498
|
+
Running: 'running',
|
|
1499
|
+
Complete: 'complete',
|
|
1500
|
+
Failed: 'failed'
|
|
1501
|
+
};
|
|
1456
1502
|
/**
|
|
1457
1503
|
* ApplicationsApi - axios parameter creator
|
|
1458
1504
|
* @export
|
|
@@ -2668,7 +2714,7 @@ const ComposeApiAxiosParamCreator = function (configuration) {
|
|
|
2668
2714
|
(0, common_1.assertParamExists)('getEnvironmentCompose', 'application', application);
|
|
2669
2715
|
// verify required parameter 'environment' is not null or undefined
|
|
2670
2716
|
(0, common_1.assertParamExists)('getEnvironmentCompose', 'environment', environment);
|
|
2671
|
-
const localVarPath = `/api/v3/organizations/{organisation}/environments/{environment}/compose`
|
|
2717
|
+
const localVarPath = `/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose`
|
|
2672
2718
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
|
|
2673
2719
|
.replace(`{${"application"}}`, encodeURIComponent(String(application)))
|
|
2674
2720
|
.replace(`{${"environment"}}`, encodeURIComponent(String(environment)));
|
|
@@ -2693,7 +2739,7 @@ const ComposeApiAxiosParamCreator = function (configuration) {
|
|
|
2693
2739
|
};
|
|
2694
2740
|
}),
|
|
2695
2741
|
/**
|
|
2696
|
-
* 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\').
|
|
2742
|
+
* 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\').
|
|
2697
2743
|
* @summary Validate a compose file
|
|
2698
2744
|
* @param {string} organisation The organisation ID
|
|
2699
2745
|
* @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.
|
|
@@ -2762,7 +2808,7 @@ const ComposeApiFp = function (configuration) {
|
|
|
2762
2808
|
});
|
|
2763
2809
|
},
|
|
2764
2810
|
/**
|
|
2765
|
-
* 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\').
|
|
2811
|
+
* 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\').
|
|
2766
2812
|
* @summary Validate a compose file
|
|
2767
2813
|
* @param {string} organisation The organisation ID
|
|
2768
2814
|
* @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.
|
|
@@ -2802,7 +2848,7 @@ const ComposeApiFactory = function (configuration, basePath, axios) {
|
|
|
2802
2848
|
return localVarFp.getEnvironmentCompose(organisation, application, environment, options).then((request) => request(axios, basePath));
|
|
2803
2849
|
},
|
|
2804
2850
|
/**
|
|
2805
|
-
* 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\').
|
|
2851
|
+
* 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\').
|
|
2806
2852
|
* @summary Validate a compose file
|
|
2807
2853
|
* @param {string} organisation The organisation ID
|
|
2808
2854
|
* @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.
|
|
@@ -2837,7 +2883,7 @@ class ComposeApi extends base_1.BaseAPI {
|
|
|
2837
2883
|
return (0, exports.ComposeApiFp)(this.configuration).getEnvironmentCompose(organisation, application, environment, options).then((request) => request(this.axios, this.basePath));
|
|
2838
2884
|
}
|
|
2839
2885
|
/**
|
|
2840
|
-
* 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\').
|
|
2886
|
+
* 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\').
|
|
2841
2887
|
* @summary Validate a compose file
|
|
2842
2888
|
* @param {string} organisation The organisation ID
|
|
2843
2889
|
* @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.
|
|
@@ -3140,7 +3186,7 @@ const CrawlerSchedulesApiAxiosParamCreator = function (configuration) {
|
|
|
3140
3186
|
(0, common_1.assertParamExists)('crawlerSchedulesDelete', 'crawler', crawler);
|
|
3141
3187
|
// verify required parameter 'crawlerSchedule' is not null or undefined
|
|
3142
3188
|
(0, common_1.assertParamExists)('crawlerSchedulesDelete', 'crawlerSchedule', crawlerSchedule);
|
|
3143
|
-
const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules`
|
|
3189
|
+
const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}`
|
|
3144
3190
|
.replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
|
|
3145
3191
|
.replace(`{${"project"}}`, encodeURIComponent(String(project)))
|
|
3146
3192
|
.replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)))
|
|
@@ -3171,23 +3217,27 @@ const CrawlerSchedulesApiAxiosParamCreator = function (configuration) {
|
|
|
3171
3217
|
* @param {string} organization Organization identifier
|
|
3172
3218
|
* @param {string} project Project identifier
|
|
3173
3219
|
* @param {string} crawler Crawler identifier
|
|
3220
|
+
* @param {string} crawlerSchedule Crawler schedule identifier
|
|
3174
3221
|
* @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
|
|
3175
3222
|
* @param {*} [options] Override http request option.
|
|
3176
3223
|
* @throws {RequiredError}
|
|
3177
3224
|
*/
|
|
3178
|
-
crawlerSchedulesEdit: (organization, project, crawler, v2CrawlerScheduleRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3225
|
+
crawlerSchedulesEdit: (organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3179
3226
|
// verify required parameter 'organization' is not null or undefined
|
|
3180
3227
|
(0, common_1.assertParamExists)('crawlerSchedulesEdit', 'organization', organization);
|
|
3181
3228
|
// verify required parameter 'project' is not null or undefined
|
|
3182
3229
|
(0, common_1.assertParamExists)('crawlerSchedulesEdit', 'project', project);
|
|
3183
3230
|
// verify required parameter 'crawler' is not null or undefined
|
|
3184
3231
|
(0, common_1.assertParamExists)('crawlerSchedulesEdit', 'crawler', crawler);
|
|
3232
|
+
// verify required parameter 'crawlerSchedule' is not null or undefined
|
|
3233
|
+
(0, common_1.assertParamExists)('crawlerSchedulesEdit', 'crawlerSchedule', crawlerSchedule);
|
|
3185
3234
|
// verify required parameter 'v2CrawlerScheduleRequest' is not null or undefined
|
|
3186
3235
|
(0, common_1.assertParamExists)('crawlerSchedulesEdit', 'v2CrawlerScheduleRequest', v2CrawlerScheduleRequest);
|
|
3187
|
-
const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules`
|
|
3236
|
+
const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}`
|
|
3188
3237
|
.replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
|
|
3189
3238
|
.replace(`{${"project"}}`, encodeURIComponent(String(project)))
|
|
3190
|
-
.replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)))
|
|
3239
|
+
.replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)))
|
|
3240
|
+
.replace(`{${"crawler_schedule"}}`, encodeURIComponent(String(crawlerSchedule)));
|
|
3191
3241
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3192
3242
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3193
3243
|
let baseOptions;
|
|
@@ -3348,14 +3398,15 @@ const CrawlerSchedulesApiFp = function (configuration) {
|
|
|
3348
3398
|
* @param {string} organization Organization identifier
|
|
3349
3399
|
* @param {string} project Project identifier
|
|
3350
3400
|
* @param {string} crawler Crawler identifier
|
|
3401
|
+
* @param {string} crawlerSchedule Crawler schedule identifier
|
|
3351
3402
|
* @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
|
|
3352
3403
|
* @param {*} [options] Override http request option.
|
|
3353
3404
|
* @throws {RequiredError}
|
|
3354
3405
|
*/
|
|
3355
|
-
crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
|
|
3406
|
+
crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
|
|
3356
3407
|
var _a, _b, _c;
|
|
3357
3408
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3358
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options);
|
|
3409
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options);
|
|
3359
3410
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3360
3411
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CrawlerSchedulesApi.crawlerSchedulesEdit']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3361
3412
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3440,12 +3491,13 @@ const CrawlerSchedulesApiFactory = function (configuration, basePath, axios) {
|
|
|
3440
3491
|
* @param {string} organization Organization identifier
|
|
3441
3492
|
* @param {string} project Project identifier
|
|
3442
3493
|
* @param {string} crawler Crawler identifier
|
|
3494
|
+
* @param {string} crawlerSchedule Crawler schedule identifier
|
|
3443
3495
|
* @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
|
|
3444
3496
|
* @param {*} [options] Override http request option.
|
|
3445
3497
|
* @throws {RequiredError}
|
|
3446
3498
|
*/
|
|
3447
|
-
crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
|
|
3448
|
-
return localVarFp.crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options).then((request) => request(axios, basePath));
|
|
3499
|
+
crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
|
|
3500
|
+
return localVarFp.crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options).then((request) => request(axios, basePath));
|
|
3449
3501
|
},
|
|
3450
3502
|
/**
|
|
3451
3503
|
*
|
|
@@ -3516,13 +3568,14 @@ class CrawlerSchedulesApi extends base_1.BaseAPI {
|
|
|
3516
3568
|
* @param {string} organization Organization identifier
|
|
3517
3569
|
* @param {string} project Project identifier
|
|
3518
3570
|
* @param {string} crawler Crawler identifier
|
|
3571
|
+
* @param {string} crawlerSchedule Crawler schedule identifier
|
|
3519
3572
|
* @param {V2CrawlerScheduleRequest} v2CrawlerScheduleRequest
|
|
3520
3573
|
* @param {*} [options] Override http request option.
|
|
3521
3574
|
* @throws {RequiredError}
|
|
3522
3575
|
* @memberof CrawlerSchedulesApi
|
|
3523
3576
|
*/
|
|
3524
|
-
crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options) {
|
|
3525
|
-
return (0, exports.CrawlerSchedulesApiFp)(this.configuration).crawlerSchedulesEdit(organization, project, crawler, v2CrawlerScheduleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3577
|
+
crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options) {
|
|
3578
|
+
return (0, exports.CrawlerSchedulesApiFp)(this.configuration).crawlerSchedulesEdit(organization, project, crawler, crawlerSchedule, v2CrawlerScheduleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3526
3579
|
}
|
|
3527
3580
|
/**
|
|
3528
3581
|
*
|
|
@@ -3716,6 +3769,51 @@ const CrawlersApiAxiosParamCreator = function (configuration) {
|
|
|
3716
3769
|
options: localVarRequestOptions,
|
|
3717
3770
|
};
|
|
3718
3771
|
}),
|
|
3772
|
+
/**
|
|
3773
|
+
*
|
|
3774
|
+
* @summary Run a crawler
|
|
3775
|
+
* @param {string} organization Organization identifier
|
|
3776
|
+
* @param {string} project Project identifier
|
|
3777
|
+
* @param {string} crawler Crawler identifier
|
|
3778
|
+
* @param {CrawlersRunRequest} crawlersRunRequest
|
|
3779
|
+
* @param {*} [options] Override http request option.
|
|
3780
|
+
* @throws {RequiredError}
|
|
3781
|
+
*/
|
|
3782
|
+
crawlersRun: (organization, project, crawler, crawlersRunRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3783
|
+
// verify required parameter 'organization' is not null or undefined
|
|
3784
|
+
(0, common_1.assertParamExists)('crawlersRun', 'organization', organization);
|
|
3785
|
+
// verify required parameter 'project' is not null or undefined
|
|
3786
|
+
(0, common_1.assertParamExists)('crawlersRun', 'project', project);
|
|
3787
|
+
// verify required parameter 'crawler' is not null or undefined
|
|
3788
|
+
(0, common_1.assertParamExists)('crawlersRun', 'crawler', crawler);
|
|
3789
|
+
// verify required parameter 'crawlersRunRequest' is not null or undefined
|
|
3790
|
+
(0, common_1.assertParamExists)('crawlersRun', 'crawlersRunRequest', crawlersRunRequest);
|
|
3791
|
+
const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run`
|
|
3792
|
+
.replace(`{${"organization"}}`, encodeURIComponent(String(organization)))
|
|
3793
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)))
|
|
3794
|
+
.replace(`{${"crawler"}}`, encodeURIComponent(String(crawler)));
|
|
3795
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3796
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3797
|
+
let baseOptions;
|
|
3798
|
+
if (configuration) {
|
|
3799
|
+
baseOptions = configuration.baseOptions;
|
|
3800
|
+
}
|
|
3801
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
3802
|
+
const localVarHeaderParameter = {};
|
|
3803
|
+
const localVarQueryParameter = {};
|
|
3804
|
+
// authentication BearerAuth required
|
|
3805
|
+
// http bearer authentication required
|
|
3806
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
3807
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3808
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3809
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3810
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3811
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(crawlersRunRequest, localVarRequestOptions, configuration);
|
|
3812
|
+
return {
|
|
3813
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3814
|
+
options: localVarRequestOptions,
|
|
3815
|
+
};
|
|
3816
|
+
}),
|
|
3719
3817
|
/**
|
|
3720
3818
|
*
|
|
3721
3819
|
* @summary Update a crawler
|
|
@@ -3842,6 +3940,25 @@ const CrawlersApiFp = function (configuration) {
|
|
|
3842
3940
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3843
3941
|
});
|
|
3844
3942
|
},
|
|
3943
|
+
/**
|
|
3944
|
+
*
|
|
3945
|
+
* @summary Run a crawler
|
|
3946
|
+
* @param {string} organization Organization identifier
|
|
3947
|
+
* @param {string} project Project identifier
|
|
3948
|
+
* @param {string} crawler Crawler identifier
|
|
3949
|
+
* @param {CrawlersRunRequest} crawlersRunRequest
|
|
3950
|
+
* @param {*} [options] Override http request option.
|
|
3951
|
+
* @throws {RequiredError}
|
|
3952
|
+
*/
|
|
3953
|
+
crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
|
|
3954
|
+
var _a, _b, _c;
|
|
3955
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3956
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.crawlersRun(organization, project, crawler, crawlersRunRequest, options);
|
|
3957
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3958
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CrawlersApi.crawlersRun']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3959
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3960
|
+
});
|
|
3961
|
+
},
|
|
3845
3962
|
/**
|
|
3846
3963
|
*
|
|
3847
3964
|
* @summary Update a crawler
|
|
@@ -3918,6 +4035,19 @@ const CrawlersApiFactory = function (configuration, basePath, axios) {
|
|
|
3918
4035
|
crawlersRead(organization, project, crawler, options) {
|
|
3919
4036
|
return localVarFp.crawlersRead(organization, project, crawler, options).then((request) => request(axios, basePath));
|
|
3920
4037
|
},
|
|
4038
|
+
/**
|
|
4039
|
+
*
|
|
4040
|
+
* @summary Run a crawler
|
|
4041
|
+
* @param {string} organization Organization identifier
|
|
4042
|
+
* @param {string} project Project identifier
|
|
4043
|
+
* @param {string} crawler Crawler identifier
|
|
4044
|
+
* @param {CrawlersRunRequest} crawlersRunRequest
|
|
4045
|
+
* @param {*} [options] Override http request option.
|
|
4046
|
+
* @throws {RequiredError}
|
|
4047
|
+
*/
|
|
4048
|
+
crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
|
|
4049
|
+
return localVarFp.crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(axios, basePath));
|
|
4050
|
+
},
|
|
3921
4051
|
/**
|
|
3922
4052
|
*
|
|
3923
4053
|
* @summary Update a crawler
|
|
@@ -3992,6 +4122,20 @@ class CrawlersApi extends base_1.BaseAPI {
|
|
|
3992
4122
|
crawlersRead(organization, project, crawler, options) {
|
|
3993
4123
|
return (0, exports.CrawlersApiFp)(this.configuration).crawlersRead(organization, project, crawler, options).then((request) => request(this.axios, this.basePath));
|
|
3994
4124
|
}
|
|
4125
|
+
/**
|
|
4126
|
+
*
|
|
4127
|
+
* @summary Run a crawler
|
|
4128
|
+
* @param {string} organization Organization identifier
|
|
4129
|
+
* @param {string} project Project identifier
|
|
4130
|
+
* @param {string} crawler Crawler identifier
|
|
4131
|
+
* @param {CrawlersRunRequest} crawlersRunRequest
|
|
4132
|
+
* @param {*} [options] Override http request option.
|
|
4133
|
+
* @throws {RequiredError}
|
|
4134
|
+
* @memberof CrawlersApi
|
|
4135
|
+
*/
|
|
4136
|
+
crawlersRun(organization, project, crawler, crawlersRunRequest, options) {
|
|
4137
|
+
return (0, exports.CrawlersApiFp)(this.configuration).crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4138
|
+
}
|
|
3995
4139
|
/**
|
|
3996
4140
|
*
|
|
3997
4141
|
* @summary Update a crawler
|
|
@@ -6590,10 +6734,11 @@ const KVApiAxiosParamCreator = function (configuration) {
|
|
|
6590
6734
|
* @param {string} [cursor] Cursor for pagination
|
|
6591
6735
|
* @param {number} [limit] Number of items to return
|
|
6592
6736
|
* @param {string} [search] Search filter for keys
|
|
6737
|
+
* @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \'[ENCRYPTED]\' for security.
|
|
6593
6738
|
* @param {*} [options] Override http request option.
|
|
6594
6739
|
* @throws {RequiredError}
|
|
6595
6740
|
*/
|
|
6596
|
-
kVItemsList: (organization, project, storeId, cursor, limit, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
6741
|
+
kVItemsList: (organization, project, storeId, cursor, limit, search, includeValues, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
6597
6742
|
// verify required parameter 'organization' is not null or undefined
|
|
6598
6743
|
(0, common_1.assertParamExists)('kVItemsList', 'organization', organization);
|
|
6599
6744
|
// verify required parameter 'project' is not null or undefined
|
|
@@ -6625,6 +6770,9 @@ const KVApiAxiosParamCreator = function (configuration) {
|
|
|
6625
6770
|
if (search !== undefined) {
|
|
6626
6771
|
localVarQueryParameter['search'] = search;
|
|
6627
6772
|
}
|
|
6773
|
+
if (includeValues !== undefined) {
|
|
6774
|
+
localVarQueryParameter['include_values'] = includeValues;
|
|
6775
|
+
}
|
|
6628
6776
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6629
6777
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6630
6778
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -6634,7 +6782,7 @@ const KVApiAxiosParamCreator = function (configuration) {
|
|
|
6634
6782
|
};
|
|
6635
6783
|
}),
|
|
6636
6784
|
/**
|
|
6637
|
-
*
|
|
6785
|
+
* 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.
|
|
6638
6786
|
* @summary Get an item from a kv store
|
|
6639
6787
|
* @param {string} organization
|
|
6640
6788
|
* @param {string} project
|
|
@@ -6895,20 +7043,21 @@ const KVApiFp = function (configuration) {
|
|
|
6895
7043
|
* @param {string} [cursor] Cursor for pagination
|
|
6896
7044
|
* @param {number} [limit] Number of items to return
|
|
6897
7045
|
* @param {string} [search] Search filter for keys
|
|
7046
|
+
* @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \'[ENCRYPTED]\' for security.
|
|
6898
7047
|
* @param {*} [options] Override http request option.
|
|
6899
7048
|
* @throws {RequiredError}
|
|
6900
7049
|
*/
|
|
6901
|
-
kVItemsList(organization, project, storeId, cursor, limit, search, options) {
|
|
7050
|
+
kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
|
|
6902
7051
|
var _a, _b, _c;
|
|
6903
7052
|
return __awaiter(this, void 0, void 0, function* () {
|
|
6904
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.kVItemsList(organization, project, storeId, cursor, limit, search, options);
|
|
7053
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options);
|
|
6905
7054
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6906
7055
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['KVApi.kVItemsList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6907
7056
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6908
7057
|
});
|
|
6909
7058
|
},
|
|
6910
7059
|
/**
|
|
6911
|
-
*
|
|
7060
|
+
* 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.
|
|
6912
7061
|
* @summary Get an item from a kv store
|
|
6913
7062
|
* @param {string} organization
|
|
6914
7063
|
* @param {string} project
|
|
@@ -7050,14 +7199,15 @@ const KVApiFactory = function (configuration, basePath, axios) {
|
|
|
7050
7199
|
* @param {string} [cursor] Cursor for pagination
|
|
7051
7200
|
* @param {number} [limit] Number of items to return
|
|
7052
7201
|
* @param {string} [search] Search filter for keys
|
|
7202
|
+
* @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \'[ENCRYPTED]\' for security.
|
|
7053
7203
|
* @param {*} [options] Override http request option.
|
|
7054
7204
|
* @throws {RequiredError}
|
|
7055
7205
|
*/
|
|
7056
|
-
kVItemsList(organization, project, storeId, cursor, limit, search, options) {
|
|
7057
|
-
return localVarFp.kVItemsList(organization, project, storeId, cursor, limit, search, options).then((request) => request(axios, basePath));
|
|
7206
|
+
kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
|
|
7207
|
+
return localVarFp.kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options).then((request) => request(axios, basePath));
|
|
7058
7208
|
},
|
|
7059
7209
|
/**
|
|
7060
|
-
*
|
|
7210
|
+
* 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.
|
|
7061
7211
|
* @summary Get an item from a kv store
|
|
7062
7212
|
* @param {string} organization
|
|
7063
7213
|
* @param {string} project
|
|
@@ -7179,15 +7329,16 @@ class KVApi extends base_1.BaseAPI {
|
|
|
7179
7329
|
* @param {string} [cursor] Cursor for pagination
|
|
7180
7330
|
* @param {number} [limit] Number of items to return
|
|
7181
7331
|
* @param {string} [search] Search filter for keys
|
|
7332
|
+
* @param {boolean} [includeValues] Include values in the response. Secret values will be redacted as \'[ENCRYPTED]\' for security.
|
|
7182
7333
|
* @param {*} [options] Override http request option.
|
|
7183
7334
|
* @throws {RequiredError}
|
|
7184
7335
|
* @memberof KVApi
|
|
7185
7336
|
*/
|
|
7186
|
-
kVItemsList(organization, project, storeId, cursor, limit, search, options) {
|
|
7187
|
-
return (0, exports.KVApiFp)(this.configuration).kVItemsList(organization, project, storeId, cursor, limit, search, options).then((request) => request(this.axios, this.basePath));
|
|
7337
|
+
kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options) {
|
|
7338
|
+
return (0, exports.KVApiFp)(this.configuration).kVItemsList(organization, project, storeId, cursor, limit, search, includeValues, options).then((request) => request(this.axios, this.basePath));
|
|
7188
7339
|
}
|
|
7189
7340
|
/**
|
|
7190
|
-
*
|
|
7341
|
+
* 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.
|
|
7191
7342
|
* @summary Get an item from a kv store
|
|
7192
7343
|
* @param {string} organization
|
|
7193
7344
|
* @param {string} project
|
|
@@ -12588,16 +12739,19 @@ const VolumesApiAxiosParamCreator = function (configuration) {
|
|
|
12588
12739
|
* @param {string} organisation The organisation ID
|
|
12589
12740
|
* @param {string} application The application ID
|
|
12590
12741
|
* @param {string} environment The environment ID
|
|
12742
|
+
* @param {CreateVolumeRequest} createVolumeRequest
|
|
12591
12743
|
* @param {*} [options] Override http request option.
|
|
12592
12744
|
* @throws {RequiredError}
|
|
12593
12745
|
*/
|
|
12594
|
-
createVolume: (organisation, application, environment, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
12746
|
+
createVolume: (organisation, application, environment, createVolumeRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
12595
12747
|
// verify required parameter 'organisation' is not null or undefined
|
|
12596
12748
|
(0, common_1.assertParamExists)('createVolume', 'organisation', organisation);
|
|
12597
12749
|
// verify required parameter 'application' is not null or undefined
|
|
12598
12750
|
(0, common_1.assertParamExists)('createVolume', 'application', application);
|
|
12599
12751
|
// verify required parameter 'environment' is not null or undefined
|
|
12600
12752
|
(0, common_1.assertParamExists)('createVolume', 'environment', environment);
|
|
12753
|
+
// verify required parameter 'createVolumeRequest' is not null or undefined
|
|
12754
|
+
(0, common_1.assertParamExists)('createVolume', 'createVolumeRequest', createVolumeRequest);
|
|
12601
12755
|
const localVarPath = `/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes`
|
|
12602
12756
|
.replace(`{${"organisation"}}`, encodeURIComponent(String(organisation)))
|
|
12603
12757
|
.replace(`{${"application"}}`, encodeURIComponent(String(application)))
|
|
@@ -12614,9 +12768,11 @@ const VolumesApiAxiosParamCreator = function (configuration) {
|
|
|
12614
12768
|
// authentication BearerAuth required
|
|
12615
12769
|
// http bearer authentication required
|
|
12616
12770
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
12771
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12617
12772
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
12618
12773
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12619
12774
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
12775
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createVolumeRequest, localVarRequestOptions, configuration);
|
|
12620
12776
|
return {
|
|
12621
12777
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
12622
12778
|
options: localVarRequestOptions,
|
|
@@ -12766,13 +12922,14 @@ const VolumesApiFp = function (configuration) {
|
|
|
12766
12922
|
* @param {string} organisation The organisation ID
|
|
12767
12923
|
* @param {string} application The application ID
|
|
12768
12924
|
* @param {string} environment The environment ID
|
|
12925
|
+
* @param {CreateVolumeRequest} createVolumeRequest
|
|
12769
12926
|
* @param {*} [options] Override http request option.
|
|
12770
12927
|
* @throws {RequiredError}
|
|
12771
12928
|
*/
|
|
12772
|
-
createVolume(organisation, application, environment, options) {
|
|
12929
|
+
createVolume(organisation, application, environment, createVolumeRequest, options) {
|
|
12773
12930
|
var _a, _b, _c;
|
|
12774
12931
|
return __awaiter(this, void 0, void 0, function* () {
|
|
12775
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.createVolume(organisation, application, environment, options);
|
|
12932
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createVolume(organisation, application, environment, createVolumeRequest, options);
|
|
12776
12933
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
12777
12934
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['VolumesApi.createVolume']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
12778
12935
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -12850,11 +13007,12 @@ const VolumesApiFactory = function (configuration, basePath, axios) {
|
|
|
12850
13007
|
* @param {string} organisation The organisation ID
|
|
12851
13008
|
* @param {string} application The application ID
|
|
12852
13009
|
* @param {string} environment The environment ID
|
|
13010
|
+
* @param {CreateVolumeRequest} createVolumeRequest
|
|
12853
13011
|
* @param {*} [options] Override http request option.
|
|
12854
13012
|
* @throws {RequiredError}
|
|
12855
13013
|
*/
|
|
12856
|
-
createVolume(organisation, application, environment, options) {
|
|
12857
|
-
return localVarFp.createVolume(organisation, application, environment, options).then((request) => request(axios, basePath));
|
|
13014
|
+
createVolume(organisation, application, environment, createVolumeRequest, options) {
|
|
13015
|
+
return localVarFp.createVolume(organisation, application, environment, createVolumeRequest, options).then((request) => request(axios, basePath));
|
|
12858
13016
|
},
|
|
12859
13017
|
/**
|
|
12860
13018
|
*
|
|
@@ -12910,12 +13068,13 @@ class VolumesApi extends base_1.BaseAPI {
|
|
|
12910
13068
|
* @param {string} organisation The organisation ID
|
|
12911
13069
|
* @param {string} application The application ID
|
|
12912
13070
|
* @param {string} environment The environment ID
|
|
13071
|
+
* @param {CreateVolumeRequest} createVolumeRequest
|
|
12913
13072
|
* @param {*} [options] Override http request option.
|
|
12914
13073
|
* @throws {RequiredError}
|
|
12915
13074
|
* @memberof VolumesApi
|
|
12916
13075
|
*/
|
|
12917
|
-
createVolume(organisation, application, environment, options) {
|
|
12918
|
-
return (0, exports.VolumesApiFp)(this.configuration).createVolume(organisation, application, environment, options).then((request) => request(this.axios, this.basePath));
|
|
13076
|
+
createVolume(organisation, application, environment, createVolumeRequest, options) {
|
|
13077
|
+
return (0, exports.VolumesApiFp)(this.configuration).createVolume(organisation, application, environment, createVolumeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12919
13078
|
}
|
|
12920
13079
|
/**
|
|
12921
13080
|
*
|