@revoengine/sdk 1.0.1 → 1.5.6
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 +69 -12
- package/dist/{errors-Y4bv4vIM.d.cts → errors-XTYAxN-H.d.cts} +542 -145
- package/dist/{errors-Y4bv4vIM.d.ts → errors-XTYAxN-H.d.ts} +542 -145
- package/dist/hosted.cjs +7416 -4210
- package/dist/hosted.cjs.map +1 -1
- package/dist/hosted.d.cts +2 -2
- package/dist/hosted.d.ts +2 -2
- package/dist/hosted.js +7422 -4216
- package/dist/hosted.js.map +1 -1
- package/dist/index.cjs +7416 -4208
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4914 -2015
- package/dist/index.d.ts +4914 -2015
- package/dist/index.js +7422 -4214
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import * as node_worker_threads from 'node:worker_threads';
|
|
2
2
|
|
|
3
|
-
declare const SDK_VERSION: "1.
|
|
3
|
+
declare const SDK_VERSION: "1.5.6";
|
|
4
4
|
declare const PROTOCOL_VERSION: 1;
|
|
5
|
-
declare const CONTRACT_REVISION: "
|
|
6
|
-
type RuntimeSurfaceName = 'api' | 'storage' | 'agents' | 'lowCode';
|
|
5
|
+
declare const CONTRACT_REVISION: "8a1f8936cd7f3b2e9d418a0676e02024b3dd54c3d2aa721d698b0c3ea66bbf04";
|
|
6
|
+
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'agents' | 'lowCode';
|
|
7
7
|
|
|
8
8
|
// AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
|
|
9
9
|
// Sources: api.swagger-contracts.generated.d.ts, api.public.d.ts
|
|
@@ -43,7 +43,7 @@ interface SwaggerAgentCheapTurnPolicyDto {
|
|
|
43
43
|
}
|
|
44
44
|
interface SwaggerAgentConfigDto {
|
|
45
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"
|
|
46
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna";
|
|
47
47
|
/** Reasoning effort passed to assistant threads. */
|
|
48
48
|
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
49
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. */
|
|
@@ -56,6 +56,8 @@ interface SwaggerAgentConfigDto {
|
|
|
56
56
|
"persona"?: "friendly" | "pragmatic" | "professional" | "concise" | "calm" | "mentor" | "assertive";
|
|
57
57
|
/** Additional per-agent system instructions persisted with the definition. Runtime policy still has higher priority. */
|
|
58
58
|
"systemInstructions"?: string;
|
|
59
|
+
/** Structured operator-owned Agent identity loaded on every autonomous turn. Learned memory cannot mutate this definition. */
|
|
60
|
+
"definition"?: SwaggerAgentDefinitionDto;
|
|
59
61
|
/** Durable cross-run memory defaults such as recall budget, retained summary size, and retention horizon. */
|
|
60
62
|
"memoryPolicy"?: SwaggerAgentMemoryPolicyDto;
|
|
61
63
|
/** Release metadata and rollout controls for governed agent capabilities. */
|
|
@@ -81,6 +83,18 @@ interface SwaggerAgentConfigDto {
|
|
|
81
83
|
/** How the parent reacts when one delegated child fails. */
|
|
82
84
|
"childFailureMode"?: "fail_parent" | "merge_partial";
|
|
83
85
|
}
|
|
86
|
+
interface SwaggerAgentDefinitionDto {
|
|
87
|
+
/** Stable operator-owned identity of the Agent. */
|
|
88
|
+
"identity"?: string;
|
|
89
|
+
/** Stable operator-owned mission of the Agent. */
|
|
90
|
+
"mission"?: string;
|
|
91
|
+
/** Responsibilities owned by the Agent. */
|
|
92
|
+
"responsibilities"?: Array<string>;
|
|
93
|
+
/** Operator-owned principles applied on every Agent turn. */
|
|
94
|
+
"operatingPrinciples"?: Array<string>;
|
|
95
|
+
/** Persistent completion criteria for the Agent role. */
|
|
96
|
+
"successCriteria"?: Array<string>;
|
|
97
|
+
}
|
|
84
98
|
interface SwaggerAgentMemoryPolicyDto {
|
|
85
99
|
/** Whether the runtime may load and persist durable cross-run memory for this agent. */
|
|
86
100
|
"enabled"?: boolean;
|
|
@@ -94,6 +108,8 @@ interface SwaggerAgentPluginApprovalConfigDto {
|
|
|
94
108
|
"mode"?: "none" | "always" | "conditional";
|
|
95
109
|
/** Safety tier enforced for approval and mutation governance. */
|
|
96
110
|
"safetyTier"?: "read" | "write" | "destructive" | "external" | "execute";
|
|
111
|
+
/** Required for conditional mode: a verifiable constraint RevoShield must confirm in addition to user authorization. */
|
|
112
|
+
"condition"?: string;
|
|
97
113
|
}
|
|
98
114
|
interface SwaggerAgentPluginComponentToolConfigDto {
|
|
99
115
|
/** Whether this component-backed tool is enabled for runtime selection and execution. */
|
|
@@ -364,6 +380,8 @@ interface SwaggerDatabaseDefinition {
|
|
|
364
380
|
"name": string;
|
|
365
381
|
/** Description. */
|
|
366
382
|
"desc"?: string | null;
|
|
383
|
+
/** Optional column metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
384
|
+
"metadata"?: Record<string, unknown>;
|
|
367
385
|
/** You need to specify type [SMALLINT,INTEGER,BIGINT,REAL,DOUBLE PRECISION,NUMERIC,JSON,JSONB,TEXT,UUID,DATE,TIME,TIMETZ,TIMESTAMP,TIMESTAMPTZ,BOOLEAN]. */
|
|
368
386
|
"type": "SMALLINT" | "INTEGER" | "BIGINT" | "REAL" | "DOUBLE PRECISION" | "NUMERIC" | "JSON" | "JSONB" | "TEXT" | "UUID" | "DATE" | "TIME" | "TIMETZ" | "TIMESTAMP" | "TIMESTAMPTZ" | "BOOLEAN";
|
|
369
387
|
/** Provide if this column is primary key. */
|
|
@@ -425,12 +443,83 @@ interface SwaggerPartitionDefinition {
|
|
|
425
443
|
*/
|
|
426
444
|
"remainder"?: number;
|
|
427
445
|
}
|
|
446
|
+
interface SwaggerStorageCellInputDto {
|
|
447
|
+
/** A1 cell address. */
|
|
448
|
+
"address": string;
|
|
449
|
+
/** Literal cell value. Supports JSON-compatible strings, numbers, booleans, arrays, objects, and null. */
|
|
450
|
+
"value"?: string | number | boolean | Record<string, unknown> | Array<unknown> | null;
|
|
451
|
+
/** Excel formula without a leading equals sign. */
|
|
452
|
+
"formula"?: string;
|
|
453
|
+
/** Cached formula result. ExcelJS does not calculate formulas. Supports JSON-compatible strings, numbers, booleans, arrays, objects, and null. */
|
|
454
|
+
"result"?: string | number | boolean | Record<string, unknown> | Array<unknown> | null;
|
|
455
|
+
/** Declarative cell style for XLSX output. */
|
|
456
|
+
"style"?: Record<string, unknown>;
|
|
457
|
+
}
|
|
458
|
+
interface SwaggerStorageCsvOptionsDto {
|
|
459
|
+
/** Output character encoding. Input encoding is detected when omitted. */
|
|
460
|
+
"encoding"?: string;
|
|
461
|
+
/** Emit a byte order mark at the start of the file. */
|
|
462
|
+
"bom"?: boolean;
|
|
463
|
+
/** Column delimiter. */
|
|
464
|
+
"delimiter"?: string;
|
|
465
|
+
/** Record delimiter. */
|
|
466
|
+
"recordDelimiter"?: "\n" | "\r" | "\r\n";
|
|
467
|
+
/** Quote character. */
|
|
468
|
+
"quote"?: string;
|
|
469
|
+
/** Quote escape character. */
|
|
470
|
+
"escape"?: string;
|
|
471
|
+
/** Prefix spreadsheet formula-like values to prevent CSV formula injection. */
|
|
472
|
+
"escapeFormulae"?: boolean;
|
|
473
|
+
}
|
|
428
474
|
interface SwaggerStorageRetentionDto {
|
|
429
475
|
/** Positive lifetime in seconds. The lifetime starts when the file is finalized. */
|
|
430
476
|
"ttlSeconds"?: number;
|
|
431
477
|
/** Absolute future expiration timestamp in ISO 8601 format. */
|
|
432
478
|
"expiresAt"?: string;
|
|
433
479
|
}
|
|
480
|
+
interface SwaggerStorageSheetColumnDto {
|
|
481
|
+
/** Object key used when appending row objects. */
|
|
482
|
+
"key": string;
|
|
483
|
+
/** Visible header. Defaults to key. */
|
|
484
|
+
"header"?: string;
|
|
485
|
+
/** Logical value type retained in XLSX fileStats and used by typed row producers and getFileData reads. Without a declared type, imported XLSX values remain strings; styles never infer a type. */
|
|
486
|
+
"type"?: "string" | "number" | "boolean" | "date";
|
|
487
|
+
/** Column width in Excel character units. */
|
|
488
|
+
"width"?: number;
|
|
489
|
+
/** Hide the worksheet column. */
|
|
490
|
+
"hidden"?: boolean;
|
|
491
|
+
/** Declarative column style for XLSX output. */
|
|
492
|
+
"style"?: Record<string, unknown>;
|
|
493
|
+
}
|
|
494
|
+
interface SwaggerStorageSheetDataPartDto {
|
|
495
|
+
/** Target worksheet name. */
|
|
496
|
+
"sheet": string;
|
|
497
|
+
/** Rows represented as keyed objects or positional value arrays. In writeMode "direct", append row-only payloads to worksheets declared at session creation. In writeMode "staged", row payloads remain independently retryable until finalize. */
|
|
498
|
+
"rows"?: Array<Record<string, unknown> | Array<unknown>>;
|
|
499
|
+
/** Sparse cells addressed independently from table rows. Supported in writeMode "staged"; direct XLSX parts must be row-only. */
|
|
500
|
+
"cells"?: Array<SwaggerStorageCellInputDto>;
|
|
501
|
+
}
|
|
502
|
+
interface SwaggerStorageSheetFreezeDto {
|
|
503
|
+
"rows"?: number;
|
|
504
|
+
"columns"?: number;
|
|
505
|
+
}
|
|
506
|
+
interface SwaggerStorageSheetOptionsDto {
|
|
507
|
+
/** Worksheet name. */
|
|
508
|
+
"name": string;
|
|
509
|
+
"state"?: "visible" | "hidden" | "veryHidden";
|
|
510
|
+
"table"?: SwaggerStorageSheetTableDto;
|
|
511
|
+
"freeze"?: SwaggerStorageSheetFreezeDto;
|
|
512
|
+
}
|
|
513
|
+
interface SwaggerStorageSheetTableDto {
|
|
514
|
+
/** Top-left table cell. */
|
|
515
|
+
"origin"?: string;
|
|
516
|
+
/** Write a header row. */
|
|
517
|
+
"header"?: boolean;
|
|
518
|
+
/** Add an auto-filter to the table header. */
|
|
519
|
+
"autoFilter"?: boolean;
|
|
520
|
+
/** Stable column order. Required for every worksheet in writeMode "direct"; optional in "staged" mode, where keys may be inferred from appended rows. */
|
|
521
|
+
"columns"?: Array<SwaggerStorageSheetColumnDto>;
|
|
522
|
+
}
|
|
434
523
|
interface SwaggerWebhookRequestDetailsDto {
|
|
435
524
|
"url": string;
|
|
436
525
|
"method": "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
|
|
@@ -444,6 +533,8 @@ interface AgentRunCancelInput {
|
|
|
444
533
|
"reason"?: string;
|
|
445
534
|
}
|
|
446
535
|
interface DatabaseCloneInput {
|
|
536
|
+
/** Replacement user metadata for the root clone only. Omit to inherit source metadata; pass {} to clear user metadata. Maximum 16 KiB and 64 top-level keys. Keys starting with "__" are reserved for backend use. */
|
|
537
|
+
"metadata"?: Record<string, unknown>;
|
|
447
538
|
/** Optional audit override. Defaults to the source logical table setting. */
|
|
448
539
|
"audit"?: boolean;
|
|
449
540
|
/** Optional target root database name. Defaults to the source database name with "_Clone" suffix. */
|
|
@@ -480,7 +571,7 @@ interface AgentCreateInput {
|
|
|
480
571
|
"ownerId"?: string;
|
|
481
572
|
/** Owner type, typically USER or GROUP. */
|
|
482
573
|
"ownerType"?: string;
|
|
483
|
-
/** Optional resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
574
|
+
/** Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
484
575
|
"metadata"?: Record<string, unknown>;
|
|
485
576
|
/** 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
577
|
"config"?: SwaggerAgentConfigDto;
|
|
@@ -496,8 +587,8 @@ interface AgentInboxItemCreateInput {
|
|
|
496
587
|
"payload"?: Record<string, unknown>;
|
|
497
588
|
/** Queue priority. Higher values are claimed first. */
|
|
498
589
|
"priority"?: number;
|
|
499
|
-
/** Optional
|
|
500
|
-
"
|
|
590
|
+
/** Optional claim deadline within 30 days of acceptance. The inbox item is recorded immediately. */
|
|
591
|
+
"scheduleFor"?: string | number;
|
|
501
592
|
/** Optional de-duplication key unique per agent among non-terminal inbox items. */
|
|
502
593
|
"dedupeKey"?: string;
|
|
503
594
|
}
|
|
@@ -510,7 +601,7 @@ interface DatabaseCreateInput {
|
|
|
510
601
|
"category"?: string;
|
|
511
602
|
/** Description. */
|
|
512
603
|
"desc"?: string;
|
|
513
|
-
/** Optional resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
604
|
+
/** Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
514
605
|
"metadata"?: Record<string, unknown>;
|
|
515
606
|
/** Provide if access should be restricted. */
|
|
516
607
|
"restricted": boolean;
|
|
@@ -522,16 +613,22 @@ interface DatabaseCreateInput {
|
|
|
522
613
|
"definition"?: Array<SwaggerDatabaseDefinition>;
|
|
523
614
|
/** Name. */
|
|
524
615
|
"parent"?: string;
|
|
616
|
+
/** Expected immutable ID of the parent selected by name. Requires parent; rejects a stale selection after rename or name reuse. */
|
|
617
|
+
"parentDatabaseId"?: string;
|
|
525
618
|
/** Partition configuration. */
|
|
526
619
|
"partition"?: SwaggerPartitionDefinition;
|
|
527
620
|
}
|
|
528
621
|
interface AssistantMessageInput {
|
|
622
|
+
/** Finalized Storage files to link to this message. File access is checked on send and every read. */
|
|
623
|
+
"storageEntryIds"?: Array<string>;
|
|
529
624
|
/** Content of the message, validated up to 100000 tokens. */
|
|
530
625
|
"content": string;
|
|
531
626
|
/** 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
627
|
"preflightMessageId"?: string;
|
|
533
|
-
/** Optional assistant execution-model override. GPT-5.6 Luna is the default; Sol, Terra,
|
|
534
|
-
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna"
|
|
628
|
+
/** Optional assistant execution-model override. GPT-5.6 Luna is the default; GPT-5.6 Sol, Terra, and Luna are supported. */
|
|
629
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna";
|
|
630
|
+
/** Optional GPT-5.6 Luna Fast mode. The backend rejects enabling it for any other model. Defaults to false and remains opt-in per thread. */
|
|
631
|
+
"fastMode"?: boolean;
|
|
535
632
|
/** Optional assistant reasoning effort override: low, medium, high, or xhigh. Defaults to low. */
|
|
536
633
|
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
537
634
|
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
@@ -566,7 +663,7 @@ interface StorageFolderInput {
|
|
|
566
663
|
"parentStorageEntryId"?: string;
|
|
567
664
|
/** Optional provider config id for root-level folders. Omit for the internal/default provider. Ignored when parentStorageEntryId is provided. */
|
|
568
665
|
"storageProviderConfigId"?: string;
|
|
569
|
-
/** Folder metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
666
|
+
/** Folder metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
570
667
|
"metadata"?: Record<string, unknown>;
|
|
571
668
|
/** Optional external reference id. */
|
|
572
669
|
"refId"?: string;
|
|
@@ -606,9 +703,15 @@ interface StorageUploadSessionInput {
|
|
|
606
703
|
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
607
704
|
/** 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
705
|
"uploadMode"?: "direct" | "chunked" | "incremental";
|
|
609
|
-
/**
|
|
706
|
+
/** Post-finalize compute mode for this upload session. Defaults to sync for XLSX and text/* sessions and none for other binary sessions; an explicit value always overrides the default. */
|
|
610
707
|
"computeStats"?: "none" | "sync" | "async";
|
|
611
|
-
/**
|
|
708
|
+
/** Structured file write mode. Use "direct" for a predeclared CSV/XLSX layout with row-only XLSX parts. Use the default "staged" mode for independent requests that may be retried, replaced, reordered, or use inferred columns, sparse cells, formulas, or dynamic worksheets. For direct XLSX, declare every worksheet and its table.columns before the first append. */
|
|
709
|
+
"writeMode"?: "staged" | "direct";
|
|
710
|
+
/** CSV dialect used when row payloads are appended to a text/csv session. */
|
|
711
|
+
"csv"?: SwaggerStorageCsvOptionsDto;
|
|
712
|
+
/** Workbook worksheet layout. XLSX is inferred from contentTypeHint. In writeMode "direct", declare every worksheet here and configure table.columns for each one. */
|
|
713
|
+
"sheets"?: Array<SwaggerStorageSheetOptionsDto>;
|
|
714
|
+
/** File metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
612
715
|
"metadata"?: Record<string, unknown>;
|
|
613
716
|
/** Optional external reference id. */
|
|
614
717
|
"refId"?: string;
|
|
@@ -624,7 +727,11 @@ interface StorageUploadSessionInput {
|
|
|
624
727
|
"users"?: Array<string>;
|
|
625
728
|
}
|
|
626
729
|
interface StorageUploadSessionFinalizeInput {
|
|
627
|
-
/**
|
|
730
|
+
/** Expected contiguous multipart count (parts 1..N). Use this to fence distributed uploads against missing parts. */
|
|
731
|
+
"expectedPartCount"?: number;
|
|
732
|
+
/** Expected explicit multipart numbers. Use for sparse distributed uploads; cannot be combined with expectedPartCount. */
|
|
733
|
+
"expectedPartNumbers"?: Array<number>;
|
|
734
|
+
/** Optional metadata replacement at finalize time. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
628
735
|
"metadata"?: Record<string, unknown>;
|
|
629
736
|
/** Optional post-finalize compute mode. */
|
|
630
737
|
"computeStats"?: "none" | "sync" | "async";
|
|
@@ -660,7 +767,7 @@ interface StoragePutObjectInput {
|
|
|
660
767
|
"dataEncoding"?: "utf8" | "base64";
|
|
661
768
|
/** Mime type of the object. */
|
|
662
769
|
"mimeType"?: string;
|
|
663
|
-
/**
|
|
770
|
+
/** Post-write compute mode. Defaults to sync for text/* objects and none for other binary objects; an explicit value always overrides the default. */
|
|
664
771
|
"computeStats"?: "none" | "sync" | "async";
|
|
665
772
|
/** Whether the finalized entry should be restricted. */
|
|
666
773
|
"restricted"?: boolean;
|
|
@@ -674,7 +781,7 @@ interface StoragePutObjectInput {
|
|
|
674
781
|
"refType"?: string;
|
|
675
782
|
/** Optional external reference version. */
|
|
676
783
|
"refVer"?: number;
|
|
677
|
-
/** Entry metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
784
|
+
/** Entry metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
678
785
|
"metadata"?: Record<string, unknown>;
|
|
679
786
|
/** Logical storage lifecycle tier. Select only when creating a new file or upload session; existing files keep their tier.
|
|
680
787
|
HOT: Active files used in live workflows, previews, and frequent downloads.
|
|
@@ -684,6 +791,10 @@ interface StoragePutObjectInput {
|
|
|
684
791
|
"tier"?: "HOT" | "WARM" | "COLD" | "FROZEN";
|
|
685
792
|
}
|
|
686
793
|
interface AssistantActionResolutionInput {
|
|
794
|
+
/** Finalized Storage files linked to this action response. */
|
|
795
|
+
"storageEntryIds"?: Array<string>;
|
|
796
|
+
/** Optimistic action version used as the idempotency key together with the action id. */
|
|
797
|
+
"actionVersion"?: number;
|
|
687
798
|
/** Resolution decision for the pending action. */
|
|
688
799
|
"decision": "approve" | "approve_all_for_turn" | "reject" | "submit";
|
|
689
800
|
/** Optional approval item id when resolving one item from a multi-approval action. */
|
|
@@ -695,7 +806,9 @@ interface AssistantActionResolutionInput {
|
|
|
695
806
|
/** 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
807
|
"backgroundProcessing"?: boolean;
|
|
697
808
|
/** 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"
|
|
809
|
+
"model"?: "gpt-5.6-sol" | "gpt-5.6-terra" | "gpt-5.6-luna";
|
|
810
|
+
/** Optional GPT-5.6 Luna Fast-mode override for the resumed turn. The backend rejects enabling it for any other model. */
|
|
811
|
+
"fastMode"?: boolean;
|
|
699
812
|
/** Optional assistant reasoning effort override for the resumed turn: low, medium, high, or xhigh. */
|
|
700
813
|
"reasoningEffort"?: "low" | "medium" | "high" | "xhigh";
|
|
701
814
|
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
@@ -724,8 +837,8 @@ interface AgentRunInput {
|
|
|
724
837
|
"triggerRefType"?: string;
|
|
725
838
|
/** Optional external reference id for correlation. */
|
|
726
839
|
"triggerRefId"?: string;
|
|
727
|
-
/** Optional
|
|
728
|
-
"
|
|
840
|
+
/** Optional first-dispatch deadline, from acceptance through 30 days ahead. The run is recorded immediately. */
|
|
841
|
+
"scheduleFor"?: string | number;
|
|
729
842
|
/** Optional run-scoped state merged into the initial supervisor state. */
|
|
730
843
|
"state"?: Record<string, unknown>;
|
|
731
844
|
/** Optional registry plugin ids attached for this run. */
|
|
@@ -748,7 +861,7 @@ interface AgentUpdateInput {
|
|
|
748
861
|
"ownerId"?: string;
|
|
749
862
|
/** Updated owner type. */
|
|
750
863
|
"ownerType"?: string;
|
|
751
|
-
/** Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
864
|
+
/** Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
752
865
|
"metadata"?: Record<string, unknown>;
|
|
753
866
|
/** Replacement persisted agent identity and runtime defaults. Fast-path routing, prompt tier, and per-turn telemetry stay runtime-derived. */
|
|
754
867
|
"config"?: SwaggerAgentConfigDto;
|
|
@@ -766,8 +879,8 @@ interface AgentInboxItemUpdateInput {
|
|
|
766
879
|
"payload"?: Record<string, unknown>;
|
|
767
880
|
/** Queue priority. Higher values are claimed first. */
|
|
768
881
|
"priority"?: number;
|
|
769
|
-
/** Optional
|
|
770
|
-
"
|
|
882
|
+
/** Optional updated claim deadline within 30 days of this request. */
|
|
883
|
+
"scheduleFor"?: string | number;
|
|
771
884
|
/** Optional de-duplication key unique per agent among non-terminal inbox items. */
|
|
772
885
|
"dedupeKey"?: string;
|
|
773
886
|
}
|
|
@@ -780,7 +893,7 @@ interface DatabaseUpdateInput {
|
|
|
780
893
|
"category"?: string;
|
|
781
894
|
/** Description. */
|
|
782
895
|
"desc"?: string;
|
|
783
|
-
/** Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use. */
|
|
896
|
+
/** Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
784
897
|
"metadata"?: Record<string, unknown>;
|
|
785
898
|
/** Provide if access should be restricted. */
|
|
786
899
|
"restricted"?: boolean;
|
|
@@ -798,7 +911,7 @@ interface StorageEntryUpdateInput {
|
|
|
798
911
|
"retention"?: SwaggerStorageRetentionDto | null;
|
|
799
912
|
/** New display name. */
|
|
800
913
|
"name"?: string;
|
|
801
|
-
/** Metadata replacement. Top-level keys starting with "__" are reserved for backend use. */
|
|
914
|
+
/** Metadata replacement. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use. */
|
|
802
915
|
"metadata"?: Record<string, unknown>;
|
|
803
916
|
/** Whether this entry is restricted to the provided users/groups. */
|
|
804
917
|
"restricted"?: boolean;
|
|
@@ -809,29 +922,19 @@ interface StorageEntryUpdateInput {
|
|
|
809
922
|
/** Current entity version. */
|
|
810
923
|
"version"?: number;
|
|
811
924
|
}
|
|
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
925
|
interface AssistantThreadTitleInput {
|
|
827
926
|
/** New user-defined title for the thread. */
|
|
828
927
|
"title": string;
|
|
829
928
|
}
|
|
830
929
|
interface StorageUploadPartInput {
|
|
831
930
|
/** Part payload. Use base64 for binary payloads. */
|
|
832
|
-
"data"
|
|
931
|
+
"data"?: string | Array<string>;
|
|
833
932
|
/** Payload encoding. */
|
|
834
933
|
"dataEncoding"?: "utf8" | "base64";
|
|
934
|
+
/** Rows represented as keyed objects or positional value arrays for a single-sheet CSV or XLSX session. The target sheet is inferred. Direct XLSX sessions require the declared row schema; staged sessions support retryable independent requests. */
|
|
935
|
+
"rows"?: Array<Record<string, unknown> | Array<unknown>>;
|
|
936
|
+
/** Rows and optional sparse cells for one or more declared XLSX worksheets. In writeMode "direct", each worksheet must have configured table.columns and every part must be row-only; staged mode supports sparse cells and replacement or out-of-order parts. */
|
|
937
|
+
"sheets"?: Array<SwaggerStorageSheetDataPartDto>;
|
|
835
938
|
}
|
|
836
939
|
interface WebhookInput {
|
|
837
940
|
/** Optional Id of webhook. */
|
|
@@ -850,7 +953,7 @@ interface WebhookInput {
|
|
|
850
953
|
"maskDetails"?: Array<string>;
|
|
851
954
|
/** Override creator. */
|
|
852
955
|
"createdBy"?: string;
|
|
853
|
-
/** Optional key/value metadata for grouping and querying webhooks. Top-level keys starting with "__" are reserved for backend use. */
|
|
956
|
+
/** 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. */
|
|
854
957
|
"metadata"?: Record<string, unknown>;
|
|
855
958
|
}
|
|
856
959
|
/**
|
|
@@ -858,6 +961,23 @@ interface WebhookInput {
|
|
|
858
961
|
* Lifecycle input DTOs are generated from Swagger in api.swagger-contracts.generated.d.ts.
|
|
859
962
|
* Edit this file for model guidance, then regenerate api.monaco.ts.
|
|
860
963
|
*/
|
|
964
|
+
/** Ordered, literal-safe updates. Repeated columns run top to bottom (maximum 100 operations).
|
|
965
|
+
* NULL is preserved unless nulls: 'empty' is selected for text/array/JSON transforms.
|
|
966
|
+
* insert.position is 1-based Unicode character position. replace replaces all exact matches.
|
|
967
|
+
* JSON paths use string arrays; setJsonPath creates the final property only, not missing parents.
|
|
968
|
+
*/
|
|
969
|
+
interface DatabaseUpdateOperation {
|
|
970
|
+
column: string;
|
|
971
|
+
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';
|
|
972
|
+
value?: unknown;
|
|
973
|
+
position?: number;
|
|
974
|
+
search?: string;
|
|
975
|
+
path?: string[];
|
|
976
|
+
create?: boolean;
|
|
977
|
+
unit?: string;
|
|
978
|
+
nulls?: 'preserve' | 'empty';
|
|
979
|
+
}
|
|
980
|
+
type DatabaseUpdateData = Record<string, any> | DatabaseUpdateOperation[];
|
|
861
981
|
/**
|
|
862
982
|
* Supported database column types used by schema metadata and casts.
|
|
863
983
|
*/
|
|
@@ -875,11 +995,33 @@ type ExecutionTargetType = 'JOB_TEMPLATE' | 'AGENT' | (string & {});
|
|
|
875
995
|
/**
|
|
876
996
|
* Supported payload validator types for util.validate().
|
|
877
997
|
*/
|
|
878
|
-
type ValidatorType = 'string' | 'number' | 'boolean' | 'object' | 'array' | 'date' | 'any';
|
|
998
|
+
type ValidatorType = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'date' | 'any';
|
|
879
999
|
interface ValidatorProperty {
|
|
880
1000
|
type: ValidatorType;
|
|
881
1001
|
required?: boolean;
|
|
1002
|
+
nullable?: boolean;
|
|
1003
|
+
empty?: 'allow' | 'reject';
|
|
1004
|
+
integer?: boolean;
|
|
1005
|
+
finite?: boolean;
|
|
1006
|
+
safeInteger?: boolean;
|
|
1007
|
+
exclusiveMin?: number;
|
|
1008
|
+
exclusiveMax?: number;
|
|
1009
|
+
/** Exact allowed values; prefer this to regex alternatives for a finite set. */
|
|
1010
|
+
enum?: any[];
|
|
1011
|
+
/** One exact allowed value; prefer this to a literal-matching regex. */
|
|
1012
|
+
const?: any;
|
|
1013
|
+
additionalProperties?: 'allow' | 'strip' | 'reject';
|
|
1014
|
+
format?: 'date' | 'time' | 'date-time';
|
|
1015
|
+
timezone?: boolean;
|
|
1016
|
+
/**
|
|
1017
|
+
* String pattern for constraints not expressible with enum, const, type, length or format rules.
|
|
1018
|
+
* Prefer those explicit rules when equivalent. Even one simple regex can roughly double
|
|
1019
|
+
* Endpoint guard preparation time or more for small requests; actual cost varies.
|
|
1020
|
+
* Preserve the accepted-value contract when replacing a pattern; bound string length with max.
|
|
1021
|
+
*/
|
|
882
1022
|
regex?: string;
|
|
1023
|
+
/** JavaScript regular expression flags, for example i or u. */
|
|
1024
|
+
regexFlags?: string;
|
|
883
1025
|
min?: number;
|
|
884
1026
|
max?: number;
|
|
885
1027
|
objectSchema?: ValidatorObject[];
|
|
@@ -890,6 +1032,9 @@ interface ValidatorObject {
|
|
|
890
1032
|
schema: ValidatorProperty;
|
|
891
1033
|
}
|
|
892
1034
|
interface ValidatorSchemaInput {
|
|
1035
|
+
/** Existing schemas default to legacy; use strict for new schemas. */
|
|
1036
|
+
profile?: 'legacy' | 'strict';
|
|
1037
|
+
additionalProperties?: 'allow' | 'strip' | 'reject';
|
|
893
1038
|
whitelist?: boolean;
|
|
894
1039
|
whitelistErrors?: boolean;
|
|
895
1040
|
schema: ValidatorProperty;
|
|
@@ -897,6 +1042,12 @@ interface ValidatorSchemaInput {
|
|
|
897
1042
|
interface ValidationResult<T = any> {
|
|
898
1043
|
valid: boolean;
|
|
899
1044
|
errors: string[];
|
|
1045
|
+
issues: Array<{
|
|
1046
|
+
code: string;
|
|
1047
|
+
path: string;
|
|
1048
|
+
message: string;
|
|
1049
|
+
params?: Record<string, any>;
|
|
1050
|
+
}>;
|
|
900
1051
|
value: T;
|
|
901
1052
|
}
|
|
902
1053
|
/**
|
|
@@ -1087,7 +1238,6 @@ interface SelectInput {
|
|
|
1087
1238
|
joins?: SelectJoin[];
|
|
1088
1239
|
/**
|
|
1089
1240
|
* Recursive filter tree.
|
|
1090
|
-
* Example:
|
|
1091
1241
|
* { and: [{ field: 'status', op: 'eq', value: 'active' }] }
|
|
1092
1242
|
*/
|
|
1093
1243
|
filter?: SelectFilterNode;
|
|
@@ -1105,7 +1255,9 @@ interface SelectInput {
|
|
|
1105
1255
|
*/
|
|
1106
1256
|
cast?: Record<string, DatabaseDefinitionType>;
|
|
1107
1257
|
/**
|
|
1108
|
-
*
|
|
1258
|
+
* getDatabaseData accepts a number (at most 100,000) or explicit null.
|
|
1259
|
+
* Omitting take uses 2,000 and logs one warning per execution.
|
|
1260
|
+
* Use walkDatabaseData for processing without a finite page.
|
|
1109
1261
|
* The backend fetches one extra row internally to determine next-page availability.
|
|
1110
1262
|
*/
|
|
1111
1263
|
take?: number;
|
|
@@ -1139,30 +1291,98 @@ interface GetDatabaseDataResponse<T = any> {
|
|
|
1139
1291
|
cache?: any;
|
|
1140
1292
|
}
|
|
1141
1293
|
interface BufferConstructor {
|
|
1142
|
-
new (
|
|
1143
|
-
from(
|
|
1144
|
-
|
|
1294
|
+
new (value: string | number | number[] | Uint8Array | ArrayBuffer, encoding?: string): Buffer;
|
|
1295
|
+
from(array: any[]): Buffer;
|
|
1296
|
+
from(arrayBuffer: ArrayBufferLike, byteOffset?: number, length?: number): Buffer;
|
|
1297
|
+
from(buffer: Buffer | Uint8Array): Buffer;
|
|
1298
|
+
from(str: string, encoding?: string): Buffer;
|
|
1299
|
+
isBuffer(obj: any): obj is Buffer;
|
|
1300
|
+
isEncoding(encoding: string): boolean;
|
|
1301
|
+
byteLength(string: string, encoding?: string): number;
|
|
1302
|
+
concat(list: readonly Uint8Array[], totalLength?: number): Buffer;
|
|
1303
|
+
compare(buf1: Buffer, buf2: Buffer): number;
|
|
1304
|
+
alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer;
|
|
1145
1305
|
allocUnsafe(size: number): Buffer;
|
|
1146
|
-
|
|
1306
|
+
allocUnsafeSlow(size: number): Buffer;
|
|
1147
1307
|
}
|
|
1148
|
-
/**
|
|
1149
|
-
|
|
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;
|
|
1308
|
+
/** Browser Buffer 5.7.1, without other Node.js globals. */
|
|
1309
|
+
interface Buffer extends Uint8Array<ArrayBuffer> {
|
|
1156
1310
|
inspect(): string;
|
|
1311
|
+
write(string: string, offset?: number, length?: number, encoding?: string): number;
|
|
1312
|
+
toString(encoding?: string, start?: number, end?: number): string;
|
|
1313
|
+
toJSON(): {
|
|
1314
|
+
type: 'Buffer';
|
|
1315
|
+
data: any[];
|
|
1316
|
+
};
|
|
1317
|
+
equals(otherBuffer: Buffer): boolean;
|
|
1318
|
+
compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
|
|
1319
|
+
copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
|
|
1320
|
+
slice(start?: number, end?: number): Buffer;
|
|
1321
|
+
writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1322
|
+
writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1323
|
+
writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1324
|
+
writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1325
|
+
readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1326
|
+
readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1327
|
+
readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1328
|
+
readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
|
|
1329
|
+
readUInt8(offset: number, noAssert?: boolean): number;
|
|
1330
|
+
readUInt16LE(offset: number, noAssert?: boolean): number;
|
|
1331
|
+
readUInt16BE(offset: number, noAssert?: boolean): number;
|
|
1332
|
+
readUInt32LE(offset: number, noAssert?: boolean): number;
|
|
1333
|
+
readUInt32BE(offset: number, noAssert?: boolean): number;
|
|
1334
|
+
readInt8(offset: number, noAssert?: boolean): number;
|
|
1335
|
+
readInt16LE(offset: number, noAssert?: boolean): number;
|
|
1336
|
+
readInt16BE(offset: number, noAssert?: boolean): number;
|
|
1337
|
+
readInt32LE(offset: number, noAssert?: boolean): number;
|
|
1338
|
+
readInt32BE(offset: number, noAssert?: boolean): number;
|
|
1339
|
+
readFloatLE(offset: number, noAssert?: boolean): number;
|
|
1340
|
+
readFloatBE(offset: number, noAssert?: boolean): number;
|
|
1341
|
+
readDoubleLE(offset: number, noAssert?: boolean): number;
|
|
1342
|
+
readDoubleBE(offset: number, noAssert?: boolean): number;
|
|
1343
|
+
reverse(): this;
|
|
1344
|
+
swap16(): Buffer;
|
|
1345
|
+
swap32(): Buffer;
|
|
1346
|
+
swap64(): Buffer;
|
|
1347
|
+
writeUInt8(value: number, offset: number, noAssert?: boolean): number;
|
|
1348
|
+
writeUInt16LE(value: number, offset: number, noAssert?: boolean): number;
|
|
1349
|
+
writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
|
1350
|
+
writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
|
1351
|
+
writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
|
1352
|
+
writeInt8(value: number, offset: number, noAssert?: boolean): number;
|
|
1353
|
+
writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
|
|
1354
|
+
writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
|
|
1355
|
+
writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
|
|
1356
|
+
writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
|
|
1357
|
+
writeFloatLE(value: number, offset: number, noAssert?: boolean): number;
|
|
1358
|
+
writeFloatBE(value: number, offset: number, noAssert?: boolean): number;
|
|
1359
|
+
writeDoubleLE(value: number, offset: number, noAssert?: boolean): number;
|
|
1360
|
+
writeDoubleBE(value: number, offset: number, noAssert?: boolean): number;
|
|
1361
|
+
fill(value: any, offset?: number, end?: number, encoding?: string): this;
|
|
1362
|
+
indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number;
|
|
1363
|
+
lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number;
|
|
1364
|
+
includes(value: string | number | Buffer, byteOffset?: number, encoding?: string): boolean;
|
|
1157
1365
|
}
|
|
1158
1366
|
declare var Buffer: BufferConstructor;
|
|
1159
1367
|
interface LooseObject<T> {
|
|
1160
1368
|
[key: string]: T;
|
|
1161
1369
|
}
|
|
1370
|
+
/** Absolute automation execution time. Numeric values are Unix timestamps in milliseconds. */
|
|
1371
|
+
type AutomationScheduleFor = Date | string | number;
|
|
1372
|
+
interface AutomationScheduleOptions {
|
|
1373
|
+
/** Absolute time as Date, ISO 8601 date-time, or Unix timestamp in milliseconds. Maximum horizon: 30 days. */
|
|
1374
|
+
scheduleFor?: AutomationScheduleFor;
|
|
1375
|
+
}
|
|
1376
|
+
interface TriggerEventOptions extends AutomationScheduleOptions {
|
|
1377
|
+
/** Searchable event metadata (max 16 KiB and 64 top-level keys). Top-level keys starting with "__" are reserved. */
|
|
1378
|
+
metadata?: LooseObject<unknown>;
|
|
1379
|
+
}
|
|
1162
1380
|
interface DatabaseDefinition {
|
|
1163
1381
|
databaseDefinitionId?: string;
|
|
1164
1382
|
name: string;
|
|
1165
1383
|
desc: string | null;
|
|
1384
|
+
/** Optional column metadata (max 16 KiB and 64 top-level keys). Top-level keys starting with "__" are reserved. */
|
|
1385
|
+
metadata?: Record<string, unknown>;
|
|
1166
1386
|
type: 'SMALLINT' | 'INTEGER' | 'BIGINT' | 'REAL' | 'DOUBLE PRECISION' | 'NUMERIC' | 'JSON' | 'JSONB' | 'TEXT' | 'TIME' | 'DATE' | 'TIMETZ' | 'TIMESTAMP' | 'TIMESTAMPTZ' | 'BOOLEAN';
|
|
1167
1387
|
isPrimaryKey: boolean;
|
|
1168
1388
|
isArray: boolean;
|
|
@@ -1175,6 +1395,10 @@ interface DatabaseDefinition {
|
|
|
1175
1395
|
interface Database extends BaseProperties {
|
|
1176
1396
|
databaseId?: string;
|
|
1177
1397
|
name: string;
|
|
1398
|
+
parent?: string | null;
|
|
1399
|
+
master?: string | null;
|
|
1400
|
+
parentDatabaseId?: string | null;
|
|
1401
|
+
masterDatabaseId?: string | null;
|
|
1178
1402
|
category: string | null;
|
|
1179
1403
|
desc: string | null;
|
|
1180
1404
|
restricted: boolean;
|
|
@@ -1275,7 +1499,7 @@ interface HttpStorageSourceRef {
|
|
|
1275
1499
|
}
|
|
1276
1500
|
type HttpStorageTargetRef =
|
|
1277
1501
|
/** Creates a new Storage entry and writes the complete HTTP response into it. */
|
|
1278
|
-
(Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> & {
|
|
1502
|
+
(Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'replaceExpectedVersion' | 'uploadMode'> & {
|
|
1279
1503
|
name: string;
|
|
1280
1504
|
namespace?: string;
|
|
1281
1505
|
})
|
|
@@ -1287,6 +1511,8 @@ type HttpStorageTargetRef =
|
|
|
1287
1511
|
contentTypeHint?: string;
|
|
1288
1512
|
computeStats?: 'none' | 'sync' | 'async';
|
|
1289
1513
|
metadata?: LooseObject<any>;
|
|
1514
|
+
} | {
|
|
1515
|
+
storageUploadSessionId: string;
|
|
1290
1516
|
};
|
|
1291
1517
|
interface HttpRequestOptionsInterface {
|
|
1292
1518
|
//@default: undefined
|
|
@@ -1298,9 +1524,9 @@ interface HttpRequestOptionsInterface {
|
|
|
1298
1524
|
* when an integration should expose an explicit, self-documenting JSON contract.
|
|
1299
1525
|
*/
|
|
1300
1526
|
//@default: 'json'
|
|
1301
|
-
responseType?: 'json' | 'base64buffer' | 'document' | 'text' | '
|
|
1527
|
+
responseType?: 'json' | 'base64buffer' | 'document' | 'text' | 'storage';
|
|
1302
1528
|
//@default: 'json'
|
|
1303
|
-
requestType?: 'json' | 'base64buffer' | 'form-data' | 'text' | '
|
|
1529
|
+
requestType?: 'json' | 'base64buffer' | 'form-data' | 'text' | 'storage';
|
|
1304
1530
|
//@default: false
|
|
1305
1531
|
currentCredentials?: boolean;
|
|
1306
1532
|
}
|
|
@@ -1440,21 +1666,88 @@ interface StorageDownload {
|
|
|
1440
1666
|
downloadUrl: string;
|
|
1441
1667
|
preview: boolean;
|
|
1442
1668
|
}
|
|
1443
|
-
|
|
1669
|
+
type StorageDocumentFormat = 'auto' | 'text' | 'json' | 'xml';
|
|
1670
|
+
interface StorageDocumentReadOptions {
|
|
1671
|
+
/** Text line window; cannot be combined with byte ranges or JSON/XML/PDF/DOCX extraction. */
|
|
1444
1672
|
startLine?: number | null;
|
|
1445
1673
|
endLine?: number | null;
|
|
1446
1674
|
maxChars?: number | null;
|
|
1675
|
+
/** Parser selection. Defaults to text; auto selects JSON/XML from MIME or extension. PDF/DOCX extract text; no byte ranges for binary documents. */
|
|
1676
|
+
format?: StorageDocumentFormat;
|
|
1677
|
+
/** Inclusive source byte offset. Only supported for plain text, not PDF/DOCX. */
|
|
1678
|
+
start?: number;
|
|
1679
|
+
/** Exclusive source byte offset. Only supported for plain text, not PDF/DOCX. */
|
|
1680
|
+
end?: number;
|
|
1681
|
+
}
|
|
1682
|
+
interface StorageDocument {
|
|
1683
|
+
storageEntryId: string;
|
|
1684
|
+
name: string;
|
|
1685
|
+
mimeType: string | null;
|
|
1686
|
+
size: number | null;
|
|
1687
|
+
format: Exclude<StorageDocumentFormat, 'auto'>;
|
|
1688
|
+
start?: number;
|
|
1689
|
+
end?: number;
|
|
1690
|
+
sourceBytes?: number;
|
|
1691
|
+
content?: string;
|
|
1692
|
+
document?: any;
|
|
1693
|
+
/** Present for bounded PDF/DOCX text extraction; no visual/OCR content is inferred. */
|
|
1694
|
+
extraction?: {
|
|
1695
|
+
sourceFormat: 'pdf' | 'docx';
|
|
1696
|
+
textOnly: true;
|
|
1697
|
+
truncated: boolean;
|
|
1698
|
+
totalPages: number | null;
|
|
1699
|
+
processedPages: number | null;
|
|
1700
|
+
mayRequireOcr: boolean;
|
|
1701
|
+
};
|
|
1702
|
+
/** Present for line-window reads instead of source byte offsets. */
|
|
1703
|
+
startLine?: number;
|
|
1704
|
+
endLine?: number;
|
|
1705
|
+
returnedLineCount?: number;
|
|
1706
|
+
totalLines?: number;
|
|
1707
|
+
truncated?: boolean;
|
|
1447
1708
|
}
|
|
1448
1709
|
interface StorageFileReadOptions {
|
|
1449
1710
|
batchNumber?: number;
|
|
1450
1711
|
buffer?: boolean;
|
|
1451
1712
|
start?: number;
|
|
1452
1713
|
end?: number;
|
|
1714
|
+
/** Continue a structured CSV/XLSX read. Cursor restores sheet and batch position. */
|
|
1715
|
+
cursor?: string;
|
|
1716
|
+
/** XLSX sheet name. The first visible sheet is used when omitted. */
|
|
1717
|
+
sheet?: string;
|
|
1718
|
+
/** One-based source header row. Pass null when the file has no header. */
|
|
1719
|
+
headerRow?: number | null;
|
|
1720
|
+
/** Override CSV source encoding when auto-detection is not sufficient. */
|
|
1721
|
+
encoding?: string;
|
|
1722
|
+
delimiter?: string;
|
|
1723
|
+
recordDelimiter?: '\n' | '\r' | '\r\n';
|
|
1724
|
+
quote?: string;
|
|
1725
|
+
escape?: string;
|
|
1726
|
+
/** XML record path such as `Orders/Order`; required for XML row reads. */
|
|
1727
|
+
recordPath?: string;
|
|
1728
|
+
/** Rows per persisted storage index page. Defaults to 100,000 and cannot exceed 100,000. */
|
|
1729
|
+
batchSize?: number;
|
|
1730
|
+
/** Rows returned by this call. Defaults to the index page size and cannot exceed 100,000. */
|
|
1731
|
+
limit?: number;
|
|
1732
|
+
/** Optional structured projection. Omit to return every source column. */
|
|
1733
|
+
columns?: Array<string | {
|
|
1734
|
+
source: string;
|
|
1735
|
+
key?: string;
|
|
1736
|
+
type?: 'string' | 'number' | 'boolean' | 'date';
|
|
1737
|
+
}>;
|
|
1453
1738
|
}
|
|
1454
1739
|
interface StorageFileStatsOptions {
|
|
1455
1740
|
separator?: string;
|
|
1741
|
+
encoding?: string;
|
|
1742
|
+
delimiter?: string;
|
|
1743
|
+
recordDelimiter?: '\n' | '\r' | '\r\n';
|
|
1744
|
+
quote?: string;
|
|
1745
|
+
escape?: string;
|
|
1746
|
+
headerRow?: number | null;
|
|
1456
1747
|
reloadStats?: boolean;
|
|
1457
1748
|
batchSize?: number;
|
|
1749
|
+
/** XML record path such as `Orders/Order`; required for XML row stats. */
|
|
1750
|
+
recordPath?: string;
|
|
1458
1751
|
}
|
|
1459
1752
|
interface StorageFileStats {
|
|
1460
1753
|
lineCount?: number;
|
|
@@ -1463,18 +1756,50 @@ interface StorageFileStats {
|
|
|
1463
1756
|
batches?: number;
|
|
1464
1757
|
batchSize?: number;
|
|
1465
1758
|
encoding?: string | null;
|
|
1759
|
+
format?: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
|
|
1760
|
+
columns?: Array<{
|
|
1761
|
+
key: string;
|
|
1762
|
+
header: string;
|
|
1763
|
+
}>;
|
|
1764
|
+
bom?: boolean;
|
|
1765
|
+
delimiter?: string;
|
|
1766
|
+
recordDelimiter?: string;
|
|
1767
|
+
quote?: string;
|
|
1768
|
+
escape?: string;
|
|
1769
|
+
rowCount?: number;
|
|
1770
|
+
headers?: Array<{
|
|
1771
|
+
key: string;
|
|
1772
|
+
header: string;
|
|
1773
|
+
}>;
|
|
1774
|
+
sheets?: Array<{
|
|
1775
|
+
name: string;
|
|
1776
|
+
state: 'visible' | 'hidden' | 'veryHidden';
|
|
1777
|
+
rowCount: number;
|
|
1778
|
+
batches: number;
|
|
1779
|
+
columns: Array<{
|
|
1780
|
+
key: string;
|
|
1781
|
+
header: string;
|
|
1782
|
+
}>;
|
|
1783
|
+
}>;
|
|
1466
1784
|
}
|
|
1467
|
-
interface
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1785
|
+
interface StorageStructuredFileDataPage {
|
|
1786
|
+
format: 'csv' | 'xlsx' | 'ndjson' | 'json-array' | 'xml';
|
|
1787
|
+
sheet: string | null;
|
|
1788
|
+
headers: Array<{
|
|
1789
|
+
key: string;
|
|
1790
|
+
header: string;
|
|
1791
|
+
}>;
|
|
1792
|
+
columns: Array<{
|
|
1793
|
+
key: string;
|
|
1794
|
+
header: string;
|
|
1795
|
+
}>;
|
|
1796
|
+
rows: Array<LooseObject<any>>;
|
|
1797
|
+
rowCount: number;
|
|
1798
|
+
totalRows: number;
|
|
1799
|
+
batchNumber: number;
|
|
1800
|
+
batchSize: number;
|
|
1801
|
+
next: boolean;
|
|
1802
|
+
nextCursor: string | null;
|
|
1478
1803
|
}
|
|
1479
1804
|
interface LoggedUser {
|
|
1480
1805
|
userId: string;
|
|
@@ -1487,8 +1812,13 @@ interface LoggedUser {
|
|
|
1487
1812
|
phone: string;
|
|
1488
1813
|
groups: string[];
|
|
1489
1814
|
roles: string[];
|
|
1815
|
+
metadata: LooseObject<any>;
|
|
1816
|
+
/** @deprecated Use metadata instead. */
|
|
1490
1817
|
metaData: LooseObject<any>;
|
|
1818
|
+
metadataAdvanced: LooseObject<any>;
|
|
1819
|
+
/** @deprecated Use metadataAdvanced instead. */
|
|
1491
1820
|
advancedData: LooseObject<any>;
|
|
1821
|
+
/** Avatar storage entry ID; `/me` separately returns a signed download URL. */
|
|
1492
1822
|
avatar: string;
|
|
1493
1823
|
platformAccess: boolean;
|
|
1494
1824
|
}
|
|
@@ -1521,7 +1851,7 @@ interface AgentToolInput {
|
|
|
1521
1851
|
}
|
|
1522
1852
|
interface Input {
|
|
1523
1853
|
templateId: string;
|
|
1524
|
-
templateInputs:
|
|
1854
|
+
templateInputs: Record<string, JsonValue>;
|
|
1525
1855
|
/**
|
|
1526
1856
|
* Present when this component is executed as an agent plugin component tool.
|
|
1527
1857
|
*/
|
|
@@ -1540,6 +1870,9 @@ interface Input {
|
|
|
1540
1870
|
excludeLibs?: string[];
|
|
1541
1871
|
includeLibs?: string[];
|
|
1542
1872
|
}
|
|
1873
|
+
type JsonValue = string | number | boolean | null | JsonValue[] | {
|
|
1874
|
+
[key: string]: JsonValue;
|
|
1875
|
+
};
|
|
1543
1876
|
interface InstanceDetails {
|
|
1544
1877
|
id: string;
|
|
1545
1878
|
organizationId: string;
|
|
@@ -1575,7 +1908,18 @@ interface DatabaseDataActionResponse {
|
|
|
1575
1908
|
requested: number;
|
|
1576
1909
|
success: number;
|
|
1577
1910
|
elapsed: number;
|
|
1578
|
-
|
|
1911
|
+
/** Omitted when the write is called with `return: false`. */
|
|
1912
|
+
data?: any[];
|
|
1913
|
+
}
|
|
1914
|
+
interface DatabaseDataWriteOptions {
|
|
1915
|
+
/** Defaults to true, preserving the legacy full-row response. */
|
|
1916
|
+
return?: boolean;
|
|
1917
|
+
/** With return enabled, return only primary keys. */
|
|
1918
|
+
onlyKeys?: boolean;
|
|
1919
|
+
}
|
|
1920
|
+
interface DatabaseUpsertOptions extends DatabaseDataWriteOptions {
|
|
1921
|
+
/** Defaults to true. Set false for the legacy full-replacement conflict behavior. */
|
|
1922
|
+
patch?: boolean;
|
|
1579
1923
|
}
|
|
1580
1924
|
interface TruncateDatabaseOptions {
|
|
1581
1925
|
/**
|
|
@@ -1617,12 +1961,20 @@ type ExportDatabaseOptions = Omit<SelectInput, 'from'> & {
|
|
|
1617
1961
|
* Default is false.
|
|
1618
1962
|
*/
|
|
1619
1963
|
async?: boolean;
|
|
1964
|
+
/** Suppress the export completion/failure System notification for this low-code call. */
|
|
1965
|
+
skipNotification?: boolean;
|
|
1966
|
+
/** Output format. CSV is the default. XLSX validates the effective row count before starting. */
|
|
1967
|
+
format?: 'csv' | 'xlsx';
|
|
1620
1968
|
/** Omit for private user storage, use ROOT, or provide an accessible explorer folder id. */
|
|
1621
1969
|
storageDestination?: 'ROOT' | string;
|
|
1622
|
-
/** Dedicated output name. Omit for an automatic database-and-timestamp
|
|
1970
|
+
/** Dedicated output name. Omit for an automatic database-and-timestamp name using the selected extension. */
|
|
1623
1971
|
fileName?: string;
|
|
1624
1972
|
/** Whether the output entry is restricted. Default is true. */
|
|
1625
1973
|
restricted?: boolean;
|
|
1974
|
+
/** Explicit allowed group ids for the output entry when restricted is true. */
|
|
1975
|
+
groups?: string[];
|
|
1976
|
+
/** Explicit allowed user ids for the output entry when restricted is true. */
|
|
1977
|
+
users?: string[];
|
|
1626
1978
|
/** CSV delimiter. Default is a comma. */
|
|
1627
1979
|
delimiter?: string;
|
|
1628
1980
|
boolType?: 'emoji' | 'number' | 'boolean';
|
|
@@ -1638,6 +1990,7 @@ interface ExportDatabaseAcceptedResponse {
|
|
|
1638
1990
|
storageNamespace: string;
|
|
1639
1991
|
parentStorageEntryId: string | null;
|
|
1640
1992
|
fileName: string;
|
|
1993
|
+
format: 'csv' | 'xlsx';
|
|
1641
1994
|
restricted: boolean;
|
|
1642
1995
|
message: string;
|
|
1643
1996
|
}
|
|
@@ -1649,12 +2002,21 @@ interface ExportDatabaseCompletedResponse {
|
|
|
1649
2002
|
storageNamespace: string;
|
|
1650
2003
|
parentStorageEntryId: string | null;
|
|
1651
2004
|
fileName: string;
|
|
2005
|
+
format: 'csv' | 'xlsx';
|
|
1652
2006
|
restricted: boolean;
|
|
1653
2007
|
storageEntryId: string;
|
|
1654
2008
|
storageEntry: StorageEntryView;
|
|
1655
2009
|
message: string;
|
|
1656
2010
|
}
|
|
1657
2011
|
type ExportDatabaseResponse = ExportDatabaseAcceptedResponse | ExportDatabaseCompletedResponse;
|
|
2012
|
+
interface DatabaseCountQuery extends Omit<SelectInput, 'take' | 'skip' | 'count' | 'sort'> {
|
|
2013
|
+
}
|
|
2014
|
+
/** Omitted take or explicit null selects 2,000 rows; omission warns once per execution. */
|
|
2015
|
+
interface DatabaseBoundedReadQuery extends Omit<SelectInput, 'take'> {
|
|
2016
|
+
take?: number | null;
|
|
2017
|
+
}
|
|
2018
|
+
interface DatabaseRowQuery extends Omit<SelectInput, 'take' | 'skip' | 'count'> {
|
|
2019
|
+
}
|
|
1658
2020
|
interface Context {
|
|
1659
2021
|
requestId: string;
|
|
1660
2022
|
date: Date;
|
|
@@ -1667,6 +2029,10 @@ interface Context {
|
|
|
1667
2029
|
targetId?: string;
|
|
1668
2030
|
}
|
|
1669
2031
|
interface ComponentExecuteRequest {
|
|
2032
|
+
/** Defaults to local: fresh isolate on the same host. Remote uses the Sandbox service. */
|
|
2033
|
+
options?: {
|
|
2034
|
+
executionHost?: 'local' | 'remote';
|
|
2035
|
+
};
|
|
1670
2036
|
/**
|
|
1671
2037
|
* Active executable component id to run in an isolated child execution.
|
|
1672
2038
|
*/
|
|
@@ -1718,26 +2084,22 @@ interface InstanceData {
|
|
|
1718
2084
|
id: string;
|
|
1719
2085
|
};
|
|
1720
2086
|
}
|
|
1721
|
-
interface SFTPClient {
|
|
1722
|
-
host: string;
|
|
1723
|
-
port: number;
|
|
1724
|
-
username: string;
|
|
1725
|
-
password?: string;
|
|
1726
|
-
privateKey?: string;
|
|
1727
|
-
passphrase?: string;
|
|
1728
|
-
}
|
|
1729
2087
|
interface StorageFileTargetRequest extends Omit<StorageUploadSessionInput, 'replaceStorageEntryId' | 'uploadMode'> {
|
|
1730
2088
|
name: string;
|
|
1731
2089
|
}
|
|
1732
|
-
|
|
2090
|
+
/** Storage destination for transport.sftpImport. Uses the same namespace and ACL contract as storage.* and HTTP targets. */
|
|
2091
|
+
type SFTPImportStorage = (StorageFileTargetRequest & {
|
|
2092
|
+
namespace?: string;
|
|
2093
|
+
}) | {
|
|
1733
2094
|
storageEntryId: string;
|
|
2095
|
+
namespace?: string;
|
|
2096
|
+
replace: true;
|
|
1734
2097
|
};
|
|
1735
|
-
|
|
2098
|
+
/** Existing Storage file used by transport.sftpExport. */
|
|
2099
|
+
interface SFTPExportStorage {
|
|
1736
2100
|
storageEntryId: string;
|
|
1737
|
-
|
|
1738
|
-
}
|
|
1739
|
-
storage: StorageFileTargetRequest;
|
|
1740
|
-
};
|
|
2101
|
+
namespace?: string;
|
|
2102
|
+
}
|
|
1741
2103
|
interface JWTHeader {
|
|
1742
2104
|
alg: string | 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512' | 'ES256' | 'ES384' | 'ES512' | 'PS256' | 'PS384' | 'PS512' | 'none';
|
|
1743
2105
|
typ?: string | undefined;
|
|
@@ -2016,7 +2378,7 @@ interface AgentInboxItem {
|
|
|
2016
2378
|
result?: Record<string, any> | null;
|
|
2017
2379
|
error?: Record<string, any> | null;
|
|
2018
2380
|
priority?: number;
|
|
2019
|
-
|
|
2381
|
+
scheduledFor?: Date | string;
|
|
2020
2382
|
claimedByRunId?: string | null;
|
|
2021
2383
|
leaseToken?: string | null;
|
|
2022
2384
|
leaseExpiresAt?: Date | string | null;
|
|
@@ -2212,7 +2574,6 @@ interface AssistantThread {
|
|
|
2212
2574
|
actionRequired?: AssistantActionRequired | null;
|
|
2213
2575
|
executionPlan?: AssistantPublicExecutionPlan | null;
|
|
2214
2576
|
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2215
|
-
goal?: AssistantThreadGoal | null;
|
|
2216
2577
|
share?: AssistantThreadShare | null;
|
|
2217
2578
|
createdBy?: string;
|
|
2218
2579
|
createdAt?: Date | string;
|
|
@@ -2222,23 +2583,6 @@ interface AssistantThread {
|
|
|
2222
2583
|
deletedAt?: Date | string | null;
|
|
2223
2584
|
version?: number;
|
|
2224
2585
|
}
|
|
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
2586
|
interface AssistantMessage {
|
|
2243
2587
|
assistantMessageId: string;
|
|
2244
2588
|
assistantThreadId: string;
|
|
@@ -2255,7 +2599,6 @@ interface AssistantThreadState {
|
|
|
2255
2599
|
actionRequired: AssistantActionRequired | null;
|
|
2256
2600
|
executionPlan: AssistantPublicExecutionPlan | null;
|
|
2257
2601
|
workerProgress?: AssistantWorkerProgress[] | null;
|
|
2258
|
-
goal?: AssistantThreadGoal | null;
|
|
2259
2602
|
}
|
|
2260
2603
|
interface AssistantThreadShare {
|
|
2261
2604
|
shareId: string;
|
|
@@ -2294,27 +2637,29 @@ interface AssistantThreadCompactionRequest {
|
|
|
2294
2637
|
}
|
|
2295
2638
|
interface RevoApi {
|
|
2296
2639
|
createDatabase(data: DatabaseCreateInput): Promise<Database>;
|
|
2297
|
-
cloneDatabase<TAsync extends boolean = false>(
|
|
2640
|
+
cloneDatabase<TAsync extends boolean = false>(name: string, options?: DatabaseCloneInput & {
|
|
2298
2641
|
async?: TAsync;
|
|
2299
2642
|
}): Promise<TAsync extends true ? CloneDatabaseAcceptedResponse : TAsync extends false ? CloneDatabaseCompletedResponse : CloneDatabaseResponse>;
|
|
2300
|
-
exportDatabase<TAsync extends boolean = false>(
|
|
2643
|
+
exportDatabase<TAsync extends boolean = false>(name: string, options?: ExportDatabaseOptions & {
|
|
2301
2644
|
async?: TAsync;
|
|
2302
2645
|
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
2303
|
-
exportDatabaseView<TAsync extends boolean = false>(
|
|
2646
|
+
exportDatabaseView<TAsync extends boolean = false>(name: string, options?: ExportDatabaseOptions & {
|
|
2304
2647
|
async?: TAsync;
|
|
2305
2648
|
}): Promise<TAsync extends true ? ExportDatabaseAcceptedResponse : TAsync extends false ? ExportDatabaseCompletedResponse : ExportDatabaseResponse>;
|
|
2306
|
-
updateDatabase(
|
|
2307
|
-
deleteDatabase(
|
|
2308
|
-
restoreDatabase(
|
|
2309
|
-
truncateDatabase(
|
|
2310
|
-
getDatabaseData<T = any>(name: string, request?:
|
|
2649
|
+
updateDatabase(name: string, data: DatabaseUpdateInput): Promise<Database>;
|
|
2650
|
+
deleteDatabase(name: string): Promise<void>;
|
|
2651
|
+
restoreDatabase(name: string): Promise<void>;
|
|
2652
|
+
truncateDatabase(name: string, options?: TruncateDatabaseOptions): Promise<void>;
|
|
2653
|
+
getDatabaseData<T = any>(name: string, request?: DatabaseBoundedReadQuery): Promise<GetDatabaseDataResponse<T>>;
|
|
2654
|
+
getDatabaseDataRow<T = any>(name: string, query: DatabaseRowQuery): Promise<T | null>;
|
|
2655
|
+
countDatabase(name: string, query?: DatabaseCountQuery): Promise<number>;
|
|
2311
2656
|
getDatabaseViewData<T = any>(name: string, request?: SelectInput): Promise<GetDatabaseDataResponse<T>>;
|
|
2312
2657
|
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>;
|
|
2658
|
+
insertDatabaseData(name: string, data: LooseObject<any>[], options?: DatabaseDataWriteOptions): Promise<DatabaseDataActionResponse>;
|
|
2659
|
+
upsertDatabaseData(name: string, data: LooseObject<any>[], options?: DatabaseUpsertOptions): Promise<DatabaseDataActionResponse>;
|
|
2315
2660
|
updateDatabaseData(name: string, oldObject: LooseObject<any>, newObject: LooseObject<any>): Promise<ResourceItem>;
|
|
2316
2661
|
deleteDatabaseData(name: string, data: ResourceItem[]): Promise<any>;
|
|
2317
|
-
updateDatabaseDataRequest(name: string, request: DatabaseMutationRequest, payload:
|
|
2662
|
+
updateDatabaseDataRequest(name: string, request: DatabaseMutationRequest, payload: DatabaseUpdateData, options?: {
|
|
2318
2663
|
return?: boolean;
|
|
2319
2664
|
onlyKeys?: boolean;
|
|
2320
2665
|
}): Promise<{
|
|
@@ -2376,10 +2721,34 @@ interface RevoApi {
|
|
|
2376
2721
|
rateLimit(key: string, limit: number, ttl: number): Promise<boolean>;
|
|
2377
2722
|
releaseRateLimit(key: string): Promise<void>;
|
|
2378
2723
|
releaseConcurrencyLimit(key: string): Promise<void>;
|
|
2379
|
-
triggerEvent(name: string, message: any,
|
|
2380
|
-
triggerTarget(targetType: ExecutionTargetType, targetId: string, input?:
|
|
2381
|
-
triggerJob(
|
|
2382
|
-
triggerWebhook(webhook: WebhookInput,
|
|
2724
|
+
triggerEvent(name: string, message: any, options?: TriggerEventOptions): Promise<string>;
|
|
2725
|
+
triggerTarget(targetType: ExecutionTargetType, targetId: string, input?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2726
|
+
triggerJob(templateIdOrName: string, templateInputs?: Record<string, JsonValue>, options?: AutomationScheduleOptions): Promise<string>;
|
|
2727
|
+
triggerWebhook(webhook: WebhookInput, options?: AutomationScheduleOptions): Promise<Webhook>;
|
|
2728
|
+
httpCall(config: HttpRequestInterface, options: HttpRequestOptionsInterface & {
|
|
2729
|
+
responseType: 'storage';
|
|
2730
|
+
target: HttpStorageTargetRef;
|
|
2731
|
+
timeout?: number;
|
|
2732
|
+
proxy?: false;
|
|
2733
|
+
}): Promise<{
|
|
2734
|
+
status: number;
|
|
2735
|
+
statusText: string;
|
|
2736
|
+
time: number;
|
|
2737
|
+
headers: LooseObject<string>;
|
|
2738
|
+
request: {
|
|
2739
|
+
config: HttpRequestInterface;
|
|
2740
|
+
options: HttpRequestOptionsInterface;
|
|
2741
|
+
};
|
|
2742
|
+
} & ({
|
|
2743
|
+
data: undefined;
|
|
2744
|
+
storage: {
|
|
2745
|
+
session: StorageUploadSession;
|
|
2746
|
+
entry: StorageEntryView;
|
|
2747
|
+
};
|
|
2748
|
+
} | {
|
|
2749
|
+
data: string;
|
|
2750
|
+
storage?: undefined;
|
|
2751
|
+
})>;
|
|
2383
2752
|
httpCall(config: HttpRequestInterface, options?: HttpRequestOptionsInterface & {
|
|
2384
2753
|
timeout?: number;
|
|
2385
2754
|
proxy?: boolean;
|
|
@@ -2403,42 +2772,74 @@ interface RevoApi {
|
|
|
2403
2772
|
};
|
|
2404
2773
|
};
|
|
2405
2774
|
}>;
|
|
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
2775
|
}
|
|
2413
2776
|
interface RevoStorage {
|
|
2414
2777
|
explore(query?: StorageExploreRequest): Promise<StorageExploreResult>;
|
|
2778
|
+
explore(namespace: string, query?: StorageExploreRequest): Promise<StorageExploreResult>;
|
|
2415
2779
|
resolveFolderPath(path: string): Promise<StorageEntryView>;
|
|
2780
|
+
resolveFolderPath(path: string, namespace: string): Promise<StorageEntryView>;
|
|
2416
2781
|
ensureFolderPath(path: string, options?: StorageEnsureFolderPathOptions): Promise<StorageEntryView>;
|
|
2782
|
+
ensureFolderPath(path: string, options: StorageEnsureFolderPathOptions | undefined, namespace: string): Promise<StorageEntryView>;
|
|
2417
2783
|
getFile(storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2418
|
-
|
|
2784
|
+
getFile(namespace: string, storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2785
|
+
getFileData(storageEntryId: string, options?: StorageFileReadOptions): Promise<StorageStructuredFileDataPage | string[] | string>;
|
|
2786
|
+
getFileData(namespace: string, storageEntryId: string, options?: StorageFileReadOptions): Promise<StorageStructuredFileDataPage | string[] | string>;
|
|
2419
2787
|
getFileStats(storageEntryId: string, options?: StorageFileStatsOptions): Promise<StorageFileStats>;
|
|
2788
|
+
getFileStats(namespace: string, storageEntryId: string, options?: StorageFileStatsOptions): Promise<StorageFileStats>;
|
|
2420
2789
|
getEntry(storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2790
|
+
getEntry(namespace: string, storageEntryId: string, includeDeleted?: boolean): Promise<StorageEntryView>;
|
|
2421
2791
|
createFolder(data: StorageFolderInput): Promise<StorageEntryView>;
|
|
2792
|
+
createFolder(namespace: string, data: StorageFolderInput): Promise<StorageEntryView>;
|
|
2422
2793
|
putObject(data: StoragePutObjectInput): Promise<StorageEntryView>;
|
|
2794
|
+
putObject(namespace: string, data: StoragePutObjectInput): Promise<StorageEntryView>;
|
|
2423
2795
|
createUploadSession(data: StorageUploadSessionInput): Promise<{
|
|
2424
2796
|
session: StorageUploadSession;
|
|
2425
2797
|
upload: StorageUploadTarget;
|
|
2426
2798
|
}>;
|
|
2799
|
+
createUploadSession(namespace: string, data: StorageUploadSessionInput): Promise<{
|
|
2800
|
+
session: StorageUploadSession;
|
|
2801
|
+
upload: StorageUploadTarget;
|
|
2802
|
+
}>;
|
|
2427
2803
|
extendUploadSession(storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2804
|
+
extendUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2428
2805
|
getUploadSession(storageUploadSessionId: string): Promise<StorageUploadSessionView>;
|
|
2806
|
+
getUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSessionView>;
|
|
2429
2807
|
uploadPart(storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
|
|
2808
|
+
uploadPart(namespace: string, storageUploadSessionId: string, partNumber: number | StorageUploadPartInput, data?: StorageUploadPartInput): Promise<StorageUploadPartResult>;
|
|
2430
2809
|
finalizeUploadSession(storageUploadSessionId: string, data?: StorageUploadSessionFinalizeInput): Promise<{
|
|
2431
2810
|
session: StorageUploadSession;
|
|
2432
2811
|
entry: StorageEntryView;
|
|
2812
|
+
fileStats?: StorageFileStats;
|
|
2813
|
+
}>;
|
|
2814
|
+
finalizeUploadSession(namespace: string, storageUploadSessionId: string, data?: StorageUploadSessionFinalizeInput): Promise<{
|
|
2815
|
+
session: StorageUploadSession;
|
|
2816
|
+
entry: StorageEntryView;
|
|
2817
|
+
fileStats?: StorageFileStats;
|
|
2433
2818
|
}>;
|
|
2434
2819
|
abortUploadSession(storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2820
|
+
abortUploadSession(namespace: string, storageUploadSessionId: string): Promise<StorageUploadSession>;
|
|
2435
2821
|
updateEntry(storageEntryId: string, data: StorageEntryUpdateInput): Promise<StorageEntryView>;
|
|
2822
|
+
updateEntry(namespace: string, storageEntryId: string, data: StorageEntryUpdateInput): Promise<StorageEntryView>;
|
|
2436
2823
|
moveEntry(storageEntryId: string, data: StorageEntryMoveInput): Promise<StorageEntryView>;
|
|
2824
|
+
moveEntry(namespace: string, storageEntryId: string, data: StorageEntryMoveInput): Promise<StorageEntryView>;
|
|
2437
2825
|
archiveEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2826
|
+
archiveEntry(namespace: string, storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2438
2827
|
restoreEntry(storageEntryId: string, data: StorageRestoreInput): Promise<StorageEntryView>;
|
|
2828
|
+
restoreEntry(namespace: string, storageEntryId: string, data: StorageRestoreInput): Promise<StorageEntryView>;
|
|
2439
2829
|
deleteEntry(storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2830
|
+
deleteEntry(namespace: string, storageEntryId: string, data: StorageVersionInput): Promise<StorageEntryView>;
|
|
2440
2831
|
getDownload(storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
|
|
2441
|
-
|
|
2832
|
+
getDownload(namespace: string, storageEntryId: string, preview?: boolean): Promise<StorageDownload>;
|
|
2833
|
+
getDocument(storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
|
|
2834
|
+
getDocument(namespace: string, storageEntryId: string, options?: StorageDocumentReadOptions): Promise<StorageDocument>;
|
|
2835
|
+
}
|
|
2836
|
+
interface RevoTransport {
|
|
2837
|
+
sftpImport(path: string, storage: SFTPImportStorage, secretNameOrId: string): Promise<{
|
|
2838
|
+
session: StorageUploadSession;
|
|
2839
|
+
entry: StorageEntryView;
|
|
2840
|
+
}>;
|
|
2841
|
+
sftpExport(path: string, storage: SFTPExportStorage, secretNameOrId: string): Promise<void>;
|
|
2842
|
+
sftpCommands(commands: any[], secretNameOrId: string): Promise<any>;
|
|
2442
2843
|
}
|
|
2443
2844
|
interface RevoAgents {
|
|
2444
2845
|
list(): Promise<Agent[]>;
|
|
@@ -2467,11 +2868,6 @@ interface RevoAgents {
|
|
|
2467
2868
|
hideDeleted?: boolean;
|
|
2468
2869
|
}): Promise<AssistantThread>;
|
|
2469
2870
|
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
2871
|
getThreadShare(assistantThreadId: string): Promise<AssistantThreadShare | null>;
|
|
2476
2872
|
enableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
|
|
2477
2873
|
disableThreadShare(assistantThreadId: string): Promise<AssistantThreadShare>;
|
|
@@ -2497,8 +2893,8 @@ interface RevoAgents {
|
|
|
2497
2893
|
}
|
|
2498
2894
|
interface RevoUtils {
|
|
2499
2895
|
sleep(ms: number): Promise<void>;
|
|
2500
|
-
aesDecrypt(encrypted: string, passphrase: string): string
|
|
2501
|
-
aesEncrypt(payload: string, passphrase: string): string
|
|
2896
|
+
aesDecrypt(encrypted: string, passphrase: string): Promise<string>;
|
|
2897
|
+
aesEncrypt(payload: string, passphrase: string): Promise<string>;
|
|
2502
2898
|
compareHash(password: string | undefined, hash: string | undefined): Promise<boolean>;
|
|
2503
2899
|
isBase64(input: any): boolean;
|
|
2504
2900
|
decodeBase64(base64String: string): string;
|
|
@@ -2524,7 +2920,7 @@ interface RevoUtils {
|
|
|
2524
2920
|
randomInt(min?: number, max?: number): number;
|
|
2525
2921
|
randomString(length?: number, alphabet?: string): string;
|
|
2526
2922
|
otp(length?: number): string;
|
|
2527
|
-
validate(payload: any, schema: ValidatorSchemaInput): ValidationResult<any
|
|
2923
|
+
validate(payload: any, schema: ValidatorSchemaInput): Promise<ValidationResult<any>>;
|
|
2528
2924
|
jwtDecode(token: string, options?: {
|
|
2529
2925
|
complete?: boolean;
|
|
2530
2926
|
json?: boolean;
|
|
@@ -2566,17 +2962,17 @@ interface RevoUtils {
|
|
|
2566
2962
|
maxAge?: string | number;
|
|
2567
2963
|
allowInvalidAsymmetricKeyTypes?: boolean;
|
|
2568
2964
|
}): any;
|
|
2569
|
-
rsaDecrypt(privateKey: string, payload: string, passphrase?: string): string
|
|
2570
|
-
rsaEncrypt(publicKey: string, payload: string): string
|
|
2965
|
+
rsaDecrypt(privateKey: string, payload: string, passphrase?: string): Promise<string>;
|
|
2966
|
+
rsaEncrypt(publicKey: string, payload: string): Promise<string>;
|
|
2571
2967
|
rsaGeneratePair(config?: {
|
|
2572
2968
|
modulusLength?: number;
|
|
2573
2969
|
passphrase?: string;
|
|
2574
|
-
}): {
|
|
2970
|
+
}): Promise<{
|
|
2575
2971
|
publicKey: string;
|
|
2576
2972
|
privateKey: string;
|
|
2577
|
-
}
|
|
2578
|
-
rsaSign(privateKey: string, payload: string, passphrase?: string): string
|
|
2579
|
-
rsaVerify(publicKey: string, payload: string, signature: string): boolean
|
|
2973
|
+
}>;
|
|
2974
|
+
rsaSign(privateKey: string, payload: string, passphrase?: string): Promise<string>;
|
|
2975
|
+
rsaVerify(publicKey: string, payload: string, signature: string): Promise<boolean>;
|
|
2580
2976
|
}
|
|
2581
2977
|
/**
|
|
2582
2978
|
* Source language for an ad-hoc low-code execution.
|
|
@@ -2683,6 +3079,7 @@ interface RevoRuntime {
|
|
|
2683
3079
|
readonly api: RevoApi;
|
|
2684
3080
|
readonly utils: RevoUtils;
|
|
2685
3081
|
readonly storage: RevoStorage;
|
|
3082
|
+
readonly transport: RevoTransport;
|
|
2686
3083
|
readonly agents: RevoAgents;
|
|
2687
3084
|
readonly execute: RevoExecute;
|
|
2688
3085
|
readonly batch: RevoBatchController;
|
|
@@ -2780,4 +3177,4 @@ declare class RevoHttpResponseError extends RevoError {
|
|
|
2780
3177
|
constructor(statusCode: number, body?: unknown);
|
|
2781
3178
|
}
|
|
2782
3179
|
|
|
2783
|
-
export {
|
|
3180
|
+
export { RevoRuntimeContextUnavailableError as A, type BatchFailureMode as B, CONTRACT_REVISION as C, RevoTransportError as D, type RuntimeBatchRequest as E, type RuntimeBatchResponse as F, type RuntimeCall as G, type HostedRuntimeBootstrap as H, type RuntimeCallResult as I, type SerializedRevoError as J, 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 RevoTransport as i, type RevoAgents as j, type RevoExecute as k, type RevoBatchController as l, type RevoClientOptions as m, type RevoApi as n, RevoAuthenticationError as o, RevoBatchConfigurationError as p, RevoBatchLimitError as q, type RevoBatchLimits as r, type RevoBatchOptions as s, RevoConfigurationError as t, RevoError as u, type RevoExecuteOptions as v, type RevoExecutionDefaults as w, RevoPermissionDeniedError as x, RevoProtocolError as y, RevoRemoteError as z };
|