@revoengine/sdk 1.5.8 → 1.6.3
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/README.md +110 -8
- package/dist/{errors-Bo-6u7Hg.d.cts → errors-BF0cw_Ut.d.cts} +364 -76
- package/dist/{errors-Bo-6u7Hg.d.ts → errors-BF0cw_Ut.d.ts} +364 -76
- package/dist/hosted.cjs +2383 -594
- package/dist/hosted.cjs.map +1 -1
- package/dist/hosted.d.cts +3 -2
- package/dist/hosted.d.ts +3 -2
- package/dist/hosted.js +2383 -594
- package/dist/hosted.js.map +1 -1
- package/dist/index.cjs +2385 -594
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2198 -659
- package/dist/index.d.ts +2198 -659
- package/dist/index.js +2385 -594
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import * as node_worker_threads from 'node:worker_threads';
|
|
2
|
+
import { Buffer as Buffer$1 } from 'node:buffer';
|
|
2
3
|
|
|
3
|
-
declare const SDK_VERSION: "1.
|
|
4
|
+
declare const SDK_VERSION: "1.6.3";
|
|
4
5
|
declare const PROTOCOL_VERSION: 1;
|
|
5
|
-
declare const CONTRACT_REVISION: "
|
|
6
|
-
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
|
|
6
|
+
declare const CONTRACT_REVISION: "8083c90249a517982be7395a44c016ab08dcd047eb9b12231211e496c842120d";
|
|
7
|
+
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'agents' | 'lowCode';
|
|
7
8
|
|
|
8
9
|
// AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
|
|
9
10
|
// Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
|
|
@@ -43,9 +44,9 @@ interface SwaggerAgentCheapTurnPolicyDto {
|
|
|
43
44
|
}
|
|
44
45
|
interface SwaggerAgentConfigDto {
|
|
45
46
|
/** Supported assistant model used when the agent starts a thread. */
|
|
46
|
-
"model"?: "gpt-
|
|
47
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
47
48
|
/** Reasoning effort passed to assistant threads. */
|
|
48
|
-
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
49
|
+
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
49
50
|
/** Durable execution-mode default used for agent-loop turns. Per-turn fast-path routing and prompt-tier selection are derived by runtime, not configured here. */
|
|
50
51
|
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
51
52
|
/** Durable planning policy default used for agent-loop turns. standard executes normally; review_required creates a reviewed plan before interactive execution. */
|
|
@@ -114,7 +115,7 @@ interface SwaggerAgentPluginApprovalConfigDto {
|
|
|
114
115
|
interface SwaggerAgentPluginComponentToolConfigDto {
|
|
115
116
|
/** Whether this component-backed tool is enabled for runtime selection and execution. */
|
|
116
117
|
"enabled"?: boolean;
|
|
117
|
-
/** Whether this component
|
|
118
|
+
/** Whether this exact expanded component action is deferred behind plugin discovery/loading instead of eagerly exposed. */
|
|
118
119
|
"deferLoading"?: boolean;
|
|
119
120
|
/** Explicit local tool alias exposed to the runtime when set. */
|
|
120
121
|
"alias"?: string;
|
|
@@ -128,7 +129,7 @@ interface SwaggerAgentPluginComponentToolConfigDto {
|
|
|
128
129
|
"inputs"?: Record<string, unknown>;
|
|
129
130
|
/** Named component result to return when the component executor supports result popping. */
|
|
130
131
|
"popResult"?: string;
|
|
131
|
-
/** Strict
|
|
132
|
+
/** Strict model-facing input schema for this exact action. The component receives matching arguments under api.input().agentTool.args and must explicitly translate them when a downstream provider uses a different wire shape. Must be an object schema with additionalProperties=false and descriptions on every declared property. */
|
|
132
133
|
"inputSchema"?: Record<string, unknown>;
|
|
133
134
|
/** Structured output schema expected from this tool. */
|
|
134
135
|
"outputSchema"?: Record<string, unknown>;
|
|
@@ -150,7 +151,7 @@ interface SwaggerAgentPluginComponentToolConfigDto {
|
|
|
150
151
|
interface SwaggerAgentPluginComponentToolsetDto {
|
|
151
152
|
/** Default governance and loading policy for component-backed tools. */
|
|
152
153
|
"defaultConfig"?: SwaggerAgentPluginComponentToolConfigDto;
|
|
153
|
-
/** Component-backed
|
|
154
|
+
/** Component-backed actions keyed by stable capability name. Every entry expands into a separate executable tool; alias is its exact local model-visible action name when set. */
|
|
154
155
|
"tools"?: Record<string, unknown>;
|
|
155
156
|
}
|
|
156
157
|
interface SwaggerAgentPluginConfigDto {
|
|
@@ -170,6 +171,8 @@ interface SwaggerAgentPluginConfigDto {
|
|
|
170
171
|
"executionMode"?: "sync" | "background";
|
|
171
172
|
/** Component id executed when this plugin runs. */
|
|
172
173
|
"componentId"?: string;
|
|
174
|
+
/** Portable component revision digest. */
|
|
175
|
+
"componentDigest"?: string;
|
|
173
176
|
/** Optional fixed component version. */
|
|
174
177
|
"componentVersion"?: number;
|
|
175
178
|
/** Multiple governed tool contracts backed by the same component implementation. */
|
|
@@ -210,8 +213,10 @@ interface SwaggerAgentPluginConfigDto {
|
|
|
210
213
|
interface SwaggerAgentPluginMcpConfigDto {
|
|
211
214
|
/** Remote MCP transport supported by the SaaS runtime. */
|
|
212
215
|
"transport": "streamable_http" | "sse";
|
|
213
|
-
/** Absolute HTTPS endpoint
|
|
216
|
+
/** Absolute public HTTPS MCP endpoint URL. Private and localhost destinations are blocked at connection time. */
|
|
214
217
|
"url": string;
|
|
218
|
+
/** Public HTTPS network policy. Legacy private values are restricted to public HTTPS at execution time. */
|
|
219
|
+
"networkAccess"?: "public";
|
|
215
220
|
/** Manifest cache time-to-live in milliseconds. */
|
|
216
221
|
"manifestTtlMs"?: number;
|
|
217
222
|
/** Connection and handshake timeout in milliseconds. */
|
|
@@ -236,6 +241,8 @@ interface SwaggerAgentPluginMcpConfigDto {
|
|
|
236
241
|
interface SwaggerAgentPluginMcpHeaderBindingDto {
|
|
237
242
|
/** Header name sent to the remote MCP server. */
|
|
238
243
|
"name": string;
|
|
244
|
+
/** Vault BoundValue resolved for the executing user, organization, or instance after an explicit grant. */
|
|
245
|
+
"vault"?: SwaggerAgentPluginMcpVaultRefDto;
|
|
239
246
|
/** Secret id containing the header value. */
|
|
240
247
|
"secretId"?: string;
|
|
241
248
|
/** Optional secret data revision id when the binding should pin a specific secret revision. */
|
|
@@ -248,7 +255,7 @@ interface SwaggerAgentPluginMcpHeaderBindingDto {
|
|
|
248
255
|
interface SwaggerAgentPluginMcpToolConfigDto {
|
|
249
256
|
/** Whether the tool is enabled for runtime selection and execution. */
|
|
250
257
|
"enabled"?: boolean;
|
|
251
|
-
/** Whether the tool is deferred behind discovery instead of eagerly exposed. */
|
|
258
|
+
/** Whether the remote tool schema is deferred behind plugin discovery/loading instead of eagerly exposed. The manifest tool remains known by remote name; alias changes only its local exposed name. */
|
|
252
259
|
"deferLoading"?: boolean;
|
|
253
260
|
/** Explicit local tool alias exposed to the runtime when set. */
|
|
254
261
|
"alias"?: string;
|
|
@@ -268,9 +275,23 @@ interface SwaggerAgentPluginMcpToolConfigDto {
|
|
|
268
275
|
interface SwaggerAgentPluginMcpToolsetDto {
|
|
269
276
|
/** Default governance and loading policy for tools discovered from this MCP server. */
|
|
270
277
|
"defaultConfig"?: SwaggerAgentPluginMcpToolConfigDto;
|
|
271
|
-
/** Per-remote-tool overrides keyed by remote tool name. */
|
|
278
|
+
/** Per-remote-tool overrides keyed by exact remote manifest tool name, never by local alias or plugin registry id. */
|
|
272
279
|
"configs"?: Record<string, unknown>;
|
|
273
280
|
}
|
|
281
|
+
interface SwaggerAgentPluginMcpVaultRefDto {
|
|
282
|
+
/** Opaque Vault reference marker. */
|
|
283
|
+
"__revoBoundValue": "vault-v1";
|
|
284
|
+
/** Credential requirement name declared by the plugin. */
|
|
285
|
+
"name": string;
|
|
286
|
+
/** Credential owner scope. */
|
|
287
|
+
"scope": "instance" | "user" | "organization";
|
|
288
|
+
/** Vault value source. */
|
|
289
|
+
"source": "secret" | "integration";
|
|
290
|
+
/** Literal text prepended to the resolved value. */
|
|
291
|
+
"prefix": string;
|
|
292
|
+
/** Literal text appended to the resolved value. */
|
|
293
|
+
"suffix": string;
|
|
294
|
+
}
|
|
274
295
|
interface SwaggerAgentPluginPackageConfigDto {
|
|
275
296
|
/** Stable package identity used across internal catalogs and future community marketplace publishing. */
|
|
276
297
|
"externalId": string;
|
|
@@ -278,12 +299,12 @@ interface SwaggerAgentPluginPackageConfigDto {
|
|
|
278
299
|
"format"?: "markdown";
|
|
279
300
|
/** Markdown instruction content loaded into the assistant runtime when the package is attached. */
|
|
280
301
|
"content": string;
|
|
281
|
-
/**
|
|
302
|
+
/** Exact direct registry plugin UUIDs exposed lazily when this package is loaded. Dependencies may be skill, tools, or MCP plugins, never packages. */
|
|
282
303
|
"pluginIds"?: Array<string>;
|
|
283
304
|
/** Disabled marketplace-facing package metadata reserved for catalog publishing. */
|
|
284
305
|
"metadata"?: SwaggerAgentPluginPackageMetadataDto;
|
|
285
|
-
/** Maximum number of package content
|
|
286
|
-
"
|
|
306
|
+
/** Maximum number of package content tokens allowed into one prompt. Defaults to 10000. */
|
|
307
|
+
"maxPromptTokens"?: number;
|
|
287
308
|
}
|
|
288
309
|
interface SwaggerAgentPluginPackageMetadataDto {
|
|
289
310
|
/** Package avatar or icon URL shown in package catalogs. */
|
|
@@ -320,10 +341,10 @@ interface SwaggerAgentPluginSkillConfigDto {
|
|
|
320
341
|
"format"?: "markdown";
|
|
321
342
|
/** Markdown instruction content loaded into the assistant runtime when the plugin is attached. */
|
|
322
343
|
"content": string;
|
|
323
|
-
/**
|
|
344
|
+
/** Exact registry plugin UUIDs exposed lazily when this skill is loaded. Dependencies may be skill, tools, or MCP plugins, never packages. */
|
|
324
345
|
"pluginIds"?: Array<string>;
|
|
325
|
-
/** Maximum number of skill content
|
|
326
|
-
"
|
|
346
|
+
/** Maximum number of skill content tokens allowed into one prompt. Defaults to 10000. */
|
|
347
|
+
"maxPromptTokens"?: number;
|
|
327
348
|
}
|
|
328
349
|
interface SwaggerAgentPolicyDto {
|
|
329
350
|
/** Default approval mode applied to agent tool calls when no per-tool override exists. */
|
|
@@ -523,8 +544,8 @@ interface SwaggerStorageSheetColumnDto {
|
|
|
523
544
|
"key": string;
|
|
524
545
|
/** Visible header. Defaults to key. */
|
|
525
546
|
"header"?: string;
|
|
526
|
-
/** Logical value type retained in XLSX fileStats and used by typed row producers and getFileData reads. Without a declared type, imported
|
|
527
|
-
"type"?: "string" | "number" | "boolean" | "date";
|
|
547
|
+
/** Logical value type retained in XLSX/CSV/TSV fileStats and used by typed row producers and getFileData reads. Object parses a JSON object or array from text. Without a declared type, imported tabular values remain strings; XLSX styles never infer a type. */
|
|
548
|
+
"type"?: "string" | "number" | "boolean" | "date" | "object";
|
|
528
549
|
/** Column width in Excel character units. */
|
|
529
550
|
"width"?: number;
|
|
530
551
|
/** Hide the worksheet column. */
|
|
@@ -558,9 +579,19 @@ interface SwaggerStorageSheetTableDto {
|
|
|
558
579
|
"header"?: boolean;
|
|
559
580
|
/** Add an auto-filter to the table header. */
|
|
560
581
|
"autoFilter"?: boolean;
|
|
561
|
-
/** Stable column order. Required for every
|
|
582
|
+
/** Stable XLSX/CSV/TSV column order, keys, headers, and logical types. Required for every logical sheet in writeMode "direct"; optional in "staged" mode, where keys may be inferred from appended rows. */
|
|
562
583
|
"columns"?: Array<SwaggerStorageSheetColumnDto>;
|
|
563
584
|
}
|
|
585
|
+
interface SwaggerStorageTabularSchemaPolicyDto {
|
|
586
|
+
/** How missing sheets or columns and invalid declared values are handled. fallback retains imperfect data with diagnostics; strict fails structured indexing. Defaults to fallback. */
|
|
587
|
+
"profile"?: "fallback" | "strict";
|
|
588
|
+
/** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. The raw file is preserved. */
|
|
589
|
+
"additionalProperties"?: "allow" | "strip" | "reject";
|
|
590
|
+
}
|
|
591
|
+
interface SwaggerWebhookMapPatchDto {
|
|
592
|
+
"set"?: Record<string, string>;
|
|
593
|
+
"remove"?: Array<string>;
|
|
594
|
+
}
|
|
564
595
|
interface SwaggerWebhookRequestDetailsDto {
|
|
565
596
|
"url": string;
|
|
566
597
|
"method": "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
@@ -569,6 +600,16 @@ interface SwaggerWebhookRequestDetailsDto {
|
|
|
569
600
|
/** Headers. */
|
|
570
601
|
"headers"?: Record<string, unknown>;
|
|
571
602
|
}
|
|
603
|
+
interface SwaggerWebhookRequestPatchDto {
|
|
604
|
+
"url"?: string;
|
|
605
|
+
"method"?: "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
606
|
+
"headers"?: SwaggerWebhookMapPatchDto;
|
|
607
|
+
"query"?: SwaggerWebhookMapPatchDto;
|
|
608
|
+
/** Additional request paths to mask in the new attempt. Existing masks are always preserved. */
|
|
609
|
+
"maskDetails"?: Array<string>;
|
|
610
|
+
/** Explicit replacement of the whole body. Omitted body reuses the saved body. */
|
|
611
|
+
"body"?: Record<string, unknown> | Array<unknown>;
|
|
612
|
+
}
|
|
572
613
|
interface AgentRunCancelInput {
|
|
573
614
|
/** Optional cancellation reason for audit traces. */
|
|
574
615
|
"reason"?: string;
|
|
@@ -668,14 +709,14 @@ interface AssistantMessageInput {
|
|
|
668
709
|
"content": string;
|
|
669
710
|
/** Optional hidden draft user message id created before attachment uploads. When provided, the send operation finalizes that draft instead of creating a new user message. */
|
|
670
711
|
"preflightMessageId"?: string;
|
|
671
|
-
/** Optional assistant execution-model override. GPT-
|
|
672
|
-
"model"?: "gpt-
|
|
673
|
-
/** Optional GPT-
|
|
712
|
+
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6.1 Sol and GPT-6 Luna are supported. */
|
|
713
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
714
|
+
/** Optional GPT-6 Luna Fast mode. Defaults to false and remains opt-in per thread. */
|
|
674
715
|
"fastMode"?: boolean;
|
|
675
|
-
/** Optional assistant reasoning effort override: low, medium, high, or xhigh. Defaults to
|
|
676
|
-
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
716
|
+
/** Optional assistant reasoning effort override: none, low, medium, high, or xhigh. Defaults to medium. */
|
|
717
|
+
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
677
718
|
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
678
|
-
"reasoning"?: "low" | "medium" | "high" | "xhigh";
|
|
719
|
+
"reasoning"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
679
720
|
/** Optional flag selecting deadline-bounded background provider recovery. On SSE routes it also allows the turn to continue after client disconnect. Defaults to false. */
|
|
680
721
|
"backgroundProcessing"?: boolean;
|
|
681
722
|
/** Optional flag for send-message endpoints. When true, an active streamed assistant turn for the thread is interrupted before appending this message. */
|
|
@@ -704,7 +745,7 @@ interface StorageFolderInput {
|
|
|
704
745
|
"name": string;
|
|
705
746
|
/** Parent folder id. Omit for root. */
|
|
706
747
|
"parentStorageEntryId"?: string;
|
|
707
|
-
/** Optional
|
|
748
|
+
/** Optional registered Storage destination for root-level folders. Omit to use the default destination. Ignored when parentStorageEntryId is provided. */
|
|
708
749
|
"storageProviderConfigId"?: string;
|
|
709
750
|
/** Folder metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
710
751
|
"metadata"?: Record<string, unknown> | null;
|
|
@@ -726,7 +767,7 @@ interface StorageUploadSessionInput {
|
|
|
726
767
|
"retention"?: SwaggerStorageRetentionDto | null;
|
|
727
768
|
/** Parent folder id. Required for create mode when uploading into a folder. */
|
|
728
769
|
"parentStorageEntryId"?: string;
|
|
729
|
-
/** Optional
|
|
770
|
+
/** Optional registered Storage destination for a root-level upload. Omit to use the default destination. Ignored when parentStorageEntryId is provided or when replacing an existing file. */
|
|
730
771
|
"storageProviderConfigId"?: string;
|
|
731
772
|
/** Existing storage entry id to replace instead of creating a new file. */
|
|
732
773
|
"replaceStorageEntryId"?: string;
|
|
@@ -744,18 +785,22 @@ interface StorageUploadSessionInput {
|
|
|
744
785
|
COLD: Compliance snapshots, historic imports, and retained evidence that is rarely opened.
|
|
745
786
|
FROZEN: Deep archive or legal-hold data kept mainly for audit or recovery obligations. */
|
|
746
787
|
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
747
|
-
/**
|
|
788
|
+
/** Byte-transfer mode. Use "direct" when the client sends the complete file to the returned temporary upload target, "chunked" for explicit numbered parts, and "incremental" for server-assigned part numbering by default. Incremental sessions can still re-upload a specific part number when repairing an upload. */
|
|
748
789
|
"uploadMode"?: "direct" | "chunked" | "incremental";
|
|
749
790
|
/** Post-finalize compute mode for this upload session. Defaults to sync for XLSX and text/* sessions and none for other binary sessions; an explicit value always overrides the default. */
|
|
750
791
|
"computeStats"?: "none" | "sync" | "async";
|
|
792
|
+
/** Independent validation and undeclared-column policies for an uploaded XLSX, CSV, or TSV. Defaults to fallback validation with additional columns allowed; strict validation defaults to rejecting additional columns. The raw file is preserved. */
|
|
793
|
+
"schemaPolicy"?: SwaggerStorageTabularSchemaPolicyDto;
|
|
751
794
|
/** Structured file write mode. Use "direct" for a predeclared CSV/XLSX layout with row-only XLSX parts. Use the default "staged" mode for independent requests that may be retried, replaced, reordered, or use inferred columns, sparse cells, formulas, or dynamic worksheets. For direct XLSX, declare every worksheet and its table.columns before the first append. */
|
|
752
795
|
"writeMode"?: "staged" | "direct";
|
|
753
|
-
/** CSV dialect used when row payloads are appended
|
|
796
|
+
/** CSV/TSV dialect used when row payloads are appended or direct uploaded bytes are indexed. */
|
|
754
797
|
"csv"?: SwaggerStorageCsvOptionsDto;
|
|
755
|
-
/**
|
|
798
|
+
/** Shared tabular layout. XLSX accepts multiple worksheets; CSV/TSV accepts one logical sheet used for column keys, types, and schema diagnostics. In writeMode "direct", configure table.columns for every declared sheet. */
|
|
756
799
|
"sheets"?: Array<SwaggerStorageSheetOptionsDto>;
|
|
757
800
|
/** File metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
758
801
|
"metadata"?: Record<string, unknown> | null;
|
|
802
|
+
/** Suppress Storage lifecycle events for the finalized file. Omit to preserve the existing setting on replacement; false explicitly enables events. */
|
|
803
|
+
"ignoreEvent"?: boolean;
|
|
759
804
|
/** Optional external reference id. */
|
|
760
805
|
"refId"?: string;
|
|
761
806
|
/** Optional external reference type. */
|
|
@@ -785,6 +830,13 @@ interface AssistantForkMessageInput {
|
|
|
785
830
|
/** Optional explicit title for the forked thread. When omitted, orchestration will generate the new thread title. */
|
|
786
831
|
"title"?: string;
|
|
787
832
|
}
|
|
833
|
+
interface JobsBulkInput {
|
|
834
|
+
/** Existing platform filter tree. Exactly one of filter and resource IDs is required. */
|
|
835
|
+
"filter"?: Record<string, unknown>;
|
|
836
|
+
/** Caller-generated key: repeated admission returns the same operation. Maximum 200 characters. */
|
|
837
|
+
"idempotencyKey"?: string;
|
|
838
|
+
"jobIds"?: Array<string>;
|
|
839
|
+
}
|
|
788
840
|
interface StorageEntryMoveInput {
|
|
789
841
|
/** Destination parent folder id. Omit or pass null for root. */
|
|
790
842
|
"parentStorageEntryId"?: string;
|
|
@@ -798,7 +850,7 @@ interface StoragePutObjectInput {
|
|
|
798
850
|
"retention"?: SwaggerStorageRetentionDto | null;
|
|
799
851
|
/** Parent folder id. Omit for root. */
|
|
800
852
|
"parentStorageEntryId"?: string;
|
|
801
|
-
/** Optional
|
|
853
|
+
/** Optional registered Storage destination for root-level writes. Omit to use the default destination. */
|
|
802
854
|
"storageProviderConfigId"?: string;
|
|
803
855
|
/** Existing file entry id to replace. */
|
|
804
856
|
"replaceStorageEntryId"?: string;
|
|
@@ -826,6 +878,8 @@ interface StoragePutObjectInput {
|
|
|
826
878
|
"refVer"?: number;
|
|
827
879
|
/** Entry metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
828
880
|
"metadata"?: Record<string, unknown> | null;
|
|
881
|
+
/** Suppress Storage lifecycle events for this file. Omit to preserve the existing setting on replacement; false explicitly enables events. */
|
|
882
|
+
"ignoreEvent"?: boolean;
|
|
829
883
|
/** Logical storage lifecycle tier. Select only when creating a new file or upload session; existing files keep their tier.
|
|
830
884
|
HOT: Active files used in live workflows, previews, and frequent downloads.
|
|
831
885
|
WARM: Completed or less-active business files that are still occasionally accessed.
|
|
@@ -849,13 +903,13 @@ interface AssistantActionResolutionInput {
|
|
|
849
903
|
/** Optional flag selecting deadline-bounded background provider recovery. On the SSE route it also allows the resumed turn to continue after client disconnect. Streamed action resolution defaults this to true. */
|
|
850
904
|
"backgroundProcessing"?: boolean;
|
|
851
905
|
/** Optional assistant model override for the resumed turn after this action is resolved. */
|
|
852
|
-
"model"?: "gpt-
|
|
853
|
-
/** Optional
|
|
906
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
907
|
+
/** Optional Fast-mode override for the resumed turn. Available only on GPT-6 Luna. */
|
|
854
908
|
"fastMode"?: boolean;
|
|
855
|
-
/** Optional assistant reasoning effort override for the resumed turn: low, medium, high, or xhigh. */
|
|
856
|
-
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
909
|
+
/** Optional assistant reasoning effort override for the resumed turn: none, low, medium, high, or xhigh. */
|
|
910
|
+
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
857
911
|
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
858
|
-
"reasoning"?: "low" | "medium" | "high" | "xhigh";
|
|
912
|
+
"reasoning"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
859
913
|
/** Execution mode override for the resumed turn after this action is resolved. */
|
|
860
914
|
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
861
915
|
/** Planning policy override for the resumed turn after this action is resolved. */
|
|
@@ -990,6 +1044,8 @@ interface WebhookInput {
|
|
|
990
1044
|
"proxy"?: boolean;
|
|
991
1045
|
/** Save entire request. */
|
|
992
1046
|
"saveDetails"?: boolean;
|
|
1047
|
+
/** Stop delivery on a supported attempt status. Processing of delivery logs is asynchronous. */
|
|
1048
|
+
"stopOnStatuses"?: Array<"UNAUTHENTICATED">;
|
|
993
1049
|
/** Max attempts. */
|
|
994
1050
|
"maxAttempts"?: number;
|
|
995
1051
|
/** Provide data */
|
|
@@ -1001,6 +1057,25 @@ interface WebhookInput {
|
|
|
1001
1057
|
/** Optional key/value metadata for grouping and querying webhooks. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
1002
1058
|
"metadata"?: Record<string, unknown> | null;
|
|
1003
1059
|
}
|
|
1060
|
+
interface WebhooksBulkInput {
|
|
1061
|
+
/** Existing platform filter tree. Exactly one of filter and resource IDs is required. */
|
|
1062
|
+
"filter"?: Record<string, unknown>;
|
|
1063
|
+
/** Caller-generated key: repeated admission returns the same operation. Maximum 200 characters. */
|
|
1064
|
+
"idempotencyKey"?: string;
|
|
1065
|
+
"webhookIds"?: Array<string>;
|
|
1066
|
+
/** Only allowed for retry. Missing masked values must be supplied explicitly. */
|
|
1067
|
+
"requestPatch"?: SwaggerWebhookRequestPatchDto;
|
|
1068
|
+
}
|
|
1069
|
+
interface AutomationOperation {
|
|
1070
|
+
operationId: string;
|
|
1071
|
+
resource: 'jobs' | 'webhooks';
|
|
1072
|
+
action: 'cancel' | 'retry' | 'delete';
|
|
1073
|
+
status: 'PENDING' | 'PROCESSING' | 'FINISHED' | 'ERROR';
|
|
1074
|
+
total: number;
|
|
1075
|
+
processed: number;
|
|
1076
|
+
skipped: number;
|
|
1077
|
+
failed: number;
|
|
1078
|
+
}
|
|
1004
1079
|
/**
|
|
1005
1080
|
* Canonical public low-code API declarations shared by Monaco and local editors.
|
|
1006
1081
|
* Lifecycle input DTOs are generated from Swagger in api.swagger-contracts.generated.d.ts.
|
|
@@ -1258,7 +1333,8 @@ interface SelectJoinOn {
|
|
|
1258
1333
|
}
|
|
1259
1334
|
/**
|
|
1260
1335
|
* Join definition.
|
|
1261
|
-
*
|
|
1336
|
+
* `table` is the logical name of a database, view, or materialized view.
|
|
1337
|
+
* If alias is omitted, the backend defaults it to that logical relation name.
|
|
1262
1338
|
*/
|
|
1263
1339
|
interface SelectJoin {
|
|
1264
1340
|
alias?: string;
|
|
@@ -1268,7 +1344,8 @@ interface SelectJoin {
|
|
|
1268
1344
|
}
|
|
1269
1345
|
/**
|
|
1270
1346
|
* Public structured input accepted by api.getDatabaseData(name, options).
|
|
1271
|
-
* The backend
|
|
1347
|
+
* The backend resolves databases, views, and materialized views by logical name
|
|
1348
|
+
* and injects their physical relation and schema metadata automatically.
|
|
1272
1349
|
*/
|
|
1273
1350
|
interface SelectInput {
|
|
1274
1351
|
/**
|
|
@@ -1277,8 +1354,8 @@ interface SelectInput {
|
|
|
1277
1354
|
*/
|
|
1278
1355
|
fields?: SelectItem[];
|
|
1279
1356
|
/**
|
|
1280
|
-
* Related
|
|
1281
|
-
* The backend resolves
|
|
1357
|
+
* Related databases, views, or materialized views to join.
|
|
1358
|
+
* The backend resolves each logical relation and its definition automatically.
|
|
1282
1359
|
*/
|
|
1283
1360
|
joins?: SelectJoin[];
|
|
1284
1361
|
/**
|
|
@@ -1530,7 +1607,8 @@ interface LogInterface {
|
|
|
1530
1607
|
}
|
|
1531
1608
|
interface TemplateFormData {
|
|
1532
1609
|
key: string;
|
|
1533
|
-
|
|
1610
|
+
/** Numbers and booleans are sent as text. Read credentials explicitly with vault.get/getAccessToken. */
|
|
1611
|
+
value?: string | number | boolean;
|
|
1534
1612
|
/** Storage entry to append as this multipart part. Use this instead of value for binary content. */
|
|
1535
1613
|
storageEntryId?: string;
|
|
1536
1614
|
/** Storage namespace for storageEntryId. Defaults to explorer. */
|
|
@@ -1583,17 +1661,22 @@ interface HttpRevoResponseScope {
|
|
|
1583
1661
|
}
|
|
1584
1662
|
interface HttpRequestInterface {
|
|
1585
1663
|
url: string;
|
|
1664
|
+
/** Replaces complete `{name}` path segments with URL-encoded bound values. */
|
|
1665
|
+
pathParams?: Record<string, string>;
|
|
1586
1666
|
method: 'POST' | 'PUT' | 'DELETE' | 'GET' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'PURGE' | 'LINK' | 'UNLINK';
|
|
1587
1667
|
timeout?: number;
|
|
1668
|
+
/** HTTP headers; use an explicitly awaited vault.get/getAccessToken result for credentials. */
|
|
1588
1669
|
headers?: LooseObject<string>;
|
|
1589
1670
|
params?: TemplateParameters[];
|
|
1671
|
+
/** Integration-owned payload. Credential values and provider echoes are caller-managed data. */
|
|
1590
1672
|
data?: any;
|
|
1591
1673
|
//@default: undefined
|
|
1592
1674
|
formData?: TemplateFormData[];
|
|
1593
1675
|
}
|
|
1594
1676
|
interface TemplateParameters {
|
|
1595
1677
|
key: string;
|
|
1596
|
-
|
|
1678
|
+
/** Numbers and booleans are sent as text. Legacy plain maps retain '[object Object]' conversion; serialize structured queries explicitly. */
|
|
1679
|
+
value: string | number | boolean | LooseObject<boolean | number | string>;
|
|
1597
1680
|
}
|
|
1598
1681
|
interface ProcessLog {
|
|
1599
1682
|
time: string;
|
|
@@ -1764,7 +1847,7 @@ interface StorageFileReadOptions {
|
|
|
1764
1847
|
buffer?: boolean;
|
|
1765
1848
|
start?: number;
|
|
1766
1849
|
end?: number;
|
|
1767
|
-
/** Continue a structured CSV/XLSX read.
|
|
1850
|
+
/** Continue a structured CSV/TSV, XLSX, NDJSON/JSONL, JSON-array, or XML read. Keep the opaque cursor unchanged. */
|
|
1768
1851
|
cursor?: string;
|
|
1769
1852
|
/** XLSX sheet name. The first visible sheet is used when omitted. */
|
|
1770
1853
|
sheet?: string;
|
|
@@ -1786,7 +1869,7 @@ interface StorageFileReadOptions {
|
|
|
1786
1869
|
columns?: Array<string | {
|
|
1787
1870
|
source: string;
|
|
1788
1871
|
key?: string;
|
|
1789
|
-
type?:
|
|
1872
|
+
type?: StorageTabularColumnType;
|
|
1790
1873
|
}>;
|
|
1791
1874
|
}
|
|
1792
1875
|
interface StorageFileStatsOptions {
|
|
@@ -1802,6 +1885,29 @@ interface StorageFileStatsOptions {
|
|
|
1802
1885
|
/** XML record path such as `Orders/Order`; required for XML row stats. */
|
|
1803
1886
|
recordPath?: string;
|
|
1804
1887
|
}
|
|
1888
|
+
type StorageTabularColumnType = 'string' | 'number' | 'boolean' | 'date' | 'object';
|
|
1889
|
+
interface StorageTabularColumn {
|
|
1890
|
+
key: string;
|
|
1891
|
+
header: string;
|
|
1892
|
+
type?: StorageTabularColumnType;
|
|
1893
|
+
}
|
|
1894
|
+
interface StorageTabularSchemaIssue {
|
|
1895
|
+
code: 'SHEET_MISSING' | 'SHEET_UNDECLARED' | 'COLUMN_MISSING' | 'COLUMN_UNDECLARED' | 'COLUMN_KEY_DUPLICATE' | 'COLUMN_TYPE_FALLBACK';
|
|
1896
|
+
sheet: string;
|
|
1897
|
+
column?: string;
|
|
1898
|
+
declaredType?: StorageTabularColumnType;
|
|
1899
|
+
invalidRows?: number;
|
|
1900
|
+
sampleRows?: number[];
|
|
1901
|
+
}
|
|
1902
|
+
interface StorageTabularSchemaPolicy {
|
|
1903
|
+
profile: 'fallback' | 'strict';
|
|
1904
|
+
additionalProperties: 'allow' | 'strip' | 'reject';
|
|
1905
|
+
}
|
|
1906
|
+
interface StorageTabularSchemaResult {
|
|
1907
|
+
policy: StorageTabularSchemaPolicy;
|
|
1908
|
+
status: 'MATCHED' | 'FALLBACK' | 'FAILED';
|
|
1909
|
+
issues: StorageTabularSchemaIssue[];
|
|
1910
|
+
}
|
|
1805
1911
|
interface StorageFileStats {
|
|
1806
1912
|
lineCount?: number;
|
|
1807
1913
|
map?: LooseObject<number>;
|
|
@@ -1810,42 +1916,29 @@ interface StorageFileStats {
|
|
|
1810
1916
|
batchSize?: number;
|
|
1811
1917
|
encoding?: string | null;
|
|
1812
1918
|
format?: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
|
|
1813
|
-
columns?:
|
|
1814
|
-
key: string;
|
|
1815
|
-
header: string;
|
|
1816
|
-
}>;
|
|
1919
|
+
columns?: StorageTabularColumn[];
|
|
1817
1920
|
bom?: boolean;
|
|
1818
1921
|
delimiter?: string;
|
|
1819
1922
|
recordDelimiter?: string;
|
|
1820
1923
|
quote?: string;
|
|
1821
1924
|
escape?: string;
|
|
1822
1925
|
rowCount?: number;
|
|
1823
|
-
headers?:
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
}>;
|
|
1926
|
+
headers?: StorageTabularColumn[];
|
|
1927
|
+
/** Present when an XLSX/CSV/TSV upload session declared table columns. */
|
|
1928
|
+
schema?: StorageTabularSchemaResult;
|
|
1827
1929
|
sheets?: Array<{
|
|
1828
1930
|
name: string;
|
|
1829
1931
|
state: 'visible' | 'hidden' | 'veryHidden';
|
|
1830
1932
|
rowCount: number;
|
|
1831
1933
|
batches: number;
|
|
1832
|
-
columns:
|
|
1833
|
-
key: string;
|
|
1834
|
-
header: string;
|
|
1835
|
-
}>;
|
|
1934
|
+
columns: StorageTabularColumn[];
|
|
1836
1935
|
}>;
|
|
1837
1936
|
}
|
|
1838
1937
|
interface StorageStructuredFileDataPage {
|
|
1839
1938
|
format: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
|
|
1840
1939
|
sheet: string | null;
|
|
1841
|
-
headers:
|
|
1842
|
-
|
|
1843
|
-
header: string;
|
|
1844
|
-
}>;
|
|
1845
|
-
columns: Array<{
|
|
1846
|
-
key: string;
|
|
1847
|
-
header: string;
|
|
1848
|
-
}>;
|
|
1940
|
+
headers: StorageTabularColumn[];
|
|
1941
|
+
columns: StorageTabularColumn[];
|
|
1849
1942
|
rows: Array<LooseObject<any>>;
|
|
1850
1943
|
rowCount: number;
|
|
1851
1944
|
totalRows: number;
|
|
@@ -2017,7 +2110,7 @@ type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
|
2017
2110
|
/** Suppress the export completion/failure System notification for this low-code call. */
|
|
2018
2111
|
skipNotification?: boolean;
|
|
2019
2112
|
/** Output format. CSV is the default. XLSX validates the effective row count before starting. */
|
|
2020
|
-
format?: 'csv' | 'xlsx';
|
|
2113
|
+
format?: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
2021
2114
|
/** Omit for private user storage, use ROOT, or provide an accessible explorer folder id. */
|
|
2022
2115
|
storageDestination?: 'ROOT' | string;
|
|
2023
2116
|
/** Dedicated output name. Omit for an automatic database-and-timestamp name using the selected extension. */
|
|
@@ -2036,14 +2129,30 @@ type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
|
2036
2129
|
/** Omit for the destination default, null for no expiration. */
|
|
2037
2130
|
retention?: StorageRetentionInput;
|
|
2038
2131
|
};
|
|
2132
|
+
type ImportDatabaseOptions = {
|
|
2133
|
+
storageEntryId: string;
|
|
2134
|
+
format: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
2135
|
+
mode: 'insert' | 'upsert';
|
|
2136
|
+
onError: 'abort' | 'skipRow';
|
|
2137
|
+
mapping?: {
|
|
2138
|
+
columns: Record<string, {
|
|
2139
|
+
databaseName: string;
|
|
2140
|
+
column: string;
|
|
2141
|
+
} | null>;
|
|
2142
|
+
nullMode?: 'escaped' | 'literal' | 'empty' | 'nullText';
|
|
2143
|
+
};
|
|
2144
|
+
/** Skips manual approval after the same full validation; ambiguous mapping still needs review. */
|
|
2145
|
+
autoCommit?: boolean;
|
|
2146
|
+
};
|
|
2039
2147
|
interface ExportDatabaseAcceptedResponse {
|
|
2040
2148
|
accepted: true;
|
|
2041
2149
|
databaseId: string;
|
|
2042
2150
|
exportId: string;
|
|
2151
|
+
jobId: string;
|
|
2043
2152
|
storageNamespace: string;
|
|
2044
2153
|
parentStorageEntryId: string | null;
|
|
2045
2154
|
fileName: string;
|
|
2046
|
-
format: 'csv' | 'xlsx';
|
|
2155
|
+
format: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
2047
2156
|
restricted: boolean;
|
|
2048
2157
|
message: string;
|
|
2049
2158
|
}
|
|
@@ -2052,10 +2161,11 @@ interface ExportDatabaseCompletedResponse {
|
|
|
2052
2161
|
completed: true;
|
|
2053
2162
|
databaseId: string;
|
|
2054
2163
|
exportId: string;
|
|
2164
|
+
jobId: string;
|
|
2055
2165
|
storageNamespace: string;
|
|
2056
2166
|
parentStorageEntryId: string | null;
|
|
2057
2167
|
fileName: string;
|
|
2058
|
-
format: 'csv' | 'xlsx';
|
|
2168
|
+
format: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
2059
2169
|
restricted: boolean;
|
|
2060
2170
|
storageEntryId: string;
|
|
2061
2171
|
storageEntry: StorageEntryView;
|
|
@@ -2266,7 +2376,7 @@ interface AgentPluginSkillConfig {
|
|
|
2266
2376
|
format?: 'markdown';
|
|
2267
2377
|
content: string;
|
|
2268
2378
|
pluginIds?: string[];
|
|
2269
|
-
|
|
2379
|
+
maxPromptTokens?: number;
|
|
2270
2380
|
}
|
|
2271
2381
|
interface AgentPluginPackageMetadata {
|
|
2272
2382
|
avatarUrl?: string | null;
|
|
@@ -2287,7 +2397,7 @@ interface AgentPluginPackageConfig {
|
|
|
2287
2397
|
content: string;
|
|
2288
2398
|
pluginIds?: string[];
|
|
2289
2399
|
metadata?: AgentPluginPackageMetadata;
|
|
2290
|
-
|
|
2400
|
+
maxPromptTokens?: number;
|
|
2291
2401
|
}
|
|
2292
2402
|
interface AgentPluginConfig {
|
|
2293
2403
|
contractVersion?: 1;
|
|
@@ -2688,6 +2798,145 @@ interface AssistantThreadCompactionRequest {
|
|
|
2688
2798
|
keepContext?: boolean;
|
|
2689
2799
|
content?: string;
|
|
2690
2800
|
}
|
|
2801
|
+
// ApiInterface
|
|
2802
|
+
/** Owner selection; omitted means instance. User scope uses the verified execution account. */
|
|
2803
|
+
interface SecretScopeOptions {
|
|
2804
|
+
scope?: 'instance' | 'user';
|
|
2805
|
+
}
|
|
2806
|
+
/** Null or omission selects NOW at write time. Numbers are Unix epoch milliseconds. */
|
|
2807
|
+
type SecretDate = string | Date | number | null;
|
|
2808
|
+
interface SecretRotateOptions extends SecretScopeOptions {
|
|
2809
|
+
validFrom?: SecretDate;
|
|
2810
|
+
}
|
|
2811
|
+
interface SecretGetOptions extends SecretRotateOptions {
|
|
2812
|
+
/** Exact validFrom timestamp. If both selectors are supplied they must agree. */
|
|
2813
|
+
version?: SecretDate;
|
|
2814
|
+
}
|
|
2815
|
+
interface SecretDeleteOptions extends SecretGetOptions {
|
|
2816
|
+
}
|
|
2817
|
+
interface SecretRevisionListOptions extends SecretScopeOptions {
|
|
2818
|
+
cursor?: string;
|
|
2819
|
+
limit?: number;
|
|
2820
|
+
}
|
|
2821
|
+
interface SecretProperties {
|
|
2822
|
+
category?: string | null;
|
|
2823
|
+
description?: string | null;
|
|
2824
|
+
/** Replacement JSON object, at most 16 KiB and 64 top-level keys. Backend keys are reserved. */
|
|
2825
|
+
metadata?: Record<string, unknown>;
|
|
2826
|
+
}
|
|
2827
|
+
interface SecretCreateInput extends SecretProperties {
|
|
2828
|
+
/** Nonempty text, at most 65,536 characters. */
|
|
2829
|
+
value: string;
|
|
2830
|
+
validFrom?: SecretDate;
|
|
2831
|
+
enabled?: boolean;
|
|
2832
|
+
}
|
|
2833
|
+
interface SecretRotateInput {
|
|
2834
|
+
value: string;
|
|
2835
|
+
}
|
|
2836
|
+
interface SecretUpdateInput extends SecretProperties {
|
|
2837
|
+
/** Parent metadata counter, distinct from a revision's timestamp version. */
|
|
2838
|
+
version: number;
|
|
2839
|
+
}
|
|
2840
|
+
/** Unified metadata-only parent. */
|
|
2841
|
+
interface Secret {
|
|
2842
|
+
name: string;
|
|
2843
|
+
scope: 'instance' | 'user';
|
|
2844
|
+
category: string | null;
|
|
2845
|
+
description: string | null;
|
|
2846
|
+
metadata: Record<string, unknown>;
|
|
2847
|
+
version: number;
|
|
2848
|
+
createdAt: string;
|
|
2849
|
+
updatedAt: string;
|
|
2850
|
+
}
|
|
2851
|
+
interface SecretRevision {
|
|
2852
|
+
name: string;
|
|
2853
|
+
scope: 'instance' | 'user';
|
|
2854
|
+
/** Stable version identity: the unique validFrom timestamp, normalized to ISO. */
|
|
2855
|
+
version: string;
|
|
2856
|
+
enabled: boolean;
|
|
2857
|
+
validFrom: string;
|
|
2858
|
+
createdAt: string;
|
|
2859
|
+
updatedAt: string;
|
|
2860
|
+
}
|
|
2861
|
+
interface SecretWithRevision extends Secret {
|
|
2862
|
+
revision: SecretRevision;
|
|
2863
|
+
}
|
|
2864
|
+
interface SecretValueRevision extends SecretRevision {
|
|
2865
|
+
value: Buffer;
|
|
2866
|
+
}
|
|
2867
|
+
interface SecretWithValue extends Secret {
|
|
2868
|
+
revision: SecretValueRevision;
|
|
2869
|
+
}
|
|
2870
|
+
interface SecretRevisionPage {
|
|
2871
|
+
items: SecretRevision[];
|
|
2872
|
+
nextCursor: string | null;
|
|
2873
|
+
}
|
|
2874
|
+
interface VaultIntegrationConfig {
|
|
2875
|
+
resourceUrl: string;
|
|
2876
|
+
scopes: string[];
|
|
2877
|
+
issuer?: string;
|
|
2878
|
+
clientId?: string;
|
|
2879
|
+
clientSecret?: string;
|
|
2880
|
+
tenantId?: string;
|
|
2881
|
+
metadataScopeAliases?: Record<string, string>;
|
|
2882
|
+
}
|
|
2883
|
+
interface VaultConnectIntegrationInput extends VaultIntegrationConfig {
|
|
2884
|
+
/** Null creates a definition; otherwise use its exact revision from getIntegrationMetadata. */
|
|
2885
|
+
expectedRevision: string | null;
|
|
2886
|
+
}
|
|
2887
|
+
interface VaultAccessToken {
|
|
2888
|
+
accessToken: string;
|
|
2889
|
+
expiresAt: string;
|
|
2890
|
+
tokenType: 'Bearer';
|
|
2891
|
+
}
|
|
2892
|
+
interface VaultIntegrationMetadata {
|
|
2893
|
+
name: string;
|
|
2894
|
+
scope: 'instance' | 'user';
|
|
2895
|
+
revision: string | null;
|
|
2896
|
+
resourceUrl: string;
|
|
2897
|
+
issuer: string;
|
|
2898
|
+
scopes: string[];
|
|
2899
|
+
tenantId: string | null;
|
|
2900
|
+
metadataScopeAliases: Record<string, string>;
|
|
2901
|
+
clientId: string | null;
|
|
2902
|
+
hasClientSecret: boolean;
|
|
2903
|
+
registrationMode: 'dynamic_public' | 'byo_public' | 'byo_confidential';
|
|
2904
|
+
authorizationEndpoint: string;
|
|
2905
|
+
registrationEndpoint: string | null;
|
|
2906
|
+
}
|
|
2907
|
+
interface VaultIntegrationDiscovery {
|
|
2908
|
+
issuers: string[];
|
|
2909
|
+
requiresIssuerSelection: boolean;
|
|
2910
|
+
supportedScopes: string[];
|
|
2911
|
+
issuer?: string;
|
|
2912
|
+
authorizationEndpoint?: string;
|
|
2913
|
+
registrationEndpoint?: string | null;
|
|
2914
|
+
registrationMode?: 'dynamic_public' | 'byo_public' | 'byo_confidential';
|
|
2915
|
+
requiresClientId?: boolean;
|
|
2916
|
+
redirectUri?: string;
|
|
2917
|
+
}
|
|
2918
|
+
interface VaultIntegrationConnectResult {
|
|
2919
|
+
name: string;
|
|
2920
|
+
scope: 'instance' | 'user';
|
|
2921
|
+
revision: string;
|
|
2922
|
+
authorizationUrl: string;
|
|
2923
|
+
}
|
|
2924
|
+
interface RevoVault$1 {
|
|
2925
|
+
get(name: string, options?: SecretGetOptions): Promise<SecretWithValue>;
|
|
2926
|
+
create(name: string, data: SecretCreateInput, options?: SecretScopeOptions): Promise<Secret | null>;
|
|
2927
|
+
update(name: string, data: SecretUpdateInput, options?: SecretScopeOptions): Promise<Secret | null>;
|
|
2928
|
+
delete(name: string, options?: SecretDeleteOptions): Promise<void | null>;
|
|
2929
|
+
rotate(name: string, data: SecretRotateInput, options?: SecretRotateOptions): Promise<SecretWithRevision | null>;
|
|
2930
|
+
listRevisions(name: string, options?: SecretRevisionListOptions): Promise<SecretRevisionPage>;
|
|
2931
|
+
getAccessToken(name: string, options?: SecretScopeOptions): Promise<VaultAccessToken>;
|
|
2932
|
+
getIntegrationMetadata(name: string, options?: SecretScopeOptions): Promise<VaultIntegrationMetadata>;
|
|
2933
|
+
discoverIntegration(name: string, data: VaultIntegrationConfig, options?: SecretScopeOptions): Promise<VaultIntegrationDiscovery>;
|
|
2934
|
+
connectIntegration(name: string, data: VaultConnectIntegrationInput, options?: SecretScopeOptions): Promise<VaultIntegrationConnectResult | null>;
|
|
2935
|
+
disconnectIntegration(name: string, options?: SecretScopeOptions): Promise<{
|
|
2936
|
+
name: string;
|
|
2937
|
+
disabled: boolean;
|
|
2938
|
+
} | null>;
|
|
2939
|
+
}
|
|
2691
2940
|
interface RevoApi {
|
|
2692
2941
|
createDatabase(data: DatabaseCreateInput): Promise<Database>;
|
|
2693
2942
|
cloneDatabase<TAsync extends boolean = false>(name: string, options?: DatabaseCloneInput & {
|
|
@@ -2696,9 +2945,19 @@ interface RevoApi {
|
|
|
2696
2945
|
exportDatabase<TAsync extends boolean = false>(name: string, options?: ExportDatabaseOptions & {
|
|
2697
2946
|
async?: TAsync;
|
|
2698
2947
|
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2948
|
+
importDatabase(name: string, options: ImportDatabaseOptions): Promise<{
|
|
2949
|
+
importId: string;
|
|
2950
|
+
jobId: string;
|
|
2951
|
+
status: string;
|
|
2952
|
+
}>;
|
|
2953
|
+
updateDatabaseImportMapping(importId: string, mapping: NonNullable<ImportDatabaseOptions['mapping']>): Promise<{
|
|
2954
|
+
importId: string;
|
|
2955
|
+
status: string;
|
|
2956
|
+
}>;
|
|
2957
|
+
commitDatabaseImport(importId: string): Promise<{
|
|
2958
|
+
importId: string;
|
|
2959
|
+
status: string;
|
|
2960
|
+
}>;
|
|
2702
2961
|
updateDatabase(name: string, data: DatabaseUpdateInput): Promise<Database>;
|
|
2703
2962
|
deleteDatabase(name: string): Promise<void>;
|
|
2704
2963
|
restoreDatabase(name: string): Promise<void>;
|
|
@@ -2706,12 +2965,11 @@ interface RevoApi {
|
|
|
2706
2965
|
getDatabaseData<T = any>(name: string, request?: DatabaseBoundedReadQuery): Promise<GetDatabaseDataResponse<T>>;
|
|
2707
2966
|
getDatabaseDataRow<T = any>(name: string, query: DatabaseRowQuery): Promise<T | null>;
|
|
2708
2967
|
countDatabase(name: string, query?: DatabaseCountQuery): Promise<number>;
|
|
2709
|
-
getDatabaseViewData<T = any>(name: string, request?: SelectInput): Promise<GetDatabaseDataResponse<T>>;
|
|
2710
2968
|
getDatabaseAudit(name: string, query?: DatabaseAuditQuery): Promise<DatabaseAuditResponse>;
|
|
2711
2969
|
insertDatabaseData(name: string, data: LooseObject<any>[], options?: DatabaseDataWriteOptions): Promise<DatabaseDataActionResponse>;
|
|
2712
2970
|
upsertDatabaseData(name: string, data: LooseObject<any>[], options?: DatabaseUpsertOptions): Promise<DatabaseDataActionResponse>;
|
|
2713
2971
|
updateDatabaseData(name: string, oldObject: LooseObject<any>, newObject: LooseObject<any>): Promise<ResourceItem>;
|
|
2714
|
-
deleteDatabaseData(name: string, data:
|
|
2972
|
+
deleteDatabaseData(name: string, data: LooseObject<any>[]): Promise<any>;
|
|
2715
2973
|
updateDatabaseDataRequest(name: string, request: DatabaseMutationRequest, payload: DatabaseUpdateData, options?: {
|
|
2716
2974
|
return?: boolean;
|
|
2717
2975
|
onlyKeys?: boolean;
|
|
@@ -2776,6 +3034,26 @@ interface RevoApi {
|
|
|
2776
3034
|
triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2777
3035
|
triggerJob(templateIdOrName: string, templateInputs?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2778
3036
|
triggerWebhook(webhook: WebhookInput, options?: AutomationScheduleOptions): Promise<Webhook>;
|
|
3037
|
+
cancelJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3038
|
+
retryJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3039
|
+
deleteJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3040
|
+
cancelWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3041
|
+
retryWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3042
|
+
deleteWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3043
|
+
previewAutomationOperation(resource: 'jobs' | 'webhooks', action: 'cancel' | 'retry' | 'delete', input: JobsBulkInput | WebhooksBulkInput): Promise<{
|
|
3044
|
+
matched: number;
|
|
3045
|
+
eligible: number;
|
|
3046
|
+
}>;
|
|
3047
|
+
getAutomationOperation(operationId: string): Promise<AutomationOperation>;
|
|
3048
|
+
getAutomationOperationItems(operationId: string, after?: string): Promise<{
|
|
3049
|
+
data: Array<{
|
|
3050
|
+
resourceId: string;
|
|
3051
|
+
status: string;
|
|
3052
|
+
resultId: string | null;
|
|
3053
|
+
errorCode: string | null;
|
|
3054
|
+
}>;
|
|
3055
|
+
nextCursor: string | null;
|
|
3056
|
+
}>;
|
|
2779
3057
|
httpCall(config: HttpRequestInterface, options: HttpRequestOptionsInterface & {
|
|
2780
3058
|
responseType: 'storage';
|
|
2781
3059
|
target: HttpStorageTargetRef;
|
|
@@ -3054,6 +3332,15 @@ interface RevoLowCode {
|
|
|
3054
3332
|
execute<T = LooseObject<any>>(code: string, options?: LowCodeExecuteOptions): Promise<ComponentExecuteResult<T>>;
|
|
3055
3333
|
}
|
|
3056
3334
|
|
|
3335
|
+
type VaultReadResult = Awaited<ReturnType<RevoVault$1['get']>>;
|
|
3336
|
+
/** Wire decoding returns a full Node.js Buffer, extending the portable low-code type. */
|
|
3337
|
+
type RevoVault = Omit<RevoVault$1, 'get'> & {
|
|
3338
|
+
get(...args: Parameters<RevoVault$1['get']>): Promise<Omit<VaultReadResult, 'revision'> & {
|
|
3339
|
+
revision: Omit<VaultReadResult['revision'], 'value'> & {
|
|
3340
|
+
value: Buffer$1;
|
|
3341
|
+
};
|
|
3342
|
+
}>;
|
|
3343
|
+
};
|
|
3057
3344
|
type RevoExecute = RevoLowCode['execute'];
|
|
3058
3345
|
type RevoExecuteOptions = NonNullable<Parameters<RevoExecute>[1]>;
|
|
3059
3346
|
type RevoExecutionDefaults = Omit<RevoExecuteOptions, 'inputs'>;
|
|
@@ -3141,6 +3428,7 @@ interface RevoRuntime {
|
|
|
3141
3428
|
readonly api: RevoApi;
|
|
3142
3429
|
readonly utils: RevoUtils;
|
|
3143
3430
|
readonly storage: RevoStorage;
|
|
3431
|
+
readonly vault: RevoVault;
|
|
3144
3432
|
readonly transport: RevoTransport;
|
|
3145
3433
|
readonly agents: RevoAgents;
|
|
3146
3434
|
readonly execute: RevoExecute;
|
|
@@ -3239,4 +3527,4 @@ declare class RevoHttpResponseError extends RevoError {
|
|
|
3239
3527
|
constructor(statusCode: number, body?: unknown);
|
|
3240
3528
|
}
|
|
3241
3529
|
|
|
3242
|
-
export {
|
|
3530
|
+
export { RevoRemoteError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, RevoRuntimeContextUnavailableError as D, RevoTransportError as E, type RuntimeBatchRequest as F, type RuntimeBatchResponse as G, type HostedRuntimeBootstrap as H, type RuntimeCall as I, type RuntimeCallResult as J, type SerializedRevoError as K, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoVault as i, type RevoTransport as j, type RevoAgents as k, type RevoExecute as l, type RevoBatchController as m, type RevoClientOptions as n, type RevoApi as o, RevoAuthenticationError as p, RevoBatchConfigurationError as q, RevoBatchLimitError as r, type RevoBatchLimits as s, type RevoBatchOptions as t, RevoConfigurationError as u, RevoError as v, type RevoExecuteOptions as w, type RevoExecutionDefaults as x, RevoPermissionDeniedError as y, RevoProtocolError as z };
|