@archastro/sdk 0.17.0 → 0.19.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/auth.d.ts +42 -18
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +53 -19
- package/dist/auth.js.map +1 -1
- package/dist/channels/api_chat_channel.d.ts +11 -1
- package/dist/channels/api_chat_channel.d.ts.map +1 -1
- package/dist/channels/api_chat_channel.js +14 -2
- package/dist/channels/api_chat_channel.js.map +1 -1
- package/dist/effective-access.d.ts +1 -1
- package/dist/effective-access.d.ts.map +1 -1
- package/dist/effective-access.js +2 -5
- package/dist/effective-access.js.map +1 -1
- package/dist/types/ai.d.ts +310 -0
- package/dist/types/ai.d.ts.map +1 -1
- package/dist/types/ai.js +51 -1
- package/dist/types/ai.js.map +1 -1
- package/dist/types/artifacts.d.ts +14 -2
- package/dist/types/artifacts.d.ts.map +1 -1
- package/dist/types/artifacts.js +5 -1
- package/dist/types/artifacts.js.map +1 -1
- package/dist/types/chat.d.ts +192 -168
- package/dist/types/chat.d.ts.map +1 -1
- package/dist/types/chat.js +10 -3
- package/dist/types/chat.js.map +1 -1
- package/dist/types/common.d.ts +347 -128
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +39 -20
- package/dist/types/common.js.map +1 -1
- package/dist/types/config.d.ts +2 -2
- package/dist/types/events.d.ts +32 -32
- package/dist/types/extractions.d.ts +12 -12
- package/dist/types/tasks.d.ts +34 -8
- package/dist/types/tasks.d.ts.map +1 -1
- package/dist/types/tasks.js +12 -3
- package/dist/types/tasks.js.map +1 -1
- package/dist/types/teams.d.ts +10 -10
- package/dist/types/threads.d.ts +18 -18
- 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/agents.d.ts +8 -2
- package/dist/v1/resources/agents.d.ts.map +1 -1
- package/dist/v1/resources/agents.js +7 -2
- package/dist/v1/resources/agents.js.map +1 -1
- package/dist/v1/resources/ai.d.ts +72 -1
- package/dist/v1/resources/ai.d.ts.map +1 -1
- package/dist/v1/resources/ai.js +44 -1
- package/dist/v1/resources/ai.js.map +1 -1
- package/dist/v1/resources/artifacts.d.ts +52 -0
- package/dist/v1/resources/artifacts.d.ts.map +1 -1
- package/dist/v1/resources/artifacts.js +35 -1
- package/dist/v1/resources/artifacts.js.map +1 -1
- package/dist/v1/resources/files.d.ts +7 -0
- package/dist/v1/resources/files.d.ts.map +1 -1
- package/dist/v1/resources/files.js +8 -1
- package/dist/v1/resources/files.js.map +1 -1
- package/dist/v1/resources/knowledge_sources.d.ts +41 -0
- package/dist/v1/resources/knowledge_sources.d.ts.map +1 -1
- package/dist/v1/resources/knowledge_sources.js +31 -1
- package/dist/v1/resources/knowledge_sources.js.map +1 -1
- package/dist/v1/resources/orgs.d.ts +506 -0
- package/dist/v1/resources/orgs.d.ts.map +1 -1
- package/dist/v1/resources/orgs.js +71 -1
- package/dist/v1/resources/orgs.js.map +1 -1
- package/dist/v1/resources/sandboxes.d.ts +3 -2
- package/dist/v1/resources/sandboxes.d.ts.map +1 -1
- package/dist/v1/resources/sandboxes.js +4 -3
- package/dist/v1/resources/sandboxes.js.map +1 -1
- package/dist/v1/resources/scripts.d.ts +6 -2
- package/dist/v1/resources/scripts.d.ts.map +1 -1
- package/dist/v1/resources/scripts.js +5 -3
- package/dist/v1/resources/scripts.js.map +1 -1
- package/dist/v1/resources/tasks.d.ts +58 -3
- package/dist/v1/resources/tasks.d.ts.map +1 -1
- package/dist/v1/resources/tasks.js +61 -2
- package/dist/v1/resources/tasks.js.map +1 -1
- package/dist/v1/resources/teams.d.ts +46 -14
- package/dist/v1/resources/teams.d.ts.map +1 -1
- package/dist/v1/resources/teams.js +54 -16
- package/dist/v1/resources/teams.js.map +1 -1
- package/dist/v1/resources/threads.d.ts +16 -6
- package/dist/v1/resources/threads.d.ts.map +1 -1
- package/dist/v1/resources/threads.js +19 -8
- package/dist/v1/resources/threads.js.map +1 -1
- package/dist/v1/resources/users.d.ts +13 -3
- package/dist/v1/resources/users.d.ts.map +1 -1
- package/dist/v1/resources/users.js +13 -3
- package/dist/v1/resources/users.js.map +1 -1
- package/package.json +1 -1
package/dist/types/common.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
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: d38489a6b420
|
|
4
4
|
import { z } from "zod";
|
|
5
5
|
import { automationParticipantSlotSchema, automationPrefillsSchema } from "./automations.js";
|
|
6
6
|
import { configSchema } from "./config.js";
|
|
@@ -163,6 +163,15 @@ export const workerStatusSchema = z.object({
|
|
|
163
163
|
/** Current execution state of the worker. One of `"queued"`, `"executing"`, `"retrying"`, `"completed"`, `"discarded"`, or `"cancelled"`. */
|
|
164
164
|
status: z.string().describe("Current execution state of the worker. One of `\"queued\"`, `\"executing\"`, `\"retrying\"`, `\"completed\"`, `\"discarded\"`, or `\"cancelled\"`."),
|
|
165
165
|
}).describe("Execution state of the background worker processing a routine run. Reflects the current job status and retry progress.");
|
|
166
|
+
/** Runtime validator for {@link Setup}. */
|
|
167
|
+
export const setupSchema = z.object({
|
|
168
|
+
/** Recommended next step for MCP setup. */
|
|
169
|
+
next_action: z.string().describe("Recommended next step for MCP setup."),
|
|
170
|
+
/** MCP protocol health is not checked by this assessment. */
|
|
171
|
+
protocol_status: z.literal("not_checked").describe("MCP protocol health is not checked by this assessment."),
|
|
172
|
+
/** Reason for the current MCP setup state. */
|
|
173
|
+
reason: z.string().describe("Reason for the current MCP setup state."),
|
|
174
|
+
}).describe("Current MCP setup assessment, not a historical downgrade reason or upstream protocol probe.");
|
|
166
175
|
/** Runtime validator for {@link MediaVariant}. */
|
|
167
176
|
export const mediaVariantSchema = z.object({
|
|
168
177
|
/** MIME type of this variant's file (e.g., `"image/jpeg"`, `"video/mp4"`). `null` if the file is not loaded. */
|
|
@@ -212,12 +221,12 @@ export const attachmentSchema = z.object({
|
|
|
212
221
|
media_type: z.string().optional().describe("The media category, e.g. `\"video\"` or `\"audio\"`. Present on `media` type only; omitted otherwise."),
|
|
213
222
|
/** Display name of the media item. Present on `media` type only. `null` otherwise. */
|
|
214
223
|
name: z.string().nullable().optional().describe("Display name of the media item. Present on `media` type only. `null` otherwise."),
|
|
215
|
-
/** The full embedded object payload. For `task` type, contains the task record. For `action` type, contains the action definition. For `chart` type, contains the chart with its inline `spec`. Omitted on other types. */
|
|
216
|
-
object: z.record(z.custom((value) => value !== undefined)).optional().describe("The full embedded object payload. For `task` type, contains the task record. For `action` type, contains the action definition. For `chart` type, contains the chart with its inline `spec`. Omitted on other types."),
|
|
224
|
+
/** The full embedded object payload. For `task` type, contains the task record. For `action` type, contains the action definition. For `chart` type, contains the chart with its inline `spec`. For `structured_data` type, contains the inline `data` and the `schema_url` or `schema_config` naming its JSON Schema. Omitted on other types. */
|
|
225
|
+
object: z.record(z.custom((value) => value !== undefined)).optional().describe("The full embedded object payload. For `task` type, contains the task record. For `action` type, contains the action definition. For `chart` type, contains the chart with its inline `spec`. For `structured_data` type, contains the inline `data` and the `schema_url` or `schema_config` naming its JSON Schema. Omitted on other types."),
|
|
217
226
|
/** Display title. The page title for `scraped_link`, the artifact name for `artifact`, and the task title for `task` types. `null` on other types. */
|
|
218
227
|
title: z.string().nullable().optional().describe("Display title. The page title for `scraped_link`, the artifact name for `artifact`, and the task title for `task` types. `null` on other types."),
|
|
219
|
-
/** The attachment type. One of `"file"`, `"scraped_link"`, `"artifact"`, `"task"`, `"media"`, `"action"`, or `"
|
|
220
|
-
type: z.string().describe("The attachment type. One of `\"file\"`, `\"scraped_link\"`, `\"artifact\"`, `\"task\"`, `\"media\"`, `\"action\"`, or `\"
|
|
228
|
+
/** The attachment type. One of `"file"`, `"scraped_link"`, `"artifact"`, `"task"`, `"media"`, `"action"`, `"chart"`, or `"structured_data"`. Determines which additional fields are present. */
|
|
229
|
+
type: z.string().describe("The attachment type. One of `\"file\"`, `\"scraped_link\"`, `\"artifact\"`, `\"task\"`, `\"media\"`, `\"action\"`, `\"chart\"`, or `\"structured_data\"`. Determines which additional fields are present."),
|
|
221
230
|
/** URL to access the resource. A signed download URL for `file` and `artifact` types; the original URL for `scraped_link`; a media playback URL for `media`. `null` on `task` and `action` types. */
|
|
222
231
|
url: z.string().nullable().optional().describe("URL to access the resource. A signed download URL for `file` and `artifact` types; the original URL for `scraped_link`; a media playback URL for `media`. `null` on `task` and `action` types."),
|
|
223
232
|
/** Array of available encoding variants for the media item (e.g. different resolutions). Present on `media` type only; omitted otherwise. */
|
|
@@ -229,6 +238,8 @@ export const attachmentSchema = z.object({
|
|
|
229
238
|
}).describe("A rich attachment associated with a message, such as a file, scraped link, artifact, task, media item, or inline action.");
|
|
230
239
|
/** Runtime validator for {@link AuthTokens}. */
|
|
231
240
|
export const authTokensSchema = z.object({
|
|
241
|
+
/** `true` when this request created the account (the same moment the platform records the signup), `false` for a returning sign-in or a token refresh. Registration always returns `true`; password login and refresh always return `false`. */
|
|
242
|
+
account_created: z.boolean().describe("`true` when this request created the account (the same moment the platform records the signup), `false` for a returning sign-in or a token refresh. Registration always returns `true`; password login and refresh always return `false`."),
|
|
232
243
|
/** Number of seconds until `token` expires. After this period, use `refresh_token` to obtain a new access token. */
|
|
233
244
|
expires_in: z.number().int().describe("Number of seconds until `token` expires. After this period, use `refresh_token` to obtain a new access token."),
|
|
234
245
|
/** Optional auxiliary data associated with this authentication event, such as `onboarding_job_id` when the user is completing onboarding. `null` when no extra context is present. */
|
|
@@ -394,13 +405,6 @@ export const okSchema = z.object({
|
|
|
394
405
|
content: z.string(),
|
|
395
406
|
status: z.literal("ok"),
|
|
396
407
|
}).describe("A successful local-tool outcome.");
|
|
397
|
-
/** Runtime validator for {@link Error}. */
|
|
398
|
-
export const errorSchema = z.object({
|
|
399
|
-
call_id: z.string(),
|
|
400
|
-
code: z.string(),
|
|
401
|
-
message: z.string(),
|
|
402
|
-
status: z.literal("error"),
|
|
403
|
-
}).describe("A failed local-tool outcome.");
|
|
404
408
|
/** Runtime validator for {@link Command}. */
|
|
405
409
|
export const commandSchema = z.object({
|
|
406
410
|
/** Human-readable description of what the command does, shown alongside the name in the workflow builder. */
|
|
@@ -518,12 +522,23 @@ export const createdPrivateServiceEnrollmentSchema = z.object({
|
|
|
518
522
|
id: z.string(),
|
|
519
523
|
private_service: z.string(),
|
|
520
524
|
}).describe("Creation-only private service enrollment response. The raw token is shown once and is omitted from every read schema.");
|
|
525
|
+
/** Runtime validator for {@link EffectiveAccessBillingTrial}. */
|
|
526
|
+
export const effectiveAccessBillingTrialSchema = z.object({
|
|
527
|
+
/** Effective trial end: the earlier of its accepted boundary and enrollment end. */
|
|
528
|
+
ends_at: z.string().describe("Effective trial end: the earlier of its accepted boundary and enrollment end."),
|
|
529
|
+
/** Whether a provider webhook has confirmed a stored payment method. */
|
|
530
|
+
payment_method_stored: z.boolean().describe("Whether a provider webhook has confirmed a stored payment method."),
|
|
531
|
+
/** Catalog plan whose trial is active. */
|
|
532
|
+
plan: z.string().describe("Catalog plan whose trial is active."),
|
|
533
|
+
}).describe("Privacy-safe current trial state for one Viewer-derived billing principal.");
|
|
521
534
|
/** Runtime validator for {@link EffectiveAccessBillingPrincipal}. */
|
|
522
535
|
export const effectiveAccessBillingPrincipalSchema = z.object({
|
|
523
536
|
/** Whether the authenticated user may administer this principal's billing account. */
|
|
524
537
|
administrator: z.boolean().describe("Whether the authenticated user may administer this principal's billing account."),
|
|
525
538
|
principal_type: z.enum(["user", "org"]),
|
|
526
|
-
|
|
539
|
+
/** Currently active trials for this Viewer-derived principal. Contains no billing-account or provider identifiers. */
|
|
540
|
+
trials: z.array(effectiveAccessBillingTrialSchema).describe("Currently active trials for this Viewer-derived principal. Contains no billing-account or provider identifiers."),
|
|
541
|
+
}).describe("Billing authority and relevant active trials for one Viewer-derived principal kind.");
|
|
527
542
|
/** Runtime validator for {@link EffectiveAccessEntitlement}. */
|
|
528
543
|
export const effectiveAccessEntitlementSchema = z.object({
|
|
529
544
|
/** Whether any eligible source grants the key. */
|
|
@@ -539,11 +554,11 @@ export const effectiveAccessEntitlementSchema = z.object({
|
|
|
539
554
|
}).describe("A billing-derived effective entitlement for the authenticated user.");
|
|
540
555
|
/** Runtime validator for {@link EffectiveAccess}. */
|
|
541
556
|
export const effectiveAccessSchema = z.object({
|
|
542
|
-
/** Administration authority for the personal and current-organization principals. */
|
|
543
|
-
billing: z.array(effectiveAccessBillingPrincipalSchema).describe("Administration authority for the personal and current-organization principals."),
|
|
557
|
+
/** Administration authority and requested-entitlement-relevant trials for the personal and current-organization principals. */
|
|
558
|
+
billing: z.array(effectiveAccessBillingPrincipalSchema).describe("Administration authority and requested-entitlement-relevant trials for the personal and current-organization principals."),
|
|
544
559
|
/** Requested catalog entitlements in request order. */
|
|
545
560
|
entitlements: z.array(effectiveAccessEntitlementSchema).describe("Requested catalog entitlements in request order."),
|
|
546
|
-
}).describe("Live effective access
|
|
561
|
+
}).describe("Live effective access, billing authority, and relevant trials for the authenticated user.");
|
|
547
562
|
/** Runtime validator for {@link CurrentUser}. */
|
|
548
563
|
export const currentUserSchema = z.object({
|
|
549
564
|
/** Short handle or alias of the user. */
|
|
@@ -568,6 +583,8 @@ export const currentUserSchema = z.object({
|
|
|
568
583
|
notification_settings: z.record(z.custom((value) => value !== undefined)).describe("The authenticated user's notification preferences."),
|
|
569
584
|
/** ID of the current organization (`org_...`). */
|
|
570
585
|
org: z.string().nullable().optional().describe("ID of the current organization (`org_...`)."),
|
|
586
|
+
/** Whether the current organization is company-domain or person-owned. */
|
|
587
|
+
org_kind: z.enum(["company", "personal"]).nullable().optional().describe("Whether the current organization is company-domain or person-owned."),
|
|
571
588
|
/** Display name of the current organization. */
|
|
572
589
|
org_name: z.string().nullable().optional().describe("Display name of the current organization."),
|
|
573
590
|
/** The authenticated user's role in the current organization. */
|
|
@@ -1392,8 +1409,8 @@ export const solutionSummarySchema = z.object({
|
|
|
1392
1409
|
events: z.record(z.custom((value) => value !== undefined)).optional().describe("Custom analytics events declared in the Solution body's `events:` manifest — a map of event key (snake_case) to its definition (`label`, optional `description`, optional typed `fields`). Dashboards use the `label` as the event's display name. Present as an empty object when the body declares none."),
|
|
1393
1410
|
/** Solution config ID (`cfg_...`). */
|
|
1394
1411
|
id: z.string().describe("Solution config ID (`cfg_...`)."),
|
|
1395
|
-
/** Absolute URL of the Solution's cover image — the bundled asset the body's `image:` field names. A stable, non-expiring capability URL (like `org_logo.url`), safe to hold in caches and OpenGraph tags; it 404s if the Solution stops declaring a cover. `null` when the Solution has no cover image
|
|
1396
|
-
image_url: z.string().nullable().optional().describe("Absolute URL of the Solution's cover image — the bundled asset the body's `image:` field names. A stable, non-expiring capability URL (like `org_logo.url`), safe to hold in caches and OpenGraph tags; it 404s if the Solution stops declaring a cover. `null` when the Solution has no cover image
|
|
1412
|
+
/** Absolute URL of the Solution's cover image — the bundled asset the body's `image:` field names. A stable, non-expiring capability URL (like `org_logo.url`), safe to hold in caches and OpenGraph tags; it 404s if the Solution stops declaring a cover. `null` when the Solution has no cover image. Org-only rows remain `null`; when a list entry merges an org copy with its system counterpart, it may reuse the system row's public cover URL. Permanent URLs are never minted for private org assets. */
|
|
1413
|
+
image_url: z.string().nullable().optional().describe("Absolute URL of the Solution's cover image — the bundled asset the body's `image:` field names. A stable, non-expiring capability URL (like `org_logo.url`), safe to hold in caches and OpenGraph tags; it 404s if the Solution stops declaring a cover. `null` when the Solution has no cover image. Org-only rows remain `null`; when a list entry merges an org copy with its system counterpart, it may reuse the system row's public cover URL. Permanent URLs are never minted for private org assets."),
|
|
1397
1414
|
/** Config IDs (`cfg_...`) of this Solution's installations in the viewer's organization. The array is empty when the Solution is visible only from the system catalog. */
|
|
1398
1415
|
installed_config_ids: z.array(z.string()).describe("Config IDs (`cfg_...`) of this Solution's installations in the viewer's organization. The array is empty when the Solution is visible only from the system catalog."),
|
|
1399
1416
|
/** Resource type. Always `"Solution"`. */
|
|
@@ -1905,8 +1922,10 @@ export const agentToolSchema = z.object({
|
|
|
1905
1922
|
parameters: z.record(z.custom((value) => value !== undefined)).optional().describe("JSON Schema object describing the tool's input parameters as presented to the LLM."),
|
|
1906
1923
|
/** ID of the config record (`cfg_...`) storing the tool's parameter schema. `null` when parameters are defined inline. */
|
|
1907
1924
|
parameters_config: z.string().optional().describe("ID of the config record (`cfg_...`) storing the tool's parameter schema. `null` when parameters are defined inline."),
|
|
1908
|
-
/** Current
|
|
1909
|
-
|
|
1925
|
+
/** Current MCP setup assessment, not a historical downgrade reason or upstream protocol probe. */
|
|
1926
|
+
setup: setupSchema.nullable().optional().describe("Current MCP setup assessment, not a historical downgrade reason or upstream protocol probe."),
|
|
1927
|
+
/** Current status of the tool. One of `"active"` or `"draft"`. */
|
|
1928
|
+
status: z.string().optional().describe("Current status of the tool. One of `\"active\"` or `\"draft\"`."),
|
|
1910
1929
|
/** When the tool was last modified (ISO 8601). */
|
|
1911
1930
|
updated_at: z.string().optional().describe("When the tool was last modified (ISO 8601)."),
|
|
1912
1931
|
}).describe("A tool attached to an agent, defining a capability the agent can invoke during a conversation or task run.");
|