@revoengine/sdk 1.0.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/LICENSE +21 -0
- package/README.md +639 -0
- package/THIRD_PARTY_NOTICES.md +30 -0
- package/dist/errors-ieF9jeMP.d.cts +2760 -0
- package/dist/errors-ieF9jeMP.d.ts +2760 -0
- package/dist/hosted.cjs +19424 -0
- package/dist/hosted.cjs.map +1 -0
- package/dist/hosted.d.cts +7 -0
- package/dist/hosted.d.ts +7 -0
- package/dist/hosted.js +19430 -0
- package/dist/hosted.js.map +1 -0
- package/dist/index.cjs +19596 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +11163 -0
- package/dist/index.d.ts +11163 -0
- package/dist/index.js +19590 -0
- package/dist/index.js.map +1 -0
- package/licenses/THIRD_PARTY_LICENSES.txt +745 -0
- package/package.json +76 -0
|
@@ -0,0 +1,2760 @@
|
|
|
1
|
+
import * as node_worker_threads from 'node:worker_threads';
|
|
2
|
+
|
|
3
|
+
declare const SDK_VERSION: "1.0.0";
|
|
4
|
+
declare const PROTOCOL_VERSION: 1;
|
|
5
|
+
declare const CONTRACT_REVISION: "a88e3ddff38d91762aa4c771955343e986039cebb04e4347fd257bd96f65bf5c";
|
|
6
|
+
type RuntimeSurfaceName = 'api' | 'storage' | 'agents';
|
|
7
|
+
|
|
8
|
+
// AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
|
|
9
|
+
// Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
|
|
10
|
+
// AUTO-GENERATED FROM packages/platform-openapi/generated/api.openapi.json. DO NOT EDIT.
|
|
11
|
+
// These input contracts are the Swagger DTO surface used by low-code lifecycle methods.
|
|
12
|
+
interface SwaggerAgentAutomationApprovalRoutingDto {
|
|
13
|
+
/** How non-interactive automation should behave when a later phase adds approval delegation. */
|
|
14
|
+
"mode"?: "block" | "delegate" | "notify";
|
|
15
|
+
/** Users who should receive delegated approval or escalation when automation cannot continue autonomously. */
|
|
16
|
+
"delegateUserIds"?: Array<string>;
|
|
17
|
+
/** Users who should be notified when automation reaches an approval gate or escalation path. */
|
|
18
|
+
"notifyUserIds"?: Array<string>;
|
|
19
|
+
}
|
|
20
|
+
interface SwaggerAgentAutomationNotificationPolicyDto {
|
|
21
|
+
/** Suggested dedupe window for downstream delivery or inbox fan-out keyed by one automation trigger. */
|
|
22
|
+
"dedupeWindowSeconds"?: number;
|
|
23
|
+
/** Suggested maximum delivery attempts for downstream notification or future chat delivery workers. */
|
|
24
|
+
"maxAttempts"?: number;
|
|
25
|
+
/** Whether automation-triggered delivery should retain an audit trail inside durable trigger state and future delivery workers. */
|
|
26
|
+
"auditTrail"?: boolean;
|
|
27
|
+
}
|
|
28
|
+
interface SwaggerAgentAutomationPolicyConfigDto {
|
|
29
|
+
/** Default trigger delivery mode for automation when the caller does not override it explicitly. */
|
|
30
|
+
"defaultDeliveryMode"?: "INBOX" | "DIRECT_RUN";
|
|
31
|
+
/** Approval-routing metadata reserved for enterprise automation escalation and operator delegation. */
|
|
32
|
+
"approvalRouting"?: SwaggerAgentAutomationApprovalRoutingDto;
|
|
33
|
+
/** Notification and delivery policy reserved for idempotent inbox fan-out and future chat delivery surfaces. */
|
|
34
|
+
"notificationPolicy"?: SwaggerAgentAutomationNotificationPolicyDto;
|
|
35
|
+
}
|
|
36
|
+
interface SwaggerAgentCheapTurnPolicyDto {
|
|
37
|
+
/** Whether cheap lookup turns should still receive persona guidance. */
|
|
38
|
+
"includePersona"?: boolean;
|
|
39
|
+
/** Whether cheap lookup turns should still receive custom agent system instructions. */
|
|
40
|
+
"includeSystemInstructions"?: boolean;
|
|
41
|
+
/** Whether cheap lookup turns should still receive recalled cross-run memory. */
|
|
42
|
+
"includeMemory"?: boolean;
|
|
43
|
+
}
|
|
44
|
+
interface SwaggerAgentConfigDto {
|
|
45
|
+
/** Supported assistant model used when the agent starts a thread. */
|
|
46
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna" | "gpt-5.4-nano";
|
|
47
|
+
/** Reasoning effort passed to assistant threads. */
|
|
48
|
+
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
49
|
+
/** 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
|
+
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
51
|
+
/** Durable planning policy default used for agent-loop turns. standard executes normally; review_required creates a reviewed plan before interactive execution. */
|
|
52
|
+
"planningPolicy"?: "standard" | "review_required";
|
|
53
|
+
/** Operating mode used to tune the agent toward the selected kind of work. */
|
|
54
|
+
"workMode"?: "balanced" | "coding" | "business" | "analyst" | "operator" | "creative";
|
|
55
|
+
/** Response persona applied beneath runtime policy and explicit agent instructions. */
|
|
56
|
+
"persona"?: "friendly" | "pragmatic" | "professional" | "concise" | "calm" | "mentor" | "assertive";
|
|
57
|
+
/** Additional per-agent system instructions persisted with the definition. Runtime policy still has higher priority. */
|
|
58
|
+
"systemInstructions"?: string;
|
|
59
|
+
/** Durable cross-run memory defaults such as recall budget, retained summary size, and retention horizon. */
|
|
60
|
+
"memoryPolicy"?: SwaggerAgentMemoryPolicyDto;
|
|
61
|
+
/** Release metadata and rollout controls for governed agent capabilities. */
|
|
62
|
+
"release"?: SwaggerAgentReleaseConfigDto;
|
|
63
|
+
/** Enterprise automation defaults such as delivery mode, approval routing, and future delivery settings. */
|
|
64
|
+
"automation"?: SwaggerAgentAutomationPolicyConfigDto;
|
|
65
|
+
/** Cheap-turn cost controls for persona, agent instructions, and memory recall on read-only fast paths. */
|
|
66
|
+
"cheapTurn"?: SwaggerAgentCheapTurnPolicyDto;
|
|
67
|
+
/** Additional registered tool names associated with this agent. The runtime still exposes the complete callable tool registry. */
|
|
68
|
+
"toolNames"?: Array<string>;
|
|
69
|
+
/** Default registry plugin ids attached to this agent. These are the agent-owned baseline attachments applied to every run unless additional runtime plugin ids are supplied. */
|
|
70
|
+
"pluginIds"?: Array<string>;
|
|
71
|
+
/** Primary plugin contract surface. Plugins are provider-governed and define the executable agent-plugin surface. */
|
|
72
|
+
"plugins"?: Array<SwaggerAgentPluginConfigDto>;
|
|
73
|
+
/** Maximum number of concurrently admitted root runs for this agent. Additional root runs remain queued until capacity is released. */
|
|
74
|
+
"maxActiveRootRuns"?: number;
|
|
75
|
+
/** Maximum number of delegated child runs the parent may spawn per execution plan. */
|
|
76
|
+
"maxChildRuns"?: number;
|
|
77
|
+
/** Maximum number of delegated child runs that one parent may start concurrently. Remaining delegated steps wait for a later parent tick. */
|
|
78
|
+
"maxConcurrentChildRuns"?: number;
|
|
79
|
+
/** Maximum number of ticks allowed for one run. */
|
|
80
|
+
"maxTicks"?: number;
|
|
81
|
+
/** How the parent reacts when one delegated child fails. */
|
|
82
|
+
"childFailureMode"?: "fail_parent" | "merge_partial";
|
|
83
|
+
}
|
|
84
|
+
interface SwaggerAgentMemoryPolicyDto {
|
|
85
|
+
/** Whether the runtime may load and persist durable cross-run memory for this agent. */
|
|
86
|
+
"enabled"?: boolean;
|
|
87
|
+
/** Maximum number of memory records the runtime should recall into one run. */
|
|
88
|
+
"maxRecallEntries"?: number;
|
|
89
|
+
/** Total character budget reserved for compact recalled memory summaries across one run. */
|
|
90
|
+
"maxRecallChars"?: number;
|
|
91
|
+
}
|
|
92
|
+
interface SwaggerAgentPluginApprovalConfigDto {
|
|
93
|
+
/** How plugin execution approval is enforced before the provider call is made. */
|
|
94
|
+
"mode"?: "none" | "always" | "conditional";
|
|
95
|
+
/** Safety tier enforced for approval and mutation governance. */
|
|
96
|
+
"safetyTier"?: "read" | "write" | "destructive" | "external" | "execute";
|
|
97
|
+
}
|
|
98
|
+
interface SwaggerAgentPluginComponentToolConfigDto {
|
|
99
|
+
/** Whether this component-backed tool is enabled for runtime selection and execution. */
|
|
100
|
+
"enabled"?: boolean;
|
|
101
|
+
/** Whether this component-backed tool is deferred behind discovery instead of eagerly exposed. */
|
|
102
|
+
"deferLoading"?: boolean;
|
|
103
|
+
/** Explicit local tool alias exposed to the runtime when set. */
|
|
104
|
+
"alias"?: string;
|
|
105
|
+
/** Operator-facing title for this component-backed tool. */
|
|
106
|
+
"title"?: string;
|
|
107
|
+
/** Tool-specific description exposed to the assistant runtime. */
|
|
108
|
+
"description"?: string;
|
|
109
|
+
/** Stable implementation entrypoint passed to the component in api.input().agentTool.entrypoint. Defaults to the tool key. */
|
|
110
|
+
"entrypoint"?: string;
|
|
111
|
+
/** Static runtime inputs passed to the component under api.input().agentTool.inputs. */
|
|
112
|
+
"inputs"?: Record<string, unknown>;
|
|
113
|
+
/** Named component result to return when the component executor supports result popping. */
|
|
114
|
+
"popResult"?: string;
|
|
115
|
+
/** Strict structured input schema exposed for this tool. The component receives matching arguments under api.input().agentTool.args. Must be an object schema with additionalProperties=false and descriptions on every declared property. */
|
|
116
|
+
"inputSchema"?: Record<string, unknown>;
|
|
117
|
+
/** Structured output schema expected from this tool. */
|
|
118
|
+
"outputSchema"?: Record<string, unknown>;
|
|
119
|
+
/** Per-tool approval contract enforced before execution. */
|
|
120
|
+
"approvalPolicy"?: SwaggerAgentPluginApprovalConfigDto;
|
|
121
|
+
/** Declared mutation intent for this component-backed tool. */
|
|
122
|
+
"mutationIntent"?: "read" | "write" | "destructive" | "external";
|
|
123
|
+
/** Declared reversibility for this component-backed tool. */
|
|
124
|
+
"reversibility"?: "reversible" | "operator_reversible" | "irreversible" | "unknown";
|
|
125
|
+
/** Primary runtime scope impacted by this component-backed tool. */
|
|
126
|
+
"targetScope"?: "assistant_thread" | "agent" | "tenant" | "external";
|
|
127
|
+
/** Concise side-effect declaration recorded for this tool. */
|
|
128
|
+
"sideEffectSummary"?: string;
|
|
129
|
+
/** Normalized side-effect categories used for rollout and operator review. */
|
|
130
|
+
"sideEffectCategories"?: Array<string>;
|
|
131
|
+
/** Optional rollout policy applied to this tool. */
|
|
132
|
+
"rollout"?: SwaggerAgentReleaseRolloutPolicyDto;
|
|
133
|
+
}
|
|
134
|
+
interface SwaggerAgentPluginComponentToolsetDto {
|
|
135
|
+
/** Default governance and loading policy for component-backed tools. */
|
|
136
|
+
"defaultConfig"?: SwaggerAgentPluginComponentToolConfigDto;
|
|
137
|
+
/** Component-backed tools keyed by stable capability name. */
|
|
138
|
+
"tools"?: Record<string, unknown>;
|
|
139
|
+
}
|
|
140
|
+
interface SwaggerAgentPluginConfigDto {
|
|
141
|
+
/** Plugin contract version for the governed runtime surface. */
|
|
142
|
+
"contractVersion"?: number;
|
|
143
|
+
/** Stable plugin id used by the agent runtime. */
|
|
144
|
+
"id"?: string;
|
|
145
|
+
/** Plugin execution provider kind. */
|
|
146
|
+
"kind"?: "tools" | "mcp_server" | "skill" | "package";
|
|
147
|
+
/** Operator-facing plugin name. */
|
|
148
|
+
"name"?: string;
|
|
149
|
+
/** Optional plugin description. */
|
|
150
|
+
"description"?: string;
|
|
151
|
+
/** Canonical English routing metadata used for planner and fallback matching. Operator-facing name and description may remain localized. */
|
|
152
|
+
"routing"?: SwaggerAgentPluginRoutingConfigDto;
|
|
153
|
+
/** Execution mode expected for the plugin provider. */
|
|
154
|
+
"executionMode"?: "sync" | "background";
|
|
155
|
+
/** Component id executed when this plugin runs. */
|
|
156
|
+
"componentId"?: string;
|
|
157
|
+
/** Optional fixed component version. */
|
|
158
|
+
"componentVersion"?: number;
|
|
159
|
+
/** Multiple governed tool contracts backed by the same component implementation. */
|
|
160
|
+
"componentToolset"?: SwaggerAgentPluginComponentToolsetDto;
|
|
161
|
+
/** Remote MCP server configuration used when `kind` is `mcp_server`. */
|
|
162
|
+
"mcpServer"?: SwaggerAgentPluginMcpConfigDto;
|
|
163
|
+
/** Per-tool MCP governance and loading configuration used when `kind` is `mcp_server`. */
|
|
164
|
+
"mcpToolset"?: SwaggerAgentPluginMcpToolsetDto;
|
|
165
|
+
/** Markdown skill configuration used when `kind` is `skill`. */
|
|
166
|
+
"skill"?: SwaggerAgentPluginSkillConfigDto;
|
|
167
|
+
/** Markdown package manifest and dependency ids used when `kind` is `package`. */
|
|
168
|
+
"package"?: SwaggerAgentPluginPackageConfigDto;
|
|
169
|
+
/** Strict structured input schema exposed to discovery and runtime validation. Must be an object schema with additionalProperties=false and descriptions on every declared property. */
|
|
170
|
+
"inputSchema"?: Record<string, unknown>;
|
|
171
|
+
/** Structured output schema expected from the plugin provider. */
|
|
172
|
+
"outputSchema"?: Record<string, unknown>;
|
|
173
|
+
/** Approval contract enforced before execution. */
|
|
174
|
+
"approvalPolicy"?: SwaggerAgentPluginApprovalConfigDto;
|
|
175
|
+
/** Declared mutation intent for governance and planner safety. */
|
|
176
|
+
"mutationIntent"?: "read" | "write" | "destructive" | "external";
|
|
177
|
+
/** Declared reversibility of the plugin side effects. */
|
|
178
|
+
"reversibility"?: "reversible" | "operator_reversible" | "irreversible" | "unknown";
|
|
179
|
+
/** Primary runtime scope impacted when the plugin executes. */
|
|
180
|
+
"targetScope"?: "assistant_thread" | "agent" | "tenant" | "external";
|
|
181
|
+
/** Concise side-effect declaration recorded in approval, evidence, and audit surfaces. */
|
|
182
|
+
"sideEffectSummary"?: string;
|
|
183
|
+
/** Normalized side-effect categories used for rollout and operator review. */
|
|
184
|
+
"sideEffectCategories"?: Array<string>;
|
|
185
|
+
/** Maximum runtime in milliseconds. */
|
|
186
|
+
"timeoutMs"?: number;
|
|
187
|
+
/** Maximum serialized result size in bytes. */
|
|
188
|
+
"resultMaxBytes"?: number;
|
|
189
|
+
/** Whether the plugin should be surfaced as summary-only discovery context before explicit attachment. */
|
|
190
|
+
"autoDiscovery"?: boolean;
|
|
191
|
+
/** Whether the plugin is enabled for execution. */
|
|
192
|
+
"enabled"?: boolean;
|
|
193
|
+
}
|
|
194
|
+
interface SwaggerAgentPluginMcpConfigDto {
|
|
195
|
+
/** Remote MCP transport supported by the SaaS runtime. */
|
|
196
|
+
"transport"?: "streamable_http" | "sse";
|
|
197
|
+
/** Absolute HTTPS endpoint for the remote MCP server. */
|
|
198
|
+
"url"?: string;
|
|
199
|
+
/** Manifest cache time-to-live in milliseconds. */
|
|
200
|
+
"manifestTtlMs"?: number;
|
|
201
|
+
/** Connection and handshake timeout in milliseconds. */
|
|
202
|
+
"connectTimeoutMs"?: number;
|
|
203
|
+
/** Prefix used to derive local MCP tool names from remote tool names. */
|
|
204
|
+
"toolNamePrefix"?: string;
|
|
205
|
+
/** Auth mode used when calling the remote MCP server. */
|
|
206
|
+
"authMode"?: "none" | "bearer" | "basic" | "header";
|
|
207
|
+
/** Secret id containing the bearer token. */
|
|
208
|
+
"bearerSecretId"?: string;
|
|
209
|
+
/** Optional secret data revision id for the bearer token binding. */
|
|
210
|
+
"bearerSecretDataId"?: string;
|
|
211
|
+
/** Optional username for basic auth. */
|
|
212
|
+
"basicUsername"?: string;
|
|
213
|
+
/** Secret id containing the basic auth password. */
|
|
214
|
+
"basicPasswordSecretId"?: string;
|
|
215
|
+
/** Optional secret data revision id for the basic auth password binding. */
|
|
216
|
+
"basicPasswordSecretDataId"?: string;
|
|
217
|
+
/** Additional header bindings resolved from tenant secrets before calling the MCP server. */
|
|
218
|
+
"headers"?: Array<SwaggerAgentPluginMcpHeaderBindingDto>;
|
|
219
|
+
}
|
|
220
|
+
interface SwaggerAgentPluginMcpHeaderBindingDto {
|
|
221
|
+
/** Header name sent to the remote MCP server. */
|
|
222
|
+
"name"?: string;
|
|
223
|
+
/** Secret id containing the header value. */
|
|
224
|
+
"secretId"?: string;
|
|
225
|
+
/** Optional secret data revision id when the binding should pin a specific secret revision. */
|
|
226
|
+
"secretDataId"?: string;
|
|
227
|
+
/** Optional static header value used when the binding does not read from a secret. */
|
|
228
|
+
"value"?: string;
|
|
229
|
+
/** Optional static prefix added before the resolved secret value, for example `Bearer `. */
|
|
230
|
+
"prefix"?: string;
|
|
231
|
+
}
|
|
232
|
+
interface SwaggerAgentPluginMcpToolConfigDto {
|
|
233
|
+
/** Whether the tool is enabled for runtime selection and execution. */
|
|
234
|
+
"enabled"?: boolean;
|
|
235
|
+
/** Whether the tool is deferred behind discovery instead of eagerly exposed. */
|
|
236
|
+
"deferLoading"?: boolean;
|
|
237
|
+
/** Explicit local tool alias exposed to the runtime when set. */
|
|
238
|
+
"alias"?: string;
|
|
239
|
+
/** Per-tool approval contract enforced before execution. */
|
|
240
|
+
"approvalPolicy"?: SwaggerAgentPluginApprovalConfigDto;
|
|
241
|
+
/** Declared mutation intent for this remote tool override. */
|
|
242
|
+
"mutationIntent"?: "read" | "write" | "destructive" | "external";
|
|
243
|
+
/** Declared reversibility for this remote tool override. */
|
|
244
|
+
"reversibility"?: "reversible" | "operator_reversible" | "irreversible" | "unknown";
|
|
245
|
+
/** Primary runtime scope impacted by this remote tool override. */
|
|
246
|
+
"targetScope"?: "assistant_thread" | "agent" | "tenant" | "external";
|
|
247
|
+
/** Concise side-effect declaration recorded for this remote tool override. */
|
|
248
|
+
"sideEffectSummary"?: string;
|
|
249
|
+
/** Optional rollout policy applied to this remote tool override. */
|
|
250
|
+
"rollout"?: SwaggerAgentReleaseRolloutPolicyDto;
|
|
251
|
+
}
|
|
252
|
+
interface SwaggerAgentPluginMcpToolsetDto {
|
|
253
|
+
/** Default governance and loading policy for tools discovered from this MCP server. */
|
|
254
|
+
"defaultConfig"?: SwaggerAgentPluginMcpToolConfigDto;
|
|
255
|
+
/** Per-remote-tool overrides keyed by remote tool name. */
|
|
256
|
+
"configs"?: Record<string, unknown>;
|
|
257
|
+
}
|
|
258
|
+
interface SwaggerAgentPluginPackageConfigDto {
|
|
259
|
+
/** Stable package identity used across internal catalogs and future community marketplace publishing. */
|
|
260
|
+
"externalId": string;
|
|
261
|
+
/** Package content format. Markdown is the only supported v1 format. */
|
|
262
|
+
"format"?: "markdown";
|
|
263
|
+
/** Markdown instruction content loaded into the assistant runtime when the package is attached. */
|
|
264
|
+
"content"?: string;
|
|
265
|
+
/** Registry plugin ids declared as package dependencies. */
|
|
266
|
+
"pluginIds"?: Array<string>;
|
|
267
|
+
/** Disabled marketplace-facing package metadata reserved for catalog publishing. */
|
|
268
|
+
"metadata"?: SwaggerAgentPluginPackageMetadataDto;
|
|
269
|
+
/** Maximum number of package content characters allowed into one prompt. */
|
|
270
|
+
"maxPromptChars"?: number;
|
|
271
|
+
}
|
|
272
|
+
interface SwaggerAgentPluginPackageMetadataDto {
|
|
273
|
+
/** Package avatar or icon URL shown in package catalogs. */
|
|
274
|
+
"avatarUrl"?: string;
|
|
275
|
+
/** Package website URL. */
|
|
276
|
+
"websiteUrl"?: string;
|
|
277
|
+
/** Package documentation URL. */
|
|
278
|
+
"documentationUrl"?: string;
|
|
279
|
+
/** Package terms of service URL. */
|
|
280
|
+
"termsOfServiceUrl"?: string;
|
|
281
|
+
/** Package privacy policy URL. */
|
|
282
|
+
"privacyPolicyUrl"?: string;
|
|
283
|
+
/** Package support URL. */
|
|
284
|
+
"supportUrl"?: string;
|
|
285
|
+
/** Publisher display name. */
|
|
286
|
+
"publisherName"?: string;
|
|
287
|
+
/** Publisher website URL. */
|
|
288
|
+
"publisherUrl"?: string;
|
|
289
|
+
/** Package license label. */
|
|
290
|
+
"license"?: string;
|
|
291
|
+
/** Package catalog categories. */
|
|
292
|
+
"categories"?: Array<string>;
|
|
293
|
+
/** Package search tags. */
|
|
294
|
+
"tags"?: Array<string>;
|
|
295
|
+
}
|
|
296
|
+
interface SwaggerAgentPluginRoutingConfigDto {
|
|
297
|
+
/** Canonical English routing title used for planner and fallback matching. Display names may remain localized. */
|
|
298
|
+
"title"?: string;
|
|
299
|
+
/** Canonical English routing summary used for planner and fallback matching. Display descriptions may remain localized. */
|
|
300
|
+
"summary"?: string;
|
|
301
|
+
}
|
|
302
|
+
interface SwaggerAgentPluginSkillConfigDto {
|
|
303
|
+
/** Skill content format. Markdown is the only supported v1 format. */
|
|
304
|
+
"format"?: "markdown";
|
|
305
|
+
/** Markdown instruction content loaded into the assistant runtime when the plugin is attached. */
|
|
306
|
+
"content"?: string;
|
|
307
|
+
/** Registry plugin ids declared as one-level skill dependencies. */
|
|
308
|
+
"pluginIds"?: Array<string>;
|
|
309
|
+
/** Maximum number of skill content characters allowed into one prompt. */
|
|
310
|
+
"maxPromptChars"?: number;
|
|
311
|
+
}
|
|
312
|
+
interface SwaggerAgentPolicyDto {
|
|
313
|
+
/** Default approval mode applied to agent tool calls when no per-tool override exists. */
|
|
314
|
+
"defaultToolPermission"?: "default" | "auto_review" | "full";
|
|
315
|
+
/** Per-tool approval mode overrides keyed by the runtime tool name. */
|
|
316
|
+
"toolPermissions"?: Record<string, "default" | "auto_review" | "full">;
|
|
317
|
+
/** Additional policy-managed tool names. Tool permissions govern operations without truncating the callable registry. */
|
|
318
|
+
"toolNames"?: Array<string>;
|
|
319
|
+
/** Policy-enforced registry plugin ids attached to this agent. These are governance-managed attachments and are merged in regardless of run-level plugin selection. */
|
|
320
|
+
"pluginIds"?: Array<string>;
|
|
321
|
+
/** Policy-managed plugins merged with config plugins before execution-time routing narrows the active surface. */
|
|
322
|
+
"plugins"?: Array<SwaggerAgentPluginConfigDto>;
|
|
323
|
+
/** Policy-enforced maximum number of concurrently admitted root runs for this agent. */
|
|
324
|
+
"maxActiveRootRuns"?: number;
|
|
325
|
+
/** Maximum number of delegated child runs allowed by policy. */
|
|
326
|
+
"maxChildRuns"?: number;
|
|
327
|
+
/** Policy-enforced maximum number of delegated child runs that one parent may start concurrently. */
|
|
328
|
+
"maxConcurrentChildRuns"?: number;
|
|
329
|
+
/** Maximum number of ticks allowed by policy. */
|
|
330
|
+
"maxTicks"?: number;
|
|
331
|
+
/** How the parent reacts when one delegated child fails. */
|
|
332
|
+
"childFailureMode"?: "fail_parent" | "merge_partial";
|
|
333
|
+
}
|
|
334
|
+
interface SwaggerAgentReleaseConfigDto {
|
|
335
|
+
/** Operator-facing release label such as 2026.04.10 or canary-1. */
|
|
336
|
+
"versionLabel"?: string;
|
|
337
|
+
/** Short operator-facing rollout or change summary for the current definition. */
|
|
338
|
+
"changeSummary"?: string;
|
|
339
|
+
/** Routing rollout policy used for shadow, canary, enable, disable, and rollback decisions. */
|
|
340
|
+
"routingRollout"?: SwaggerAgentReleaseRolloutPolicyDto;
|
|
341
|
+
/** Delegated worker rollout policy used for staged worker enablement and rollback planning. */
|
|
342
|
+
"workerRollout"?: SwaggerAgentReleaseRolloutPolicyDto;
|
|
343
|
+
/** Plugin rollout policy used for staged plugin execution and rollback planning. */
|
|
344
|
+
"pluginRollout"?: SwaggerAgentReleaseRolloutPolicyDto;
|
|
345
|
+
}
|
|
346
|
+
interface SwaggerAgentReleaseRolloutPolicyDto {
|
|
347
|
+
/** Current rollout mode for the governed feature or plugin surface. */
|
|
348
|
+
"mode"?: "disabled" | "shadow" | "canary" | "enabled";
|
|
349
|
+
/** Canary percentage used when mode=canary. */
|
|
350
|
+
"canaryPercent"?: number;
|
|
351
|
+
/** Shadow sampling percentage used when mode=shadow. */
|
|
352
|
+
"shadowSamplePercent"?: number;
|
|
353
|
+
/** Required deterministic eval suite name for this rollout policy. */
|
|
354
|
+
"requiredEvalSuite"?: string;
|
|
355
|
+
/** Telemetry scorecards that operators must watch during rollout. */
|
|
356
|
+
"requiredTelemetryScorecards"?: Array<string>;
|
|
357
|
+
/** Optional admitted snapshot to roll back to when the current rollout is revoked. */
|
|
358
|
+
"rollbackToSnapshotId"?: string;
|
|
359
|
+
}
|
|
360
|
+
interface SwaggerDatabaseDefinition {
|
|
361
|
+
/** Column id, required only for update. */
|
|
362
|
+
"databaseDefinitionId"?: string;
|
|
363
|
+
/** Name. */
|
|
364
|
+
"name": string;
|
|
365
|
+
/** Description. */
|
|
366
|
+
"desc"?: string | null;
|
|
367
|
+
/** You need to specify type [SMALLINT,INTEGER,BIGINT,REAL,DOUBLE PRECISION,NUMERIC,JSON,JSONB,TEXT,UUID,DATE,TIME,TIMETZ,TIMESTAMP,TIMESTAMPTZ,BOOLEAN]. */
|
|
368
|
+
"type": "SMALLINT" | "INTEGER" | "BIGINT" | "REAL" | "DOUBLE PRECISION" | "NUMERIC" | "JSON" | "JSONB" | "TEXT" | "UUID" | "DATE" | "TIME" | "TIMETZ" | "TIMESTAMP" | "TIMESTAMPTZ" | "BOOLEAN";
|
|
369
|
+
/** Provide if this column is primary key. */
|
|
370
|
+
"isPrimaryKey": boolean;
|
|
371
|
+
/** Provide if this column is array of provided type, primary keys cannot be arrays. */
|
|
372
|
+
"isArray": boolean;
|
|
373
|
+
/** Provide if this column should contain only unique values for entire table. */
|
|
374
|
+
"isUnique": boolean;
|
|
375
|
+
/** Provide if this column should can contain NULL values or not. */
|
|
376
|
+
"isNullable": boolean;
|
|
377
|
+
/** Provide if this column should should be index. */
|
|
378
|
+
"isIndex": boolean;
|
|
379
|
+
/** Default: boolean, number, string */
|
|
380
|
+
"default"?: string | boolean | number | null;
|
|
381
|
+
/** Foreign references to other database definitions. */
|
|
382
|
+
"foreignReferences"?: Array<SwaggerDatabaseDefinitionForeignReferences> | null;
|
|
383
|
+
}
|
|
384
|
+
interface SwaggerDatabaseDefinitionForeignReference {
|
|
385
|
+
/** Column. */
|
|
386
|
+
"column": string;
|
|
387
|
+
/** Target database. */
|
|
388
|
+
"targetDatabase": string;
|
|
389
|
+
/** Target column. */
|
|
390
|
+
"targetColumn": string;
|
|
391
|
+
}
|
|
392
|
+
interface SwaggerDatabaseDefinitionForeignReferences {
|
|
393
|
+
/** You need to specify reference type [SMALLINT,INTEGER,BIGINT,REAL,DOUBLE PRECISION,NUMERIC,JSON,JSONB,TEXT,UUID,DATE,TIME,TIMETZ,TIMESTAMP,TIMESTAMPTZ,BOOLEAN]. */
|
|
394
|
+
"reference": Array<SwaggerDatabaseDefinitionForeignReference>;
|
|
395
|
+
/** You need to specify what happen on update of referenced table data, "none" will raise an error if there are records existing in this table that reference it. */
|
|
396
|
+
"onUpdate": "none" | "cascade" | "restrict";
|
|
397
|
+
/** You need to specify what happen on update of referenced table data, "none" will raise an error if there are records existing in this table that reference it. */
|
|
398
|
+
"onDelete": "none" | "cascade" | "restrict" | "default" | "null";
|
|
399
|
+
}
|
|
400
|
+
interface SwaggerPartitionDefinition {
|
|
401
|
+
/** Partition type. */
|
|
402
|
+
"type"?: "LIST" | "RANGE" | "HASH";
|
|
403
|
+
/** Column name to use as partition key. Must match one of the column names in definition. */
|
|
404
|
+
"key"?: string;
|
|
405
|
+
/** Mark if this partition is default. */
|
|
406
|
+
"isDefault"?: boolean;
|
|
407
|
+
/** For LIST partitioning: array of values. For RANGE partitioning: not used. */
|
|
408
|
+
"values"?: Array<string>;
|
|
409
|
+
/** For RANGE partitioning: starting value (use "MINVALUE" for unbounded start). */
|
|
410
|
+
"from"?: Record<string, unknown>;
|
|
411
|
+
/** For RANGE partitioning: ending value (use "MAXVALUE" for unbounded end). */
|
|
412
|
+
"to"?: Record<string, unknown>;
|
|
413
|
+
/**
|
|
414
|
+
The modulus value for a HASH partition.
|
|
415
|
+
Required only when the partition type is HASH.
|
|
416
|
+
It represents the total number of hash partitions.
|
|
417
|
+
The remainder value (0 to modulus - 1) determines which partition a row belongs to.
|
|
418
|
+
*/
|
|
419
|
+
"modulus"?: number;
|
|
420
|
+
/**
|
|
421
|
+
The remainder value for a HASH partition.
|
|
422
|
+
Required only when the partition type is HASH.
|
|
423
|
+
This value must be between 0 and (modulus - 1).
|
|
424
|
+
Determines which partition a row will belong to within the hash partitions.
|
|
425
|
+
*/
|
|
426
|
+
"remainder"?: number;
|
|
427
|
+
}
|
|
428
|
+
interface SwaggerStorageRetentionDto {
|
|
429
|
+
/** Positive lifetime in seconds. The lifetime starts when the file is finalized. */
|
|
430
|
+
"ttlSeconds"?: number;
|
|
431
|
+
/** Absolute future expiration timestamp in ISO 8601 format. */
|
|
432
|
+
"expiresAt"?: string;
|
|
433
|
+
}
|
|
434
|
+
interface SwaggerWebhookRequestDetailsDto {
|
|
435
|
+
"url": string;
|
|
436
|
+
"method": "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
437
|
+
/** Body. */
|
|
438
|
+
"body"?: Record<string, unknown>;
|
|
439
|
+
/** Headers. */
|
|
440
|
+
"headers"?: Record<string, unknown>;
|
|
441
|
+
}
|
|
442
|
+
interface AgentRunCancelInput {
|
|
443
|
+
/** Optional cancellation reason for audit traces. */
|
|
444
|
+
"reason"?: string;
|
|
445
|
+
}
|
|
446
|
+
interface DatabaseCloneInput {
|
|
447
|
+
/** Optional audit override. Defaults to the source logical table setting. */
|
|
448
|
+
"audit"?: boolean;
|
|
449
|
+
/** Optional target root database name. Defaults to the source database name with "_Clone" suffix. */
|
|
450
|
+
"name"?: string;
|
|
451
|
+
/** Suffix used for automatically generated clone names. Defaults to "Clone". */
|
|
452
|
+
"suffix"?: string;
|
|
453
|
+
/** Whether to copy existing rows/items into the clone. Defaults to false. */
|
|
454
|
+
"includeItems"?: boolean;
|
|
455
|
+
/** Alias for includeItems. Defaults to false. */
|
|
456
|
+
"includeData"?: boolean;
|
|
457
|
+
/** Whether to clone connected table partitions. Defaults to true. */
|
|
458
|
+
"includePartitions"?: boolean;
|
|
459
|
+
/** Optional cloned database category override. */
|
|
460
|
+
"category"?: string;
|
|
461
|
+
/** Optional cloned database description override. */
|
|
462
|
+
"desc"?: string;
|
|
463
|
+
/** Optional cloned database tags override. */
|
|
464
|
+
"tags"?: Array<string>;
|
|
465
|
+
/** Optional cloned database restricted flag override. */
|
|
466
|
+
"restricted"?: boolean;
|
|
467
|
+
/** Optional cloned database group access override. */
|
|
468
|
+
"groups"?: Array<string>;
|
|
469
|
+
/** Optional cloned database user access override. */
|
|
470
|
+
"users"?: Array<string>;
|
|
471
|
+
}
|
|
472
|
+
interface AgentCreateInput {
|
|
473
|
+
/** Stable display name of the agent. */
|
|
474
|
+
"name": string;
|
|
475
|
+
/** Optional operator-facing description. */
|
|
476
|
+
"desc"?: string;
|
|
477
|
+
/** User id of the service account used as the execution principal. */
|
|
478
|
+
"serviceAccountUserId": string;
|
|
479
|
+
/** Owning user or group id used for visibility and management. */
|
|
480
|
+
"ownerId"?: string;
|
|
481
|
+
/** Owner type, typically USER or GROUP. */
|
|
482
|
+
"ownerType"?: string;
|
|
483
|
+
/** Optional resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
484
|
+
"metadata"?: Record<string, unknown>;
|
|
485
|
+
/** Persisted agent identity and runtime defaults such as model, persona, custom system instructions, memory policy, planning mode, and loop limits. Per-turn prompt tier, fast-path eligibility, and route telemetry are derived by runtime and are not accepted here. */
|
|
486
|
+
"config"?: SwaggerAgentConfigDto;
|
|
487
|
+
/** Persisted policy constraints such as tool allowlists, agent plugins, and delegation ceilings. Runtime-only route metadata is not configured here. */
|
|
488
|
+
"policy"?: SwaggerAgentPolicyDto;
|
|
489
|
+
}
|
|
490
|
+
interface AgentInboxItemCreateInput {
|
|
491
|
+
/** Logical task type such as task, incident, sync, or concierge_message. */
|
|
492
|
+
"type"?: string;
|
|
493
|
+
/** Instruction that will be passed into the agent run when the item is claimed. */
|
|
494
|
+
"instruction": string;
|
|
495
|
+
/** Opaque task payload persisted with the inbox item and copied into the run state. */
|
|
496
|
+
"payload"?: Record<string, unknown>;
|
|
497
|
+
/** Queue priority. Higher values are claimed first. */
|
|
498
|
+
"priority"?: number;
|
|
499
|
+
/** Optional ISO timestamp after which the inbox item becomes claimable. */
|
|
500
|
+
"availableAt"?: string;
|
|
501
|
+
/** Optional de-duplication key unique per agent among non-terminal inbox items. */
|
|
502
|
+
"dedupeKey"?: string;
|
|
503
|
+
}
|
|
504
|
+
interface DatabaseCreateInput {
|
|
505
|
+
/** Capture future row inserts, updates, and deletes in database audit history. */
|
|
506
|
+
"audit"?: boolean;
|
|
507
|
+
/** Name. */
|
|
508
|
+
"name": string;
|
|
509
|
+
/** Category. */
|
|
510
|
+
"category"?: string;
|
|
511
|
+
/** Description. */
|
|
512
|
+
"desc"?: string;
|
|
513
|
+
/** Optional resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
514
|
+
"metadata"?: Record<string, unknown>;
|
|
515
|
+
/** Provide if access should be restricted. */
|
|
516
|
+
"restricted": boolean;
|
|
517
|
+
/** Provide which groups should have access to it, once restricted is true. */
|
|
518
|
+
"groups"?: Array<string>;
|
|
519
|
+
/** Provide which users should have access to it, once restricted is true. */
|
|
520
|
+
"users"?: Array<string>;
|
|
521
|
+
/** Database definitions. */
|
|
522
|
+
"definition"?: Array<SwaggerDatabaseDefinition>;
|
|
523
|
+
/** Name. */
|
|
524
|
+
"parent"?: string;
|
|
525
|
+
/** Partition configuration. */
|
|
526
|
+
"partition"?: SwaggerPartitionDefinition;
|
|
527
|
+
}
|
|
528
|
+
interface AssistantMessageInput {
|
|
529
|
+
/** Content of the message, validated up to 100000 tokens. */
|
|
530
|
+
"content": string;
|
|
531
|
+
/** 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. */
|
|
532
|
+
"preflightMessageId"?: string;
|
|
533
|
+
/** Optional assistant execution-model override. GPT-5.6 Luna is the default; Sol, Terra, Luna, and GPT-5.4 Nano are supported. */
|
|
534
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna" | "gpt-5.4-nano";
|
|
535
|
+
/** Optional assistant reasoning effort override: low, medium, high, or xhigh. Defaults to low. */
|
|
536
|
+
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
537
|
+
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
538
|
+
"reasoning"?: "low" | "medium" | "high" | "xhigh";
|
|
539
|
+
/** Optional flag selecting deadline-bounded background provider recovery. On SSE routes it also allows the turn to continue after client disconnect. Defaults to false. */
|
|
540
|
+
"backgroundProcessing"?: boolean;
|
|
541
|
+
/** Optional flag for send-message endpoints. When true, an active streamed assistant turn for the thread is interrupted before appending this message. */
|
|
542
|
+
"interruptActive"?: boolean;
|
|
543
|
+
/** Internal steer flag set by steer endpoints. When true, the visible user message is preserved while the executor receives a wrapper telling it to apply the message as a correction or refinement to the interrupted task. */
|
|
544
|
+
"steeringMode"?: boolean;
|
|
545
|
+
/** Optional durable turn goal for non-plan execution. Agent runtime carries this goal across tool loops, compaction, and follow-up turns without forcing visible plan review. */
|
|
546
|
+
"goal"?: string;
|
|
547
|
+
/** Execution mode for the turn. Interactive may pause for approval or clarification. Background and automation should avoid user-blocking pauses. */
|
|
548
|
+
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
549
|
+
/** Planning policy for the turn. standard lets the assistant use internal planning and optionally expose progress; review_required always creates a user-reviewed plan before execution. */
|
|
550
|
+
"planningPolicy"?: "standard" | "review_required";
|
|
551
|
+
/** Per-turn approval policy. default requires approval for side-effecting tool calls, auto_review uses conditional safe auto-review, and full skips normal approval gates. */
|
|
552
|
+
"permissions"?: "default" | "auto_review" | "full";
|
|
553
|
+
/** Optional per-tool approval policy overrides. Runtime sanitizes keys and enum values before persisting them. */
|
|
554
|
+
"toolPermissions"?: Record<string, "default" | "auto_review" | "full">;
|
|
555
|
+
/** Optional allowlist of operational tool names for this turn. Omit to allow the gateway default surface; pass an empty array to admit no tools for direct-answer turns. */
|
|
556
|
+
"toolNames"?: Array<string>;
|
|
557
|
+
/** Optional registry plugin ids attached to this assistant turn. */
|
|
558
|
+
"pluginIds"?: Array<string>;
|
|
559
|
+
/** Optional per-turn backend performance debugger. When true, payload build timing traces are persisted into assistant report artifacts, and local/test runtimes may persist hidden model-call snapshots for this turn. */
|
|
560
|
+
"performanceDebugger"?: boolean;
|
|
561
|
+
}
|
|
562
|
+
interface StorageFolderInput {
|
|
563
|
+
/** Folder name. */
|
|
564
|
+
"name": string;
|
|
565
|
+
/** Parent folder id. Omit for root. */
|
|
566
|
+
"parentStorageEntryId"?: string;
|
|
567
|
+
/** Optional provider config id for root-level folders. Omit for the internal/default provider. Ignored when parentStorageEntryId is provided. */
|
|
568
|
+
"storageProviderConfigId"?: string;
|
|
569
|
+
/** Folder metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
570
|
+
"metadata"?: Record<string, unknown>;
|
|
571
|
+
/** Optional external reference id. */
|
|
572
|
+
"refId"?: string;
|
|
573
|
+
/** Optional external reference type. */
|
|
574
|
+
"refType"?: string;
|
|
575
|
+
/** Optional external reference version. */
|
|
576
|
+
"refVer"?: number;
|
|
577
|
+
/** Whether this folder is restricted to the provided users/groups. */
|
|
578
|
+
"restricted"?: boolean;
|
|
579
|
+
/** Explicit allowed group ids when restricted. */
|
|
580
|
+
"groups"?: Array<string>;
|
|
581
|
+
/** Explicit allowed user ids when restricted. */
|
|
582
|
+
"users"?: Array<string>;
|
|
583
|
+
}
|
|
584
|
+
interface StorageUploadSessionInput {
|
|
585
|
+
/** Retention for the finalized file. Duration starts at finalization; null means no expiration. */
|
|
586
|
+
"retention"?: SwaggerStorageRetentionDto | null;
|
|
587
|
+
/** Parent folder id. Required for create mode when uploading into a folder. */
|
|
588
|
+
"parentStorageEntryId"?: string;
|
|
589
|
+
/** Optional provider config id for root-level uploads. Omit for the internal/default provider. Ignored when parentStorageEntryId is provided or when replacing an existing file. */
|
|
590
|
+
"storageProviderConfigId"?: string;
|
|
591
|
+
/** Existing storage entry id to replace instead of creating a new file. */
|
|
592
|
+
"replaceStorageEntryId"?: string;
|
|
593
|
+
/** Expected current version of the file being replaced. The upload is rejected if the file changed after overwrite confirmation. */
|
|
594
|
+
"replaceExpectedVersion"?: number;
|
|
595
|
+
/** File name. Required for create mode. */
|
|
596
|
+
"name"?: string;
|
|
597
|
+
/** Expected content type. */
|
|
598
|
+
"contentTypeHint"?: string;
|
|
599
|
+
/** Expected size in bytes. */
|
|
600
|
+
"sizeHint"?: number;
|
|
601
|
+
/** Logical storage lifecycle tier. Select only when creating a new file or upload session; existing files keep their tier.
|
|
602
|
+
HOT: Active files used in live workflows, previews, and frequent downloads.
|
|
603
|
+
WARM: Completed or less-active business files that are still occasionally accessed.
|
|
604
|
+
COLD: Compliance snapshots, historic imports, and retained evidence that is rarely opened.
|
|
605
|
+
FROZEN: Deep archive or legal-hold data kept mainly for audit or recovery obligations. */
|
|
606
|
+
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
607
|
+
/** Upload mode. Use "direct" for provider resumable uploads, "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. */
|
|
608
|
+
"uploadMode"?: "direct" | "chunked" | "incremental";
|
|
609
|
+
/** Default post-finalize compute mode for this upload session. */
|
|
610
|
+
"computeStats"?: "none" | "sync" | "async";
|
|
611
|
+
/** File metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
612
|
+
"metadata"?: Record<string, unknown>;
|
|
613
|
+
/** Optional external reference id. */
|
|
614
|
+
"refId"?: string;
|
|
615
|
+
/** Optional external reference type. */
|
|
616
|
+
"refType"?: string;
|
|
617
|
+
/** Optional external reference version. */
|
|
618
|
+
"refVer"?: number;
|
|
619
|
+
/** Whether the finalized entry should be restricted. */
|
|
620
|
+
"restricted"?: boolean;
|
|
621
|
+
/** Explicit allowed group ids for the finalized entry. */
|
|
622
|
+
"groups"?: Array<string>;
|
|
623
|
+
/** Explicit allowed user ids for the finalized entry. */
|
|
624
|
+
"users"?: Array<string>;
|
|
625
|
+
}
|
|
626
|
+
interface StorageUploadSessionFinalizeInput {
|
|
627
|
+
/** Optional metadata replacement at finalize time. Top-level keys starting with "__" are reserved for backend use. */
|
|
628
|
+
"metadata"?: Record<string, unknown>;
|
|
629
|
+
/** Optional post-finalize compute mode. */
|
|
630
|
+
"computeStats"?: "none" | "sync" | "async";
|
|
631
|
+
}
|
|
632
|
+
interface AssistantForkMessageInput {
|
|
633
|
+
/** Optional assistant runtime API version for the forked thread. v1 is expired and rejected. */
|
|
634
|
+
"version"?: "v1" | "v2";
|
|
635
|
+
/** Optional explicit title for the forked thread. When omitted, orchestration will generate the new thread title. */
|
|
636
|
+
"title"?: string;
|
|
637
|
+
}
|
|
638
|
+
interface StorageEntryMoveInput {
|
|
639
|
+
/** Destination parent folder id. Omit or pass null for root. */
|
|
640
|
+
"parentStorageEntryId"?: string;
|
|
641
|
+
/** Optional destination provider config id for root-level moves. Omit for the internal/default provider. Ignored when parentStorageEntryId is provided. */
|
|
642
|
+
"storageProviderConfigId"?: string;
|
|
643
|
+
/** Current entity version. */
|
|
644
|
+
"version"?: number;
|
|
645
|
+
}
|
|
646
|
+
interface StoragePutObjectInput {
|
|
647
|
+
/** File retention. Omit for the caller default, or set null for no expiration. */
|
|
648
|
+
"retention"?: SwaggerStorageRetentionDto | null;
|
|
649
|
+
/** Parent folder id. Omit for root. */
|
|
650
|
+
"parentStorageEntryId"?: string;
|
|
651
|
+
/** Optional provider config id for root-level writes. */
|
|
652
|
+
"storageProviderConfigId"?: string;
|
|
653
|
+
/** Existing file entry id to replace. */
|
|
654
|
+
"replaceStorageEntryId"?: string;
|
|
655
|
+
/** Object name. */
|
|
656
|
+
"name": string;
|
|
657
|
+
/** Object payload. For binary payloads send a base64 string and set dataEncoding to "base64". */
|
|
658
|
+
"data": string | Array<string>;
|
|
659
|
+
/** Payload encoding. */
|
|
660
|
+
"dataEncoding"?: "utf8" | "base64";
|
|
661
|
+
/** Mime type of the object. */
|
|
662
|
+
"mimeType"?: string;
|
|
663
|
+
/** Optional post-write compute mode. */
|
|
664
|
+
"computeStats"?: "none" | "sync" | "async";
|
|
665
|
+
/** Whether the finalized entry should be restricted. */
|
|
666
|
+
"restricted"?: boolean;
|
|
667
|
+
/** Explicit allowed group ids. */
|
|
668
|
+
"groups"?: Array<string>;
|
|
669
|
+
/** Explicit allowed user ids. */
|
|
670
|
+
"users"?: Array<string>;
|
|
671
|
+
/** Optional external reference id. */
|
|
672
|
+
"refId"?: string;
|
|
673
|
+
/** Optional external reference type. */
|
|
674
|
+
"refType"?: string;
|
|
675
|
+
/** Optional external reference version. */
|
|
676
|
+
"refVer"?: number;
|
|
677
|
+
/** Entry metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
678
|
+
"metadata"?: Record<string, unknown>;
|
|
679
|
+
/** Logical storage lifecycle tier. Select only when creating a new file or upload session; existing files keep their tier.
|
|
680
|
+
HOT: Active files used in live workflows, previews, and frequent downloads.
|
|
681
|
+
WARM: Completed or less-active business files that are still occasionally accessed.
|
|
682
|
+
COLD: Compliance snapshots, historic imports, and retained evidence that is rarely opened.
|
|
683
|
+
FROZEN: Deep archive or legal-hold data kept mainly for audit or recovery obligations. */
|
|
684
|
+
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
685
|
+
}
|
|
686
|
+
interface AssistantActionResolutionInput {
|
|
687
|
+
/** Resolution decision for the pending action. */
|
|
688
|
+
"decision": "approve" | "approve_all_for_turn" | "reject" | "submit";
|
|
689
|
+
/** Optional approval item id when resolving one item from a multi-approval action. */
|
|
690
|
+
"actionItemId"?: string;
|
|
691
|
+
/** Optional free-text response for clarification or correction context. */
|
|
692
|
+
"responseText"?: string;
|
|
693
|
+
/** Optional structured payload for clarification answers or action metadata. */
|
|
694
|
+
"responsePayload"?: Record<string, unknown>;
|
|
695
|
+
/** 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. */
|
|
696
|
+
"backgroundProcessing"?: boolean;
|
|
697
|
+
/** Optional assistant model override for the resumed turn after this action is resolved. */
|
|
698
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna" | "gpt-5.4-nano";
|
|
699
|
+
/** Optional assistant reasoning effort override for the resumed turn: low, medium, high, or xhigh. */
|
|
700
|
+
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
701
|
+
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
702
|
+
"reasoning"?: "low" | "medium" | "high" | "xhigh";
|
|
703
|
+
/** Execution mode override for the resumed turn after this action is resolved. */
|
|
704
|
+
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
705
|
+
/** Planning policy override for the resumed turn after this action is resolved. */
|
|
706
|
+
"planningPolicy"?: "standard" | "review_required";
|
|
707
|
+
/** Optional operational tool names admitted for the resumed turn. Omit to keep the current thread admission; pass an empty array to admit no tools for direct-answer continuation. */
|
|
708
|
+
"toolNames"?: Array<string>;
|
|
709
|
+
/** Optional additional registry plugin ids attached to the resumed turn. */
|
|
710
|
+
"pluginIds"?: Array<string>;
|
|
711
|
+
}
|
|
712
|
+
interface StorageRestoreInput {
|
|
713
|
+
/** Current entity version. */
|
|
714
|
+
"version": number;
|
|
715
|
+
/** Required for TTL-expired entries. Use null to restore without another expiration. */
|
|
716
|
+
"retention"?: SwaggerStorageRetentionDto | null;
|
|
717
|
+
}
|
|
718
|
+
interface AgentRunInput {
|
|
719
|
+
/** Instruction or mission passed to the root agent run. */
|
|
720
|
+
"instruction": string;
|
|
721
|
+
/** Optional trigger type such as REQUEST, EVENT, or SCHEDULE. */
|
|
722
|
+
"triggerType"?: string;
|
|
723
|
+
/** Optional external reference type for correlation. */
|
|
724
|
+
"triggerRefType"?: string;
|
|
725
|
+
/** Optional external reference id for correlation. */
|
|
726
|
+
"triggerRefId"?: string;
|
|
727
|
+
/** Optional delay before the first tick is scheduled. */
|
|
728
|
+
"delaySeconds"?: number;
|
|
729
|
+
/** Optional run-scoped state merged into the initial supervisor state. */
|
|
730
|
+
"state"?: Record<string, unknown>;
|
|
731
|
+
/** Optional registry plugin ids attached for this run. */
|
|
732
|
+
"pluginIds"?: Array<string>;
|
|
733
|
+
}
|
|
734
|
+
interface StorageVersionInput {
|
|
735
|
+
/** Current entity version. */
|
|
736
|
+
"version": number;
|
|
737
|
+
}
|
|
738
|
+
interface AgentUpdateInput {
|
|
739
|
+
/** Updated display name of the agent. */
|
|
740
|
+
"name"?: string;
|
|
741
|
+
/** Updated operator-facing description. */
|
|
742
|
+
"desc"?: string;
|
|
743
|
+
/** Optional status transition, for example ACTIVE or PAUSED. */
|
|
744
|
+
"status"?: "ACTIVE" | "PAUSED" | "DISABLED";
|
|
745
|
+
/** Replacement service-account execution principal. */
|
|
746
|
+
"serviceAccountUserId"?: string;
|
|
747
|
+
/** Updated owner id. */
|
|
748
|
+
"ownerId"?: string;
|
|
749
|
+
/** Updated owner type. */
|
|
750
|
+
"ownerType"?: string;
|
|
751
|
+
/** Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
752
|
+
"metadata"?: Record<string, unknown>;
|
|
753
|
+
/** Replacement persisted agent identity and runtime defaults. Fast-path routing, prompt tier, and per-turn telemetry stay runtime-derived. */
|
|
754
|
+
"config"?: SwaggerAgentConfigDto;
|
|
755
|
+
/** Replacement persisted policy constraints. Execution-time route metadata stays derived from the current turn. */
|
|
756
|
+
"policy"?: SwaggerAgentPolicyDto;
|
|
757
|
+
/** Optimistic locking version. */
|
|
758
|
+
"version"?: number;
|
|
759
|
+
}
|
|
760
|
+
interface AgentInboxItemUpdateInput {
|
|
761
|
+
/** Logical task type such as task, incident, sync, or concierge_message. */
|
|
762
|
+
"type"?: string;
|
|
763
|
+
/** Instruction that will be passed into the agent run when the item is claimed. */
|
|
764
|
+
"instruction"?: string;
|
|
765
|
+
/** Opaque task payload persisted with the inbox item and copied into the run state. */
|
|
766
|
+
"payload"?: Record<string, unknown>;
|
|
767
|
+
/** Queue priority. Higher values are claimed first. */
|
|
768
|
+
"priority"?: number;
|
|
769
|
+
/** Optional ISO timestamp after which the inbox item becomes claimable. */
|
|
770
|
+
"availableAt"?: string;
|
|
771
|
+
/** Optional de-duplication key unique per agent among non-terminal inbox items. */
|
|
772
|
+
"dedupeKey"?: string;
|
|
773
|
+
}
|
|
774
|
+
interface DatabaseUpdateInput {
|
|
775
|
+
/** Enable or disable future row audit capture for the logical table. */
|
|
776
|
+
"audit"?: boolean;
|
|
777
|
+
/** Name. */
|
|
778
|
+
"name"?: string;
|
|
779
|
+
/** Category. */
|
|
780
|
+
"category"?: string;
|
|
781
|
+
/** Description. */
|
|
782
|
+
"desc"?: string;
|
|
783
|
+
/** Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
784
|
+
"metadata"?: Record<string, unknown>;
|
|
785
|
+
/** Provide if access should be restricted. */
|
|
786
|
+
"restricted"?: boolean;
|
|
787
|
+
/** Provide which groups should have access to it, once restricted is true. */
|
|
788
|
+
"groups"?: Array<string>;
|
|
789
|
+
/** Provide which users should have access to it, once restricted is true. */
|
|
790
|
+
"users"?: Array<string>;
|
|
791
|
+
/** Database definitions. */
|
|
792
|
+
"definition"?: Array<SwaggerDatabaseDefinition>;
|
|
793
|
+
/** Provide current version. */
|
|
794
|
+
"version": number;
|
|
795
|
+
}
|
|
796
|
+
interface StorageEntryUpdateInput {
|
|
797
|
+
/** Replacement file retention. Omit to preserve, or set null to clear expiration. */
|
|
798
|
+
"retention"?: SwaggerStorageRetentionDto | null;
|
|
799
|
+
/** New display name. */
|
|
800
|
+
"name"?: string;
|
|
801
|
+
/** Metadata replacement. Top-level keys starting with "__" are reserved for backend use. */
|
|
802
|
+
"metadata"?: Record<string, unknown>;
|
|
803
|
+
/** Whether this entry is restricted to the provided users/groups. */
|
|
804
|
+
"restricted"?: boolean;
|
|
805
|
+
/** Explicit allowed group ids. */
|
|
806
|
+
"groups"?: Array<string>;
|
|
807
|
+
/** Explicit allowed user ids. */
|
|
808
|
+
"users"?: Array<string>;
|
|
809
|
+
/** Current entity version. */
|
|
810
|
+
"version"?: number;
|
|
811
|
+
}
|
|
812
|
+
interface AssistantThreadGoalInput {
|
|
813
|
+
/** Durable thread-level objective used to validate assistant completion across turns, tool loops, approval resumes, and compaction. */
|
|
814
|
+
"objective": string;
|
|
815
|
+
/** Optional concrete criteria the goal reviewer should require before marking the goal satisfied. */
|
|
816
|
+
"successCriteria"?: Array<string>;
|
|
817
|
+
/** Optional exclusions that should not be treated as required work for this goal. */
|
|
818
|
+
"nonGoals"?: Array<string>;
|
|
819
|
+
/** Optional evidence the reviewer should expect, such as tests, lint, screenshots, API results, or changed resources. */
|
|
820
|
+
"requiredEvidence"?: Array<string>;
|
|
821
|
+
/** Optional validation commands or checks relevant to this goal. */
|
|
822
|
+
"validationCommands"?: Array<string>;
|
|
823
|
+
/** Optional concise definition of done used by the reviewer when evaluating candidate completion. */
|
|
824
|
+
"doneDefinition"?: string;
|
|
825
|
+
}
|
|
826
|
+
interface AssistantThreadTitleInput {
|
|
827
|
+
/** New user-defined title for the thread. */
|
|
828
|
+
"title": string;
|
|
829
|
+
}
|
|
830
|
+
interface StorageUploadPartInput {
|
|
831
|
+
/** Part payload. Use base64 for binary payloads. */
|
|
832
|
+
"data": string | Array<string>;
|
|
833
|
+
/** Payload encoding. */
|
|
834
|
+
"dataEncoding"?: "utf8" | "base64";
|
|
835
|
+
}
|
|
836
|
+
interface WebhookInput {
|
|
837
|
+
/** Optional Id of webhook. */
|
|
838
|
+
"customId"?: string;
|
|
839
|
+
/** Creator of event will be set as System not requester. */
|
|
840
|
+
"system"?: boolean;
|
|
841
|
+
/** Mark if proxy should be used with static outbound IP. */
|
|
842
|
+
"proxy"?: boolean;
|
|
843
|
+
/** Save entire request. */
|
|
844
|
+
"saveDetails"?: boolean;
|
|
845
|
+
/** Max attempts. */
|
|
846
|
+
"maxAttempts"?: number;
|
|
847
|
+
/** Provide data */
|
|
848
|
+
"request"?: SwaggerWebhookRequestDetailsDto;
|
|
849
|
+
/** Mask request details. */
|
|
850
|
+
"maskDetails"?: Array<string>;
|
|
851
|
+
/** Override creator. */
|
|
852
|
+
"createdBy"?: string;
|
|
853
|
+
/** Optional key/value metadata for grouping and querying webhooks. Top-level keys starting with "__" are reserved for backend use. */
|
|
854
|
+
"metadata"?: Record<string, unknown>;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* Canonical public low-code API declarations shared by Monaco and local editors.
|
|
858
|
+
* Lifecycle input DTOs are generated from Swagger in api.swagger-contracts.generated.d.ts.
|
|
859
|
+
* Edit this file for model guidance, then regenerate api.monaco.ts.
|
|
860
|
+
*/
|
|
861
|
+
/**
|
|
862
|
+
* Supported database column types used by schema metadata and casts.
|
|
863
|
+
*/
|
|
864
|
+
type DatabaseDefinitionType = 'SMALLINT' | 'INTEGER' | 'BIGINT' | 'REAL' | 'DOUBLE PRECISION' | 'NUMERIC' | 'JSON' | 'JSONB' | 'TEXT' | 'UUID' | 'DATE' | 'TIME' | 'TIMETZ' | 'TIMESTAMP' | 'TIMESTAMPTZ' | 'BOOLEAN';
|
|
865
|
+
/**
|
|
866
|
+
* Logical filter value types used by operator validation.
|
|
867
|
+
*/
|
|
868
|
+
type ValueType = 'number' | 'text' | 'uuid' | 'date' | 'datetime' | 'time' | 'boolean' | 'json';
|
|
869
|
+
/**
|
|
870
|
+
* Sort direction accepted by object-based sort definitions.
|
|
871
|
+
*/
|
|
872
|
+
type SortDir = 'ASC' | 'DESC' | 'asc' | 'desc';
|
|
873
|
+
type JoinType = 'left' | 'inner';
|
|
874
|
+
type ExecutionTargetType = 'JOB_TEMPLATE' | 'AGENT' | (string & {});
|
|
875
|
+
/**
|
|
876
|
+
* Supported payload validator types for util.validate().
|
|
877
|
+
*/
|
|
878
|
+
type ValidatorType = 'string' | 'number' | 'boolean' | 'object' | 'array' | 'date' | 'any';
|
|
879
|
+
interface ValidatorProperty {
|
|
880
|
+
type: ValidatorType;
|
|
881
|
+
required?: boolean;
|
|
882
|
+
regex?: string;
|
|
883
|
+
min?: number;
|
|
884
|
+
max?: number;
|
|
885
|
+
objectSchema?: ValidatorObject[];
|
|
886
|
+
arraySchema?: ValidatorProperty;
|
|
887
|
+
}
|
|
888
|
+
interface ValidatorObject {
|
|
889
|
+
property: string;
|
|
890
|
+
schema: ValidatorProperty;
|
|
891
|
+
}
|
|
892
|
+
interface ValidatorSchemaInput {
|
|
893
|
+
whitelist?: boolean;
|
|
894
|
+
whitelistErrors?: boolean;
|
|
895
|
+
schema: ValidatorProperty;
|
|
896
|
+
}
|
|
897
|
+
interface ValidationResult<T = any> {
|
|
898
|
+
valid: boolean;
|
|
899
|
+
errors: string[];
|
|
900
|
+
value: T;
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* Allowed SQL functions for safe dynamic selects and expressions.
|
|
904
|
+
*/
|
|
905
|
+
type RawAllowedFn = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'LOWER' | 'UPPER' | 'TRIM' | 'LENGTH' | 'COALESCE' | 'NULLIF' | 'ROUND' | 'ABS' | 'GREATEST' | 'LEAST' | 'JSONB_BUILD_OBJECT' | 'JSONB_AGG' | 'ARRAY_AGG' | 'NOW' | 'DATE_TRUNC';
|
|
906
|
+
/**
|
|
907
|
+
* Canonical filter operators supported by the ORM.
|
|
908
|
+
*/
|
|
909
|
+
type FilterOp = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'notLike' | 'ilike' | 'notILike' | 'in' | 'notIn' | 'any' | 'isNull' | 'isNotNull' | 'between' | 'contains' | 'containedBy' | 'arrayHas' | 'arrayHasAny' | 'arrayHasAll' | 'arrayContainedBy' | 'jsonArrayHas' | 'jsonArrayHasAny' | 'jsonArrayHasAll' | 'startsWith' | 'endsWith' | 'true' | 'false';
|
|
910
|
+
/**
|
|
911
|
+
* Primitive parameter values that can be safely bound to SQL placeholders.
|
|
912
|
+
*/
|
|
913
|
+
type SqlPrimitive = string | number | boolean | Date | null;
|
|
914
|
+
/**
|
|
915
|
+
* Reusable SQL-safe expression building block.
|
|
916
|
+
* Used inside select items, function args, raw placeholders, joins, casts and case statements.
|
|
917
|
+
*/
|
|
918
|
+
type SelectExpr = string | {
|
|
919
|
+
field: string;
|
|
920
|
+
castAs?: DatabaseDefinitionType;
|
|
921
|
+
} | {
|
|
922
|
+
value: SqlPrimitive | Record<string, any> | any[];
|
|
923
|
+
} | {
|
|
924
|
+
fn: RawAllowedFn;
|
|
925
|
+
args?: SelectExpr[];
|
|
926
|
+
distinct?: boolean;
|
|
927
|
+
} | {
|
|
928
|
+
cast: SelectExpr;
|
|
929
|
+
asType: DatabaseDefinitionType;
|
|
930
|
+
} | {
|
|
931
|
+
coalesce: SelectExpr[];
|
|
932
|
+
} | {
|
|
933
|
+
raw: string;
|
|
934
|
+
args?: SelectExpr[];
|
|
935
|
+
} | {
|
|
936
|
+
case: {
|
|
937
|
+
when: {
|
|
938
|
+
if: SelectFilterNode | SelectFilterNode[];
|
|
939
|
+
then: SelectExpr;
|
|
940
|
+
}[];
|
|
941
|
+
else?: SelectExpr;
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
/**
|
|
945
|
+
* Leaf filter node.
|
|
946
|
+
* Use either op/value form or shorthand operator properties.
|
|
947
|
+
*/
|
|
948
|
+
interface SelectFieldFilter {
|
|
949
|
+
field: string;
|
|
950
|
+
op?: FilterOp;
|
|
951
|
+
value?: any;
|
|
952
|
+
values?: any[];
|
|
953
|
+
castAs?: DatabaseDefinitionType;
|
|
954
|
+
filterType?: ValueType;
|
|
955
|
+
path?: Array<string | number>;
|
|
956
|
+
eq?: any;
|
|
957
|
+
ne?: any;
|
|
958
|
+
gt?: any;
|
|
959
|
+
gte?: any;
|
|
960
|
+
lt?: any;
|
|
961
|
+
lte?: any;
|
|
962
|
+
like?: any;
|
|
963
|
+
notLike?: any;
|
|
964
|
+
ilike?: any;
|
|
965
|
+
notILike?: any;
|
|
966
|
+
in?: any[];
|
|
967
|
+
notIn?: any[];
|
|
968
|
+
any?: any[];
|
|
969
|
+
isNull?: boolean;
|
|
970
|
+
isNotNull?: boolean;
|
|
971
|
+
between?: [
|
|
972
|
+
any,
|
|
973
|
+
any
|
|
974
|
+
];
|
|
975
|
+
contains?: any;
|
|
976
|
+
containedBy?: any;
|
|
977
|
+
arrayHas?: any;
|
|
978
|
+
arrayHasAny?: any[];
|
|
979
|
+
arrayHasAll?: any[];
|
|
980
|
+
arrayContainedBy?: any[];
|
|
981
|
+
jsonArrayHas?: any;
|
|
982
|
+
jsonArrayHasAny?: any[];
|
|
983
|
+
jsonArrayHasAll?: any[];
|
|
984
|
+
startsWith?: any;
|
|
985
|
+
endsWith?: any;
|
|
986
|
+
true?: boolean;
|
|
987
|
+
false?: boolean;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* Boolean AND group.
|
|
991
|
+
*/
|
|
992
|
+
interface SelectFilterAnd {
|
|
993
|
+
and: SelectFilterNode[];
|
|
994
|
+
}
|
|
995
|
+
/**
|
|
996
|
+
* Boolean OR group.
|
|
997
|
+
*/
|
|
998
|
+
interface SelectFilterOr {
|
|
999
|
+
or: SelectFilterNode[];
|
|
1000
|
+
}
|
|
1001
|
+
/**
|
|
1002
|
+
* Boolean NOT group.
|
|
1003
|
+
*/
|
|
1004
|
+
interface SelectFilterNot {
|
|
1005
|
+
not: SelectFilterNode | SelectFilterNode[];
|
|
1006
|
+
}
|
|
1007
|
+
/**
|
|
1008
|
+
* Recursive filter tree.
|
|
1009
|
+
* Nest groups instead of writing SQL parentheses manually.
|
|
1010
|
+
*/
|
|
1011
|
+
type SelectFilterNode = SelectFieldFilter | SelectFilterAnd | SelectFilterOr | SelectFilterNot | SelectFilterNode[];
|
|
1012
|
+
/**
|
|
1013
|
+
* Supported select item shapes.
|
|
1014
|
+
* Use plain fields for direct columns and fn/raw/cast/coalesce/case for computed output fields.
|
|
1015
|
+
*/
|
|
1016
|
+
type SelectItem = string | {
|
|
1017
|
+
field: string;
|
|
1018
|
+
as?: string;
|
|
1019
|
+
castAs?: DatabaseDefinitionType;
|
|
1020
|
+
distinct?: boolean;
|
|
1021
|
+
filterType?: ValueType;
|
|
1022
|
+
} | {
|
|
1023
|
+
fn: RawAllowedFn;
|
|
1024
|
+
args?: SelectExpr[];
|
|
1025
|
+
distinct?: boolean;
|
|
1026
|
+
as?: string;
|
|
1027
|
+
filterType?: ValueType;
|
|
1028
|
+
} | {
|
|
1029
|
+
raw: string;
|
|
1030
|
+
args?: SelectExpr[];
|
|
1031
|
+
as?: string;
|
|
1032
|
+
filterType?: ValueType;
|
|
1033
|
+
} | {
|
|
1034
|
+
cast: SelectExpr;
|
|
1035
|
+
asType: DatabaseDefinitionType;
|
|
1036
|
+
as?: string;
|
|
1037
|
+
filterType?: ValueType;
|
|
1038
|
+
} | {
|
|
1039
|
+
coalesce: SelectExpr[];
|
|
1040
|
+
as?: string;
|
|
1041
|
+
filterType?: ValueType;
|
|
1042
|
+
} | {
|
|
1043
|
+
case: {
|
|
1044
|
+
when: {
|
|
1045
|
+
if: SelectFilterNode | SelectFilterNode[];
|
|
1046
|
+
then: SelectExpr;
|
|
1047
|
+
}[];
|
|
1048
|
+
else?: SelectExpr;
|
|
1049
|
+
};
|
|
1050
|
+
as?: string;
|
|
1051
|
+
filterType?: ValueType;
|
|
1052
|
+
};
|
|
1053
|
+
/**
|
|
1054
|
+
* Join condition.
|
|
1055
|
+
* Unqualified left operands are resolved against the root table first.
|
|
1056
|
+
* Unqualified right operands are resolved against the join table first.
|
|
1057
|
+
*/
|
|
1058
|
+
interface SelectJoinOn {
|
|
1059
|
+
left: string | SelectExpr;
|
|
1060
|
+
op?: '=' | '<>' | '!=' | '>' | '>=' | '<' | '<=';
|
|
1061
|
+
right: string | SelectExpr;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* Join definition.
|
|
1065
|
+
* If alias is omitted, the backend defaults it to the join table name.
|
|
1066
|
+
*/
|
|
1067
|
+
interface SelectJoin {
|
|
1068
|
+
alias?: string;
|
|
1069
|
+
table: string;
|
|
1070
|
+
type?: JoinType;
|
|
1071
|
+
on: SelectJoinOn[];
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Public structured input accepted by api.getDatabaseData(name, options).
|
|
1075
|
+
* The backend injects the source table schema automatically based on the name argument.
|
|
1076
|
+
*/
|
|
1077
|
+
interface SelectInput {
|
|
1078
|
+
/**
|
|
1079
|
+
* Selected output columns and computed fields.
|
|
1080
|
+
* If omitted, the ORM selects all root-table columns by default.
|
|
1081
|
+
*/
|
|
1082
|
+
fields?: SelectItem[];
|
|
1083
|
+
/**
|
|
1084
|
+
* Related tables to join.
|
|
1085
|
+
* The backend resolves join definitions automatically.
|
|
1086
|
+
*/
|
|
1087
|
+
joins?: SelectJoin[];
|
|
1088
|
+
/**
|
|
1089
|
+
* Recursive filter tree.
|
|
1090
|
+
* Example:
|
|
1091
|
+
* { and: [{ field: 'status', op: 'eq', value: 'active' }] }
|
|
1092
|
+
*/
|
|
1093
|
+
filter?: SelectFilterNode;
|
|
1094
|
+
/**
|
|
1095
|
+
* Sort definition.
|
|
1096
|
+
* Array form supports '-field' for descending order.
|
|
1097
|
+
*/
|
|
1098
|
+
sort?: string[] | Record<string, SortDir>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Fields to use in GROUP BY when aggregate fields are selected.
|
|
1101
|
+
*/
|
|
1102
|
+
groupBy?: string[];
|
|
1103
|
+
/**
|
|
1104
|
+
* Optional global cast overrides by field path.
|
|
1105
|
+
*/
|
|
1106
|
+
cast?: Record<string, DatabaseDefinitionType>;
|
|
1107
|
+
/**
|
|
1108
|
+
* Maximum number of rows to return.
|
|
1109
|
+
* The backend fetches one extra row internally to determine next-page availability.
|
|
1110
|
+
*/
|
|
1111
|
+
take?: number;
|
|
1112
|
+
/**
|
|
1113
|
+
* Number of rows to skip.
|
|
1114
|
+
*/
|
|
1115
|
+
skip?: number;
|
|
1116
|
+
/**
|
|
1117
|
+
* Reserved count flag for extended query flows.
|
|
1118
|
+
*/
|
|
1119
|
+
count?: boolean;
|
|
1120
|
+
}
|
|
1121
|
+
/**
|
|
1122
|
+
* Advanced structured selector for bulk database mutations.
|
|
1123
|
+
* Legacy field-key filters such as `{ status: { equals: 'NEW' } }` are not accepted.
|
|
1124
|
+
*/
|
|
1125
|
+
interface DatabaseMutationRequest {
|
|
1126
|
+
filter: SelectFilterNode;
|
|
1127
|
+
joins?: SelectJoin[];
|
|
1128
|
+
take?: number;
|
|
1129
|
+
skip?: number;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* Normal data response returned by the ORM query execution layer.
|
|
1133
|
+
*/
|
|
1134
|
+
interface GetDatabaseDataResponse<T = any> {
|
|
1135
|
+
data: T[];
|
|
1136
|
+
results: number;
|
|
1137
|
+
next: boolean;
|
|
1138
|
+
total?: number;
|
|
1139
|
+
cache?: any;
|
|
1140
|
+
}
|
|
1141
|
+
interface BufferConstructor {
|
|
1142
|
+
new (arg: number | string | number[] | string[] | ArrayBuffer | Uint8Array | Record<string, unknown>, encoding?: 'utf-8' | 'utf8'): Buffer;
|
|
1143
|
+
from(input: number | string | number[] | string[] | ArrayBuffer | Uint8Array | Record<string, unknown>, encodingOrOffset?: 'utf-8' | 'utf8' | number, length?: number): Buffer;
|
|
1144
|
+
alloc(size: number): Buffer;
|
|
1145
|
+
allocUnsafe(size: number): Buffer;
|
|
1146
|
+
byteLength(input: string | number | boolean | null | undefined, encoding?: 'utf-8' | 'utf8'): number;
|
|
1147
|
+
}
|
|
1148
|
+
/**
|
|
1149
|
+
* Minimal UTF-8 Buffer compatibility exposed by the isolated V8 runtime.
|
|
1150
|
+
*
|
|
1151
|
+
* This is not the full Node.js Buffer API. For base64, base64url, hex,
|
|
1152
|
+
* hashing, signatures, or random bytes, prefer the matching util.* helper.
|
|
1153
|
+
*/
|
|
1154
|
+
interface Buffer extends Uint8Array {
|
|
1155
|
+
toString(encoding?: 'utf-8' | 'utf8'): string;
|
|
1156
|
+
inspect(): string;
|
|
1157
|
+
}
|
|
1158
|
+
declare var Buffer: BufferConstructor;
|
|
1159
|
+
interface LooseObject<T> {
|
|
1160
|
+
[key: string]: T;
|
|
1161
|
+
}
|
|
1162
|
+
interface DatabaseDefinition {
|
|
1163
|
+
databaseDefinitionId?: string;
|
|
1164
|
+
name: string;
|
|
1165
|
+
desc: string | null;
|
|
1166
|
+
type: 'SMALLINT' | 'INTEGER' | 'BIGINT' | 'REAL' | 'DOUBLE PRECISION' | 'NUMERIC' | 'JSON' | 'JSONB' | 'TEXT' | 'TIME' | 'DATE' | 'TIMETZ' | 'TIMESTAMP' | 'TIMESTAMPTZ' | 'BOOLEAN';
|
|
1167
|
+
isPrimaryKey: boolean;
|
|
1168
|
+
isArray: boolean;
|
|
1169
|
+
isUnique: boolean;
|
|
1170
|
+
isNullable: boolean;
|
|
1171
|
+
isIndex: boolean;
|
|
1172
|
+
default: string | boolean | number | null;
|
|
1173
|
+
foreignReferences?: SwaggerDatabaseDefinitionForeignReferences[] | null;
|
|
1174
|
+
}
|
|
1175
|
+
interface Database extends BaseProperties {
|
|
1176
|
+
databaseId?: string;
|
|
1177
|
+
name: string;
|
|
1178
|
+
category: string | null;
|
|
1179
|
+
desc: string | null;
|
|
1180
|
+
restricted: boolean;
|
|
1181
|
+
audit: boolean;
|
|
1182
|
+
groups: string[];
|
|
1183
|
+
users: string[];
|
|
1184
|
+
type: string;
|
|
1185
|
+
definition: DatabaseDefinition[];
|
|
1186
|
+
size?: {
|
|
1187
|
+
total: number;
|
|
1188
|
+
table: number;
|
|
1189
|
+
indexes: number;
|
|
1190
|
+
relations: number;
|
|
1191
|
+
};
|
|
1192
|
+
}
|
|
1193
|
+
type DatabaseAuditOperation = 'INSERT' | 'UPDATE' | 'DELETE';
|
|
1194
|
+
/**
|
|
1195
|
+
* Newest-first audit-history query. The default response contains metadata and
|
|
1196
|
+
* changedFields only. To return payload data, request explicit paths in fields:
|
|
1197
|
+
* e.g. ['snapshot.manufacturer', 'changes.manufacturer']. A requested path enables
|
|
1198
|
+
* its snapshot/changes root automatically; if that path is absent on a historical
|
|
1199
|
+
* row, its returned value is null rather than an error.
|
|
1200
|
+
*
|
|
1201
|
+
* changed matches events where any supplied top-level field is present in
|
|
1202
|
+
* changedFields. filter is a safe, parameterized tree restricted to snapshot.* and
|
|
1203
|
+
* changes.* paths. Example: { field: 'snapshot.manufacturer', op: 'eq', value: 'TRW' }.
|
|
1204
|
+
* Use snapshot.* or changes.* only when the complete payload is genuinely required.
|
|
1205
|
+
*/
|
|
1206
|
+
interface DatabaseAuditQuery {
|
|
1207
|
+
take?: number;
|
|
1208
|
+
cursor?: string;
|
|
1209
|
+
operation?: DatabaseAuditOperation;
|
|
1210
|
+
createdBy?: string;
|
|
1211
|
+
operationId?: string;
|
|
1212
|
+
from?: string;
|
|
1213
|
+
to?: string;
|
|
1214
|
+
rowKey?: Record<string, any>;
|
|
1215
|
+
includeSnapshot?: boolean;
|
|
1216
|
+
includeChanges?: boolean;
|
|
1217
|
+
fields?: string[];
|
|
1218
|
+
changed?: string[];
|
|
1219
|
+
filter?: any;
|
|
1220
|
+
}
|
|
1221
|
+
interface DatabaseAuditChange {
|
|
1222
|
+
type: 'added' | 'updated' | 'removed';
|
|
1223
|
+
before?: any;
|
|
1224
|
+
after?: any;
|
|
1225
|
+
}
|
|
1226
|
+
interface DatabaseAuditListItem {
|
|
1227
|
+
databaseAuditId: string;
|
|
1228
|
+
databaseId: string;
|
|
1229
|
+
databaseVersion: number;
|
|
1230
|
+
operation: DatabaseAuditOperation;
|
|
1231
|
+
createdBy: string;
|
|
1232
|
+
operationId: string;
|
|
1233
|
+
createdAt: Date | string;
|
|
1234
|
+
rowKey: Record<string, any>;
|
|
1235
|
+
previousRowKey?: Record<string, any> | null;
|
|
1236
|
+
changedFields: string[];
|
|
1237
|
+
snapshot?: Record<string, any>;
|
|
1238
|
+
changes?: Record<string, DatabaseAuditChange | Record<string, any>>;
|
|
1239
|
+
}
|
|
1240
|
+
interface DatabaseAuditResponse {
|
|
1241
|
+
data: DatabaseAuditListItem[];
|
|
1242
|
+
nextCursor: string | null;
|
|
1243
|
+
}
|
|
1244
|
+
interface Webhook {
|
|
1245
|
+
webhookId: string;
|
|
1246
|
+
status: string;
|
|
1247
|
+
statusMessage: string;
|
|
1248
|
+
attempts: number;
|
|
1249
|
+
maxAttempts: number;
|
|
1250
|
+
request: LooseObject<any>;
|
|
1251
|
+
response: LooseObject<any>;
|
|
1252
|
+
createdBy: string;
|
|
1253
|
+
createdAt: Date;
|
|
1254
|
+
deletedBy?: string;
|
|
1255
|
+
deletedAt?: Date;
|
|
1256
|
+
}
|
|
1257
|
+
interface LogInterface {
|
|
1258
|
+
message: string;
|
|
1259
|
+
duration?: number;
|
|
1260
|
+
args?: LooseObject<any>;
|
|
1261
|
+
}
|
|
1262
|
+
interface TemplateFormData {
|
|
1263
|
+
key: string;
|
|
1264
|
+
value?: string;
|
|
1265
|
+
/** Storage entry to append as this multipart part. Use this instead of value for binary content. */
|
|
1266
|
+
storageEntryId?: string;
|
|
1267
|
+
/** Storage namespace for storageEntryId. Defaults to explorer. */
|
|
1268
|
+
storageNamespace?: string;
|
|
1269
|
+
options?: LooseObject<boolean | number | string>;
|
|
1270
|
+
}
|
|
1271
|
+
interface HttpStorageSourceRef {
|
|
1272
|
+
/** Existing Storage file whose bytes become the outbound HTTP request body. */
|
|
1273
|
+
storageEntryId: string;
|
|
1274
|
+
namespace?: string;
|
|
1275
|
+
}
|
|
1276
|
+
type HttpStorageTargetRef =
|
|
1277
|
+
/** Creates a new Storage entry and writes the complete HTTP response into it. */
|
|
1278
|
+
(Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> & {
|
|
1279
|
+
name: string;
|
|
1280
|
+
namespace?: string;
|
|
1281
|
+
})
|
|
1282
|
+
/** Replaces an existing Storage entry after the complete HTTP response is received. */
|
|
1283
|
+
| {
|
|
1284
|
+
storageEntryId: string;
|
|
1285
|
+
namespace?: string;
|
|
1286
|
+
replace: true;
|
|
1287
|
+
contentTypeHint?: string;
|
|
1288
|
+
computeStats?: 'none' | 'sync' | 'async';
|
|
1289
|
+
metadata?: LooseObject<any>;
|
|
1290
|
+
};
|
|
1291
|
+
interface HttpRequestOptionsInterface {
|
|
1292
|
+
//@default: undefined
|
|
1293
|
+
source?: HttpStorageSourceRef;
|
|
1294
|
+
//@default: undefined
|
|
1295
|
+
target?: HttpStorageTargetRef;
|
|
1296
|
+
/**
|
|
1297
|
+
* JSON handling is the default. `requestType: 'json'` and `responseType: 'json'` may be stated together
|
|
1298
|
+
* when an integration should expose an explicit, self-documenting JSON contract.
|
|
1299
|
+
*/
|
|
1300
|
+
//@default: 'json'
|
|
1301
|
+
responseType?: 'json' | 'base64buffer' | 'document' | 'text' | 'stream';
|
|
1302
|
+
//@default: 'json'
|
|
1303
|
+
requestType?: 'json' | 'base64buffer' | 'form-data' | 'text' | 'stream';
|
|
1304
|
+
//@default: false
|
|
1305
|
+
currentCredentials?: boolean;
|
|
1306
|
+
}
|
|
1307
|
+
interface HttpRequestInterface {
|
|
1308
|
+
url: string;
|
|
1309
|
+
method: 'POST' | 'PUT' | 'DELETE' | 'GET' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'PURGE' | 'LINK' | 'UNLINK';
|
|
1310
|
+
timeout?: number;
|
|
1311
|
+
headers?: LooseObject<string>;
|
|
1312
|
+
params?: TemplateParameters[];
|
|
1313
|
+
data?: any;
|
|
1314
|
+
//@default: undefined
|
|
1315
|
+
formData?: TemplateFormData[];
|
|
1316
|
+
}
|
|
1317
|
+
interface TemplateParameters {
|
|
1318
|
+
key: string;
|
|
1319
|
+
value: string | LooseObject<boolean | number | string>;
|
|
1320
|
+
}
|
|
1321
|
+
interface ProcessLog {
|
|
1322
|
+
time: string;
|
|
1323
|
+
type: string;
|
|
1324
|
+
context?: string;
|
|
1325
|
+
details: LooseObject<any>;
|
|
1326
|
+
}
|
|
1327
|
+
interface StorageBreadcrumb {
|
|
1328
|
+
storageEntryId: string;
|
|
1329
|
+
name: string;
|
|
1330
|
+
}
|
|
1331
|
+
type StorageRetentionInput = null | {
|
|
1332
|
+
/** Positive duration starting when the file is finalized. */
|
|
1333
|
+
ttlSeconds?: number;
|
|
1334
|
+
/** Future ISO timestamp. Mutually exclusive with ttlSeconds. */
|
|
1335
|
+
expiresAt?: string;
|
|
1336
|
+
};
|
|
1337
|
+
interface StorageEntry extends BaseProperties {
|
|
1338
|
+
storageEntryId: string;
|
|
1339
|
+
parentStorageEntryId: string | null;
|
|
1340
|
+
kind: string;
|
|
1341
|
+
status: string;
|
|
1342
|
+
restricted: boolean;
|
|
1343
|
+
restrictedByAncestor: boolean;
|
|
1344
|
+
effectiveRestricted: boolean;
|
|
1345
|
+
name: string;
|
|
1346
|
+
storageProviderConfigId: string | null;
|
|
1347
|
+
providerVersion: string | null;
|
|
1348
|
+
mimeType: string | null;
|
|
1349
|
+
extension: string | null;
|
|
1350
|
+
size: number | null;
|
|
1351
|
+
checksumMd5: string | null;
|
|
1352
|
+
tier: string | null;
|
|
1353
|
+
metadata: LooseObject<any>;
|
|
1354
|
+
refId: string | null;
|
|
1355
|
+
refType: string | null;
|
|
1356
|
+
refVer: number | null;
|
|
1357
|
+
lastAccessAt: Date | string | null;
|
|
1358
|
+
expiresAt: Date | string | null;
|
|
1359
|
+
archivedAt: Date | string | null;
|
|
1360
|
+
archivedBy: string | null;
|
|
1361
|
+
archiveReason: 'AGENT_DELETED' | 'MANUAL' | 'TTL_EXPIRED' | 'USER_DELETED' | null;
|
|
1362
|
+
groups: string[];
|
|
1363
|
+
users: string[];
|
|
1364
|
+
}
|
|
1365
|
+
interface StorageEntryView extends StorageEntry {
|
|
1366
|
+
breadcrumbs: StorageBreadcrumb[];
|
|
1367
|
+
}
|
|
1368
|
+
interface StorageExploreRequest {
|
|
1369
|
+
parentStorageEntryId?: string;
|
|
1370
|
+
storageProviderConfigId?: string | null;
|
|
1371
|
+
term?: string;
|
|
1372
|
+
skip?: number;
|
|
1373
|
+
take?: number;
|
|
1374
|
+
includeArchived?: boolean;
|
|
1375
|
+
includeDeleted?: boolean;
|
|
1376
|
+
includeTotal?: boolean;
|
|
1377
|
+
}
|
|
1378
|
+
interface StorageExploreResult extends CollectionResult<StorageEntry> {
|
|
1379
|
+
breadcrumbs: StorageBreadcrumb[];
|
|
1380
|
+
}
|
|
1381
|
+
interface StorageEnsureFolderPathOptions {
|
|
1382
|
+
/** Provider config used only if the first path segment must be created at root. */
|
|
1383
|
+
storageProviderConfigId?: string | null;
|
|
1384
|
+
/** Applied to every newly created segment; existing folders are never mutated. */
|
|
1385
|
+
restricted?: boolean;
|
|
1386
|
+
/** Applied to every newly created segment; existing folders are never mutated. */
|
|
1387
|
+
groups?: string[];
|
|
1388
|
+
/** Applied to every newly created segment; existing folders are never mutated. */
|
|
1389
|
+
users?: string[];
|
|
1390
|
+
}
|
|
1391
|
+
interface StorageUploadSession {
|
|
1392
|
+
storageUploadSessionId: string;
|
|
1393
|
+
parentStorageEntryId: string | null;
|
|
1394
|
+
targetStorageEntryId: string | null;
|
|
1395
|
+
replaceStorageEntryId: string | null;
|
|
1396
|
+
mode: string;
|
|
1397
|
+
uploadMode: 'direct' | 'chunked' | 'incremental';
|
|
1398
|
+
status: string;
|
|
1399
|
+
name: string;
|
|
1400
|
+
mimeTypeHint: string | null;
|
|
1401
|
+
sizeHint: number | null;
|
|
1402
|
+
computeStats: 'none' | 'sync' | 'async' | null;
|
|
1403
|
+
expiresAt: Date;
|
|
1404
|
+
targetRetention?: StorageRetentionInput;
|
|
1405
|
+
finalizedAt: Date | null;
|
|
1406
|
+
}
|
|
1407
|
+
interface StorageUploadSessionPart {
|
|
1408
|
+
partNumber: number;
|
|
1409
|
+
status: string | null;
|
|
1410
|
+
size: number;
|
|
1411
|
+
checksumMd5: string | null;
|
|
1412
|
+
providerVersion: string | null;
|
|
1413
|
+
startByte: number | null;
|
|
1414
|
+
endByte: number | null;
|
|
1415
|
+
}
|
|
1416
|
+
interface StorageUploadPartResult {
|
|
1417
|
+
storageUploadSessionId: string;
|
|
1418
|
+
partNumber: number;
|
|
1419
|
+
size: number;
|
|
1420
|
+
checksumMd5: string | null;
|
|
1421
|
+
}
|
|
1422
|
+
interface StorageUploadSessionView {
|
|
1423
|
+
session: StorageUploadSession;
|
|
1424
|
+
partNumberRequired: boolean;
|
|
1425
|
+
uploadedParts: number;
|
|
1426
|
+
uploadedBytes: number;
|
|
1427
|
+
nextPartNumber: number | null;
|
|
1428
|
+
parts: StorageUploadSessionPart[];
|
|
1429
|
+
}
|
|
1430
|
+
interface StorageUploadTarget {
|
|
1431
|
+
strategy: string;
|
|
1432
|
+
uploadUrl?: string | null;
|
|
1433
|
+
method: 'PUT' | 'POST';
|
|
1434
|
+
headers?: LooseObject<string>;
|
|
1435
|
+
providerUploadId?: string | null;
|
|
1436
|
+
partNumberRequired?: boolean;
|
|
1437
|
+
}
|
|
1438
|
+
interface StorageDownload {
|
|
1439
|
+
storageEntryId: string;
|
|
1440
|
+
downloadUrl: string;
|
|
1441
|
+
preview: boolean;
|
|
1442
|
+
}
|
|
1443
|
+
interface StorageTextReadOptions {
|
|
1444
|
+
startLine?: number | null;
|
|
1445
|
+
endLine?: number | null;
|
|
1446
|
+
maxChars?: number | null;
|
|
1447
|
+
}
|
|
1448
|
+
interface StorageFileReadOptions {
|
|
1449
|
+
batchNumber?: number;
|
|
1450
|
+
buffer?: boolean;
|
|
1451
|
+
start?: number;
|
|
1452
|
+
end?: number;
|
|
1453
|
+
}
|
|
1454
|
+
interface StorageFileStatsOptions {
|
|
1455
|
+
separator?: string;
|
|
1456
|
+
reloadStats?: boolean;
|
|
1457
|
+
batchSize?: number;
|
|
1458
|
+
}
|
|
1459
|
+
interface StorageFileStats {
|
|
1460
|
+
lineCount?: number;
|
|
1461
|
+
map?: LooseObject<number>;
|
|
1462
|
+
separator?: string;
|
|
1463
|
+
batches?: number;
|
|
1464
|
+
batchSize?: number;
|
|
1465
|
+
encoding?: string | null;
|
|
1466
|
+
}
|
|
1467
|
+
interface StorageTextContent {
|
|
1468
|
+
storageEntryId: string;
|
|
1469
|
+
name: string;
|
|
1470
|
+
mimeType: string | null;
|
|
1471
|
+
size: number | null;
|
|
1472
|
+
content: string;
|
|
1473
|
+
startLine: number;
|
|
1474
|
+
endLine: number;
|
|
1475
|
+
returnedLineCount: number;
|
|
1476
|
+
totalLines: number;
|
|
1477
|
+
truncated: boolean;
|
|
1478
|
+
}
|
|
1479
|
+
interface LoggedUser {
|
|
1480
|
+
userId: string;
|
|
1481
|
+
name: string;
|
|
1482
|
+
surname: string;
|
|
1483
|
+
serviceAccount: boolean;
|
|
1484
|
+
ownerType: string;
|
|
1485
|
+
ownerId: string;
|
|
1486
|
+
mail: string;
|
|
1487
|
+
phone: string;
|
|
1488
|
+
groups: string[];
|
|
1489
|
+
roles: string[];
|
|
1490
|
+
metaData: LooseObject<any>;
|
|
1491
|
+
advancedData: LooseObject<any>;
|
|
1492
|
+
avatar: string;
|
|
1493
|
+
platformAccess: boolean;
|
|
1494
|
+
}
|
|
1495
|
+
interface AgentToolInput {
|
|
1496
|
+
/**
|
|
1497
|
+
* Local tool name exposed to the assistant runtime, usually the componentToolset tool alias.
|
|
1498
|
+
*/
|
|
1499
|
+
toolName?: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* Component toolset key selected for this execution.
|
|
1502
|
+
*/
|
|
1503
|
+
capabilityId?: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* Component implementation entrypoint selected by componentToolset.tools.<tool>.entrypoint.
|
|
1506
|
+
*/
|
|
1507
|
+
entrypoint?: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Model-provided arguments validated against componentToolset.tools.<tool>.inputSchema.
|
|
1510
|
+
*/
|
|
1511
|
+
args?: LooseObject<any>;
|
|
1512
|
+
/**
|
|
1513
|
+
* Static runtime inputs from componentToolset.tools.<tool>.inputs.
|
|
1514
|
+
*/
|
|
1515
|
+
inputs?: LooseObject<any>;
|
|
1516
|
+
popResult?: string | null;
|
|
1517
|
+
pluginId?: string | null;
|
|
1518
|
+
registryPluginId?: string | null;
|
|
1519
|
+
componentId?: string | null;
|
|
1520
|
+
componentVersion?: number | null;
|
|
1521
|
+
}
|
|
1522
|
+
interface Input {
|
|
1523
|
+
templateId: string;
|
|
1524
|
+
templateInputs: LooseObject<any>;
|
|
1525
|
+
/**
|
|
1526
|
+
* Present when this component is executed as an agent plugin component tool.
|
|
1527
|
+
*/
|
|
1528
|
+
agentTool?: AgentToolInput;
|
|
1529
|
+
// Endpoints
|
|
1530
|
+
body?: any;
|
|
1531
|
+
query?: LooseObject<string>;
|
|
1532
|
+
headers?: LooseObject<string>;
|
|
1533
|
+
params?: string[];
|
|
1534
|
+
path?: string;
|
|
1535
|
+
method?: string;
|
|
1536
|
+
// Events
|
|
1537
|
+
type?: string;
|
|
1538
|
+
message?: any;
|
|
1539
|
+
// Execution context.
|
|
1540
|
+
excludeLibs?: string[];
|
|
1541
|
+
includeLibs?: string[];
|
|
1542
|
+
}
|
|
1543
|
+
interface InstanceDetails {
|
|
1544
|
+
id: string;
|
|
1545
|
+
organizationId: string;
|
|
1546
|
+
name: string;
|
|
1547
|
+
description: string;
|
|
1548
|
+
status: string;
|
|
1549
|
+
plan: string;
|
|
1550
|
+
version: number;
|
|
1551
|
+
versionComment: string;
|
|
1552
|
+
endpoints: {
|
|
1553
|
+
app: string;
|
|
1554
|
+
api: string;
|
|
1555
|
+
run: string;
|
|
1556
|
+
auth: string;
|
|
1557
|
+
sandbox: string;
|
|
1558
|
+
};
|
|
1559
|
+
}
|
|
1560
|
+
interface BaseProperties {
|
|
1561
|
+
createdBy: string;
|
|
1562
|
+
createdAt: Date;
|
|
1563
|
+
lastUpdateBy: string;
|
|
1564
|
+
lastUpdateAt: Date;
|
|
1565
|
+
version: number;
|
|
1566
|
+
deletedBy?: string;
|
|
1567
|
+
deletedAt?: Date;
|
|
1568
|
+
}
|
|
1569
|
+
interface ResourceItem extends BaseProperties {
|
|
1570
|
+
itemId: string;
|
|
1571
|
+
version: number;
|
|
1572
|
+
[key: string]: any;
|
|
1573
|
+
}
|
|
1574
|
+
interface DatabaseDataActionResponse {
|
|
1575
|
+
requested: number;
|
|
1576
|
+
success: number;
|
|
1577
|
+
elapsed: number;
|
|
1578
|
+
data: any[];
|
|
1579
|
+
}
|
|
1580
|
+
interface TruncateDatabaseOptions {
|
|
1581
|
+
/**
|
|
1582
|
+
* Restart owned identity sequences after truncation.
|
|
1583
|
+
* Defaults to false so generated keys remain stable and are not reused.
|
|
1584
|
+
*/
|
|
1585
|
+
restartIdentity?: boolean;
|
|
1586
|
+
}
|
|
1587
|
+
interface CloneDatabaseAcceptedResponse {
|
|
1588
|
+
accepted: true;
|
|
1589
|
+
databaseId: string;
|
|
1590
|
+
sourceDatabaseId: string;
|
|
1591
|
+
cloneId: string;
|
|
1592
|
+
name: string;
|
|
1593
|
+
includeItems: boolean;
|
|
1594
|
+
includePartitions: boolean;
|
|
1595
|
+
audit: boolean;
|
|
1596
|
+
message: string;
|
|
1597
|
+
}
|
|
1598
|
+
interface CloneDatabaseCompletedResponse {
|
|
1599
|
+
accepted: false;
|
|
1600
|
+
completed: true;
|
|
1601
|
+
databaseId: string;
|
|
1602
|
+
sourceDatabaseId: string;
|
|
1603
|
+
cloneId: string;
|
|
1604
|
+
name: string;
|
|
1605
|
+
includeItems: boolean;
|
|
1606
|
+
includePartitions: boolean;
|
|
1607
|
+
audit: boolean;
|
|
1608
|
+
clonedDatabaseIds: string[];
|
|
1609
|
+
databases: Database[];
|
|
1610
|
+
message: string;
|
|
1611
|
+
}
|
|
1612
|
+
type CloneDatabaseResponse = CloneDatabaseAcceptedResponse | CloneDatabaseCompletedResponse;
|
|
1613
|
+
type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
1614
|
+
/**
|
|
1615
|
+
* false waits for final storage persistence and returns the completed response.
|
|
1616
|
+
* true starts a background export and returns the accepted response.
|
|
1617
|
+
* Default is false.
|
|
1618
|
+
*/
|
|
1619
|
+
async?: boolean;
|
|
1620
|
+
/** Omit for private user storage, use ROOT, or provide an accessible explorer folder id. */
|
|
1621
|
+
storageDestination?: 'ROOT' | string;
|
|
1622
|
+
/** Dedicated output name. Omit for an automatic database-and-timestamp CSV name. */
|
|
1623
|
+
fileName?: string;
|
|
1624
|
+
/** Whether the output entry is restricted. Default is true. */
|
|
1625
|
+
restricted?: boolean;
|
|
1626
|
+
/** CSV delimiter. Default is a comma. */
|
|
1627
|
+
delimiter?: string;
|
|
1628
|
+
boolType?: 'emoji' | 'number' | 'boolean';
|
|
1629
|
+
emptyNull?: boolean;
|
|
1630
|
+
encodedJson?: boolean;
|
|
1631
|
+
/** Omit for the destination default, null for no expiration. */
|
|
1632
|
+
retention?: StorageRetentionInput;
|
|
1633
|
+
};
|
|
1634
|
+
interface ExportDatabaseAcceptedResponse {
|
|
1635
|
+
accepted: true;
|
|
1636
|
+
databaseId: string;
|
|
1637
|
+
exportId: string;
|
|
1638
|
+
storageNamespace: string;
|
|
1639
|
+
parentStorageEntryId: string | null;
|
|
1640
|
+
fileName: string;
|
|
1641
|
+
restricted: boolean;
|
|
1642
|
+
message: string;
|
|
1643
|
+
}
|
|
1644
|
+
interface ExportDatabaseCompletedResponse {
|
|
1645
|
+
accepted: false;
|
|
1646
|
+
completed: true;
|
|
1647
|
+
databaseId: string;
|
|
1648
|
+
exportId: string;
|
|
1649
|
+
storageNamespace: string;
|
|
1650
|
+
parentStorageEntryId: string | null;
|
|
1651
|
+
fileName: string;
|
|
1652
|
+
restricted: boolean;
|
|
1653
|
+
storageEntryId: string;
|
|
1654
|
+
storageEntry: StorageEntryView;
|
|
1655
|
+
message: string;
|
|
1656
|
+
}
|
|
1657
|
+
type ExportDatabaseResponse = ExportDatabaseAcceptedResponse | ExportDatabaseCompletedResponse;
|
|
1658
|
+
interface Context {
|
|
1659
|
+
requestId: string;
|
|
1660
|
+
date: Date;
|
|
1661
|
+
inputs?: any;
|
|
1662
|
+
options?: LooseObject<any>;
|
|
1663
|
+
isDebug?: boolean;
|
|
1664
|
+
async?: boolean;
|
|
1665
|
+
templateId?: string;
|
|
1666
|
+
targetType?: ExecutionTargetType;
|
|
1667
|
+
targetId?: string;
|
|
1668
|
+
}
|
|
1669
|
+
interface ComponentExecuteRequest {
|
|
1670
|
+
/**
|
|
1671
|
+
* Active executable component id to run in an isolated child execution.
|
|
1672
|
+
*/
|
|
1673
|
+
componentId: string;
|
|
1674
|
+
/**
|
|
1675
|
+
* Optional exact component version. Omit to run the latest active version.
|
|
1676
|
+
*/
|
|
1677
|
+
componentVersion?: number;
|
|
1678
|
+
/**
|
|
1679
|
+
* Input payload exposed to the child component through api.input().
|
|
1680
|
+
*/
|
|
1681
|
+
inputs?: any;
|
|
1682
|
+
/**
|
|
1683
|
+
* Maximum child runtime in milliseconds. The runtime clamps this to the parent execution's remaining timeout budget.
|
|
1684
|
+
*/
|
|
1685
|
+
timeoutMs?: number;
|
|
1686
|
+
/**
|
|
1687
|
+
* Optional child isolate memory limit in MB.
|
|
1688
|
+
*/
|
|
1689
|
+
memory?: number;
|
|
1690
|
+
}
|
|
1691
|
+
interface ComponentExecuteResult<T = LooseObject<any>> {
|
|
1692
|
+
trace: LooseObject<any>;
|
|
1693
|
+
errors: ProcessLog[];
|
|
1694
|
+
warnings: ProcessLog[];
|
|
1695
|
+
logs: ProcessLog[];
|
|
1696
|
+
results: T;
|
|
1697
|
+
context?: Context;
|
|
1698
|
+
}
|
|
1699
|
+
interface InstanceDataFilter {
|
|
1700
|
+
[field: string]: {
|
|
1701
|
+
[type: string]: string | number | null | string[] | number[];
|
|
1702
|
+
};
|
|
1703
|
+
}
|
|
1704
|
+
interface InstanceData {
|
|
1705
|
+
filter?: InstanceDataFilter | InstanceDataFilter[];
|
|
1706
|
+
sort?: string[];
|
|
1707
|
+
fields?: string[];
|
|
1708
|
+
distinct?: string;
|
|
1709
|
+
skip?: number;
|
|
1710
|
+
take?: number;
|
|
1711
|
+
cache?: {
|
|
1712
|
+
ttl?: number;
|
|
1713
|
+
key?: string;
|
|
1714
|
+
};
|
|
1715
|
+
count?: boolean;
|
|
1716
|
+
cast?: LooseObject<string>;
|
|
1717
|
+
options?: {
|
|
1718
|
+
id: string;
|
|
1719
|
+
};
|
|
1720
|
+
}
|
|
1721
|
+
interface SFTPClient {
|
|
1722
|
+
host: string;
|
|
1723
|
+
port: number;
|
|
1724
|
+
username: string;
|
|
1725
|
+
password?: string;
|
|
1726
|
+
privateKey?: string;
|
|
1727
|
+
passphrase?: string;
|
|
1728
|
+
}
|
|
1729
|
+
interface StorageFileTargetRequest extends Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> {
|
|
1730
|
+
name: string;
|
|
1731
|
+
}
|
|
1732
|
+
type SFTPFileSourceRef = {
|
|
1733
|
+
storageEntryId: string;
|
|
1734
|
+
};
|
|
1735
|
+
type SFTPFileTargetRef = {
|
|
1736
|
+
storageEntryId: string;
|
|
1737
|
+
replace?: true;
|
|
1738
|
+
} | {
|
|
1739
|
+
storage: StorageFileTargetRequest;
|
|
1740
|
+
};
|
|
1741
|
+
interface JWTHeader {
|
|
1742
|
+
alg: string | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none';
|
|
1743
|
+
typ?: string | undefined;
|
|
1744
|
+
cty?: string | undefined;
|
|
1745
|
+
crit?: Array<string | Exclude<keyof JWTHeader, 'crit'>> | undefined;
|
|
1746
|
+
kid?: string | undefined;
|
|
1747
|
+
jku?: string | undefined;
|
|
1748
|
+
x5u?: string | string[] | undefined;
|
|
1749
|
+
'x5t#S256'?: string | undefined;
|
|
1750
|
+
x5t?: string | undefined;
|
|
1751
|
+
x5c?: string | string[] | undefined;
|
|
1752
|
+
}
|
|
1753
|
+
interface Agent {
|
|
1754
|
+
agentId?: string;
|
|
1755
|
+
name: string;
|
|
1756
|
+
status?: string;
|
|
1757
|
+
desc?: string | null;
|
|
1758
|
+
ownerId?: string | null;
|
|
1759
|
+
ownerType?: string | null;
|
|
1760
|
+
serviceAccountUserId: string;
|
|
1761
|
+
rootStorageEntryId?: string | null;
|
|
1762
|
+
config?: AgentConfig;
|
|
1763
|
+
policy?: AgentPolicy;
|
|
1764
|
+
metadata?: Record<string, any>;
|
|
1765
|
+
createdBy?: string;
|
|
1766
|
+
createdAt?: Date | string;
|
|
1767
|
+
lastUpdateAt?: Date | string;
|
|
1768
|
+
lastUpdateBy?: string;
|
|
1769
|
+
deletedAt?: Date | string | null;
|
|
1770
|
+
deletedBy?: string | null;
|
|
1771
|
+
version?: number;
|
|
1772
|
+
}
|
|
1773
|
+
interface AgentPluginApprovalConfig {
|
|
1774
|
+
mode?: 'none' | 'always' | 'conditional';
|
|
1775
|
+
safetyTier?: 'read' | 'write' | 'destructive' | 'external' | 'execute';
|
|
1776
|
+
requiredApprovals?: ('interactive_user' | 'change_review' | string)[];
|
|
1777
|
+
}
|
|
1778
|
+
interface AgentReleaseRolloutPolicy {
|
|
1779
|
+
mode?: 'disabled' | 'shadow' | 'canary' | 'enabled';
|
|
1780
|
+
canaryPercent?: number;
|
|
1781
|
+
shadowSamplePercent?: number;
|
|
1782
|
+
requiredEvalSuite?: string | null;
|
|
1783
|
+
requiredTelemetryScorecards?: string[];
|
|
1784
|
+
rollbackToSnapshotId?: string | null;
|
|
1785
|
+
}
|
|
1786
|
+
interface AgentPluginRoutingConfig {
|
|
1787
|
+
title?: string;
|
|
1788
|
+
summary?: string;
|
|
1789
|
+
keywords?: string[];
|
|
1790
|
+
}
|
|
1791
|
+
interface AgentPluginMcpHeaderBinding {
|
|
1792
|
+
name: string;
|
|
1793
|
+
secretId?: string | null;
|
|
1794
|
+
secretDataId?: string | null;
|
|
1795
|
+
value?: string | null;
|
|
1796
|
+
prefix?: string;
|
|
1797
|
+
}
|
|
1798
|
+
interface AgentPluginMcpConfig {
|
|
1799
|
+
transport: 'streamable_http' | 'sse';
|
|
1800
|
+
url: string;
|
|
1801
|
+
authMode?: 'none' | 'bearer' | 'basic' | 'header';
|
|
1802
|
+
bearerSecretId?: string | null;
|
|
1803
|
+
bearerSecretDataId?: string | null;
|
|
1804
|
+
basicUsername?: string | null;
|
|
1805
|
+
basicPasswordSecretId?: string | null;
|
|
1806
|
+
basicPasswordSecretDataId?: string | null;
|
|
1807
|
+
headers?: AgentPluginMcpHeaderBinding[];
|
|
1808
|
+
manifestTtlMs?: number;
|
|
1809
|
+
connectTimeoutMs?: number;
|
|
1810
|
+
toolNamePrefix?: string;
|
|
1811
|
+
}
|
|
1812
|
+
interface AgentPluginMcpToolConfig {
|
|
1813
|
+
enabled?: boolean;
|
|
1814
|
+
deferLoading?: boolean;
|
|
1815
|
+
alias?: string | null;
|
|
1816
|
+
approvalPolicy?: AgentPluginApprovalConfig;
|
|
1817
|
+
mutationIntent?: 'read' | 'write' | 'destructive' | 'external';
|
|
1818
|
+
reversibility?: 'reversible' | 'operator_reversible' | 'irreversible' | 'unknown';
|
|
1819
|
+
targetScope?: 'assistant_thread' | 'agent' | 'tenant' | 'external';
|
|
1820
|
+
sideEffectSummary?: string;
|
|
1821
|
+
rollout?: AgentReleaseRolloutPolicy;
|
|
1822
|
+
}
|
|
1823
|
+
interface AgentPluginMcpToolset {
|
|
1824
|
+
defaultConfig?: AgentPluginMcpToolConfig;
|
|
1825
|
+
configs?: Record<string, AgentPluginMcpToolConfig>;
|
|
1826
|
+
}
|
|
1827
|
+
interface AgentPluginComponentToolConfig {
|
|
1828
|
+
enabled?: boolean;
|
|
1829
|
+
deferLoading?: boolean;
|
|
1830
|
+
alias?: string | null;
|
|
1831
|
+
title?: string;
|
|
1832
|
+
description?: string;
|
|
1833
|
+
entrypoint?: string | null;
|
|
1834
|
+
inputs?: Record<string, any>;
|
|
1835
|
+
popResult?: string | null;
|
|
1836
|
+
inputSchema?: Record<string, any>;
|
|
1837
|
+
outputSchema?: Record<string, any>;
|
|
1838
|
+
approvalPolicy?: AgentPluginApprovalConfig;
|
|
1839
|
+
mutationIntent?: 'read' | 'write' | 'destructive' | 'external';
|
|
1840
|
+
reversibility?: 'reversible' | 'operator_reversible' | 'irreversible' | 'unknown';
|
|
1841
|
+
targetScope?: 'assistant_thread' | 'agent' | 'tenant' | 'external';
|
|
1842
|
+
sideEffectSummary?: string;
|
|
1843
|
+
sideEffectCategories?: string[];
|
|
1844
|
+
rollout?: AgentReleaseRolloutPolicy;
|
|
1845
|
+
}
|
|
1846
|
+
interface AgentPluginComponentToolset {
|
|
1847
|
+
defaultConfig?: Omit<AgentPluginComponentToolConfig, 'alias' | 'title' | 'entrypoint'>;
|
|
1848
|
+
tools?: Record<string, AgentPluginComponentToolConfig>;
|
|
1849
|
+
}
|
|
1850
|
+
interface AgentPluginSkillConfig {
|
|
1851
|
+
format?: 'markdown';
|
|
1852
|
+
content: string;
|
|
1853
|
+
pluginIds?: string[];
|
|
1854
|
+
maxPromptChars?: number;
|
|
1855
|
+
}
|
|
1856
|
+
interface AgentPluginPackageMetadata {
|
|
1857
|
+
avatarUrl?: string | null;
|
|
1858
|
+
websiteUrl?: string | null;
|
|
1859
|
+
documentationUrl?: string | null;
|
|
1860
|
+
termsOfServiceUrl?: string | null;
|
|
1861
|
+
privacyPolicyUrl?: string | null;
|
|
1862
|
+
supportUrl?: string | null;
|
|
1863
|
+
publisherName?: string | null;
|
|
1864
|
+
publisherUrl?: string | null;
|
|
1865
|
+
license?: string | null;
|
|
1866
|
+
categories?: string[];
|
|
1867
|
+
tags?: string[];
|
|
1868
|
+
}
|
|
1869
|
+
interface AgentPluginPackageConfig {
|
|
1870
|
+
externalId: string;
|
|
1871
|
+
format?: 'markdown';
|
|
1872
|
+
content: string;
|
|
1873
|
+
pluginIds?: string[];
|
|
1874
|
+
metadata?: AgentPluginPackageMetadata;
|
|
1875
|
+
maxPromptChars?: number;
|
|
1876
|
+
}
|
|
1877
|
+
interface AgentPluginConfig {
|
|
1878
|
+
contractVersion?: 1;
|
|
1879
|
+
id: string;
|
|
1880
|
+
kind?: 'tools' | 'mcp_server' | 'skill' | 'package';
|
|
1881
|
+
name: string;
|
|
1882
|
+
description?: string;
|
|
1883
|
+
routing?: AgentPluginRoutingConfig;
|
|
1884
|
+
executionMode?: 'sync' | 'background';
|
|
1885
|
+
componentId?: string;
|
|
1886
|
+
componentVersion?: number | null;
|
|
1887
|
+
componentToolset?: AgentPluginComponentToolset;
|
|
1888
|
+
mcpServer?: AgentPluginMcpConfig;
|
|
1889
|
+
mcpToolset?: AgentPluginMcpToolset;
|
|
1890
|
+
skill?: AgentPluginSkillConfig;
|
|
1891
|
+
package?: AgentPluginPackageConfig;
|
|
1892
|
+
providerSource?: 'tenant_plugin' | 'community_plugin';
|
|
1893
|
+
version?: string;
|
|
1894
|
+
inputSchema?: Record<string, any>;
|
|
1895
|
+
outputSchema?: Record<string, any>;
|
|
1896
|
+
approvalPolicy?: AgentPluginApprovalConfig;
|
|
1897
|
+
mutationIntent?: 'read' | 'write' | 'destructive' | 'external';
|
|
1898
|
+
reversibility?: 'reversible' | 'operator_reversible' | 'irreversible' | 'unknown';
|
|
1899
|
+
targetScope?: 'assistant_thread' | 'agent' | 'tenant' | 'external';
|
|
1900
|
+
sideEffectSummary?: string;
|
|
1901
|
+
sideEffectCategories?: string[];
|
|
1902
|
+
timeoutMs?: number;
|
|
1903
|
+
resultMaxBytes?: number;
|
|
1904
|
+
inputMode?: 'direct' | 'args_wrapper';
|
|
1905
|
+
enabled?: boolean;
|
|
1906
|
+
autoDiscovery?: boolean;
|
|
1907
|
+
}
|
|
1908
|
+
type AgentWorkMode = 'balanced' | 'coding' | 'business' | 'analyst' | 'operator' | 'creative';
|
|
1909
|
+
type AgentPersona = 'friendly' | 'pragmatic' | 'professional' | 'concise' | 'calm' | 'mentor' | 'assertive';
|
|
1910
|
+
interface AgentMemoryPolicy {
|
|
1911
|
+
enabled?: boolean;
|
|
1912
|
+
maxRecallEntries?: number;
|
|
1913
|
+
maxRecallChars?: number;
|
|
1914
|
+
retentionDays?: number;
|
|
1915
|
+
defaultTtlDays?: number;
|
|
1916
|
+
excludedContentPaths?: string[];
|
|
1917
|
+
includeProvenance?: boolean;
|
|
1918
|
+
}
|
|
1919
|
+
interface AgentReleaseConfig {
|
|
1920
|
+
versionLabel?: string;
|
|
1921
|
+
changeSummary?: string;
|
|
1922
|
+
routingRollout?: AgentReleaseRolloutPolicy;
|
|
1923
|
+
workerRollout?: AgentReleaseRolloutPolicy;
|
|
1924
|
+
pluginRollout?: AgentReleaseRolloutPolicy;
|
|
1925
|
+
}
|
|
1926
|
+
interface AgentAutomationApprovalRouting {
|
|
1927
|
+
mode?: 'block' | 'delegate' | 'notify';
|
|
1928
|
+
delegateUserIds?: string[];
|
|
1929
|
+
notifyUserIds?: string[];
|
|
1930
|
+
}
|
|
1931
|
+
interface AgentAutomationNotificationPolicy {
|
|
1932
|
+
dedupeWindowSeconds?: number;
|
|
1933
|
+
maxAttempts?: number;
|
|
1934
|
+
auditTrail?: boolean;
|
|
1935
|
+
}
|
|
1936
|
+
interface AgentAutomationPolicyConfig {
|
|
1937
|
+
defaultDeliveryMode?: 'INBOX' | 'DIRECT_RUN';
|
|
1938
|
+
approvalRouting?: AgentAutomationApprovalRouting;
|
|
1939
|
+
notificationPolicy?: AgentAutomationNotificationPolicy;
|
|
1940
|
+
}
|
|
1941
|
+
interface AgentCheapTurnPolicy {
|
|
1942
|
+
includePersona?: boolean;
|
|
1943
|
+
includeSystemInstructions?: boolean;
|
|
1944
|
+
includeMemory?: boolean;
|
|
1945
|
+
}
|
|
1946
|
+
interface AgentConfig {
|
|
1947
|
+
model?: string;
|
|
1948
|
+
reasoningEffort?: 'none' | 'low' | 'medium' | 'high' | 'xhigh';
|
|
1949
|
+
executionMode?: 'interactive' | 'background' | 'automation';
|
|
1950
|
+
planningPolicy?: 'standard' | 'review_required';
|
|
1951
|
+
workMode?: AgentWorkMode;
|
|
1952
|
+
persona?: AgentPersona;
|
|
1953
|
+
systemInstructions?: string;
|
|
1954
|
+
memoryPolicy?: AgentMemoryPolicy;
|
|
1955
|
+
release?: AgentReleaseConfig;
|
|
1956
|
+
automation?: AgentAutomationPolicyConfig;
|
|
1957
|
+
cheapTurn?: AgentCheapTurnPolicy;
|
|
1958
|
+
toolNames?: string[];
|
|
1959
|
+
pluginIds?: string[];
|
|
1960
|
+
plugins?: AgentPluginConfig[];
|
|
1961
|
+
maxActiveRootRuns?: number;
|
|
1962
|
+
maxChildRuns?: number;
|
|
1963
|
+
maxConcurrentChildRuns?: number;
|
|
1964
|
+
maxTicks?: number;
|
|
1965
|
+
childFailureMode?: 'fail_parent' | 'merge_partial';
|
|
1966
|
+
}
|
|
1967
|
+
interface AgentPolicy {
|
|
1968
|
+
toolNames?: string[];
|
|
1969
|
+
pluginIds?: string[];
|
|
1970
|
+
plugins?: AgentPluginConfig[];
|
|
1971
|
+
maxActiveRootRuns?: number;
|
|
1972
|
+
maxChildRuns?: number;
|
|
1973
|
+
maxConcurrentChildRuns?: number;
|
|
1974
|
+
maxTicks?: number;
|
|
1975
|
+
childFailureMode?: 'fail_parent' | 'merge_partial';
|
|
1976
|
+
}
|
|
1977
|
+
interface AgentPlugin {
|
|
1978
|
+
contractVersion?: 1;
|
|
1979
|
+
id: string;
|
|
1980
|
+
kind?: 'tools' | 'mcp_server' | 'skill' | 'package';
|
|
1981
|
+
name: string;
|
|
1982
|
+
description?: string;
|
|
1983
|
+
routing?: AgentPluginRoutingConfig;
|
|
1984
|
+
executionMode?: 'sync' | 'background';
|
|
1985
|
+
componentId?: string;
|
|
1986
|
+
componentVersion?: number | null;
|
|
1987
|
+
componentToolset?: AgentPluginComponentToolset;
|
|
1988
|
+
mcpServer?: AgentPluginMcpConfig;
|
|
1989
|
+
mcpToolset?: AgentPluginMcpToolset;
|
|
1990
|
+
skill?: AgentPluginSkillConfig;
|
|
1991
|
+
package?: AgentPluginPackageConfig;
|
|
1992
|
+
providerSource?: 'tenant_plugin' | 'community_plugin';
|
|
1993
|
+
version?: string;
|
|
1994
|
+
inputSchema?: Record<string, any>;
|
|
1995
|
+
outputSchema?: Record<string, any>;
|
|
1996
|
+
approvalPolicy?: AgentPluginApprovalConfig;
|
|
1997
|
+
mutationIntent?: 'read' | 'write' | 'destructive' | 'external';
|
|
1998
|
+
reversibility?: 'reversible' | 'operator_reversible' | 'irreversible' | 'unknown';
|
|
1999
|
+
targetScope?: 'assistant_thread' | 'agent' | 'tenant' | 'external';
|
|
2000
|
+
sideEffectSummary?: string;
|
|
2001
|
+
sideEffectCategories?: string[];
|
|
2002
|
+
timeoutMs?: number;
|
|
2003
|
+
resultMaxBytes?: number;
|
|
2004
|
+
inputMode?: 'direct' | 'args_wrapper';
|
|
2005
|
+
enabled?: boolean;
|
|
2006
|
+
autoDiscovery?: boolean;
|
|
2007
|
+
scope?: 'config' | 'policy';
|
|
2008
|
+
}
|
|
2009
|
+
interface AgentInboxItem {
|
|
2010
|
+
agentInboxItemId?: string;
|
|
2011
|
+
agentId: string;
|
|
2012
|
+
status?: string;
|
|
2013
|
+
type: string;
|
|
2014
|
+
instruction: string;
|
|
2015
|
+
payload?: Record<string, any>;
|
|
2016
|
+
result?: Record<string, any> | null;
|
|
2017
|
+
error?: Record<string, any> | null;
|
|
2018
|
+
priority?: number;
|
|
2019
|
+
availableAt?: Date | string;
|
|
2020
|
+
claimedByRunId?: string | null;
|
|
2021
|
+
leaseToken?: string | null;
|
|
2022
|
+
leaseExpiresAt?: Date | string | null;
|
|
2023
|
+
completedAt?: Date | string | null;
|
|
2024
|
+
dedupeKey?: string | null;
|
|
2025
|
+
createdBy?: string;
|
|
2026
|
+
createdAt?: Date | string;
|
|
2027
|
+
lastUpdateAt?: Date | string;
|
|
2028
|
+
lastUpdateBy?: string;
|
|
2029
|
+
version?: number;
|
|
2030
|
+
}
|
|
2031
|
+
interface AgentRun {
|
|
2032
|
+
agentRunId?: string;
|
|
2033
|
+
agentId: string;
|
|
2034
|
+
rootRunId?: string | null;
|
|
2035
|
+
parentRunId?: string | null;
|
|
2036
|
+
status?: string;
|
|
2037
|
+
waitReason?: string | null;
|
|
2038
|
+
triggerType?: string | null;
|
|
2039
|
+
triggerRefType?: string | null;
|
|
2040
|
+
triggerRefId?: string | null;
|
|
2041
|
+
ownerId?: string | null;
|
|
2042
|
+
ownerType?: string | null;
|
|
2043
|
+
serviceAccountUserId?: string;
|
|
2044
|
+
rootAssistantThreadId?: string | null;
|
|
2045
|
+
currentAssistantThreadId?: string | null;
|
|
2046
|
+
lastAssistantMessageId?: string | null;
|
|
2047
|
+
nextWakeAt?: Date | string | null;
|
|
2048
|
+
scheduledTaskName?: string | null;
|
|
2049
|
+
leaseToken?: string | null;
|
|
2050
|
+
leaseExpiresAt?: Date | string | null;
|
|
2051
|
+
tickSeq?: number;
|
|
2052
|
+
tickCount?: number;
|
|
2053
|
+
childCount?: number;
|
|
2054
|
+
lastHeartbeatAt?: Date | string | null;
|
|
2055
|
+
checkpointSummary?: string | null;
|
|
2056
|
+
state?: Record<string, any>;
|
|
2057
|
+
result?: Record<string, any> | null;
|
|
2058
|
+
error?: Record<string, any> | null;
|
|
2059
|
+
createdBy?: string;
|
|
2060
|
+
createdAt?: Date | string;
|
|
2061
|
+
lastUpdateAt?: Date | string;
|
|
2062
|
+
lastUpdateBy?: string;
|
|
2063
|
+
version?: number;
|
|
2064
|
+
}
|
|
2065
|
+
interface AgentRunEvent {
|
|
2066
|
+
agentRunEventId?: string;
|
|
2067
|
+
agentRunId: string;
|
|
2068
|
+
rootRunId?: string | null;
|
|
2069
|
+
agentId: string;
|
|
2070
|
+
seq?: number;
|
|
2071
|
+
kind?: string;
|
|
2072
|
+
level?: string;
|
|
2073
|
+
summary?: string;
|
|
2074
|
+
payload?: Record<string, any>;
|
|
2075
|
+
assistantThreadId?: string | null;
|
|
2076
|
+
assistantMessageId?: string | null;
|
|
2077
|
+
assistantExecutionPlanId?: string | null;
|
|
2078
|
+
assistantActionRequiredId?: string | null;
|
|
2079
|
+
childAgentRunId?: string | null;
|
|
2080
|
+
storageEntryId?: string | null;
|
|
2081
|
+
jobId?: string | null;
|
|
2082
|
+
taskName?: string | null;
|
|
2083
|
+
requestId?: string | null;
|
|
2084
|
+
operationId?: string | null;
|
|
2085
|
+
traceId?: string | null;
|
|
2086
|
+
spanId?: string | null;
|
|
2087
|
+
createdBy?: string;
|
|
2088
|
+
createdAt?: Date | string;
|
|
2089
|
+
}
|
|
2090
|
+
interface AgentRunThread {
|
|
2091
|
+
agentRunThreadId?: string;
|
|
2092
|
+
agentRunId: string;
|
|
2093
|
+
agentId: string;
|
|
2094
|
+
assistantThreadId: string;
|
|
2095
|
+
kind?: string;
|
|
2096
|
+
purpose?: string | null;
|
|
2097
|
+
parentAssistantThreadId?: string | null;
|
|
2098
|
+
sourceAssistantMessageId?: string | null;
|
|
2099
|
+
sourceAgentRunId?: string | null;
|
|
2100
|
+
active?: boolean;
|
|
2101
|
+
meta?: Record<string, any>;
|
|
2102
|
+
createdBy?: string;
|
|
2103
|
+
createdAt?: Date | string;
|
|
2104
|
+
lastUpdateAt?: Date | string;
|
|
2105
|
+
lastUpdateBy?: string;
|
|
2106
|
+
version?: number;
|
|
2107
|
+
}
|
|
2108
|
+
interface CollectionResult<T = any> {
|
|
2109
|
+
data: T[];
|
|
2110
|
+
results: number;
|
|
2111
|
+
next: boolean;
|
|
2112
|
+
total?: number;
|
|
2113
|
+
cache?: any;
|
|
2114
|
+
}
|
|
2115
|
+
interface AssistantExecutionPlanStep {
|
|
2116
|
+
id?: string;
|
|
2117
|
+
title: string;
|
|
2118
|
+
description: string;
|
|
2119
|
+
kind: string;
|
|
2120
|
+
executor?: 'primary' | 'delegated_candidate' | string;
|
|
2121
|
+
parallelGroup?: string | null;
|
|
2122
|
+
status: 'pending' | 'in_progress' | 'completed' | 'blocked' | 'failed' | 'skipped' | string;
|
|
2123
|
+
userVisible?: boolean;
|
|
2124
|
+
approvalHint?: 'none' | 'maybe' | 'required' | string;
|
|
2125
|
+
}
|
|
2126
|
+
interface AssistantExecutionPlan {
|
|
2127
|
+
summary: string;
|
|
2128
|
+
executionStrategy: 'serial' | 'parallel_candidates' | string;
|
|
2129
|
+
steps: AssistantExecutionPlanStep[];
|
|
2130
|
+
}
|
|
2131
|
+
interface AssistantPlanningTransition {
|
|
2132
|
+
currentMode: string;
|
|
2133
|
+
requiresLaterTurn: boolean;
|
|
2134
|
+
allowedNextModes: string[];
|
|
2135
|
+
statusLabel: string;
|
|
2136
|
+
handoffSummary: string;
|
|
2137
|
+
}
|
|
2138
|
+
interface AssistantWorkerProgress {
|
|
2139
|
+
stepId: string;
|
|
2140
|
+
stepTitle: string;
|
|
2141
|
+
childExecutorType?: 'explore' | 'general' | string | null;
|
|
2142
|
+
status: 'running' | 'blocked' | 'completed' | 'failed' | string;
|
|
2143
|
+
statusLabel: string;
|
|
2144
|
+
waitReason?: 'approval' | 'dependency' | 'unknown' | string | null;
|
|
2145
|
+
currentToolName?: string | null;
|
|
2146
|
+
currentToolTitle?: string | null;
|
|
2147
|
+
childAgentRunId?: string | null;
|
|
2148
|
+
startedAt?: Date | string | null;
|
|
2149
|
+
updatedAt?: Date | string | null;
|
|
2150
|
+
summary?: string | null;
|
|
2151
|
+
artifactCount?: number | null;
|
|
2152
|
+
}
|
|
2153
|
+
interface AssistantPublicExecutionPlan {
|
|
2154
|
+
assistantExecutionPlanId: string;
|
|
2155
|
+
plan: AssistantExecutionPlan;
|
|
2156
|
+
status: 'in_progress' | 'blocked' | 'completed' | 'failed' | 'cancelled' | string;
|
|
2157
|
+
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2158
|
+
}
|
|
2159
|
+
interface AssistantActionRequired {
|
|
2160
|
+
assistantActionRequiredId: string;
|
|
2161
|
+
actionExecutionId?: string | null;
|
|
2162
|
+
assistantThreadId: string;
|
|
2163
|
+
assistantMessageId: string;
|
|
2164
|
+
kind: 'approval' | 'clarification' | 'plan' | string;
|
|
2165
|
+
status?: string;
|
|
2166
|
+
title: string;
|
|
2167
|
+
summary: string;
|
|
2168
|
+
payload: Record<string, any> | null;
|
|
2169
|
+
expiresAt: Date | string | null;
|
|
2170
|
+
toolName: string | null;
|
|
2171
|
+
toolExecutionId?: string | null;
|
|
2172
|
+
body?: {
|
|
2173
|
+
prompt: string;
|
|
2174
|
+
description: string | null;
|
|
2175
|
+
inputType: string | null;
|
|
2176
|
+
choices: any[] | null;
|
|
2177
|
+
allowCustomResponse: boolean;
|
|
2178
|
+
customResponseLabel: string | null;
|
|
2179
|
+
customResponsePlaceholder: string | null;
|
|
2180
|
+
selected: {
|
|
2181
|
+
decision: string;
|
|
2182
|
+
responseText: string | null;
|
|
2183
|
+
responsePayload: Record<string, any> | null;
|
|
2184
|
+
runtimeOptions?: Record<string, any> | null;
|
|
2185
|
+
} | null;
|
|
2186
|
+
arguments: Record<string, any> | null;
|
|
2187
|
+
approval: Record<string, any> | null;
|
|
2188
|
+
planningTransition?: AssistantPlanningTransition | null;
|
|
2189
|
+
};
|
|
2190
|
+
planningTransition?: AssistantPlanningTransition | null;
|
|
2191
|
+
}
|
|
2192
|
+
interface AssistantThread {
|
|
2193
|
+
assistantThreadId: string;
|
|
2194
|
+
title: string;
|
|
2195
|
+
status: string;
|
|
2196
|
+
model?: string;
|
|
2197
|
+
reasoning?: string | null;
|
|
2198
|
+
executionMode?: 'interactive' | 'background' | 'automation' | string;
|
|
2199
|
+
planningPolicy?: 'standard' | 'review_required' | string;
|
|
2200
|
+
visibleContextTokens?: number;
|
|
2201
|
+
visibleInputTokens?: number;
|
|
2202
|
+
visibleOutputTokens?: number;
|
|
2203
|
+
visibleCachedInputTokens?: number;
|
|
2204
|
+
visibleReasoningTokens?: number;
|
|
2205
|
+
totalContextTokens?: number;
|
|
2206
|
+
totalBilledTokens?: number;
|
|
2207
|
+
forkedFromAssistantMessageId?: string | null;
|
|
2208
|
+
forkedFromAssistantThreadId?: string | null;
|
|
2209
|
+
contextWindowTokensUsed?: number;
|
|
2210
|
+
contextWindowMaxTokens?: number;
|
|
2211
|
+
contextWindowPercent?: number;
|
|
2212
|
+
actionRequired?: AssistantActionRequired | null;
|
|
2213
|
+
executionPlan?: AssistantPublicExecutionPlan | null;
|
|
2214
|
+
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2215
|
+
goal?: AssistantThreadGoal | null;
|
|
2216
|
+
share?: AssistantThreadShare | null;
|
|
2217
|
+
createdBy?: string;
|
|
2218
|
+
createdAt?: Date | string;
|
|
2219
|
+
lastUpdateBy?: string;
|
|
2220
|
+
lastUpdateAt?: Date | string;
|
|
2221
|
+
deletedBy?: string | null;
|
|
2222
|
+
deletedAt?: Date | string | null;
|
|
2223
|
+
version?: number;
|
|
2224
|
+
}
|
|
2225
|
+
interface AssistantThreadGoal {
|
|
2226
|
+
version: 1;
|
|
2227
|
+
assistantThreadId: string;
|
|
2228
|
+
revision: number;
|
|
2229
|
+
status: 'active' | 'paused' | 'completed' | 'blocked' | 'cleared';
|
|
2230
|
+
objective: string | null;
|
|
2231
|
+
source: 'user' | 'api' | 'message' | 'system';
|
|
2232
|
+
createdAt: string;
|
|
2233
|
+
updatedAt: string;
|
|
2234
|
+
updatedBy: string | null;
|
|
2235
|
+
validation: {
|
|
2236
|
+
status: 'satisfied' | 'unsatisfied' | 'partial' | 'skipped';
|
|
2237
|
+
reviewedAt: string;
|
|
2238
|
+
rationale: string | null;
|
|
2239
|
+
evidenceRefs?: string[];
|
|
2240
|
+
} | null;
|
|
2241
|
+
}
|
|
2242
|
+
interface AssistantMessage {
|
|
2243
|
+
assistantMessageId: string;
|
|
2244
|
+
assistantThreadId: string;
|
|
2245
|
+
role: 'user' | 'assistant' | string;
|
|
2246
|
+
kind: string;
|
|
2247
|
+
message: string;
|
|
2248
|
+
contentTokens?: number;
|
|
2249
|
+
totalTokens?: number;
|
|
2250
|
+
createdBy?: string;
|
|
2251
|
+
createdAt?: Date | string;
|
|
2252
|
+
}
|
|
2253
|
+
interface AssistantThreadState {
|
|
2254
|
+
thread: AssistantThread;
|
|
2255
|
+
actionRequired: AssistantActionRequired | null;
|
|
2256
|
+
executionPlan: AssistantPublicExecutionPlan | null;
|
|
2257
|
+
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2258
|
+
goal?: AssistantThreadGoal | null;
|
|
2259
|
+
}
|
|
2260
|
+
interface AssistantThreadShare {
|
|
2261
|
+
shareId: string;
|
|
2262
|
+
assistantThreadId: string;
|
|
2263
|
+
enabled: boolean;
|
|
2264
|
+
createdBy?: string;
|
|
2265
|
+
createdAt?: Date | string;
|
|
2266
|
+
updatedAt?: Date | string;
|
|
2267
|
+
revokedAt?: Date | string | null;
|
|
2268
|
+
revokedBy?: string | null;
|
|
2269
|
+
}
|
|
2270
|
+
interface AssistantSharedThreadResponse {
|
|
2271
|
+
share: AssistantThreadShare;
|
|
2272
|
+
thread: AssistantThread;
|
|
2273
|
+
permissions: {
|
|
2274
|
+
readOnly: boolean;
|
|
2275
|
+
canFork: boolean;
|
|
2276
|
+
canContinue: boolean;
|
|
2277
|
+
canManageShare: boolean;
|
|
2278
|
+
};
|
|
2279
|
+
}
|
|
2280
|
+
interface AssistantThreadResponse {
|
|
2281
|
+
thread: AssistantThread;
|
|
2282
|
+
message?: AssistantMessage | null;
|
|
2283
|
+
assistantMessage?: AssistantMessage | null;
|
|
2284
|
+
noticeMessages?: AssistantMessage[];
|
|
2285
|
+
actionRequired?: AssistantActionRequired | null;
|
|
2286
|
+
assistantExecutionPlanId?: string | null;
|
|
2287
|
+
executionPlan?: AssistantExecutionPlan | null;
|
|
2288
|
+
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2289
|
+
}
|
|
2290
|
+
interface AssistantThreadCompactionRequest {
|
|
2291
|
+
version?: 'v1' | 'v2';
|
|
2292
|
+
keepContext?: boolean;
|
|
2293
|
+
content?: string;
|
|
2294
|
+
}
|
|
2295
|
+
interface RevoApi {
|
|
2296
|
+
createDatabase(data: DatabaseCreateInput): Promise<Database>;
|
|
2297
|
+
cloneDatabase<TAsync extends boolean = false>(databaseIdOrName: string, options?: DatabaseCloneInput & {
|
|
2298
|
+
async?: TAsync;
|
|
2299
|
+
}): Promise<TAsync extends true ? CloneDatabaseAcceptedResponse : TAsync extends false ? CloneDatabaseCompletedResponse : CloneDatabaseResponse>;
|
|
2300
|
+
exportDatabase<TAsync extends boolean = false>(databaseIdOrName: string, options?: ExportDatabaseOptions & {
|
|
2301
|
+
async?: TAsync;
|
|
2302
|
+
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
2303
|
+
exportDatabaseView<TAsync extends boolean = false>(databaseViewIdOrName: string, options?: ExportDatabaseOptions & {
|
|
2304
|
+
async?: TAsync;
|
|
2305
|
+
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
2306
|
+
updateDatabase(databaseId: string, data: DatabaseUpdateInput): Promise<Database>;
|
|
2307
|
+
deleteDatabase(databaseId: string): Promise<void>;
|
|
2308
|
+
restoreDatabase(databaseId: string): Promise<void>;
|
|
2309
|
+
truncateDatabase(databaseId: string, options?: TruncateDatabaseOptions): Promise<void>;
|
|
2310
|
+
getDatabaseData<T = any>(name: string, request?: SelectInput): Promise<GetDatabaseDataResponse<T>>;
|
|
2311
|
+
getDatabaseViewData<T = any>(name: string, request?: SelectInput): Promise<GetDatabaseDataResponse<T>>;
|
|
2312
|
+
getDatabaseAudit(name: string, query?: DatabaseAuditQuery): Promise<DatabaseAuditResponse>;
|
|
2313
|
+
insertDatabaseData(name: string, data: LooseObject<any>[]): Promise<DatabaseDataActionResponse>;
|
|
2314
|
+
upsertDatabaseData(name: string, data: LooseObject<any>[]): Promise<DatabaseDataActionResponse>;
|
|
2315
|
+
updateDatabaseData(name: string, oldObject: LooseObject<any>, newObject: LooseObject<any>): Promise<ResourceItem>;
|
|
2316
|
+
deleteDatabaseData(name: string, data: ResourceItem[]): Promise<any>;
|
|
2317
|
+
updateDatabaseDataRequest(name: string, request: DatabaseMutationRequest, payload: Record<string, any>, options?: {
|
|
2318
|
+
return?: boolean;
|
|
2319
|
+
onlyKeys?: boolean;
|
|
2320
|
+
}): Promise<{
|
|
2321
|
+
success: number;
|
|
2322
|
+
elapsed: number;
|
|
2323
|
+
data?: any;
|
|
2324
|
+
}>;
|
|
2325
|
+
deleteDatabaseDataRequest(name: string, request: DatabaseMutationRequest, options?: {
|
|
2326
|
+
return?: boolean;
|
|
2327
|
+
onlyKeys?: boolean;
|
|
2328
|
+
}): Promise<{
|
|
2329
|
+
success: number;
|
|
2330
|
+
elapsed: number;
|
|
2331
|
+
data?: any;
|
|
2332
|
+
}>;
|
|
2333
|
+
queryDatabase(query: string, params?: any[]): Promise<any>;
|
|
2334
|
+
currentUser(): LoggedUser;
|
|
2335
|
+
isDebug(): boolean;
|
|
2336
|
+
disableDebug(): void;
|
|
2337
|
+
enableDebug(): void;
|
|
2338
|
+
getCache(key: string): any;
|
|
2339
|
+
setCache(key: string, value: any): void;
|
|
2340
|
+
getContext(): Context;
|
|
2341
|
+
getErrors(): ProcessLog[];
|
|
2342
|
+
getWarnings(): ProcessLog[];
|
|
2343
|
+
getExecutionId(): string;
|
|
2344
|
+
getLogs(): LooseObject<any>[];
|
|
2345
|
+
getOperationId(): string;
|
|
2346
|
+
executeComponent<T = LooseObject<any>>(request: ComponentExecuteRequest): Promise<ComponentExecuteResult<T>>;
|
|
2347
|
+
input(name?: string): Input;
|
|
2348
|
+
log(log: string | LogInterface, type?: 'ERROR' | 'WARN' | 'INFO' | 'DEBUG', duration?: number, time?: string): void;
|
|
2349
|
+
exit(): void;
|
|
2350
|
+
throw(code: number, body?: any): void;
|
|
2351
|
+
getCurrentInstance(): string;
|
|
2352
|
+
getInstanceData(dataSource: 'Users' | 'Groups' | 'RoleGroups' | 'Keys' | 'Secrets' | 'SecretsData' | 'Templates' | 'Events' | 'Schedule' | 'Jobs' | 'Webhooks' | 'Components' | 'Logs' | 'Files' | 'EventsHistory' | 'Endpoints' | 'Databases' | 'DatabaseData', request?: InstanceData): Promise<any>;
|
|
2353
|
+
getInstanceDetails(): InstanceDetails;
|
|
2354
|
+
getSecret(name: string): Promise<string>;
|
|
2355
|
+
getSecrets(name: string[]): Promise<{
|
|
2356
|
+
[key: string]: string;
|
|
2357
|
+
}>;
|
|
2358
|
+
publishMessage(channel: string, message: any): Promise<void>;
|
|
2359
|
+
getInstanceCache(key: string): Promise<any>;
|
|
2360
|
+
setInstanceCache(key: string, value: any, seconds?: number): Promise<void>;
|
|
2361
|
+
setInstanceCacheIfNotExists(key: string, value: any, seconds?: number): Promise<boolean>;
|
|
2362
|
+
getOrSetInstanceCache(key: string, value: any, seconds?: number): Promise<any>;
|
|
2363
|
+
removeInstanceCache(key: string, wildcard?: boolean): Promise<void>;
|
|
2364
|
+
existsInstanceCache(key: string): Promise<boolean>;
|
|
2365
|
+
persistInstanceCache(key: string): Promise<void>;
|
|
2366
|
+
expireInstanceCache(key: string, ttl: number): Promise<void>;
|
|
2367
|
+
getExpireInstanceCache(key: string): Promise<number | null>;
|
|
2368
|
+
listInstanceCache(key: string): Promise<string[]>;
|
|
2369
|
+
incrementInstanceCache(key: string, by?: number, seconds?: number): Promise<number>;
|
|
2370
|
+
decrementInstanceCache(key: string, by?: number, seconds?: number): Promise<number>;
|
|
2371
|
+
compareAndSetInstanceCache(key: string, expected: any, value: any, seconds?: number): Promise<boolean>;
|
|
2372
|
+
acquireIdempotencyKey(key: string, ttl: number, value?: any): Promise<boolean>;
|
|
2373
|
+
getIdempotencyKey(key: string): Promise<any>;
|
|
2374
|
+
releaseIdempotencyKey(key: string): Promise<void>;
|
|
2375
|
+
concurrencyLimit(key: string, limit: number, ttl: number): Promise<boolean>;
|
|
2376
|
+
rateLimit(key: string, limit: number, ttl: number): Promise<boolean>;
|
|
2377
|
+
releaseRateLimit(key: string): Promise<void>;
|
|
2378
|
+
releaseConcurrencyLimit(key: string): Promise<void>;
|
|
2379
|
+
triggerEvent(name: string, message: any, scheduleDate?: Date): Promise<string>;
|
|
2380
|
+
triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: any, scheduleDate?: Date): Promise<string>;
|
|
2381
|
+
triggerJob(templateId: string, input?: any, scheduleDate?: Date): Promise<string>;
|
|
2382
|
+
triggerWebhook(webhook: WebhookInput, scheduleDate?: Date): Promise<Webhook>;
|
|
2383
|
+
httpCall(config: HttpRequestInterface, options?: HttpRequestOptionsInterface & {
|
|
2384
|
+
timeout?: number;
|
|
2385
|
+
proxy?: boolean;
|
|
2386
|
+
}): Promise<{
|
|
2387
|
+
status: number;
|
|
2388
|
+
statusText: string;
|
|
2389
|
+
time: number;
|
|
2390
|
+
headers: LooseObject<string>;
|
|
2391
|
+
data: any;
|
|
2392
|
+
storage?: {
|
|
2393
|
+
session: StorageUploadSession;
|
|
2394
|
+
entry: StorageEntryView;
|
|
2395
|
+
};
|
|
2396
|
+
request: {
|
|
2397
|
+
config: HttpRequestInterface & {
|
|
2398
|
+
timeout?: number;
|
|
2399
|
+
};
|
|
2400
|
+
options: HttpRequestOptionsInterface & {
|
|
2401
|
+
timeout?: number;
|
|
2402
|
+
proxy?: boolean;
|
|
2403
|
+
};
|
|
2404
|
+
};
|
|
2405
|
+
}>;
|
|
2406
|
+
sftpExec(commands: any[], config: SFTPClient): Promise<any>;
|
|
2407
|
+
sftpPut(source: SFTPFileSourceRef, path: string, config: SFTPClient): Promise<void>;
|
|
2408
|
+
sftpGet(target: SFTPFileTargetRef, path: string, config: SFTPClient): Promise<void | {
|
|
2409
|
+
session: StorageUploadSession;
|
|
2410
|
+
entry: StorageEntryView;
|
|
2411
|
+
}>;
|
|
2412
|
+
}
|
|
2413
|
+
interface RevoStorage {
|
|
2414
|
+
explore(query?: StorageExploreRequest): Promise<StorageExploreResult>;
|
|
2415
|
+
resolveFolderPath(path: string): Promise<StorageEntryView>;
|
|
2416
|
+
ensureFolderPath(path: string, options?: StorageEnsureFolderPathOptions): Promise<StorageEntryView>;
|
|
2417
|
+
getFile(storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2418
|
+
getFileData(storageEntryId: string, options?: StorageFileReadOptions): Promise<any>;
|
|
2419
|
+
getFileStats(storageEntryId: string, options?: StorageFileStatsOptions): Promise<StorageFileStats>;
|
|
2420
|
+
getEntry(storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2421
|
+
createFolder(data: StorageFolderInput): Promise<StorageEntryView>;
|
|
2422
|
+
putObject(data: StoragePutObjectInput): Promise<StorageEntryView>;
|
|
2423
|
+
createUploadSession(data: StorageUploadSessionInput): Promise<{
|
|
2424
|
+
session: StorageUploadSession;
|
|
2425
|
+
upload: StorageUploadTarget;
|
|
2426
|
+
}>;
|
|
2427
|
+
extendUploadSession(storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2428
|
+
getUploadSession(storageUploadSessionId: string): Promise<StorageUploadSessionView>;
|
|
2429
|
+
uploadPart(storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
|
|
2430
|
+
finalizeUploadSession(storageUploadSessionId: string, data?: StorageUploadSessionFinalizeInput): Promise<{
|
|
2431
|
+
session: StorageUploadSession;
|
|
2432
|
+
entry: StorageEntryView;
|
|
2433
|
+
}>;
|
|
2434
|
+
abortUploadSession(storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2435
|
+
updateEntry(storageEntryId: string, data: StorageEntryUpdateInput): Promise<StorageEntryView>;
|
|
2436
|
+
moveEntry(storageEntryId: string, data: StorageEntryMoveInput): Promise<StorageEntryView>;
|
|
2437
|
+
archiveEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2438
|
+
restoreEntry(storageEntryId: string, data: StorageRestoreInput): Promise<StorageEntryView>;
|
|
2439
|
+
deleteEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2440
|
+
getDownload(storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
|
|
2441
|
+
getText(storageEntryId: string, options?: StorageTextReadOptions): Promise<StorageTextContent>;
|
|
2442
|
+
}
|
|
2443
|
+
interface RevoAgents {
|
|
2444
|
+
list(): Promise<Agent[]>;
|
|
2445
|
+
get(agentId: string): Promise<Agent>;
|
|
2446
|
+
create(data: AgentCreateInput): Promise<Agent>;
|
|
2447
|
+
update(agentId: string, data: AgentUpdateInput): Promise<Agent>;
|
|
2448
|
+
listInbox(agentId: string): Promise<AgentInboxItem[]>;
|
|
2449
|
+
getInboxItem(agentId: string, agentInboxItemId: string): Promise<AgentInboxItem>;
|
|
2450
|
+
pushInbox(agentId: string, data: AgentInboxItemCreateInput): Promise<AgentInboxItem>;
|
|
2451
|
+
updateInboxItem(agentId: string, agentInboxItemId: string, data: AgentInboxItemUpdateInput): Promise<AgentInboxItem>;
|
|
2452
|
+
removeInboxItem(agentId: string, agentInboxItemId: string): Promise<AgentInboxItem>;
|
|
2453
|
+
listPlugins(agentId: string): Promise<AgentPlugin[]>;
|
|
2454
|
+
getPlugin(agentId: string, toolId: string): Promise<AgentPlugin>;
|
|
2455
|
+
listRuns(agentId: string): Promise<AgentRun[]>;
|
|
2456
|
+
getRun(agentRunId: string): Promise<AgentRun>;
|
|
2457
|
+
listRunEvents(agentRunId: string): Promise<AgentRunEvent[]>;
|
|
2458
|
+
listRunThreads(agentRunId: string): Promise<AgentRunThread[]>;
|
|
2459
|
+
startRun(agentId: string, data: AgentRunInput): Promise<AgentRun>;
|
|
2460
|
+
resumeRun(agentRunId: string): Promise<AgentRun>;
|
|
2461
|
+
retryRun(agentRunId: string): Promise<AgentRun>;
|
|
2462
|
+
tickRun(agentRunId: string): Promise<AgentRun>;
|
|
2463
|
+
cancelRun(agentRunId: string, data?: AgentRunCancelInput): Promise<AgentRun>;
|
|
2464
|
+
reconcileRuns(): Promise<any>;
|
|
2465
|
+
listThreads(query?: Record<string, any>): Promise<CollectionResult<AssistantThread>>;
|
|
2466
|
+
getThread(assistantThreadId: string, options?: {
|
|
2467
|
+
hideDeleted?: boolean;
|
|
2468
|
+
}): Promise<AssistantThread>;
|
|
2469
|
+
getThreadState(assistantThreadId: string): Promise<AssistantThreadState>;
|
|
2470
|
+
getThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal | null>;
|
|
2471
|
+
setThreadGoal(assistantThreadId: string, data: AssistantThreadGoalInput): Promise<AssistantThreadGoal>;
|
|
2472
|
+
pauseThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
|
|
2473
|
+
resumeThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
|
|
2474
|
+
clearThreadGoal(assistantThreadId: string): Promise<AssistantThreadGoal>;
|
|
2475
|
+
getThreadShare(assistantThreadId: string): Promise<AssistantThreadShare | null>;
|
|
2476
|
+
enableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
|
|
2477
|
+
disableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
|
|
2478
|
+
getSharedThread(shareId: string): Promise<AssistantSharedThreadResponse>;
|
|
2479
|
+
listSharedThreadMessages(shareId: string, query?: Record<string, any>): Promise<CollectionResult<AssistantMessage>>;
|
|
2480
|
+
getSharedThreadMessageExecutionDetails(shareId: string, assistantMessageId: string): Promise<Record<string, any>>;
|
|
2481
|
+
getSharedThreadMessageArtifact(shareId: string, assistantMessageId: string, artifactId: string): Promise<Record<string, any>>;
|
|
2482
|
+
forkSharedThreadMessage(shareId: string, assistantMessageId: string, data?: AssistantForkMessageInput): Promise<AssistantThreadResponse>;
|
|
2483
|
+
createThread(data: AssistantMessageInput): Promise<AssistantThreadResponse>;
|
|
2484
|
+
deleteThread(assistantThreadId: string): Promise<void>;
|
|
2485
|
+
restoreThread(assistantThreadId: string): Promise<void>;
|
|
2486
|
+
listThreadMessages(assistantThreadId: string, query?: Record<string, any>): Promise<CollectionResult<AssistantMessage>>;
|
|
2487
|
+
sendMessage(assistantThreadId: string, data: AssistantMessageInput): Promise<AssistantThreadResponse>;
|
|
2488
|
+
retryMessage(assistantThreadId: string, assistantMessageId: string): Promise<AssistantThreadResponse>;
|
|
2489
|
+
cancelThread(assistantThreadId: string, expectedVersion: number): Promise<void>;
|
|
2490
|
+
forkMessage(assistantThreadId: string, assistantMessageId: string, data?: AssistantForkMessageInput): Promise<AssistantThreadResponse>;
|
|
2491
|
+
renameThread(assistantThreadId: string, data: AssistantThreadTitleInput): Promise<AssistantThread>;
|
|
2492
|
+
resolveAction(assistantThreadId: string, assistantActionRequiredId: string, data: AssistantActionResolutionInput): Promise<AssistantThreadResponse>;
|
|
2493
|
+
approveAction(assistantThreadId: string, assistantActionRequiredId: string, options?: Omit<AssistantActionResolutionInput, 'decision'>): Promise<AssistantThreadResponse>;
|
|
2494
|
+
rejectAction(assistantThreadId: string, assistantActionRequiredId: string, options?: Omit<AssistantActionResolutionInput, 'decision'>): Promise<AssistantThreadResponse>;
|
|
2495
|
+
submitAction(assistantThreadId: string, assistantActionRequiredId: string, options?: Omit<AssistantActionResolutionInput, 'decision'>): Promise<AssistantThreadResponse>;
|
|
2496
|
+
compactThread(assistantThreadId: string, options?: AssistantThreadCompactionRequest): Promise<AssistantThread>;
|
|
2497
|
+
}
|
|
2498
|
+
interface RevoUtils {
|
|
2499
|
+
sleep(ms: number): Promise<void>;
|
|
2500
|
+
aesDecrypt(encrypted: string, passphrase: string): string;
|
|
2501
|
+
aesEncrypt(payload: string, passphrase: string): string;
|
|
2502
|
+
compareHash(password: string | undefined, hash: string | undefined): Promise<boolean>;
|
|
2503
|
+
isBase64(input: any): boolean;
|
|
2504
|
+
decodeBase64(base64String: string): string;
|
|
2505
|
+
encodeBase64(plainString: string): string;
|
|
2506
|
+
generateHash(password: string | undefined, rounds?: number): Promise<string>;
|
|
2507
|
+
isUUID(input: any): boolean;
|
|
2508
|
+
randomUUID(): string;
|
|
2509
|
+
getUUID(...args: [
|
|
2510
|
+
] | [
|
|
2511
|
+
value: string,
|
|
2512
|
+
namespace: string
|
|
2513
|
+
]): string;
|
|
2514
|
+
hashObject(object: any): string;
|
|
2515
|
+
sha1(payload: string): string;
|
|
2516
|
+
sha256(payload: string): string;
|
|
2517
|
+
md5(payload: string): string;
|
|
2518
|
+
timingSafeEqual(a: string | Buffer, b: string | Buffer): boolean;
|
|
2519
|
+
hmac(payload: Uint8Array | string, secret: string, algorithm?: 'sha1' | 'sha256' | 'sha512', encoding?: 'hex' | 'base64'): string;
|
|
2520
|
+
verifyHmacSignature(payload: Uint8Array | string, signature: string, secret: string, algorithm?: 'sha1' | 'sha256' | 'sha512', encoding?: 'hex' | 'base64'): boolean;
|
|
2521
|
+
base64UrlEncode(input: Uint8Array | string): string;
|
|
2522
|
+
base64UrlDecode(input: string): Uint8Array;
|
|
2523
|
+
randomBytes(size?: number, encoding?: 'hex' | 'base64'): string;
|
|
2524
|
+
randomInt(min?: number, max?: number): number;
|
|
2525
|
+
randomString(length?: number, alphabet?: string): string;
|
|
2526
|
+
otp(length?: number): string;
|
|
2527
|
+
validate(payload: any, schema: ValidatorSchemaInput): ValidationResult<any>;
|
|
2528
|
+
jwtDecode(token: string, options?: {
|
|
2529
|
+
complete?: boolean;
|
|
2530
|
+
json?: boolean;
|
|
2531
|
+
}): any;
|
|
2532
|
+
jwtSign(payload: string | object, secret: string | {
|
|
2533
|
+
key: string;
|
|
2534
|
+
passphrase: string;
|
|
2535
|
+
}, options?: {
|
|
2536
|
+
algorithm?: 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none';
|
|
2537
|
+
keyid?: string;
|
|
2538
|
+
expiresIn?: string | number;
|
|
2539
|
+
notBefore?: string | number;
|
|
2540
|
+
audience?: string | string[];
|
|
2541
|
+
subject?: string;
|
|
2542
|
+
issuer?: string;
|
|
2543
|
+
jwtid?: string;
|
|
2544
|
+
mutatePayload?: boolean;
|
|
2545
|
+
noTimestamp?: boolean;
|
|
2546
|
+
header?: JWTHeader;
|
|
2547
|
+
encoding?: string;
|
|
2548
|
+
allowInsecureKeySizes?: boolean;
|
|
2549
|
+
allowInvalidAsymmetricKeyTypes?: boolean;
|
|
2550
|
+
}): string;
|
|
2551
|
+
jwtVerify(token: string, secret: string | {
|
|
2552
|
+
key: string;
|
|
2553
|
+
passphrase: string;
|
|
2554
|
+
}, options?: {
|
|
2555
|
+
algorithms?: ('HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none')[];
|
|
2556
|
+
audience?: string | RegExp | Array<string | RegExp>;
|
|
2557
|
+
clockTimestamp?: number;
|
|
2558
|
+
clockTolerance?: number;
|
|
2559
|
+
complete?: boolean;
|
|
2560
|
+
issuer?: string | string[];
|
|
2561
|
+
ignoreExpiration?: boolean;
|
|
2562
|
+
ignoreNotBefore?: boolean;
|
|
2563
|
+
jwtid?: string;
|
|
2564
|
+
nonce?: string;
|
|
2565
|
+
subject?: string;
|
|
2566
|
+
maxAge?: string | number;
|
|
2567
|
+
allowInvalidAsymmetricKeyTypes?: boolean;
|
|
2568
|
+
}): any;
|
|
2569
|
+
rsaDecrypt(privateKey: string, payload: string, passphrase?: string): string;
|
|
2570
|
+
rsaEncrypt(publicKey: string, payload: string): string;
|
|
2571
|
+
rsaGeneratePair(config?: {
|
|
2572
|
+
modulusLength?: number;
|
|
2573
|
+
passphrase?: string;
|
|
2574
|
+
}): {
|
|
2575
|
+
publicKey: string;
|
|
2576
|
+
privateKey: string;
|
|
2577
|
+
};
|
|
2578
|
+
rsaSign(privateKey: string, payload: string, passphrase?: string): string;
|
|
2579
|
+
rsaVerify(publicKey: string, payload: string, signature: string): boolean;
|
|
2580
|
+
}
|
|
2581
|
+
|
|
2582
|
+
type StandaloneProfileMethod = 'currentUser' | 'getCurrentInstance' | 'getInstanceDetails';
|
|
2583
|
+
type AsyncMethod<Method> = Method extends (...args: infer Args) => infer Result ? (...args: Args) => Promise<Awaited<Result>> : never;
|
|
2584
|
+
/**
|
|
2585
|
+
* Standalone API surface. Profile methods perform lazy `/api/v1/me` discovery;
|
|
2586
|
+
* hosted execution context methods keep the synchronous `RevoApi` contract.
|
|
2587
|
+
*/
|
|
2588
|
+
type RevoStandaloneApi = Omit<RevoApi, StandaloneProfileMethod> & {
|
|
2589
|
+
[Method in StandaloneProfileMethod]: AsyncMethod<RevoApi[Method]>;
|
|
2590
|
+
};
|
|
2591
|
+
type BatchFailureMode = 'independent' | 'stop';
|
|
2592
|
+
interface RevoBatchOptions {
|
|
2593
|
+
failureMode?: BatchFailureMode;
|
|
2594
|
+
maxCalls?: number;
|
|
2595
|
+
maxRequestBytes?: number;
|
|
2596
|
+
maxInFlight?: number;
|
|
2597
|
+
maxQueuedCalls?: number;
|
|
2598
|
+
}
|
|
2599
|
+
interface RevoClientOptions {
|
|
2600
|
+
baseUrl?: string;
|
|
2601
|
+
apiKey?: string;
|
|
2602
|
+
fetch?: typeof fetch;
|
|
2603
|
+
requestTimeoutMs?: number;
|
|
2604
|
+
batch?: RevoBatchOptions;
|
|
2605
|
+
}
|
|
2606
|
+
interface RevoBatchLimits {
|
|
2607
|
+
maxCalls: number;
|
|
2608
|
+
maxRequestBytes: number;
|
|
2609
|
+
maxResponseBytes?: number;
|
|
2610
|
+
maxInFlight?: number;
|
|
2611
|
+
maxQueuedCalls?: number;
|
|
2612
|
+
}
|
|
2613
|
+
interface SerializedRevoError {
|
|
2614
|
+
code: string;
|
|
2615
|
+
message: string;
|
|
2616
|
+
statusCode?: number;
|
|
2617
|
+
retryable?: boolean;
|
|
2618
|
+
indeterminate?: boolean;
|
|
2619
|
+
causeCallId?: string;
|
|
2620
|
+
details?: unknown;
|
|
2621
|
+
}
|
|
2622
|
+
interface RuntimeCall {
|
|
2623
|
+
callId: string;
|
|
2624
|
+
surface: RuntimeSurfaceName;
|
|
2625
|
+
method: string;
|
|
2626
|
+
args: unknown[];
|
|
2627
|
+
argsMeta?: unknown;
|
|
2628
|
+
}
|
|
2629
|
+
interface RuntimeBatchRequest {
|
|
2630
|
+
protocolVersion: 1;
|
|
2631
|
+
clientVersion: string;
|
|
2632
|
+
contractRevision: string;
|
|
2633
|
+
batchId: string;
|
|
2634
|
+
failureMode: BatchFailureMode;
|
|
2635
|
+
debug?: boolean;
|
|
2636
|
+
calls: RuntimeCall[];
|
|
2637
|
+
}
|
|
2638
|
+
type RuntimeCallResult = {
|
|
2639
|
+
callId: string;
|
|
2640
|
+
status: 'fulfilled';
|
|
2641
|
+
value: unknown;
|
|
2642
|
+
valueMeta?: unknown;
|
|
2643
|
+
} | {
|
|
2644
|
+
callId: string;
|
|
2645
|
+
status: 'rejected';
|
|
2646
|
+
error: SerializedRevoError;
|
|
2647
|
+
} | {
|
|
2648
|
+
callId: string;
|
|
2649
|
+
status: 'skipped';
|
|
2650
|
+
error: SerializedRevoError;
|
|
2651
|
+
};
|
|
2652
|
+
interface RuntimeBatchResponse {
|
|
2653
|
+
protocolVersion: 1;
|
|
2654
|
+
contractRevision: string;
|
|
2655
|
+
limits?: RevoBatchLimits;
|
|
2656
|
+
results: RuntimeCallResult[];
|
|
2657
|
+
}
|
|
2658
|
+
interface RevoBatchController {
|
|
2659
|
+
configure(options: RevoBatchOptions): void;
|
|
2660
|
+
}
|
|
2661
|
+
interface RevoRuntime {
|
|
2662
|
+
readonly api: RevoApi;
|
|
2663
|
+
readonly utils: RevoUtils;
|
|
2664
|
+
readonly storage: RevoStorage;
|
|
2665
|
+
readonly agents: RevoAgents;
|
|
2666
|
+
readonly batch: RevoBatchController;
|
|
2667
|
+
}
|
|
2668
|
+
interface HostedRuntimeBootstrap {
|
|
2669
|
+
bridgePort: node_worker_threads.MessagePort;
|
|
2670
|
+
instanceId?: string;
|
|
2671
|
+
currentUser?: unknown;
|
|
2672
|
+
instanceDetails?: unknown;
|
|
2673
|
+
input?: unknown;
|
|
2674
|
+
context?: unknown;
|
|
2675
|
+
debug?: boolean;
|
|
2676
|
+
executionId?: string;
|
|
2677
|
+
operationId?: string;
|
|
2678
|
+
componentId?: string;
|
|
2679
|
+
componentVersion?: number;
|
|
2680
|
+
deadlineMs?: number;
|
|
2681
|
+
legacyApi?: Readonly<Record<string, unknown>>;
|
|
2682
|
+
batch?: RevoBatchOptions;
|
|
2683
|
+
}
|
|
2684
|
+
interface RevoRuntimeBridgeRequest {
|
|
2685
|
+
type: 'revo-runtime-call';
|
|
2686
|
+
requestId: string;
|
|
2687
|
+
request: RuntimeBatchRequest;
|
|
2688
|
+
}
|
|
2689
|
+
interface RevoRuntimeBridgeTransportError {
|
|
2690
|
+
code: string;
|
|
2691
|
+
message: string;
|
|
2692
|
+
retryable?: boolean;
|
|
2693
|
+
indeterminate?: boolean;
|
|
2694
|
+
}
|
|
2695
|
+
interface RevoRuntimeBridgeResponse {
|
|
2696
|
+
type: 'revo-runtime-response';
|
|
2697
|
+
requestId: string;
|
|
2698
|
+
status?: number;
|
|
2699
|
+
body?: unknown;
|
|
2700
|
+
transportError?: RevoRuntimeBridgeTransportError;
|
|
2701
|
+
}
|
|
2702
|
+
|
|
2703
|
+
declare class RevoError extends Error {
|
|
2704
|
+
readonly code: string;
|
|
2705
|
+
readonly statusCode?: number;
|
|
2706
|
+
readonly retryable: boolean;
|
|
2707
|
+
readonly indeterminate: boolean;
|
|
2708
|
+
readonly details?: unknown;
|
|
2709
|
+
constructor(message: string, options?: {
|
|
2710
|
+
code?: string;
|
|
2711
|
+
statusCode?: number;
|
|
2712
|
+
retryable?: boolean;
|
|
2713
|
+
indeterminate?: boolean;
|
|
2714
|
+
details?: unknown;
|
|
2715
|
+
cause?: unknown;
|
|
2716
|
+
});
|
|
2717
|
+
}
|
|
2718
|
+
declare class RevoConfigurationError extends RevoError {
|
|
2719
|
+
constructor(message: string);
|
|
2720
|
+
}
|
|
2721
|
+
declare class RevoAuthenticationError extends RevoError {
|
|
2722
|
+
constructor(message: string, statusCode?: number, details?: unknown);
|
|
2723
|
+
}
|
|
2724
|
+
declare class RevoPermissionDeniedError extends RevoError {
|
|
2725
|
+
constructor(message: string, details?: unknown);
|
|
2726
|
+
}
|
|
2727
|
+
declare class RevoRuntimeContextUnavailableError extends RevoError {
|
|
2728
|
+
constructor(method: string);
|
|
2729
|
+
}
|
|
2730
|
+
declare class RevoBatchConfigurationError extends RevoError {
|
|
2731
|
+
constructor(message: string);
|
|
2732
|
+
}
|
|
2733
|
+
declare class RevoBatchLimitError extends RevoError {
|
|
2734
|
+
constructor(message: string, details?: unknown);
|
|
2735
|
+
}
|
|
2736
|
+
declare class RevoProtocolError extends RevoError {
|
|
2737
|
+
constructor(message: string, details?: unknown);
|
|
2738
|
+
}
|
|
2739
|
+
declare class RevoTransportError extends RevoError {
|
|
2740
|
+
constructor(message: string, options?: {
|
|
2741
|
+
statusCode?: number;
|
|
2742
|
+
retryable?: boolean;
|
|
2743
|
+
indeterminate?: boolean;
|
|
2744
|
+
details?: unknown;
|
|
2745
|
+
cause?: unknown;
|
|
2746
|
+
});
|
|
2747
|
+
}
|
|
2748
|
+
declare class RevoRemoteError extends RevoError {
|
|
2749
|
+
readonly causeCallId?: string;
|
|
2750
|
+
constructor(error: SerializedRevoError);
|
|
2751
|
+
}
|
|
2752
|
+
declare class RevoExecutionExit extends RevoError {
|
|
2753
|
+
constructor();
|
|
2754
|
+
}
|
|
2755
|
+
declare class RevoHttpResponseError extends RevoError {
|
|
2756
|
+
readonly body: unknown;
|
|
2757
|
+
constructor(statusCode: number, body?: unknown);
|
|
2758
|
+
}
|
|
2759
|
+
|
|
2760
|
+
export { type RuntimeCall as A, type BatchFailureMode as B, CONTRACT_REVISION as C, type RuntimeCallResult as D, type SerializedRevoError as E, type HostedRuntimeBootstrap as H, 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 RevoAgents as i, type RevoBatchController as j, type RevoClientOptions as k, type RevoApi as l, RevoAuthenticationError as m, RevoBatchConfigurationError as n, RevoBatchLimitError as o, type RevoBatchLimits as p, type RevoBatchOptions as q, RevoConfigurationError as r, RevoError as s, RevoPermissionDeniedError as t, RevoProtocolError as u, RevoRemoteError as v, RevoRuntimeContextUnavailableError as w, RevoTransportError as x, type RuntimeBatchRequest as y, type RuntimeBatchResponse as z };
|