@archastro/sdk 0.19.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/channels/api_artifact_channel.d.ts +48 -0
- package/dist/channels/api_artifact_channel.d.ts.map +1 -0
- package/dist/channels/api_artifact_channel.js +85 -0
- package/dist/channels/api_artifact_channel.js.map +1 -0
- package/dist/client.d.ts +7 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +9 -3
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/types/ai.d.ts +124 -10
- package/dist/types/ai.d.ts.map +1 -1
- package/dist/types/ai.js +27 -7
- package/dist/types/ai.js.map +1 -1
- package/dist/types/artifacts.d.ts +351 -0
- package/dist/types/artifacts.d.ts.map +1 -1
- package/dist/types/artifacts.js +65 -1
- package/dist/types/artifacts.js.map +1 -1
- package/dist/types/automations.d.ts +22 -22
- package/dist/types/automations.d.ts.map +1 -1
- package/dist/types/automations.js +7 -7
- package/dist/types/automations.js.map +1 -1
- package/dist/types/chat.d.ts +467 -0
- package/dist/types/chat.d.ts.map +1 -1
- package/dist/types/common.d.ts +1161 -296
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +148 -28
- package/dist/types/common.js.map +1 -1
- package/dist/types/computers.d.ts +22 -0
- package/dist/types/computers.d.ts.map +1 -0
- package/dist/types/computers.js +12 -0
- package/dist/types/computers.js.map +1 -0
- package/dist/types/events.d.ts +34 -16
- package/dist/types/events.d.ts.map +1 -1
- package/dist/types/events.js +3 -1
- package/dist/types/events.js.map +1 -1
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +3 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/relays.d.ts +22 -0
- package/dist/types/relays.d.ts.map +1 -0
- package/dist/types/relays.js +12 -0
- package/dist/types/relays.js.map +1 -0
- package/dist/types/tasks.d.ts +598 -14
- package/dist/types/tasks.d.ts.map +1 -1
- package/dist/types/tasks.js +43 -11
- package/dist/types/tasks.js.map +1 -1
- package/dist/types/teams.d.ts +20 -0
- package/dist/types/teams.d.ts.map +1 -1
- package/dist/types/teams.js +8 -1
- package/dist/types/teams.js.map +1 -1
- package/dist/types/threads.d.ts +78 -2
- package/dist/types/threads.d.ts.map +1 -1
- package/dist/types/threads.js +3 -3
- package/dist/types/threads.js.map +1 -1
- package/dist/v1/resources/agent_computers.d.ts +33 -1
- package/dist/v1/resources/agent_computers.d.ts.map +1 -1
- package/dist/v1/resources/agent_computers.js +17 -1
- package/dist/v1/resources/agent_computers.js.map +1 -1
- package/dist/v1/resources/agent_requests.d.ts +54 -0
- package/dist/v1/resources/agent_requests.d.ts.map +1 -0
- package/dist/v1/resources/agent_requests.js +71 -0
- package/dist/v1/resources/agent_requests.js.map +1 -0
- package/dist/v1/resources/agent_sessions.d.ts +23 -1
- package/dist/v1/resources/agent_sessions.d.ts.map +1 -1
- package/dist/v1/resources/agent_sessions.js +26 -1
- package/dist/v1/resources/agent_sessions.js.map +1 -1
- package/dist/v1/resources/agents.d.ts +32 -2
- package/dist/v1/resources/agents.d.ts.map +1 -1
- package/dist/v1/resources/agents.js +12 -2
- package/dist/v1/resources/agents.js.map +1 -1
- package/dist/v1/resources/ai.d.ts +76 -7
- package/dist/v1/resources/ai.d.ts.map +1 -1
- package/dist/v1/resources/ai.js +54 -4
- package/dist/v1/resources/ai.js.map +1 -1
- package/dist/v1/resources/artifacts.d.ts +35 -2
- package/dist/v1/resources/artifacts.d.ts.map +1 -1
- package/dist/v1/resources/artifacts.js +3 -2
- package/dist/v1/resources/artifacts.js.map +1 -1
- package/dist/v1/resources/custom_objects.d.ts +99 -0
- package/dist/v1/resources/custom_objects.d.ts.map +1 -1
- package/dist/v1/resources/custom_objects.js +64 -1
- package/dist/v1/resources/custom_objects.js.map +1 -1
- package/dist/v1/resources/event_subscriptions.d.ts +12 -0
- package/dist/v1/resources/event_subscriptions.d.ts.map +1 -1
- package/dist/v1/resources/event_subscriptions.js +7 -1
- package/dist/v1/resources/event_subscriptions.js.map +1 -1
- package/dist/v1/resources/files.d.ts +32 -10
- package/dist/v1/resources/files.d.ts.map +1 -1
- package/dist/v1/resources/files.js +32 -11
- package/dist/v1/resources/files.js.map +1 -1
- package/dist/v1/resources/index.d.ts +4 -1
- package/dist/v1/resources/index.d.ts.map +1 -1
- package/dist/v1/resources/index.js +5 -2
- package/dist/v1/resources/index.js.map +1 -1
- package/dist/v1/resources/knowledge_sources.d.ts +4 -0
- package/dist/v1/resources/knowledge_sources.d.ts.map +1 -1
- package/dist/v1/resources/knowledge_sources.js +1 -1
- package/dist/v1/resources/kv.d.ts +75 -31
- package/dist/v1/resources/kv.d.ts.map +1 -1
- package/dist/v1/resources/kv.js +79 -32
- package/dist/v1/resources/kv.js.map +1 -1
- package/dist/v1/resources/notifications.d.ts +14 -0
- package/dist/v1/resources/notifications.d.ts.map +1 -1
- package/dist/v1/resources/notifications.js +13 -1
- package/dist/v1/resources/notifications.js.map +1 -1
- package/dist/v1/resources/oauth.d.ts +2 -0
- package/dist/v1/resources/oauth.d.ts.map +1 -1
- package/dist/v1/resources/oauth.js +2 -1
- package/dist/v1/resources/oauth.js.map +1 -1
- package/dist/v1/resources/orgs.d.ts +662 -2
- package/dist/v1/resources/orgs.d.ts.map +1 -1
- package/dist/v1/resources/orgs.js +380 -2
- package/dist/v1/resources/orgs.js.map +1 -1
- package/dist/v1/resources/private_service_enrollments.d.ts +7 -0
- package/dist/v1/resources/private_service_enrollments.d.ts.map +1 -1
- package/dist/v1/resources/private_service_enrollments.js +10 -1
- package/dist/v1/resources/private_service_enrollments.js.map +1 -1
- package/dist/v1/resources/relays.d.ts +38 -0
- package/dist/v1/resources/relays.d.ts.map +1 -0
- package/dist/v1/resources/relays.js +44 -0
- package/dist/v1/resources/relays.js.map +1 -0
- package/dist/v1/resources/scripts.d.ts +20 -9
- package/dist/v1/resources/scripts.d.ts.map +1 -1
- package/dist/v1/resources/scripts.js +18 -10
- package/dist/v1/resources/scripts.js.map +1 -1
- package/dist/v1/resources/task_ownership_conversions.d.ts +14 -0
- package/dist/v1/resources/task_ownership_conversions.d.ts.map +1 -0
- package/dist/v1/resources/task_ownership_conversions.js +19 -0
- package/dist/v1/resources/task_ownership_conversions.js.map +1 -0
- package/dist/v1/resources/tasks.d.ts +62 -1
- package/dist/v1/resources/tasks.d.ts.map +1 -1
- package/dist/v1/resources/tasks.js +35 -1
- package/dist/v1/resources/tasks.js.map +1 -1
- package/dist/v1/resources/teams.d.ts +141 -3
- package/dist/v1/resources/teams.d.ts.map +1 -1
- package/dist/v1/resources/teams.js +82 -1
- package/dist/v1/resources/teams.js.map +1 -1
- package/dist/v1/resources/threads.d.ts +79 -0
- package/dist/v1/resources/threads.d.ts.map +1 -1
- package/dist/v1/resources/threads.js +44 -1
- package/dist/v1/resources/threads.js.map +1 -1
- package/dist/v1/resources/users.d.ts +131 -4
- package/dist/v1/resources/users.d.ts.map +1 -1
- package/dist/v1/resources/users.js +73 -3
- package/dist/v1/resources/users.js.map +1 -1
- package/dist/v1/resources/workflows.d.ts +5 -1
- package/dist/v1/resources/workflows.d.ts.map +1 -1
- package/dist/v1/resources/workflows.js +6 -2
- package/dist/v1/resources/workflows.js.map +1 -1
- package/dist/v1.d.ts +7 -1
- package/dist/v1.d.ts.map +1 -1
- package/dist/v1.js +12 -3
- package/dist/v1.js.map +1 -1
- package/package.json +1 -1
package/dist/types/common.js
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
// Copyright (c) 2026 ArchAstro Inc. Licensed under the MIT License.
|
|
2
2
|
// This file is auto-generated by @archastro/sdk-generator. Do not edit.
|
|
3
|
-
// Content hash:
|
|
3
|
+
// Content hash: e9c10f6c8b7c
|
|
4
4
|
import { z } from "zod";
|
|
5
5
|
import { automationParticipantSlotSchema, automationPrefillsSchema } from "./automations.js";
|
|
6
6
|
import { configSchema } from "./config.js";
|
|
7
7
|
import { imageSourceSchema } from "./image.js";
|
|
8
8
|
import { userSchema } from "./users.js";
|
|
9
9
|
import { workflowJournalSchema, workflowJournalEntrySchema } from "./workflows.js";
|
|
10
|
+
/** Runtime validator for {@link Refusal}. */
|
|
11
|
+
export const refusalSchema = z.object({
|
|
12
|
+
id: z.string(),
|
|
13
|
+
type: z.literal("refusal"),
|
|
14
|
+
}).describe("The model declined to judge this question.");
|
|
10
15
|
/** Runtime validator for {@link AclGrant}. */
|
|
11
16
|
export const aclGrantSchema = z.object({
|
|
12
17
|
/** Array of action strings the principal is permitted to perform, e.g. `["read", "write"]`. Must contain at least one entry. */
|
|
@@ -129,6 +134,30 @@ export const installedConfigEntrySchema = z.object({
|
|
|
129
134
|
/** Stored `lookup_key` for this config after any suffix has been applied. `null` for `File` children inside a skill bundle, which are keyed by `(parent_id, relative_path)` rather than by `lookup_key`. */
|
|
130
135
|
lookup_key: z.string().nullable().optional().describe("Stored `lookup_key` for this config after any suffix has been applied. `null` for `File` children inside a skill bundle, which are keyed by `(parent_id, relative_path)` rather than by `lookup_key`."),
|
|
131
136
|
}).describe("A slim summary of a single config record created during an agent install transaction. Returned as an entry in `AgentCreateResponse.installed_configs`.");
|
|
137
|
+
/** Runtime validator for {@link Approvers}. */
|
|
138
|
+
export const approversSchema = z.object({
|
|
139
|
+
mode: z.string(),
|
|
140
|
+
}).describe("Approval policy, excluding user IDs.");
|
|
141
|
+
/** Runtime validator for {@link Origin}. */
|
|
142
|
+
export const originSchema = z.object({
|
|
143
|
+
routine_id: z.string().nullable().optional(),
|
|
144
|
+
session_id: z.string().nullable().optional(),
|
|
145
|
+
thread_id: z.string().nullable().optional(),
|
|
146
|
+
}).describe("Origin references.");
|
|
147
|
+
/** Runtime validator for {@link Payload}. */
|
|
148
|
+
export const payloadSchema = z.object({
|
|
149
|
+
question: z.string(),
|
|
150
|
+
}).describe("Question request payload.");
|
|
151
|
+
/** Runtime validator for {@link Resolution}. */
|
|
152
|
+
export const resolutionSchema = z.object({
|
|
153
|
+
answer: z.string().optional(),
|
|
154
|
+
reason: z.string().optional(),
|
|
155
|
+
}).describe("Answer or rejection reason; null before resolution.");
|
|
156
|
+
/** Runtime validator for {@link Summary}. */
|
|
157
|
+
export const summarySchema = z.object({
|
|
158
|
+
lines: z.array(z.string()),
|
|
159
|
+
title: z.string(),
|
|
160
|
+
}).describe("Kind-provided summary.");
|
|
132
161
|
/** Runtime validator for {@link MessagePolicy}. */
|
|
133
162
|
export const messagePolicySchema = z.object({
|
|
134
163
|
/** Required and non-empty for private visibility. Sources are additive. Routine owner includes the agent owner and optional user co-owner. */
|
|
@@ -174,10 +203,14 @@ export const setupSchema = z.object({
|
|
|
174
203
|
}).describe("Current MCP setup assessment, not a historical downgrade reason or upstream protocol probe.");
|
|
175
204
|
/** Runtime validator for {@link MediaVariant}. */
|
|
176
205
|
export const mediaVariantSchema = z.object({
|
|
206
|
+
/** Size of the stored bytes. */
|
|
207
|
+
byte_size: z.number().int().nullable().optional().describe("Size of the stored bytes."),
|
|
177
208
|
/** MIME type of this variant's file (e.g., `"image/jpeg"`, `"video/mp4"`). `null` if the file is not loaded. */
|
|
178
209
|
content_type: z.string().nullable().optional().describe("MIME type of this variant's file (e.g., `\"image/jpeg\"`, `\"video/mp4\"`). `null` if the file is not loaded."),
|
|
179
210
|
/** When this variant was created (ISO 8601). */
|
|
180
211
|
created_at: z.string().optional().describe("When this variant was created (ISO 8601)."),
|
|
212
|
+
/** Client-declared video duration in milliseconds; not server-probed. */
|
|
213
|
+
duration_ms: z.number().int().nullable().optional().describe("Client-declared video duration in milliseconds; not server-probed."),
|
|
181
214
|
/** ID of the underlying storage file that backs this variant (`fil_...`). */
|
|
182
215
|
file: z.string().optional().describe("ID of the underlying storage file that backs this variant (`fil_...`)."),
|
|
183
216
|
/** Original filename of the uploaded file for this variant. `null` if the file is not loaded. */
|
|
@@ -188,10 +221,14 @@ export const mediaVariantSchema = z.object({
|
|
|
188
221
|
id: z.string().describe("Media variant ID (`mvr_...`)."),
|
|
189
222
|
/** Resolved image delivery metadata for this variant, including dimensions and CDN URL. `null` for non-image content types. */
|
|
190
223
|
image_source: imageSourceSchema.nullable().optional().describe("Resolved image delivery metadata for this variant, including dimensions and CDN URL. `null` for non-image content types."),
|
|
224
|
+
/** Lowercase SHA-256 of the stored bytes. */
|
|
225
|
+
sha256: z.string().nullable().optional().describe("Lowercase SHA-256 of the stored bytes."),
|
|
191
226
|
/** When this variant was last updated (ISO 8601). */
|
|
192
227
|
updated_at: z.string().optional().describe("When this variant was last updated (ISO 8601)."),
|
|
193
228
|
/** Signed download URL for this variant, resolved at request time. `null` if the file is unavailable. */
|
|
194
229
|
url: z.string().nullable().optional().describe("Signed download URL for this variant, resolved at request time. `null` if the file is unavailable."),
|
|
230
|
+
/** Expiry of this variant's playable URL. */
|
|
231
|
+
url_expires_at: z.string().nullable().optional().describe("Expiry of this variant's playable URL."),
|
|
195
232
|
/** Identifier for this variant's processing tier. Common values include `"original"` (the unmodified upload) and `"thumbnail"` (a resized preview). */
|
|
196
233
|
variant_key: z.string().optional().describe("Identifier for this variant's processing tier. Common values include `\"original\"` (the unmodified upload) and `\"thumbnail\"` (a resized preview)."),
|
|
197
234
|
/** Width of this variant in pixels. `null` if not recorded. */
|
|
@@ -217,6 +254,8 @@ export const attachmentSchema = z.object({
|
|
|
217
254
|
image_url: z.string().nullable().optional().describe("URL of the preview image extracted from the scraped page. Present on `scraped_link` type only. `null` otherwise."),
|
|
218
255
|
/** Width in pixels of the scraped preview image. Present on `scraped_link` type only. `null` otherwise. */
|
|
219
256
|
image_width: z.number().int().nullable().optional().describe("Width in pixels of the scraped preview image. Present on `scraped_link` type only. `null` otherwise."),
|
|
257
|
+
/** For `structured_data` type, what the data is about as set by the sender (for example `"pr:14963"`), copied from the record so it can be read without `object`. Not unique. `null` when unset and on other types. */
|
|
258
|
+
key: z.string().nullable().optional().describe("For `structured_data` type, what the data is about as set by the sender (for example `\"pr:14963\"`), copied from the record so it can be read without `object`. Not unique. `null` when unset and on other types."),
|
|
220
259
|
/** The media category, e.g. `"video"` or `"audio"`. Present on `media` type only; omitted otherwise. */
|
|
221
260
|
media_type: z.string().optional().describe("The media category, e.g. `\"video\"` or `\"audio\"`. Present on `media` type only; omitted otherwise."),
|
|
222
261
|
/** Display name of the media item. Present on `media` type only. `null` otherwise. */
|
|
@@ -420,13 +459,6 @@ export const commandSchema = z.object({
|
|
|
420
459
|
/** JSON Schema describing the shape of a successful output. `null` if the command produces no output on success. */
|
|
421
460
|
successOutput: z.record(z.custom((value) => value !== undefined)).optional().describe("JSON Schema describing the shape of a successful output. `null` if the command produces no output on success."),
|
|
422
461
|
}).describe("A workflow command that a workflow node can invoke, including its identifier, human-readable name, and JSON schemas for its inputs and outputs.");
|
|
423
|
-
/** Runtime validator for {@link ComputerExecResult}. */
|
|
424
|
-
export const computerExecResultSchema = z.object({
|
|
425
|
-
/** The UNIX exit code returned by the process. `0` indicates success; any non-zero value indicates an error. `null` if the process did not terminate normally. */
|
|
426
|
-
exit_code: z.number().int().optional().describe("The UNIX exit code returned by the process. `0` indicates success; any non-zero value indicates an error. `null` if the process did not terminate normally."),
|
|
427
|
-
/** The combined stdout and stderr output produced by the command. `null` if the command produced no output. */
|
|
428
|
-
output: z.string().optional().describe("The combined stdout and stderr output produced by the command. `null` if the command produced no output."),
|
|
429
|
-
}).describe("The result of executing a shell command on an agent's computer environment. Contains the captured output and the process exit code.");
|
|
430
462
|
/** Runtime validator for {@link ContextDocument}. */
|
|
431
463
|
export const contextDocumentSchema = z.object({
|
|
432
464
|
/** ID of the agent that owns this document (`agi_...`). `null` if owned by a user or team. */
|
|
@@ -545,12 +577,20 @@ export const effectiveAccessEntitlementSchema = z.object({
|
|
|
545
577
|
granted: z.boolean().describe("Whether any eligible source grants the key."),
|
|
546
578
|
/** Stable entitlement catalog key. */
|
|
547
579
|
key: z.string().describe("Stable entitlement catalog key."),
|
|
580
|
+
/** Unexpired metered allowance, including exhausted grants; null for boolean entitlements. */
|
|
581
|
+
limit: z.number().int().nullable().optional().describe("Unexpired metered allowance, including exhausted grants; null for boolean entitlements."),
|
|
548
582
|
/** Privacy-safe principal kinds that contribute to the effective value. */
|
|
549
583
|
provided_by: z.array(z.enum(["personal", "organization"])).describe("Privacy-safe principal kinds that contribute to the effective value."),
|
|
584
|
+
/** Effective purchased quantity from the recurring terms linked to this key (for example seats), summed across granting principals. `null` when the key is not granted or no granting plan links a term to it. */
|
|
585
|
+
quantity: z.number().int().nullable().optional().describe("Effective purchased quantity from the recurring terms linked to this key (for example seats), summed across granting principals. `null` when the key is not granted or no granting plan links a term to it."),
|
|
586
|
+
/** Remaining metered allowance credits; null for boolean entitlements. */
|
|
587
|
+
remaining: z.number().int().nullable().optional().describe("Remaining metered allowance credits; null for boolean entitlements."),
|
|
588
|
+
/** Signed metered consumption in the allowance window; may be negative after reversals. Null for boolean entitlements. */
|
|
589
|
+
used: z.number().int().nullable().optional().describe("Signed metered consumption in the allowance window; may be negative after reversals. Null for boolean entitlements."),
|
|
550
590
|
/** Merged entitlement value, or `null` when the key is not granted. */
|
|
551
591
|
value: z.boolean().nullable().optional().describe("Merged entitlement value, or `null` when the key is not granted."),
|
|
552
592
|
/** Catalog type used to interpret `value`. */
|
|
553
|
-
value_type: z.
|
|
593
|
+
value_type: z.enum(["boolean", "metered"]).describe("Catalog type used to interpret `value`."),
|
|
554
594
|
}).describe("A billing-derived effective entitlement for the authenticated user.");
|
|
555
595
|
/** Runtime validator for {@link EffectiveAccess}. */
|
|
556
596
|
export const effectiveAccessSchema = z.object({
|
|
@@ -581,6 +621,8 @@ export const currentUserSchema = z.object({
|
|
|
581
621
|
name: z.string().nullable().optional().describe("Full display name of the user."),
|
|
582
622
|
/** The authenticated user's notification preferences. */
|
|
583
623
|
notification_settings: z.record(z.custom((value) => value !== undefined)).describe("The authenticated user's notification preferences."),
|
|
624
|
+
/** Registered display name of the verified OAuth client, when available. Not a verified vendor identity. */
|
|
625
|
+
oauth_client_name: z.string().optional().describe("Registered display name of the verified OAuth client, when available. Not a verified vendor identity."),
|
|
584
626
|
/** ID of the current organization (`org_...`). */
|
|
585
627
|
org: z.string().nullable().optional().describe("ID of the current organization (`org_...`)."),
|
|
586
628
|
/** Whether the current organization is company-domain or person-owned. */
|
|
@@ -604,8 +646,12 @@ export const currentUserSchema = z.object({
|
|
|
604
646
|
export const customObjectSchema = z.object({
|
|
605
647
|
/** Access control list governing read and write access to this custom object. Only returned to resource owners and privileged or organization-admin viewers; `null` for everyone else. */
|
|
606
648
|
acl: aclSchema.optional().describe("Access control list governing read and write access to this custom object. Only returned to resource owners and privileged or organization-admin viewers; `null` for everyone else."),
|
|
649
|
+
/** ID of the agent that owns this object (`agt_...`). `null` for other ownership types. */
|
|
650
|
+
agent: z.string().optional().describe("ID of the agent that owns this object (`agt_...`). `null` for other ownership types."),
|
|
607
651
|
/** When the custom object was created (ISO 8601). */
|
|
608
652
|
created_at: z.string().optional().describe("When the custom object was created (ISO 8601)."),
|
|
653
|
+
/** Absolute expiry time (RFC 3339). Null when no expiry is set. */
|
|
654
|
+
expires_at: z.string().nullable().optional().describe("Absolute expiry time (RFC 3339). Null when no expiry is set."),
|
|
609
655
|
/** Map of field names to their current values as defined by the object's schema type. */
|
|
610
656
|
fields: z.record(z.custom((value) => value !== undefined)).optional().describe("Map of field names to their current values as defined by the object's schema type."),
|
|
611
657
|
/** Unique identifier for the custom object (`cobj_...`). */
|
|
@@ -652,10 +698,10 @@ export const customObjectListResponseSchema = z.object({
|
|
|
652
698
|
page: z.number().int().describe("The current page number (1-indexed)."),
|
|
653
699
|
/** Maximum number of results returned per page. */
|
|
654
700
|
page_size: z.number().int().describe("Maximum number of results returned per page."),
|
|
655
|
-
/** Total number of custom objects matching the query across all pages. */
|
|
656
|
-
total_entries: z.number().int().describe("Total number of custom objects matching the query across all pages."),
|
|
657
|
-
/** Total number of pages available for the current query. */
|
|
658
|
-
total_pages: z.number().int().describe("Total number of pages available for the current query."),
|
|
701
|
+
/** Total number of custom objects matching the query across all pages; null when include_count is false. */
|
|
702
|
+
total_entries: z.number().int().nullable().describe("Total number of custom objects matching the query across all pages; null when include_count is false."),
|
|
703
|
+
/** Total number of pages available for the current query; null when include_count is false. */
|
|
704
|
+
total_pages: z.number().int().nullable().describe("Total number of pages available for the current query; null when include_count is false."),
|
|
659
705
|
}).describe("A paginated page of custom objects returned by a list operation. Use the pagination fields to navigate through result sets.");
|
|
660
706
|
/** Runtime validator for {@link CustomObjectPresenceAck}. */
|
|
661
707
|
export const customObjectPresenceAckSchema = z.object({
|
|
@@ -896,27 +942,43 @@ export const installationSourceListResponseSchema = z.object({
|
|
|
896
942
|
}).describe("Paginated list response containing installation source objects attached to an installation.");
|
|
897
943
|
/** Runtime validator for {@link KeyValueStorageEntry}. */
|
|
898
944
|
export const keyValueStorageEntrySchema = z.object({
|
|
945
|
+
/** Agent owner, if any. */
|
|
946
|
+
agent: z.string().optional().describe("Agent owner, if any."),
|
|
899
947
|
/** When this storage entry was first created (ISO 8601). `null` if not yet persisted. */
|
|
900
948
|
created_at: z.string().optional().describe("When this storage entry was first created (ISO 8601). `null` if not yet persisted."),
|
|
949
|
+
/** Expiry deadline, or null for entries without expiry. */
|
|
950
|
+
expires_at: z.string().optional().describe("Expiry deadline, or null for entries without expiry."),
|
|
901
951
|
/** The string key used to store and look up this entry. */
|
|
902
952
|
key: z.string().describe("The string key used to store and look up this entry."),
|
|
953
|
+
/** Organization scope. */
|
|
954
|
+
org: z.string().optional().describe("Organization scope."),
|
|
955
|
+
/** Team owner, if any. */
|
|
956
|
+
team: z.string().optional().describe("Team owner, if any."),
|
|
903
957
|
/** When this storage entry was last updated (ISO 8601). `null` if not yet persisted. */
|
|
904
958
|
updated_at: z.string().optional().describe("When this storage entry was last updated (ISO 8601). `null` if not yet persisted."),
|
|
905
|
-
/** ID of the user
|
|
906
|
-
user: z.string().describe("ID of the user
|
|
959
|
+
/** ID of the user owner, or null for non-user ownership. */
|
|
960
|
+
user: z.string().optional().describe("ID of the user owner, or null for non-user ownership."),
|
|
907
961
|
/** The string value stored under `key` for this user. */
|
|
908
962
|
value: z.string().describe("The string value stored under `key` for this user."),
|
|
909
|
-
}).describe("
|
|
963
|
+
}).describe("An owner-scoped key/value pair within an app, optionally expiring.");
|
|
910
964
|
/** Runtime validator for {@link KeyValueStorageEntryWithUser}. */
|
|
911
965
|
export const keyValueStorageEntryWithUserSchema = z.object({
|
|
966
|
+
/** Agent owner, if any. */
|
|
967
|
+
agent: z.string().optional().describe("Agent owner, if any."),
|
|
912
968
|
/** When this storage entry was first created (ISO 8601). */
|
|
913
969
|
created_at: z.string().describe("When this storage entry was first created (ISO 8601)."),
|
|
970
|
+
/** Expiry deadline, or null for entries without expiry. */
|
|
971
|
+
expires_at: z.string().optional().describe("Expiry deadline, or null for entries without expiry."),
|
|
914
972
|
/** The string key used to store and look up this entry. */
|
|
915
973
|
key: z.string().describe("The string key used to store and look up this entry."),
|
|
974
|
+
/** Organization scope. */
|
|
975
|
+
org: z.string().optional().describe("Organization scope."),
|
|
976
|
+
/** Team owner, if any. */
|
|
977
|
+
team: z.string().optional().describe("Team owner, if any."),
|
|
916
978
|
/** When this storage entry was last updated (ISO 8601). */
|
|
917
979
|
updated_at: z.string().describe("When this storage entry was last updated (ISO 8601)."),
|
|
918
|
-
/** ID of the user
|
|
919
|
-
user: z.string().describe("ID of the user
|
|
980
|
+
/** ID of the user owner, or null for non-user ownership. */
|
|
981
|
+
user: z.string().optional().describe("ID of the user owner, or null for non-user ownership."),
|
|
920
982
|
/** Email address of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers. */
|
|
921
983
|
user_email: z.string().optional().describe("Email address of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers."),
|
|
922
984
|
/** Display name of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers. */
|
|
@@ -1515,7 +1577,7 @@ export const agentSchema = z.object({
|
|
|
1515
1577
|
/** Runtime validator for {@link AgentComputer}. */
|
|
1516
1578
|
export const agentComputerSchema = z.object({
|
|
1517
1579
|
/** ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent. */
|
|
1518
|
-
agent: z.string().optional().describe("ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent."),
|
|
1580
|
+
agent: z.string().nullable().optional().describe("ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent."),
|
|
1519
1581
|
/** ID of the app this computer belongs to (`dap_...`). */
|
|
1520
1582
|
app: z.string().optional().describe("ID of the app this computer belongs to (`dap_...`)."),
|
|
1521
1583
|
/** Provider-specific configuration key-value pairs for the computer. Structure depends on the underlying compute provider. */
|
|
@@ -1523,25 +1585,29 @@ export const agentComputerSchema = z.object({
|
|
|
1523
1585
|
/** When the computer was created (ISO 8601). */
|
|
1524
1586
|
created_at: z.string().optional().describe("When the computer was created (ISO 8601)."),
|
|
1525
1587
|
/** Human-readable error description when `status` is `"error"`. `null` otherwise. */
|
|
1526
|
-
error_message: z.string().optional().describe("Human-readable error description when `status` is `\"error\"`. `null` otherwise."),
|
|
1588
|
+
error_message: z.string().nullable().optional().describe("Human-readable error description when `status` is `\"error\"`. `null` otherwise."),
|
|
1527
1589
|
/** Computer ID (`cmp_...`). */
|
|
1528
1590
|
id: z.string().describe("Computer ID (`cmp_...`)."),
|
|
1591
|
+
/** Stable key unique within the thread, or null if unset. */
|
|
1592
|
+
key: z.string().nullable().optional().describe("Stable key unique within the thread, or null if unset."),
|
|
1529
1593
|
/** When the computer last reported activity or received a command. `null` if the computer has never been active. */
|
|
1530
|
-
last_active_at: z.string().optional().describe("When the computer last reported activity or received a command. `null` if the computer has never been active."),
|
|
1594
|
+
last_active_at: z.string().nullable().optional().describe("When the computer last reported activity or received a command. `null` if the computer has never been active."),
|
|
1531
1595
|
/** Unique, stable identifier you assign to this computer within its app. `null` if not set. */
|
|
1532
|
-
lookup_key: z.string().optional().describe("Unique, stable identifier you assign to this computer within its app. `null` if not set."),
|
|
1596
|
+
lookup_key: z.string().nullable().optional().describe("Unique, stable identifier you assign to this computer within its app. `null` if not set."),
|
|
1533
1597
|
/** Arbitrary key-value metadata you attached to the computer. `null` if none was provided. */
|
|
1534
1598
|
metadata: z.record(z.custom((value) => value !== undefined)).optional().describe("Arbitrary key-value metadata you attached to the computer. `null` if none was provided."),
|
|
1535
1599
|
/** Human-readable display name for the computer. `null` if not set. */
|
|
1536
1600
|
name: z.string().optional().describe("Human-readable display name for the computer. `null` if not set."),
|
|
1537
|
-
/** Compute backend powering this computer: `"sprites"` (Fly Sprites)
|
|
1538
|
-
provider: z.string().optional().describe("Compute backend powering this computer: `\"sprites\"` (Fly Sprites)
|
|
1539
|
-
/** Cloud region where the computer is hosted, e.g. `"us-east-1"`. `null` if not yet assigned or when the provider has no region concept (e.g. `"vercel"`). */
|
|
1540
|
-
region: z.string().optional().describe("Cloud region where the computer is hosted, e.g. `\"us-east-1\"`. `null` if not yet assigned or when the provider has no region concept (e.g. `\"vercel\"`)."),
|
|
1601
|
+
/** Compute backend powering this computer: `"sprites"` (Fly Sprites), `"vercel"` (Vercel Sandbox) or `"e2b"` (E2B). */
|
|
1602
|
+
provider: z.string().optional().describe("Compute backend powering this computer: `\"sprites\"` (Fly Sprites), `\"vercel\"` (Vercel Sandbox) or `\"e2b\"` (E2B)."),
|
|
1603
|
+
/** Cloud region where the computer is hosted, e.g. `"us-east-1"`. `null` if not yet assigned or when the provider has no region concept (e.g. `"vercel"`, `"e2b"`). */
|
|
1604
|
+
region: z.string().nullable().optional().describe("Cloud region where the computer is hosted, e.g. `\"us-east-1\"`. `null` if not yet assigned or when the provider has no region concept (e.g. `\"vercel\"`, `\"e2b\"`)."),
|
|
1541
1605
|
/** URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available. */
|
|
1542
|
-
sprite_url: z.string().optional().describe("URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available."),
|
|
1606
|
+
sprite_url: z.string().nullable().optional().describe("URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available."),
|
|
1543
1607
|
/** Current lifecycle state of the computer. Common values include `"provisioning"`, `"ready"`, `"error"`, and `"terminated"`. */
|
|
1544
|
-
status: z.string().optional().describe("Current lifecycle state of the computer. Common values include `\"provisioning\"`, `\"ready\"`, `\"error\"`, and `\"terminated\"`."),
|
|
1608
|
+
status: z.string().nullable().optional().describe("Current lifecycle state of the computer. Common values include `\"provisioning\"`, `\"ready\"`, `\"error\"`, and `\"terminated\"`."),
|
|
1609
|
+
/** Thread this computer belongs to, or null for a non-thread computer. */
|
|
1610
|
+
thread_id: z.string().nullable().optional().describe("Thread this computer belongs to, or null for a non-thread computer."),
|
|
1545
1611
|
/** When the computer record was last modified (ISO 8601). */
|
|
1546
1612
|
updated_at: z.string().optional().describe("When the computer record was last modified (ISO 8601)."),
|
|
1547
1613
|
}).describe("A cloud computer resource provisioned for an agent to use for browser and desktop automation tasks.");
|
|
@@ -1656,6 +1722,47 @@ export const agentListResponseSchema = z.object({
|
|
|
1656
1722
|
/** Total number of pages available given the current `page_size`. */
|
|
1657
1723
|
total_pages: z.number().int().optional().describe("Total number of pages available given the current `page_size`."),
|
|
1658
1724
|
}).describe("Paginated list of agent objects. Use the pagination fields to traverse multiple pages of results.");
|
|
1725
|
+
/** Runtime validator for {@link AgentRequestAgent}. */
|
|
1726
|
+
export const agentRequestAgentSchema = z.object({
|
|
1727
|
+
id: z.string(),
|
|
1728
|
+
name: z.string().nullable().optional(),
|
|
1729
|
+
}).describe("Originating agent.");
|
|
1730
|
+
/** Runtime validator for {@link AgentRequest}. */
|
|
1731
|
+
export const agentRequestSchema = z.object({
|
|
1732
|
+
/** Originating agent. */
|
|
1733
|
+
agent: agentRequestAgentSchema.optional().describe("Originating agent."),
|
|
1734
|
+
/** Approval policy, excluding user IDs. */
|
|
1735
|
+
approvers: approversSchema.optional().describe("Approval policy, excluding user IDs."),
|
|
1736
|
+
/** Expiration time. */
|
|
1737
|
+
expires_at: z.string().optional().describe("Expiration time."),
|
|
1738
|
+
/** Request ID (`arq_...`). */
|
|
1739
|
+
id: z.string().describe("Request ID (`arq_...`)."),
|
|
1740
|
+
/** Whether the authenticated caller is an approver, regardless of request status. */
|
|
1741
|
+
is_approver: z.boolean().optional().describe("Whether the authenticated caller is an approver, regardless of request status."),
|
|
1742
|
+
/** Registered request kind. */
|
|
1743
|
+
kind: z.string().optional().describe("Registered request kind."),
|
|
1744
|
+
/** Origin references. */
|
|
1745
|
+
origin: originSchema.optional().describe("Origin references."),
|
|
1746
|
+
/** Question request payload. */
|
|
1747
|
+
payload: payloadSchema.optional().describe("Question request payload."),
|
|
1748
|
+
/** Answer or rejection reason; null before resolution. */
|
|
1749
|
+
resolution: resolutionSchema.nullable().optional().describe("Answer or rejection reason; null before resolution."),
|
|
1750
|
+
/** Resolution time. */
|
|
1751
|
+
resolved_at: z.string().optional().describe("Resolution time."),
|
|
1752
|
+
/** Resolving user ID. */
|
|
1753
|
+
resolved_by: z.string().optional().describe("Resolving user ID."),
|
|
1754
|
+
/** Request status. */
|
|
1755
|
+
status: z.string().optional().describe("Request status."),
|
|
1756
|
+
/** Kind-provided summary. */
|
|
1757
|
+
summary: summarySchema.optional().describe("Kind-provided summary."),
|
|
1758
|
+
}).describe("A request for human approval or input. Secret input is never returned.");
|
|
1759
|
+
/** Runtime validator for {@link AgentRequestListResponse}. */
|
|
1760
|
+
export const agentRequestListResponseSchema = z.object({
|
|
1761
|
+
/** Visible requests. */
|
|
1762
|
+
data: z.array(agentRequestSchema).describe("Visible requests."),
|
|
1763
|
+
/** Pass as cursor for the next page; null at the end. */
|
|
1764
|
+
next_cursor: z.string().optional().describe("Pass as cursor for the next page; null at the end."),
|
|
1765
|
+
}).describe("A page of visible agent requests.");
|
|
1659
1766
|
/** Runtime validator for {@link AgentRoutine}. */
|
|
1660
1767
|
export const agentRoutineSchema = z.object({
|
|
1661
1768
|
/** Access control list for the routine. Contains a `grants` array where each entry specifies `principal_type`, `principal`, and `actions` (`"read"`, `"invoke"`, or `"assign"` — an `"assign"` grant names the agents or orgs that may be handed this routine's embedded work items). `null` when no ACL restrictions are applied and the routine is accessible to all members of its scope. */
|
|
@@ -1849,6 +1956,19 @@ export const agentSessionSchema = z.object({
|
|
|
1849
1956
|
/** ID of the trajectory that records the full message history for this session (`trj_...`). `null` until the session has started. */
|
|
1850
1957
|
trajectory: z.string().optional().describe("ID of the trajectory that records the full message history for this session (`trj_...`). `null` until the session has started."),
|
|
1851
1958
|
}).describe("A durable agent session record representing a single AI task execution. Tracks status, trajectory, result, and any inbox messages delivered to the session.");
|
|
1959
|
+
/** Runtime validator for {@link AgentSessionEvent}. */
|
|
1960
|
+
export const agentSessionEventSchema = z.object({
|
|
1961
|
+
/** Event name: `session_started`, `message`, `tool_use`, `needs_input`, `activity`, `error`, `turn_complete`, `finished`, `adopted`, or `harness_raw`. */
|
|
1962
|
+
event: z.string().optional().describe("Event name: `session_started`, `message`, `tool_use`, `needs_input`, `activity`, `error`, `turn_complete`, `finished`, `adopted`, or `harness_raw`."),
|
|
1963
|
+
/** Harness that emitted it. */
|
|
1964
|
+
harness: z.string().nullable().optional().describe("Harness that emitted it."),
|
|
1965
|
+
/** Event ID; pass as `after` to page. */
|
|
1966
|
+
id: z.string().optional().describe("Event ID; pass as `after` to page."),
|
|
1967
|
+
/** When the event happened in the sandbox. */
|
|
1968
|
+
occurred_at: z.string().optional().describe("When the event happened in the sandbox."),
|
|
1969
|
+
/** Harness-specific event data. */
|
|
1970
|
+
payload: z.record(z.custom((value) => value !== undefined)).nullable().optional().describe("Harness-specific event data."),
|
|
1971
|
+
}).describe("One event from the coding harness running an agent session on a computer.");
|
|
1852
1972
|
/** Runtime validator for {@link AgentSessionListResponse}. */
|
|
1853
1973
|
export const agentSessionListResponseSchema = z.object({
|
|
1854
1974
|
/** Array of agent session objects for the current page. */
|