@revoengine/sdk 1.6.2 → 1.6.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -7
- package/dist/{errors-CYOB1Jvd.d.cts → errors-BA9TUmFF.d.cts} +545 -31
- package/dist/{errors-CYOB1Jvd.d.ts → errors-BA9TUmFF.d.ts} +545 -31
- package/dist/hosted.cjs +5291 -2591
- package/dist/hosted.cjs.map +1 -1
- package/dist/hosted.d.cts +3 -2
- package/dist/hosted.d.ts +3 -2
- package/dist/hosted.js +5291 -2591
- package/dist/hosted.js.map +1 -1
- package/dist/index.cjs +5295 -2591
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4714 -2331
- package/dist/index.d.ts +4714 -2331
- package/dist/index.js +5295 -2591
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import * as node_worker_threads from 'node:worker_threads';
|
|
2
|
+
import { Buffer as Buffer$1 } from 'node:buffer';
|
|
2
3
|
|
|
3
|
-
declare const SDK_VERSION: "1.6.
|
|
4
|
+
declare const SDK_VERSION: "1.6.4";
|
|
4
5
|
declare const PROTOCOL_VERSION: 1;
|
|
5
|
-
declare const CONTRACT_REVISION: "
|
|
6
|
-
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
|
|
6
|
+
declare const CONTRACT_REVISION: "d2b7e94d335d87dd070d2a97a043704b61b8c8d5c28435c20aceeda9581b70e4";
|
|
7
|
+
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
|
|
7
8
|
|
|
8
9
|
// AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
|
|
9
10
|
// Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
|
|
@@ -43,7 +44,7 @@ interface SwaggerAgentCheapTurnPolicyDto {
|
|
|
43
44
|
}
|
|
44
45
|
interface SwaggerAgentConfigDto {
|
|
45
46
|
/** Supported assistant model used when the agent starts a thread. */
|
|
46
|
-
"model"?: "gpt-6-sol" | "gpt-6-luna";
|
|
47
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
47
48
|
/** Reasoning effort passed to assistant threads. */
|
|
48
49
|
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
49
50
|
/** Durable execution-mode default used for agent-loop turns. Per-turn fast-path routing and prompt-tier selection are derived by runtime, not configured here. */
|
|
@@ -56,6 +57,8 @@ interface SwaggerAgentConfigDto {
|
|
|
56
57
|
"persona"?: "friendly" | "pragmatic" | "professional" | "concise" | "calm" | "mentor" | "assertive";
|
|
57
58
|
/** Additional per-agent system instructions persisted with the definition. Runtime policy still has higher priority. */
|
|
58
59
|
"systemInstructions"?: string;
|
|
60
|
+
/** One persistent Agent memory shared by Memory settings and runtime memory tools, included in instructions on every turn. Limited to 20,000 assistant tokens. */
|
|
61
|
+
"memory"?: string;
|
|
59
62
|
/** Structured operator-owned Agent identity loaded on every autonomous turn. Learned memory cannot mutate this definition. */
|
|
60
63
|
"definition"?: SwaggerAgentDefinitionDto;
|
|
61
64
|
/** Durable cross-run memory defaults such as recall budget, retained summary size, and retention horizon. */
|
|
@@ -70,6 +73,10 @@ interface SwaggerAgentConfigDto {
|
|
|
70
73
|
"toolNames"?: Array<string>;
|
|
71
74
|
/** 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. */
|
|
72
75
|
"pluginIds"?: Array<string>;
|
|
76
|
+
/** Attached or inherited default registry plugin IDs to load eagerly. IDs outside the effective Agent plugin access set are rejected. */
|
|
77
|
+
"eagerPluginIds"?: Array<string>;
|
|
78
|
+
/** Selected terminal IDs available to this Agent. An empty selection permits no terminals. Each use also requires the historical execution service account and its current terminal/workspace ACL. */
|
|
79
|
+
"agentTerminalIds"?: Array<string>;
|
|
73
80
|
/** Primary plugin contract surface. Plugins are provider-governed and define the executable agent-plugin surface. */
|
|
74
81
|
"plugins"?: Array<SwaggerAgentPluginConfigDto>;
|
|
75
82
|
/** Maximum number of concurrently admitted root runs for this agent. Additional root runs remain queued until capacity is released. */
|
|
@@ -476,6 +483,39 @@ interface SwaggerDatabaseIndexPredicateDto {
|
|
|
476
483
|
interface SwaggerDatabaseOptionsDto {
|
|
477
484
|
"indexes"?: Array<SwaggerDatabaseIndexDefinitionDto>;
|
|
478
485
|
}
|
|
486
|
+
interface SwaggerDatabaseViewActionExecuteDto {
|
|
487
|
+
"action": "UPDATE" | "DELETE";
|
|
488
|
+
"targetDatabaseId": string;
|
|
489
|
+
"keyMapping": Record<string, unknown>;
|
|
490
|
+
"mutationToken": string;
|
|
491
|
+
"data"?: Record<string, unknown> | Array<{
|
|
492
|
+
"column": string;
|
|
493
|
+
"op": "set" | "setNull" | "add" | "subtract" | "multiply" | "divide" | "abs" | "floor" | "ceil" | "sqrt" | "round" | "pow" | "toggle" | "addInterval" | "subtractInterval" | "truncate" | "prepend" | "append" | "insert" | "replace" | "trim" | "lower" | "upper" | "mergeJson" | "setJsonPath" | "removeJsonPath" | "addItems" | "removeItems";
|
|
494
|
+
"value"?: unknown | null;
|
|
495
|
+
"position"?: number;
|
|
496
|
+
"search"?: string;
|
|
497
|
+
"path"?: Array<string>;
|
|
498
|
+
"create"?: boolean;
|
|
499
|
+
"unit"?: string;
|
|
500
|
+
"nulls"?: "preserve" | "empty";
|
|
501
|
+
}>;
|
|
502
|
+
"return"?: boolean;
|
|
503
|
+
"onlyKeys"?: boolean;
|
|
504
|
+
}
|
|
505
|
+
interface SwaggerDeleteDatabaseRequestDto {
|
|
506
|
+
/** Filter object or array of filter objects. */
|
|
507
|
+
"filter": Record<string, unknown>;
|
|
508
|
+
/** Join definition for filtering. */
|
|
509
|
+
"join"?: Record<string, unknown>;
|
|
510
|
+
/** Limit of affected rows. */
|
|
511
|
+
"take"?: number;
|
|
512
|
+
/** Offset of affected rows. */
|
|
513
|
+
"skip"?: number;
|
|
514
|
+
/** Return updated rows. */
|
|
515
|
+
"return"?: boolean;
|
|
516
|
+
/** Return only primary keys (reduces payload). */
|
|
517
|
+
"onlyKeys"?: boolean;
|
|
518
|
+
}
|
|
479
519
|
interface SwaggerPartitionDefinition {
|
|
480
520
|
/** Partition type. */
|
|
481
521
|
"type"?: "LIST" | "RANGE" | "HASH";
|
|
@@ -504,6 +544,36 @@ interface SwaggerPartitionDefinition {
|
|
|
504
544
|
*/
|
|
505
545
|
"remainder"?: number;
|
|
506
546
|
}
|
|
547
|
+
interface SwaggerServiceAccountAccessDto {
|
|
548
|
+
/** Restrict management access to explicitly assigned users and groups. */
|
|
549
|
+
"restricted": boolean;
|
|
550
|
+
/** User UUID/email references or {id}/{mail}. No implicit creator/self access after creation. */
|
|
551
|
+
"users"?: Array<string | {
|
|
552
|
+
"id": string;
|
|
553
|
+
} | {
|
|
554
|
+
"mail": string;
|
|
555
|
+
}>;
|
|
556
|
+
/** Exact group name/UUID references or {id}/{name}. */
|
|
557
|
+
"groups"?: Array<string | {
|
|
558
|
+
"id": string;
|
|
559
|
+
} | {
|
|
560
|
+
"name": string;
|
|
561
|
+
}>;
|
|
562
|
+
}
|
|
563
|
+
interface SwaggerServiceAccountMembershipsDto {
|
|
564
|
+
/** Execution group memberships. Requires USER_ADMIN or INSTANCE_ADMIN. */
|
|
565
|
+
"groups"?: Array<string | {
|
|
566
|
+
"id": string;
|
|
567
|
+
} | {
|
|
568
|
+
"name": string;
|
|
569
|
+
}>;
|
|
570
|
+
/** Assigned active role groups. Delegators may assign only their own active groups without INSTANCE_ADMIN. */
|
|
571
|
+
"roleGroups"?: Array<string | {
|
|
572
|
+
"id": string;
|
|
573
|
+
} | {
|
|
574
|
+
"name": string;
|
|
575
|
+
}>;
|
|
576
|
+
}
|
|
507
577
|
interface SwaggerStorageCellInputDto {
|
|
508
578
|
/** A1 cell address. */
|
|
509
579
|
"address": string;
|
|
@@ -511,7 +581,7 @@ interface SwaggerStorageCellInputDto {
|
|
|
511
581
|
"value"?: string | number | boolean | Record<string, unknown> | Array<unknown> | null;
|
|
512
582
|
/** Excel formula without a leading equals sign. */
|
|
513
583
|
"formula"?: string;
|
|
514
|
-
/** Cached formula result.
|
|
584
|
+
/** Cached formula result. Formulas are not calculated by this operation. Supports JSON-compatible strings, numbers, booleans, arrays, objects, and null. */
|
|
515
585
|
"result"?: string | number | boolean | Record<string, unknown> | Array<unknown> | null;
|
|
516
586
|
/** Declarative cell style for XLSX output. */
|
|
517
587
|
"style"?: Record<string, unknown>;
|
|
@@ -587,6 +657,34 @@ interface SwaggerStorageTabularSchemaPolicyDto {
|
|
|
587
657
|
/** How undeclared source columns are handled. allow retains them, strip omits them from structured rows, and reject fails indexing. Defaults to allow for fallback and reject for strict. The raw file is preserved. */
|
|
588
658
|
"additionalProperties"?: "allow" | "strip" | "reject";
|
|
589
659
|
}
|
|
660
|
+
interface SwaggerUpdateServiceAccountAccessDto {
|
|
661
|
+
/** Restrict management access to explicitly assigned users and groups. */
|
|
662
|
+
"restricted"?: boolean;
|
|
663
|
+
/** User UUID/email references or {id}/{mail}. No implicit creator/self access after creation. */
|
|
664
|
+
"users"?: Array<string | {
|
|
665
|
+
"id": string;
|
|
666
|
+
} | {
|
|
667
|
+
"mail": string;
|
|
668
|
+
}>;
|
|
669
|
+
/** Exact group name/UUID references or {id}/{name}. */
|
|
670
|
+
"groups"?: Array<string | {
|
|
671
|
+
"id": string;
|
|
672
|
+
} | {
|
|
673
|
+
"name": string;
|
|
674
|
+
}>;
|
|
675
|
+
}
|
|
676
|
+
interface SwaggerUserKeyWhitelistDto {
|
|
677
|
+
/** You need to provide name of the user. */
|
|
678
|
+
"name": string;
|
|
679
|
+
/** You need to provide type of whitelist IP,IP_SUBNET,RANGE. */
|
|
680
|
+
"type": string;
|
|
681
|
+
/** Provide a single address, a CIDR network or an address range. */
|
|
682
|
+
"value": string;
|
|
683
|
+
}
|
|
684
|
+
interface SwaggerWebhookMapPatchDto {
|
|
685
|
+
"set"?: Record<string, string>;
|
|
686
|
+
"remove"?: Array<string>;
|
|
687
|
+
}
|
|
590
688
|
interface SwaggerWebhookRequestDetailsDto {
|
|
591
689
|
"url": string;
|
|
592
690
|
"method": "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
@@ -595,6 +693,16 @@ interface SwaggerWebhookRequestDetailsDto {
|
|
|
595
693
|
/** Headers. */
|
|
596
694
|
"headers"?: Record<string, unknown>;
|
|
597
695
|
}
|
|
696
|
+
interface SwaggerWebhookRequestPatchDto {
|
|
697
|
+
"url"?: string;
|
|
698
|
+
"method"?: "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
699
|
+
"headers"?: SwaggerWebhookMapPatchDto;
|
|
700
|
+
"query"?: SwaggerWebhookMapPatchDto;
|
|
701
|
+
/** Additional request paths to mask in the new attempt. Existing masks are always preserved. */
|
|
702
|
+
"maskDetails"?: Array<string>;
|
|
703
|
+
/** Explicit replacement of the whole body. Omitted body reuses the saved body. */
|
|
704
|
+
"body"?: Record<string, unknown> | Array<unknown>;
|
|
705
|
+
}
|
|
598
706
|
interface AgentRunCancelInput {
|
|
599
707
|
/** Optional cancellation reason for audit traces. */
|
|
600
708
|
"reason"?: string;
|
|
@@ -687,6 +795,18 @@ interface DatabaseCreateInput {
|
|
|
687
795
|
/** Advanced structured table options, including composite, expression, covering, and partial indexes. */
|
|
688
796
|
"options"?: SwaggerDatabaseOptionsDto;
|
|
689
797
|
}
|
|
798
|
+
interface ServiceAccountKeyCreateInput {
|
|
799
|
+
/** You need to provide name of the user. */
|
|
800
|
+
"name": string;
|
|
801
|
+
/** Optional resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
802
|
+
"metadata"?: Record<string, unknown> | null;
|
|
803
|
+
/** You can provide if key should be whitelisted. */
|
|
804
|
+
"restricted": boolean;
|
|
805
|
+
/** Use an empty array or null when restricted is false; provide at least one complete entry when restricted is true. */
|
|
806
|
+
"whitelist"?: Array<SwaggerUserKeyWhitelistDto> | null;
|
|
807
|
+
/** Optional API key expiration timestamp. When provided, it must be at least four hours in the future. */
|
|
808
|
+
"expireAt"?: string;
|
|
809
|
+
}
|
|
690
810
|
interface AssistantMessageInput {
|
|
691
811
|
/** Finalized Storage files to link to this message. File access is checked on send and every read. */
|
|
692
812
|
"storageEntryIds"?: Array<string>;
|
|
@@ -694,9 +814,9 @@ interface AssistantMessageInput {
|
|
|
694
814
|
"content": string;
|
|
695
815
|
/** 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. */
|
|
696
816
|
"preflightMessageId"?: string;
|
|
697
|
-
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6 Sol and Luna are supported. */
|
|
698
|
-
"model"?: "gpt-6-sol" | "gpt-6-luna";
|
|
699
|
-
/** Optional GPT-6
|
|
817
|
+
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6.1 Sol and GPT-6 Luna are supported. */
|
|
818
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
819
|
+
/** Optional GPT-6 Luna Fast mode. Defaults to false and remains opt-in per thread. */
|
|
700
820
|
"fastMode"?: boolean;
|
|
701
821
|
/** Optional assistant reasoning effort override: none, low, medium, high, or xhigh. Defaults to medium. */
|
|
702
822
|
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
@@ -725,6 +845,20 @@ interface AssistantMessageInput {
|
|
|
725
845
|
/** 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. */
|
|
726
846
|
"performanceDebugger"?: boolean;
|
|
727
847
|
}
|
|
848
|
+
interface ServiceAccountCreateInput {
|
|
849
|
+
"access"?: SwaggerServiceAccountAccessDto;
|
|
850
|
+
"memberships"?: SwaggerServiceAccountMembershipsDto;
|
|
851
|
+
/** You need to provide name of the user. */
|
|
852
|
+
"name": string;
|
|
853
|
+
/** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
854
|
+
"metadata"?: Record<string, unknown> | null;
|
|
855
|
+
/** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
856
|
+
"metaData"?: Record<string, unknown> | null;
|
|
857
|
+
/** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
858
|
+
"metadataAdvanced"?: Record<string, unknown> | null;
|
|
859
|
+
/** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
860
|
+
"advancedData"?: Record<string, unknown> | null;
|
|
861
|
+
}
|
|
728
862
|
interface StorageFolderInput {
|
|
729
863
|
/** Folder name. */
|
|
730
864
|
"name": string;
|
|
@@ -799,6 +933,31 @@ interface StorageUploadSessionInput {
|
|
|
799
933
|
/** Explicit allowed user ids for the finalized entry. */
|
|
800
934
|
"users"?: Array<string>;
|
|
801
935
|
}
|
|
936
|
+
interface DatabaseOperationInput {
|
|
937
|
+
/** Database ID/name, or view ID when viewAction is provided. */
|
|
938
|
+
"databaseName": string;
|
|
939
|
+
"action": "UPDATE" | "DELETE" | "TRUNCATE";
|
|
940
|
+
/** Filtered selection. Returning rows is not supported in background operations. */
|
|
941
|
+
"request"?: SwaggerDeleteDatabaseRequestDto;
|
|
942
|
+
"data"?: Record<string, unknown> | Array<{
|
|
943
|
+
"column": string;
|
|
944
|
+
"op": "set" | "setNull" | "add" | "subtract" | "multiply" | "divide" | "abs" | "floor" | "ceil" | "sqrt" | "round" | "pow" | "toggle" | "addInterval" | "subtractInterval" | "truncate" | "prepend" | "append" | "insert" | "replace" | "trim" | "lower" | "upper" | "mergeJson" | "setJsonPath" | "removeJsonPath" | "addItems" | "removeItems";
|
|
945
|
+
"value"?: unknown | null;
|
|
946
|
+
"position"?: number;
|
|
947
|
+
"search"?: string;
|
|
948
|
+
"path"?: Array<string>;
|
|
949
|
+
"create"?: boolean;
|
|
950
|
+
"unit"?: string;
|
|
951
|
+
"nulls"?: "preserve" | "empty";
|
|
952
|
+
}>;
|
|
953
|
+
/** Reviewed view mutation. The preview token is validated at admission. */
|
|
954
|
+
"viewAction"?: SwaggerDatabaseViewActionExecuteDto;
|
|
955
|
+
"restartIdentity"?: boolean;
|
|
956
|
+
/** Suppress the terminal System message. Low-code defaults this to true. */
|
|
957
|
+
"skipNotification"?: boolean;
|
|
958
|
+
/** Actor-scoped admission key. Reusing it with a different request is rejected. */
|
|
959
|
+
"idempotencyKey"?: string;
|
|
960
|
+
}
|
|
802
961
|
interface StorageUploadSessionFinalizeInput {
|
|
803
962
|
/** Expected contiguous multipart count (parts 1..N). Use this to fence distributed uploads against missing parts. */
|
|
804
963
|
"expectedPartCount"?: number;
|
|
@@ -815,6 +974,13 @@ interface AssistantForkMessageInput {
|
|
|
815
974
|
/** Optional explicit title for the forked thread. When omitted, orchestration will generate the new thread title. */
|
|
816
975
|
"title"?: string;
|
|
817
976
|
}
|
|
977
|
+
interface JobsBulkInput {
|
|
978
|
+
/** Existing platform filter tree. Exactly one of filter and resource IDs is required. */
|
|
979
|
+
"filter"?: Record<string, unknown>;
|
|
980
|
+
/** Caller-generated key: repeated admission returns the same operation. Maximum 200 characters. */
|
|
981
|
+
"idempotencyKey"?: string;
|
|
982
|
+
"jobIds"?: Array<string>;
|
|
983
|
+
}
|
|
818
984
|
interface StorageEntryMoveInput {
|
|
819
985
|
/** Destination parent folder id. Omit or pass null for root. */
|
|
820
986
|
"parentStorageEntryId"?: string;
|
|
@@ -865,6 +1031,32 @@ interface StoragePutObjectInput {
|
|
|
865
1031
|
FROZEN: Deep archive or legal-hold data kept mainly for audit or recovery obligations. */
|
|
866
1032
|
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
867
1033
|
}
|
|
1034
|
+
interface ServiceAccountQuery {
|
|
1035
|
+
/** Number of rows to skip before pagination starts. Parsed from a query-string integer. */
|
|
1036
|
+
"skip"?: number;
|
|
1037
|
+
/** Maximum number of rows to return. Parsed from a query-string integer. Most list endpoints default to 100 when omitted. */
|
|
1038
|
+
"take"?: number;
|
|
1039
|
+
/** Include the total count in the response envelope only when explicitly true. Omitted or false skips the count query. */
|
|
1040
|
+
"count"?: boolean;
|
|
1041
|
+
/** Filter tree as a JSON string or bracket-style query object. Supports and/or/not groups and field predicates with ops such as 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, and false. Field names are allowed logical fields; relation fields use dot paths such as groups.groupId when exposed by the endpoint. */
|
|
1042
|
+
"filter"?: string;
|
|
1043
|
+
/** Sort definition as a JSON string, indexed array query object, array, or legacy CSV. JSON object values should be ASC or DESC. CSV supports descending fields with a leading dash, for example name,-lastUpdateAt. */
|
|
1044
|
+
"sort"?: string;
|
|
1045
|
+
/** Optional DISTINCT ON logical fields as a JSON array string, indexed array query object, array, or legacy CSV. Selected distinct fields are included in the projection. */
|
|
1046
|
+
"distinct"?: string;
|
|
1047
|
+
/** Optional field projection as a JSON array string, indexed array query object, array, or legacy CSV. String fields must be allowlisted logical fields. Advanced select items may use field, fn, raw, cast, coalesce, or case expressions when the endpoint enables dynamic projection. */
|
|
1048
|
+
"fields"?: string;
|
|
1049
|
+
/** Optional join definitions as a JSON string or bracket-style query object. This is only honored by endpoints that explicitly enable dynamic joins, such as dynamic database data reads. Each join has table, alias, type (left or inner), and an on condition. */
|
|
1050
|
+
"joins"?: string;
|
|
1051
|
+
/** Optional groupBy logical fields as a JSON array string, indexed array query object, array, or legacy CSV. Only honored when the endpoint enables dynamic grouping or already has grouped defaults. */
|
|
1052
|
+
"groupBy"?: string;
|
|
1053
|
+
/** Optional cast mapping as a JSON string or bracket-style query object. Keys are selected aliases or logical fields; values are database definition types such as TEXT, INTEGER, BIGINT, NUMERIC, BOOLEAN, DATE, TIMESTAMP, TIMESTAMPTZ, JSON, JSONB, or UUID where supported. */
|
|
1054
|
+
"cast"?: string;
|
|
1055
|
+
/** Optional CTE definitions as a JSON string or bracket-style query object. Only honored by endpoints that explicitly enable dynamic CTEs. */
|
|
1056
|
+
"with"?: string;
|
|
1057
|
+
/** Enable debug output for the request, including compiled SQL, bound params, and bounded EXPLAIN plans when the endpoint supports it. */
|
|
1058
|
+
"debug"?: boolean;
|
|
1059
|
+
}
|
|
868
1060
|
interface AssistantActionResolutionInput {
|
|
869
1061
|
/** Finalized Storage files linked to this action response. */
|
|
870
1062
|
"storageEntryIds"?: Array<string>;
|
|
@@ -881,8 +1073,8 @@ interface AssistantActionResolutionInput {
|
|
|
881
1073
|
/** 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. */
|
|
882
1074
|
"backgroundProcessing"?: boolean;
|
|
883
1075
|
/** Optional assistant model override for the resumed turn after this action is resolved. */
|
|
884
|
-
"model"?: "gpt-6-sol" | "gpt-6-luna";
|
|
885
|
-
/** Optional Fast-mode override for the resumed turn. Available on GPT-6
|
|
1076
|
+
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
1077
|
+
/** Optional Fast-mode override for the resumed turn. Available only on GPT-6 Luna. */
|
|
886
1078
|
"fastMode"?: boolean;
|
|
887
1079
|
/** Optional assistant reasoning effort override for the resumed turn: none, low, medium, high, or xhigh. */
|
|
888
1080
|
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
@@ -903,9 +1095,21 @@ interface StorageRestoreInput {
|
|
|
903
1095
|
/** Required for TTL-expired entries. Use null to restore without another expiration. */
|
|
904
1096
|
"retention"?: SwaggerStorageRetentionDto | null;
|
|
905
1097
|
}
|
|
1098
|
+
interface ServiceAccountKeyRotateInput {
|
|
1099
|
+
/** Current API key version. */
|
|
1100
|
+
"version": number;
|
|
1101
|
+
/** Old-key overlap in milliseconds. Zero revokes the old key immediately. Existing expiration is never extended. */
|
|
1102
|
+
"gracePeriodMs"?: number;
|
|
1103
|
+
/** New-key ISO expiration, at least four hours ahead. Omission inherits the current expiration; null creates a key without expiration. */
|
|
1104
|
+
"expireAt"?: string | null;
|
|
1105
|
+
/** Authenticator confirmation for personal accounts. */
|
|
1106
|
+
"code"?: string;
|
|
1107
|
+
}
|
|
906
1108
|
interface AgentRunInput {
|
|
907
1109
|
/** Instruction or mission passed to the root agent run. */
|
|
908
1110
|
"instruction": string;
|
|
1111
|
+
/** Readable Agent-workspace storage entries attached to the first conversation message. */
|
|
1112
|
+
"storageEntryIds"?: Array<string>;
|
|
909
1113
|
/** Optional trigger type such as REQUEST, EVENT, or SCHEDULE. */
|
|
910
1114
|
"triggerType"?: string;
|
|
911
1115
|
/** Optional external reference type for correlation. */
|
|
@@ -983,6 +1187,36 @@ interface DatabaseUpdateInput {
|
|
|
983
1187
|
/** Provide current version. */
|
|
984
1188
|
"version": number;
|
|
985
1189
|
}
|
|
1190
|
+
interface ServiceAccountKeyUpdateInput {
|
|
1191
|
+
/** You need to provide name of the user. */
|
|
1192
|
+
"name"?: string;
|
|
1193
|
+
/** Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
1194
|
+
"metadata"?: Record<string, unknown> | null;
|
|
1195
|
+
/** You can provide if key should be whitelisted. */
|
|
1196
|
+
"restricted"?: boolean;
|
|
1197
|
+
/** Use an empty array or null when restricted is false; provide at least one complete entry when setting restricted to true. */
|
|
1198
|
+
"whitelist"?: Array<SwaggerUserKeyWhitelistDto> | null;
|
|
1199
|
+
/** Current API key version used for optimistic concurrency control. */
|
|
1200
|
+
"version": number;
|
|
1201
|
+
/** Optional six-character confirmation code when required by the account policy. */
|
|
1202
|
+
"code"?: string;
|
|
1203
|
+
}
|
|
1204
|
+
interface ServiceAccountUpdateInput {
|
|
1205
|
+
"memberships"?: SwaggerServiceAccountMembershipsDto;
|
|
1206
|
+
/** You need to provide name of the user. */
|
|
1207
|
+
"name"?: string;
|
|
1208
|
+
/** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
1209
|
+
"metadata"?: Record<string, unknown> | null;
|
|
1210
|
+
/** Custom service-account metadata. Top-level keys starting with "__" are reserved for backend use. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
1211
|
+
"metaData"?: Record<string, unknown> | null;
|
|
1212
|
+
/** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
1213
|
+
"metadataAdvanced"?: Record<string, unknown> | null;
|
|
1214
|
+
/** Extended account data with separate permissions. Same JSON format as Metadata. Maximum 16 KiB of UTF-8 JSON and 64 top-level keys. */
|
|
1215
|
+
"advancedData"?: Record<string, unknown> | null;
|
|
1216
|
+
"access"?: SwaggerUpdateServiceAccountAccessDto;
|
|
1217
|
+
/** Current account version for optimistic concurrency. */
|
|
1218
|
+
"version": number;
|
|
1219
|
+
}
|
|
986
1220
|
interface StorageEntryUpdateInput {
|
|
987
1221
|
/** Replacement file retention. Omit to preserve, or set null to clear expiration. */
|
|
988
1222
|
"retention"?: SwaggerStorageRetentionDto | null;
|
|
@@ -1022,8 +1256,10 @@ interface WebhookInput {
|
|
|
1022
1256
|
"proxy"?: boolean;
|
|
1023
1257
|
/** Save entire request. */
|
|
1024
1258
|
"saveDetails"?: boolean;
|
|
1025
|
-
/**
|
|
1026
|
-
"
|
|
1259
|
+
/** Stop delivery on a supported attempt status. Processing of delivery logs is asynchronous. */
|
|
1260
|
+
"stopOnStatuses"?: Array<"UNAUTHENTICATED">;
|
|
1261
|
+
/** Additional retries after the first request: -1 unlimited, 0 no retry, N up to N retries. */
|
|
1262
|
+
"maxRetries"?: number;
|
|
1027
1263
|
/** Provide data */
|
|
1028
1264
|
"request"?: SwaggerWebhookRequestDetailsDto;
|
|
1029
1265
|
/** Mask request details. */
|
|
@@ -1033,6 +1269,25 @@ interface WebhookInput {
|
|
|
1033
1269
|
/** Optional key/value metadata for grouping and querying webhooks. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
1034
1270
|
"metadata"?: Record<string, unknown> | null;
|
|
1035
1271
|
}
|
|
1272
|
+
interface WebhooksBulkInput {
|
|
1273
|
+
/** Existing platform filter tree. Exactly one of filter and resource IDs is required. */
|
|
1274
|
+
"filter"?: Record<string, unknown>;
|
|
1275
|
+
/** Caller-generated key: repeated admission returns the same operation. Maximum 200 characters. */
|
|
1276
|
+
"idempotencyKey"?: string;
|
|
1277
|
+
"webhookIds"?: Array<string>;
|
|
1278
|
+
/** Only allowed for retry. Missing masked values must be supplied explicitly. */
|
|
1279
|
+
"requestPatch"?: SwaggerWebhookRequestPatchDto;
|
|
1280
|
+
}
|
|
1281
|
+
interface AutomationOperation {
|
|
1282
|
+
operationId: string;
|
|
1283
|
+
resource: 'jobs' | 'webhooks';
|
|
1284
|
+
action: 'cancel' | 'retry' | 'delete';
|
|
1285
|
+
status: 'PENDING' | 'PROCESSING' | 'FINISHED' | 'ERROR';
|
|
1286
|
+
total: number;
|
|
1287
|
+
processed: number;
|
|
1288
|
+
skipped: number;
|
|
1289
|
+
failed: number;
|
|
1290
|
+
}
|
|
1036
1291
|
/**
|
|
1037
1292
|
* Canonical public low-code API declarations shared by Monaco and local editors.
|
|
1038
1293
|
* Lifecycle input DTOs are generated from Swagger in api.swagger-contracts.generated.d.ts.
|
|
@@ -1549,7 +1804,8 @@ interface Webhook {
|
|
|
1549
1804
|
status: string;
|
|
1550
1805
|
statusMessage: string;
|
|
1551
1806
|
attempts: number;
|
|
1552
|
-
|
|
1807
|
+
/** Additional retries: -1 unlimited, 0 no retry. */
|
|
1808
|
+
maxRetries: number;
|
|
1553
1809
|
request: LooseObject<any>;
|
|
1554
1810
|
response: LooseObject<any>;
|
|
1555
1811
|
createdBy: string;
|
|
@@ -1564,7 +1820,8 @@ interface LogInterface {
|
|
|
1564
1820
|
}
|
|
1565
1821
|
interface TemplateFormData {
|
|
1566
1822
|
key: string;
|
|
1567
|
-
|
|
1823
|
+
/** Numbers and booleans are sent as text. Read credentials explicitly with vault.get/getAccessToken. */
|
|
1824
|
+
value?: string | number | boolean;
|
|
1568
1825
|
/** Storage entry to append as this multipart part. Use this instead of value for binary content. */
|
|
1569
1826
|
storageEntryId?: string;
|
|
1570
1827
|
/** Storage namespace for storageEntryId. Defaults to explorer. */
|
|
@@ -1617,18 +1874,22 @@ interface HttpRevoResponseScope {
|
|
|
1617
1874
|
}
|
|
1618
1875
|
interface HttpRequestInterface {
|
|
1619
1876
|
url: string;
|
|
1877
|
+
/** Replaces complete `{name}` path segments with URL-encoded bound values. */
|
|
1878
|
+
pathParams?: Record<string, string>;
|
|
1620
1879
|
method: 'POST' | 'PUT' | 'DELETE' | 'GET' | 'PATCH' | 'OPTIONS' | 'HEAD' | 'PURGE' | 'LINK' | 'UNLINK';
|
|
1621
1880
|
timeout?: number;
|
|
1622
|
-
/**
|
|
1623
|
-
headers?: LooseObject<string
|
|
1881
|
+
/** HTTP headers; use an explicitly awaited vault.get/getAccessToken result for credentials. */
|
|
1882
|
+
headers?: LooseObject<string>;
|
|
1624
1883
|
params?: TemplateParameters[];
|
|
1884
|
+
/** Integration-owned payload. Credential values and provider echoes are caller-managed data. */
|
|
1625
1885
|
data?: any;
|
|
1626
1886
|
//@default: undefined
|
|
1627
1887
|
formData?: TemplateFormData[];
|
|
1628
1888
|
}
|
|
1629
1889
|
interface TemplateParameters {
|
|
1630
1890
|
key: string;
|
|
1631
|
-
|
|
1891
|
+
/** Numbers and booleans are sent as text. Legacy plain maps retain '[object Object]' conversion; serialize structured queries explicitly. */
|
|
1892
|
+
value: string | number | boolean | LooseObject<boolean | number | string>;
|
|
1632
1893
|
}
|
|
1633
1894
|
interface ProcessLog {
|
|
1634
1895
|
time: string;
|
|
@@ -2059,7 +2320,7 @@ type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
|
2059
2320
|
* Default is false.
|
|
2060
2321
|
*/
|
|
2061
2322
|
async?: boolean;
|
|
2062
|
-
/** Suppress the export completion/failure System notification for
|
|
2323
|
+
/** Suppress the export completion/failure System notification. Defaults to true for low-code; set false to opt in. */
|
|
2063
2324
|
skipNotification?: boolean;
|
|
2064
2325
|
/** Output format. CSV is the default. XLSX validates the effective row count before starting. */
|
|
2065
2326
|
format?: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
@@ -2082,6 +2343,8 @@ type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
|
2082
2343
|
retention?: StorageRetentionInput;
|
|
2083
2344
|
};
|
|
2084
2345
|
type ImportDatabaseOptions = {
|
|
2346
|
+
/** Suppress System messages; defaults to true in low-code. */
|
|
2347
|
+
skipNotification?: boolean;
|
|
2085
2348
|
storageEntryId: string;
|
|
2086
2349
|
format: 'csv' | 'tsv' | 'ndjson' | 'xlsx';
|
|
2087
2350
|
mode: 'insert' | 'upsert';
|
|
@@ -2428,12 +2691,18 @@ interface AgentConfig {
|
|
|
2428
2691
|
workMode?: AgentWorkMode;
|
|
2429
2692
|
persona?: AgentPersona;
|
|
2430
2693
|
systemInstructions?: string;
|
|
2694
|
+
/** Persistent Agent Memory shared with memory tools and included in every instruction packet; at most 20,000 o200k_base tokens. */
|
|
2695
|
+
memory?: string;
|
|
2431
2696
|
memoryPolicy?: AgentMemoryPolicy;
|
|
2432
2697
|
release?: AgentReleaseConfig;
|
|
2433
2698
|
automation?: AgentAutomationPolicyConfig;
|
|
2434
2699
|
cheapTurn?: AgentCheapTurnPolicy;
|
|
2435
2700
|
toolNames?: string[];
|
|
2436
2701
|
pluginIds?: string[];
|
|
2702
|
+
/** Attached or inherited default plugins to preload; at most 64 IDs, all within the effective Agent access set. */
|
|
2703
|
+
eagerPluginIds?: string[];
|
|
2704
|
+
/** Selected terminals narrow the historical execution service account's current ACL; at most 64 IDs, empty permits none. */
|
|
2705
|
+
agentTerminalIds?: string[];
|
|
2437
2706
|
plugins?: AgentPluginConfig[];
|
|
2438
2707
|
maxActiveRootRuns?: number;
|
|
2439
2708
|
maxChildRuns?: number;
|
|
@@ -2750,6 +3019,225 @@ interface AssistantThreadCompactionRequest {
|
|
|
2750
3019
|
keepContext?: boolean;
|
|
2751
3020
|
content?: string;
|
|
2752
3021
|
}
|
|
3022
|
+
// ApiInterface
|
|
3023
|
+
/** Owner selection; omitted means instance. User scope uses the verified execution account. */
|
|
3024
|
+
interface SecretScopeOptions {
|
|
3025
|
+
scope?: 'instance' | 'user';
|
|
3026
|
+
}
|
|
3027
|
+
/** Null or omission selects NOW at write time. Numbers are Unix epoch milliseconds. */
|
|
3028
|
+
type SecretDate = string | Date | number | null;
|
|
3029
|
+
interface SecretRotateOptions extends SecretScopeOptions {
|
|
3030
|
+
validFrom?: SecretDate;
|
|
3031
|
+
}
|
|
3032
|
+
interface SecretGetOptions extends SecretRotateOptions {
|
|
3033
|
+
/** Exact validFrom timestamp. If both selectors are supplied they must agree. */
|
|
3034
|
+
version?: SecretDate;
|
|
3035
|
+
}
|
|
3036
|
+
interface SecretDeleteOptions extends SecretGetOptions {
|
|
3037
|
+
}
|
|
3038
|
+
interface SecretRevisionListOptions extends SecretScopeOptions {
|
|
3039
|
+
cursor?: string;
|
|
3040
|
+
limit?: number;
|
|
3041
|
+
}
|
|
3042
|
+
interface SecretProperties {
|
|
3043
|
+
category?: string | null;
|
|
3044
|
+
description?: string | null;
|
|
3045
|
+
/** Replacement JSON object, at most 16 KiB and 64 top-level keys. Backend keys are reserved. */
|
|
3046
|
+
metadata?: Record<string, unknown>;
|
|
3047
|
+
}
|
|
3048
|
+
interface SecretCreateInput extends SecretProperties {
|
|
3049
|
+
/** Nonempty text, at most 65,536 characters. */
|
|
3050
|
+
value: string;
|
|
3051
|
+
validFrom?: SecretDate;
|
|
3052
|
+
enabled?: boolean;
|
|
3053
|
+
}
|
|
3054
|
+
interface SecretRotateInput {
|
|
3055
|
+
value: string;
|
|
3056
|
+
}
|
|
3057
|
+
interface SecretUpdateInput extends SecretProperties {
|
|
3058
|
+
/** Parent metadata counter, distinct from a revision's timestamp version. */
|
|
3059
|
+
version: number;
|
|
3060
|
+
}
|
|
3061
|
+
/** Unified metadata-only parent. */
|
|
3062
|
+
interface Secret {
|
|
3063
|
+
name: string;
|
|
3064
|
+
scope: 'instance' | 'user';
|
|
3065
|
+
category: string | null;
|
|
3066
|
+
description: string | null;
|
|
3067
|
+
metadata: Record<string, unknown>;
|
|
3068
|
+
version: number;
|
|
3069
|
+
createdAt: string;
|
|
3070
|
+
updatedAt: string;
|
|
3071
|
+
}
|
|
3072
|
+
interface SecretRevision {
|
|
3073
|
+
name: string;
|
|
3074
|
+
scope: 'instance' | 'user';
|
|
3075
|
+
/** Stable version identity: the unique validFrom timestamp, normalized to ISO. */
|
|
3076
|
+
version: string;
|
|
3077
|
+
enabled: boolean;
|
|
3078
|
+
validFrom: string;
|
|
3079
|
+
createdAt: string;
|
|
3080
|
+
updatedAt: string;
|
|
3081
|
+
}
|
|
3082
|
+
interface SecretWithRevision extends Secret {
|
|
3083
|
+
revision: SecretRevision;
|
|
3084
|
+
}
|
|
3085
|
+
interface SecretValueRevision extends SecretRevision {
|
|
3086
|
+
value: string;
|
|
3087
|
+
}
|
|
3088
|
+
interface SecretWithValue extends Secret {
|
|
3089
|
+
revision: SecretValueRevision;
|
|
3090
|
+
}
|
|
3091
|
+
interface SecretRevisionPage {
|
|
3092
|
+
items: SecretRevision[];
|
|
3093
|
+
nextCursor: string | null;
|
|
3094
|
+
}
|
|
3095
|
+
interface VaultIntegrationConfig {
|
|
3096
|
+
resourceUrl: string;
|
|
3097
|
+
scopes: string[];
|
|
3098
|
+
issuer?: string;
|
|
3099
|
+
clientId?: string;
|
|
3100
|
+
clientSecret?: string;
|
|
3101
|
+
tenantId?: string;
|
|
3102
|
+
metadataScopeAliases?: Record<string, string>;
|
|
3103
|
+
}
|
|
3104
|
+
interface VaultConnectIntegrationInput extends VaultIntegrationConfig {
|
|
3105
|
+
/** Null creates a definition; otherwise use its exact revision from getIntegrationMetadata. */
|
|
3106
|
+
expectedRevision: string | null;
|
|
3107
|
+
}
|
|
3108
|
+
interface VaultAccessToken {
|
|
3109
|
+
accessToken: string;
|
|
3110
|
+
expiresAt: string;
|
|
3111
|
+
tokenType: 'Bearer';
|
|
3112
|
+
}
|
|
3113
|
+
interface VaultIntegrationMetadata {
|
|
3114
|
+
name: string;
|
|
3115
|
+
scope: 'instance' | 'user';
|
|
3116
|
+
revision: string | null;
|
|
3117
|
+
resourceUrl: string;
|
|
3118
|
+
issuer: string;
|
|
3119
|
+
scopes: string[];
|
|
3120
|
+
tenantId: string | null;
|
|
3121
|
+
metadataScopeAliases: Record<string, string>;
|
|
3122
|
+
clientId: string | null;
|
|
3123
|
+
hasClientSecret: boolean;
|
|
3124
|
+
registrationMode: 'dynamic_public' | 'byo_public' | 'byo_confidential';
|
|
3125
|
+
authorizationEndpoint: string;
|
|
3126
|
+
registrationEndpoint: string | null;
|
|
3127
|
+
}
|
|
3128
|
+
interface VaultIntegrationDiscovery {
|
|
3129
|
+
issuers: string[];
|
|
3130
|
+
requiresIssuerSelection: boolean;
|
|
3131
|
+
supportedScopes: string[];
|
|
3132
|
+
issuer?: string;
|
|
3133
|
+
authorizationEndpoint?: string;
|
|
3134
|
+
registrationEndpoint?: string | null;
|
|
3135
|
+
registrationMode?: 'dynamic_public' | 'byo_public' | 'byo_confidential';
|
|
3136
|
+
requiresClientId?: boolean;
|
|
3137
|
+
redirectUri?: string;
|
|
3138
|
+
}
|
|
3139
|
+
interface VaultIntegrationConnectResult {
|
|
3140
|
+
name: string;
|
|
3141
|
+
scope: 'instance' | 'user';
|
|
3142
|
+
revision: string;
|
|
3143
|
+
authorizationUrl: string;
|
|
3144
|
+
}
|
|
3145
|
+
/** Native Vault manager; one contract for instance and verified user ownership.
|
|
3146
|
+
* Instance access requires Secret roles and creator ownership or an administrator.
|
|
3147
|
+
* Secret values return only through get; getAccessToken returns an integration token. Automatic diagnostic previews suppress Secret values.
|
|
3148
|
+
* Writes with readOnly: true throw READ_ONLY_OPERATION_FORBIDDEN before performing the operation.
|
|
3149
|
+
* External provider credentials and OAuth connections have their own lifecycles.
|
|
3150
|
+
*/
|
|
3151
|
+
/** Unique service-account name or ID; explicit selectors avoid ambiguity. */
|
|
3152
|
+
type ServiceAccountRef = string | {
|
|
3153
|
+
id: string;
|
|
3154
|
+
} | {
|
|
3155
|
+
name: string;
|
|
3156
|
+
};
|
|
3157
|
+
interface ServiceAccountRecord {
|
|
3158
|
+
userId: string;
|
|
3159
|
+
name: string;
|
|
3160
|
+
mail: string;
|
|
3161
|
+
serviceAccount: true;
|
|
3162
|
+
status: number;
|
|
3163
|
+
version: number;
|
|
3164
|
+
platformAccess: boolean;
|
|
3165
|
+
access: {
|
|
3166
|
+
restricted: boolean;
|
|
3167
|
+
users: Array<{
|
|
3168
|
+
userId: string;
|
|
3169
|
+
mail: string;
|
|
3170
|
+
name: string;
|
|
3171
|
+
}>;
|
|
3172
|
+
groups: Array<{
|
|
3173
|
+
groupId: string;
|
|
3174
|
+
name: string;
|
|
3175
|
+
}>;
|
|
3176
|
+
};
|
|
3177
|
+
memberships: {
|
|
3178
|
+
groups: string[];
|
|
3179
|
+
roleGroups: string[];
|
|
3180
|
+
};
|
|
3181
|
+
metadata: Record<string, any>;
|
|
3182
|
+
metadataAdvanced: Record<string, any>;
|
|
3183
|
+
}
|
|
3184
|
+
interface ServiceAccountKey {
|
|
3185
|
+
userKeyId: string;
|
|
3186
|
+
name: string;
|
|
3187
|
+
version: number;
|
|
3188
|
+
/** Masked credential label; never the usable credential. */
|
|
3189
|
+
key?: string;
|
|
3190
|
+
restricted: boolean;
|
|
3191
|
+
whitelist?: ServiceAccountKeyCreateInput['whitelist'];
|
|
3192
|
+
expireAt?: Date | null;
|
|
3193
|
+
metadata?: Record<string, any>;
|
|
3194
|
+
deletedAt?: Date | null;
|
|
3195
|
+
createdAt?: Date;
|
|
3196
|
+
lastUpdateAt?: Date;
|
|
3197
|
+
rotatedFromUserKeyId?: string | null;
|
|
3198
|
+
}
|
|
3199
|
+
/** Immutable credentials are revealed once by create/rotate only. */
|
|
3200
|
+
interface ServiceAccountKeyCreated extends ServiceAccountKey {
|
|
3201
|
+
secret: string;
|
|
3202
|
+
}
|
|
3203
|
+
interface ServiceAccountKeyRotated {
|
|
3204
|
+
newKey: ServiceAccountKeyCreated;
|
|
3205
|
+
previousKey: ServiceAccountKey;
|
|
3206
|
+
}
|
|
3207
|
+
interface RevoServiceAccount {
|
|
3208
|
+
get(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3209
|
+
list(query?: ServiceAccountQuery): Promise<CollectionResult<ServiceAccountRecord>>;
|
|
3210
|
+
create(input: ServiceAccountCreateInput): Promise<ServiceAccountRecord>;
|
|
3211
|
+
update(ref: ServiceAccountRef, input: ServiceAccountUpdateInput): Promise<ServiceAccountRecord>;
|
|
3212
|
+
delete(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3213
|
+
activate(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3214
|
+
disable(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3215
|
+
restore(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3216
|
+
enablePlatformAccess(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3217
|
+
disablePlatformAccess(ref: ServiceAccountRef): Promise<ServiceAccountRecord>;
|
|
3218
|
+
getKeys(ref: ServiceAccountRef, query?: ServiceAccountQuery): Promise<CollectionResult<ServiceAccountKey>>;
|
|
3219
|
+
getKey(ref: ServiceAccountRef, userKeyId: string): Promise<ServiceAccountKey>;
|
|
3220
|
+
createKey(ref: ServiceAccountRef, input: ServiceAccountKeyCreateInput): Promise<ServiceAccountKeyCreated>;
|
|
3221
|
+
updateKey(ref: ServiceAccountRef, userKeyId: string, input: ServiceAccountKeyUpdateInput): Promise<ServiceAccountKey>;
|
|
3222
|
+
rotateKey(ref: ServiceAccountRef, userKeyId: string, input: ServiceAccountKeyRotateInput): Promise<ServiceAccountKeyRotated>;
|
|
3223
|
+
revokeKey(ref: ServiceAccountRef, userKeyId: string): Promise<ServiceAccountKey>;
|
|
3224
|
+
}
|
|
3225
|
+
interface RevoVault$1 {
|
|
3226
|
+
get(name: string, options?: SecretGetOptions): Promise<SecretWithValue>;
|
|
3227
|
+
create(name: string, data: SecretCreateInput, options?: SecretScopeOptions): Promise<Secret | null>;
|
|
3228
|
+
update(name: string, data: SecretUpdateInput, options?: SecretScopeOptions): Promise<Secret | null>;
|
|
3229
|
+
delete(name: string, options?: SecretDeleteOptions): Promise<void | null>;
|
|
3230
|
+
rotate(name: string, data: SecretRotateInput, options?: SecretRotateOptions): Promise<SecretWithRevision | null>;
|
|
3231
|
+
listRevisions(name: string, options?: SecretRevisionListOptions): Promise<SecretRevisionPage>;
|
|
3232
|
+
getAccessToken(name: string, options?: SecretScopeOptions): Promise<VaultAccessToken>;
|
|
3233
|
+
getIntegrationMetadata(name: string, options?: SecretScopeOptions): Promise<VaultIntegrationMetadata>;
|
|
3234
|
+
discoverIntegration(name: string, data: VaultIntegrationConfig, options?: SecretScopeOptions): Promise<VaultIntegrationDiscovery>;
|
|
3235
|
+
connectIntegration(name: string, data: VaultConnectIntegrationInput, options?: SecretScopeOptions): Promise<VaultIntegrationConnectResult | null>;
|
|
3236
|
+
disconnectIntegration(name: string, options?: SecretScopeOptions): Promise<{
|
|
3237
|
+
name: string;
|
|
3238
|
+
disabled: boolean;
|
|
3239
|
+
} | null>;
|
|
3240
|
+
}
|
|
2753
3241
|
interface RevoApi {
|
|
2754
3242
|
createDatabase(data: DatabaseCreateInput): Promise<Database>;
|
|
2755
3243
|
cloneDatabase<TAsync extends boolean = false>(name: string, options?: DatabaseCloneInput & {
|
|
@@ -2758,6 +3246,11 @@ interface RevoApi {
|
|
|
2758
3246
|
exportDatabase<TAsync extends boolean = false>(name: string, options?: ExportDatabaseOptions & {
|
|
2759
3247
|
async?: TAsync;
|
|
2760
3248
|
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
3249
|
+
startDatabaseOperation(name: string, options: Omit<DatabaseOperationInput, 'databaseName'>): Promise<{
|
|
3250
|
+
accepted: true;
|
|
3251
|
+
jobId: string;
|
|
3252
|
+
status: string;
|
|
3253
|
+
}>;
|
|
2761
3254
|
importDatabase(name: string, options: ImportDatabaseOptions): Promise<{
|
|
2762
3255
|
importId: string;
|
|
2763
3256
|
jobId: string;
|
|
@@ -2802,8 +3295,6 @@ interface RevoApi {
|
|
|
2802
3295
|
queryDatabase(query: string, params?: any[]): Promise<any>;
|
|
2803
3296
|
currentUser(): LoggedUser;
|
|
2804
3297
|
isDebug(): boolean;
|
|
2805
|
-
disableDebug(): void;
|
|
2806
|
-
enableDebug(): void;
|
|
2807
3298
|
getCache(key: string): any;
|
|
2808
3299
|
setCache(key: string, value: any): void;
|
|
2809
3300
|
getContext(): Context;
|
|
@@ -2847,6 +3338,26 @@ interface RevoApi {
|
|
|
2847
3338
|
triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2848
3339
|
triggerJob(templateIdOrName: string, templateInputs?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2849
3340
|
triggerWebhook(webhook: WebhookInput, options?: AutomationScheduleOptions): Promise<Webhook>;
|
|
3341
|
+
cancelJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3342
|
+
retryJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3343
|
+
deleteJobs(input: JobsBulkInput): Promise<AutomationOperation>;
|
|
3344
|
+
cancelWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3345
|
+
retryWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3346
|
+
deleteWebhooks(input: WebhooksBulkInput): Promise<AutomationOperation>;
|
|
3347
|
+
previewAutomationOperation(resource: 'jobs' | 'webhooks', action: 'cancel' | 'retry' | 'delete', input: JobsBulkInput | WebhooksBulkInput): Promise<{
|
|
3348
|
+
matched: number;
|
|
3349
|
+
eligible: number;
|
|
3350
|
+
}>;
|
|
3351
|
+
getAutomationOperation(operationId: string): Promise<AutomationOperation>;
|
|
3352
|
+
getAutomationOperationItems(operationId: string, after?: string): Promise<{
|
|
3353
|
+
data: Array<{
|
|
3354
|
+
resourceId: string;
|
|
3355
|
+
status: string;
|
|
3356
|
+
resultId: string | null;
|
|
3357
|
+
errorCode: string | null;
|
|
3358
|
+
}>;
|
|
3359
|
+
nextCursor: string | null;
|
|
3360
|
+
}>;
|
|
2850
3361
|
httpCall(config: HttpRequestInterface, options: HttpRequestOptionsInterface & {
|
|
2851
3362
|
responseType: 'storage';
|
|
2852
3363
|
target: HttpStorageTargetRef;
|
|
@@ -3098,16 +3609,6 @@ interface RevoUtils {
|
|
|
3098
3609
|
rsaSign(privateKey: string, payload: string, passphrase?: string): Promise<string>;
|
|
3099
3610
|
rsaVerify(publicKey: string, payload: string, signature: string): Promise<boolean>;
|
|
3100
3611
|
}
|
|
3101
|
-
type VaultScope = 'instance' | 'user' | 'organization';
|
|
3102
|
-
type VaultSource = 'secret' | 'integration';
|
|
3103
|
-
type VaultBoundValue = Readonly<{
|
|
3104
|
-
__revoBoundValue: 'vault-v1';
|
|
3105
|
-
name: string;
|
|
3106
|
-
scope: VaultScope;
|
|
3107
|
-
source: VaultSource;
|
|
3108
|
-
prefix: string;
|
|
3109
|
-
suffix: string;
|
|
3110
|
-
}>;
|
|
3111
3612
|
/** Low-code byte payloads; REST JSON callers retain the base64 option. */
|
|
3112
3613
|
/** Text arrays retain their existing joining rules; bytes are snapshotted before asynchronous upload. */
|
|
3113
3614
|
type StorageBinaryPutObjectInput = Omit<StoragePutObjectInput, 'data'> & {
|
|
@@ -3124,6 +3625,8 @@ type LowCodeLanguage = 'javascript' | 'typescript';
|
|
|
3124
3625
|
interface LowCodeExecuteOptions {
|
|
3125
3626
|
/** Defaults to TypeScript. */
|
|
3126
3627
|
language?: LowCodeLanguage;
|
|
3628
|
+
/** Restrict platform writes for this execution. Inherits the hosted runtime mode when omitted. */
|
|
3629
|
+
readOnly?: boolean;
|
|
3127
3630
|
/** Input exposed through api.input() inside the low-code execution. */
|
|
3128
3631
|
inputs?: any;
|
|
3129
3632
|
/** Maximum execution time in milliseconds. Defaults to 60 seconds. */
|
|
@@ -3135,6 +3638,15 @@ interface RevoLowCode {
|
|
|
3135
3638
|
execute<T = LooseObject<any>>(code: string, options?: LowCodeExecuteOptions): Promise<ComponentExecuteResult<T>>;
|
|
3136
3639
|
}
|
|
3137
3640
|
|
|
3641
|
+
type VaultReadResult = Awaited<ReturnType<RevoVault$1['get']>>;
|
|
3642
|
+
/** Wire decoding returns a full Node.js Buffer, extending the portable low-code type. */
|
|
3643
|
+
type RevoVault = Omit<RevoVault$1, 'get'> & {
|
|
3644
|
+
get(...args: Parameters<RevoVault$1['get']>): Promise<Omit<VaultReadResult, 'revision'> & {
|
|
3645
|
+
revision: Omit<VaultReadResult['revision'], 'value'> & {
|
|
3646
|
+
value: Buffer$1;
|
|
3647
|
+
};
|
|
3648
|
+
}>;
|
|
3649
|
+
};
|
|
3138
3650
|
type RevoExecute = RevoLowCode['execute'];
|
|
3139
3651
|
type RevoExecuteOptions = NonNullable<Parameters<RevoExecute>[1]>;
|
|
3140
3652
|
type RevoExecutionDefaults = Omit<RevoExecuteOptions, 'inputs'>;
|
|
@@ -3222,6 +3734,8 @@ interface RevoRuntime {
|
|
|
3222
3734
|
readonly api: RevoApi;
|
|
3223
3735
|
readonly utils: RevoUtils;
|
|
3224
3736
|
readonly storage: RevoStorage;
|
|
3737
|
+
readonly vault: RevoVault;
|
|
3738
|
+
readonly serviceAccount: RevoServiceAccount;
|
|
3225
3739
|
readonly transport: RevoTransport;
|
|
3226
3740
|
readonly agents: RevoAgents;
|
|
3227
3741
|
readonly execute: RevoExecute;
|
|
@@ -3320,4 +3834,4 @@ declare class RevoHttpResponseError extends RevoError {
|
|
|
3320
3834
|
constructor(statusCode: number, body?: unknown);
|
|
3321
3835
|
}
|
|
3322
3836
|
|
|
3323
|
-
export {
|
|
3837
|
+
export { RevoProtocolError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, RevoRemoteError as D, RevoRuntimeContextUnavailableError as E, RevoTransportError as F, type RuntimeBatchRequest as G, type HostedRuntimeBootstrap as H, type RuntimeBatchResponse as I, type RuntimeCall as J, type RuntimeCallResult as K, type SerializedRevoError as L, PROTOCOL_VERSION as P, type RevoRuntime as R, SDK_VERSION as S, RevoExecutionExit as a, RevoHttpResponseError as b, type RevoRuntimeBridgeRequest as c, type RevoRuntimeBridgeResponse as d, type RevoRuntimeBridgeTransportError as e, type RevoStandaloneApi as f, type RevoUtils as g, type RevoStorage as h, type RevoVault as i, type RevoServiceAccount as j, type RevoTransport as k, type RevoAgents as l, type RevoExecute as m, type RevoBatchController as n, type RevoClientOptions as o, type RevoApi as p, RevoAuthenticationError as q, RevoBatchConfigurationError as r, RevoBatchLimitError as s, type RevoBatchLimits as t, type RevoBatchOptions as u, RevoConfigurationError as v, RevoError as w, type RevoExecuteOptions as x, type RevoExecutionDefaults as y, RevoPermissionDeniedError as z };
|