@archastro/sdk 0.10.0 → 0.11.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/client.d.ts +14 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +15 -1
- package/dist/client.js.map +1 -1
- package/dist/types/ai.d.ts +2 -2
- package/dist/types/chat.d.ts +30 -30
- package/dist/types/common.d.ts +625 -0
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +136 -1
- package/dist/types/common.js.map +1 -1
- package/dist/types/extractions.d.ts +36 -0
- package/dist/types/extractions.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +2 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/status.d.ts +121 -0
- package/dist/types/status.d.ts.map +1 -0
- package/dist/types/status.js +18 -0
- package/dist/types/status.js.map +1 -0
- package/dist/types/tasks.d.ts +254 -0
- package/dist/types/tasks.d.ts.map +1 -1
- package/dist/types/tasks.js +52 -1
- package/dist/types/tasks.js.map +1 -1
- package/dist/types/threads.d.ts +2 -2
- package/dist/v1/resources/activity_feed.d.ts +1 -1
- package/dist/v1/resources/activity_feed.js +2 -2
- package/dist/v1/resources/custom_objects.d.ts +31 -16
- package/dist/v1/resources/custom_objects.d.ts.map +1 -1
- package/dist/v1/resources/custom_objects.js +35 -16
- package/dist/v1/resources/custom_objects.js.map +1 -1
- package/dist/v1/resources/files.d.ts +19 -0
- package/dist/v1/resources/files.d.ts.map +1 -1
- package/dist/v1/resources/files.js +3 -1
- package/dist/v1/resources/files.js.map +1 -1
- package/dist/v1/resources/index.d.ts +7 -0
- package/dist/v1/resources/index.d.ts.map +1 -1
- package/dist/v1/resources/index.js +8 -1
- package/dist/v1/resources/index.js.map +1 -1
- package/dist/v1/resources/private_service_definitions.d.ts +12 -0
- package/dist/v1/resources/private_service_definitions.d.ts.map +1 -0
- package/dist/v1/resources/private_service_definitions.js +18 -0
- package/dist/v1/resources/private_service_definitions.js.map +1 -0
- package/dist/v1/resources/private_service_enrollments.d.ts +42 -0
- package/dist/v1/resources/private_service_enrollments.d.ts.map +1 -0
- package/dist/v1/resources/private_service_enrollments.js +56 -0
- package/dist/v1/resources/private_service_enrollments.js.map +1 -0
- package/dist/v1/resources/private_services.d.ts +46 -0
- package/dist/v1/resources/private_services.d.ts.map +1 -0
- package/dist/v1/resources/private_services.js +55 -0
- package/dist/v1/resources/private_services.js.map +1 -0
- package/dist/v1/resources/sandboxes.d.ts +81 -0
- package/dist/v1/resources/sandboxes.d.ts.map +1 -0
- package/dist/v1/resources/sandboxes.js +84 -0
- package/dist/v1/resources/sandboxes.js.map +1 -0
- package/dist/v1/resources/status.d.ts +22 -0
- package/dist/v1/resources/status.d.ts.map +1 -0
- package/dist/v1/resources/status.js +27 -0
- package/dist/v1/resources/status.js.map +1 -0
- package/dist/v1/resources/tasks.d.ts +599 -0
- package/dist/v1/resources/tasks.d.ts.map +1 -0
- package/dist/v1/resources/tasks.js +436 -0
- package/dist/v1/resources/tasks.js.map +1 -0
- package/dist/v1/resources/teams.d.ts +390 -3
- package/dist/v1/resources/teams.d.ts.map +1 -1
- package/dist/v1/resources/teams.js +227 -4
- package/dist/v1/resources/teams.js.map +1 -1
- package/dist/v1/resources/thread_messages.d.ts +6 -3
- package/dist/v1/resources/thread_messages.d.ts.map +1 -1
- package/dist/v1/resources/thread_messages.js +5 -4
- package/dist/v1/resources/thread_messages.js.map +1 -1
- package/dist/v1/resources/threads.d.ts +39 -0
- package/dist/v1/resources/threads.d.ts.map +1 -1
- package/dist/v1/resources/threads.js +36 -1
- package/dist/v1/resources/threads.js.map +1 -1
- package/dist/v1/resources/trajectories.d.ts +34 -0
- package/dist/v1/resources/trajectories.d.ts.map +1 -0
- package/dist/v1/resources/trajectories.js +41 -0
- package/dist/v1/resources/trajectories.js.map +1 -0
- package/dist/v1/resources/users.d.ts +352 -0
- package/dist/v1/resources/users.d.ts.map +1 -1
- package/dist/v1/resources/users.js +208 -1
- package/dist/v1/resources/users.js.map +1 -1
- package/dist/v1.d.ts +14 -0
- package/dist/v1.d.ts.map +1 -1
- package/dist/v1.js +22 -1
- package/dist/v1.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: 76c7762b600d
|
|
4
4
|
import { z } from "zod";
|
|
5
5
|
import { automationParticipantSlotSchema, automationPrefillsSchema } from "./automations.js";
|
|
6
6
|
import { configSchema } from "./config.js";
|
|
@@ -460,6 +460,16 @@ export const contextIngestionSchema = z.object({
|
|
|
460
460
|
/** ID of the user that initiated this ingestion (`usr_...`). `null` if initiated by an agent. */
|
|
461
461
|
user: z.string().optional().describe("ID of the user that initiated this ingestion (`usr_...`). `null` if initiated by an agent."),
|
|
462
462
|
}).describe("A context ingestion job that processes a context source and populates its documents. Tracks status and timing from submission through completion or failure.");
|
|
463
|
+
/** Runtime validator for {@link CreatedPrivateServiceEnrollment}. */
|
|
464
|
+
export const createdPrivateServiceEnrollmentSchema = z.object({
|
|
465
|
+
/** One-time connector enrollment token. Store it immediately. */
|
|
466
|
+
enrollment_token: z.string().describe("One-time connector enrollment token. Store it immediately."),
|
|
467
|
+
/** When the one-time enrollment token expires. */
|
|
468
|
+
enrollment_token_expires_at: z.string().describe("When the one-time enrollment token expires."),
|
|
469
|
+
generation: z.number().int(),
|
|
470
|
+
id: z.string(),
|
|
471
|
+
private_service: z.string(),
|
|
472
|
+
}).describe("Creation-only private service enrollment response. The raw token is shown once and is omitted from every read schema.");
|
|
463
473
|
/** Runtime validator for {@link CustomObject}. */
|
|
464
474
|
export const customObjectSchema = z.object({
|
|
465
475
|
/** 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. */
|
|
@@ -536,8 +546,17 @@ export const customObjectUpdateFieldsResponseSchema = z.object({
|
|
|
536
546
|
/** Idempotency key acknowledged for this update. */
|
|
537
547
|
operation_id: z.string().describe("Idempotency key acknowledged for this update."),
|
|
538
548
|
}).describe("Response returned after updating one or more fields on a custom object. Confirms the object that was modified and the field values that were applied.");
|
|
549
|
+
/** Runtime validator for {@link Deployment}. */
|
|
550
|
+
export const deploymentSchema = z.object({
|
|
551
|
+
/** Deployment environment, or `null` when it is not configured. */
|
|
552
|
+
environment: z.string().nullable().optional().describe("Deployment environment, or `null` when it is not configured."),
|
|
553
|
+
/** Opaque SHA-256 fingerprint of the image reference, or `null` in local development. */
|
|
554
|
+
release: z.string().nullable().optional().describe("Opaque SHA-256 fingerprint of the image reference, or `null` in local development."),
|
|
555
|
+
}).describe("Deployment metadata.");
|
|
539
556
|
/** Runtime validator for {@link StorageFile}. */
|
|
540
557
|
export const storageFileSchema = z.object({
|
|
558
|
+
/** ID of the app this file belongs to (`app_...`). */
|
|
559
|
+
app: z.string().optional().describe("ID of the app this file belongs to (`app_...`)."),
|
|
541
560
|
/** MIME type of the file, e.g. `"image/png"` or `"application/pdf"`. */
|
|
542
561
|
content_type: z.string().optional().describe("MIME type of the file, e.g. `\"image/png\"` or `\"application/pdf\"`."),
|
|
543
562
|
/** When the file was uploaded (ISO 8601). */
|
|
@@ -556,10 +575,14 @@ export const storageFileSchema = z.object({
|
|
|
556
575
|
share_url: z.string().optional().describe("Stable public URL for the file, fetchable without authentication. Present only when the file was shared (`share: true`); does not expire until sharing is disabled. Disabling and re-enabling sharing reactivates the same URL. `null` otherwise."),
|
|
557
576
|
/** Size of the file in bytes. */
|
|
558
577
|
size: z.number().int().optional().describe("Size of the file in bytes."),
|
|
578
|
+
/** ID of the team that owns this file (`team_...`). `null` if not team-owned. */
|
|
579
|
+
team: z.string().optional().describe("ID of the team that owns this file (`team_...`). `null` if not team-owned."),
|
|
559
580
|
/** When the file record was last modified (ISO 8601). */
|
|
560
581
|
updated_at: z.string().optional().describe("When the file record was last modified (ISO 8601)."),
|
|
561
582
|
/** Short-lived signed URL for downloading the file. `null` if a URL could not be generated. */
|
|
562
583
|
url: z.string().optional().describe("Short-lived signed URL for downloading the file. `null` if a URL could not be generated."),
|
|
584
|
+
/** ID of the user that owns this file (`user_...`). `null` if not user-owned. */
|
|
585
|
+
user: z.string().optional().describe("ID of the user that owns this file (`user_...`). `null` if not user-owned."),
|
|
563
586
|
}).describe("A file stored in the platform's object storage, with metadata and a signed URL for downloading its contents.");
|
|
564
587
|
/** Runtime validator for {@link AgentHealthAction}. */
|
|
565
588
|
export const agentHealthActionSchema = z.object({
|
|
@@ -798,6 +821,53 @@ export const paginatedRepliesSchema = z.object({
|
|
|
798
821
|
/** Total number of replies in the thread across all pages. */
|
|
799
822
|
total_count: z.number().int().optional().describe("Total number of replies in the thread across all pages."),
|
|
800
823
|
}).describe("A paginated list of reply messages for a thread. The reply array is returned directly, not nested inside a `data` wrapper.");
|
|
824
|
+
/** Runtime validator for {@link PrivateServiceFunction}. */
|
|
825
|
+
export const privateServiceFunctionSchema = z.object({
|
|
826
|
+
/** Human-readable guidance describing when and why to call the operation. */
|
|
827
|
+
description: z.string().describe("Human-readable guidance describing when and why to call the operation."),
|
|
828
|
+
/** JSON Schema Draft 7 object describing the operation's argument object. */
|
|
829
|
+
input_schema: z.record(z.unknown()).describe("JSON Schema Draft 7 object describing the operation's argument object."),
|
|
830
|
+
/** Stable operation name used when invoking the private service. */
|
|
831
|
+
name: z.string().describe("Stable operation name used when invoking the private service."),
|
|
832
|
+
/** Optional JSON Schema Draft 7 object describing the successful result. */
|
|
833
|
+
output_schema: z.record(z.unknown()).optional().describe("Optional JSON Schema Draft 7 object describing the successful result."),
|
|
834
|
+
}).describe("A documented callable operation exposed by a private service.");
|
|
835
|
+
/** Runtime validator for {@link PrivateService}. */
|
|
836
|
+
export const privateServiceSchema = z.object({
|
|
837
|
+
/** Sorted callable definitions exposed by this private service. */
|
|
838
|
+
functions: z.array(privateServiceFunctionSchema).describe("Sorted callable definitions exposed by this private service."),
|
|
839
|
+
/** Private service ID (`pvs_...`). */
|
|
840
|
+
id: z.string().describe("Private service ID (`pvs_...`)."),
|
|
841
|
+
}).describe("An immutable private service with complete callable operation contracts.");
|
|
842
|
+
/** Runtime validator for {@link PrivateServiceEnrollment}. */
|
|
843
|
+
export const privateServiceEnrollmentSchema = z.object({
|
|
844
|
+
/** Latest committed connector certificate generation, or zero before enrollment. */
|
|
845
|
+
generation: z.number().int().describe("Latest committed connector certificate generation, or zero before enrollment."),
|
|
846
|
+
/** Canonical certificate-bound service identity. */
|
|
847
|
+
id: z.string().describe("Canonical certificate-bound service identity."),
|
|
848
|
+
/** Immutable private service ID (`pvs_...`). */
|
|
849
|
+
private_service: z.string().describe("Immutable private service ID (`pvs_...`)."),
|
|
850
|
+
}).describe("A private service's durable connector identity. Read responses never contain an enrollment token or certificate.");
|
|
851
|
+
/** Runtime validator for {@link PrivateServiceEnrollmentPage}. */
|
|
852
|
+
export const privateServiceEnrollmentPageSchema = z.object({
|
|
853
|
+
data: z.array(privateServiceEnrollmentSchema),
|
|
854
|
+
has_next: z.boolean(),
|
|
855
|
+
has_prev: z.boolean(),
|
|
856
|
+
page: z.number().int(),
|
|
857
|
+
page_size: z.number().int(),
|
|
858
|
+
total_entries: z.number().int(),
|
|
859
|
+
total_pages: z.number().int(),
|
|
860
|
+
}).describe("A secret-free page of private service enrollments.");
|
|
861
|
+
/** Runtime validator for {@link PrivateServicePage}. */
|
|
862
|
+
export const privateServicePageSchema = z.object({
|
|
863
|
+
data: z.array(privateServiceSchema),
|
|
864
|
+
has_next: z.boolean(),
|
|
865
|
+
has_prev: z.boolean(),
|
|
866
|
+
page: z.number().int(),
|
|
867
|
+
page_size: z.number().int(),
|
|
868
|
+
total_entries: z.number().int(),
|
|
869
|
+
total_pages: z.number().int(),
|
|
870
|
+
}).describe("A page of private services.");
|
|
801
871
|
/** Runtime validator for {@link RoutinePreset}. */
|
|
802
872
|
export const routinePresetSchema = z.object({
|
|
803
873
|
/** Event types that routines using this preset may be triggered by. `["*"]` means the preset accepts any event type. Routines assigned to this preset will be rejected at creation time if their trigger event is not in this list. */
|
|
@@ -864,6 +934,52 @@ export const runJournalPageSchema = z.object({
|
|
|
864
934
|
/** Durable execution summary. `null` when this run has no journal, which is valid for script-backed, preview, or legacy runs. */
|
|
865
935
|
journal: workflowJournalSchema.optional().describe("Durable execution summary. `null` when this run has no journal, which is valid for script-backed, preview, or legacy runs."),
|
|
866
936
|
}).describe("A forward-paginated journal entry page for an automation or routine run.");
|
|
937
|
+
/** Runtime validator for {@link SandboxKey}. */
|
|
938
|
+
export const sandboxKeySchema = z.object({
|
|
939
|
+
/** When this key was created (ISO 8601). */
|
|
940
|
+
created_at: z.string().optional().describe("When this key was created (ISO 8601)."),
|
|
941
|
+
/** When this key expires and becomes invalid. `null` if the key does not expire. */
|
|
942
|
+
expires_at: z.string().optional().describe("When this key expires and becomes invalid. `null` if the key does not expire."),
|
|
943
|
+
/** The complete secret key value, returned only once when the key is first created. `null` on subsequent retrievals. */
|
|
944
|
+
full_key: z.string().optional().describe("The complete secret key value, returned only once when the key is first created. `null` on subsequent retrievals."),
|
|
945
|
+
/** Sandbox key ID (`dsk_...`). */
|
|
946
|
+
id: z.string().describe("Sandbox key ID (`dsk_...`)."),
|
|
947
|
+
/** A short hint showing the last four characters of the key, used for identification. `null` if no hint is available. */
|
|
948
|
+
key_hint: z.string().optional().describe("A short hint showing the last four characters of the key, used for identification. `null` if no hint is available."),
|
|
949
|
+
/** The full key value for `"publishable"` keys. `null` for `"secret"` keys; use `full_key` instead, which is returned only at creation time. */
|
|
950
|
+
key_value: z.string().optional().describe("The full key value for `\"publishable\"` keys. `null` for `\"secret\"` keys; use `full_key` instead, which is returned only at creation time."),
|
|
951
|
+
/** When this key was last used to authenticate a request. `null` if the key has never been used. */
|
|
952
|
+
last_used_at: z.string().optional().describe("When this key was last used to authenticate a request. `null` if the key has never been used."),
|
|
953
|
+
/** Current lifecycle status of the key. One of `"active"` (usable) or `"revoked"` (permanently disabled). */
|
|
954
|
+
status: z.string().describe("Current lifecycle status of the key. One of `\"active\"` (usable) or `\"revoked\"` (permanently disabled)."),
|
|
955
|
+
/** The kind of key. One of `"publishable"` (safe for client-side use) or `"secret"` (server-side only). */
|
|
956
|
+
type: z.string().describe("The kind of key. One of `\"publishable\"` (safe for client-side use) or `\"secret\"` (server-side only)."),
|
|
957
|
+
}).describe("An API key scoped to a developer sandbox, used to authenticate requests against sandbox resources.");
|
|
958
|
+
/** Runtime validator for {@link Sandbox}. */
|
|
959
|
+
export const sandboxSchema = z.object({
|
|
960
|
+
/** When this sandbox was created (ISO 8601). */
|
|
961
|
+
created_at: z.string().optional().describe("When this sandbox was created (ISO 8601)."),
|
|
962
|
+
/** When an eval sandbox expires and becomes eligible for platform cleanup. `null` for ordinary developer sandboxes. */
|
|
963
|
+
expires_at: z.string().optional().describe("When an eval sandbox expires and becomes eligible for platform cleanup. `null` for ordinary developer sandboxes."),
|
|
964
|
+
/** Sandbox ID (`dsb_...`). */
|
|
965
|
+
id: z.string().describe("Sandbox ID (`dsb_...`)."),
|
|
966
|
+
/** API keys associated with this sandbox. `null` if keys were not loaded with this response. */
|
|
967
|
+
keys: z.array(sandboxKeySchema).optional().describe("API keys associated with this sandbox. `null` if keys were not loaded with this response."),
|
|
968
|
+
/** Human-readable display name for the sandbox. */
|
|
969
|
+
name: z.string().describe("Human-readable display name for the sandbox."),
|
|
970
|
+
/** Organization ID this sandbox is scoped to, or `null` for an app-level sandbox. */
|
|
971
|
+
org: z.string().optional().describe("Organization ID this sandbox is scoped to, or `null` for an app-level sandbox."),
|
|
972
|
+
/** Logo of the owning organization, when present. */
|
|
973
|
+
org_logo: imageSourceSchema.optional().describe("Logo of the owning organization, when present."),
|
|
974
|
+
/** Display name of the owning organization, when org-scoped. */
|
|
975
|
+
org_name: z.string().optional().describe("Display name of the owning organization, when org-scoped."),
|
|
976
|
+
/** Sandbox purpose marker. `"eval"` marks a remote-eval sandbox; `null` for ordinary developer sandboxes. */
|
|
977
|
+
purpose: z.string().optional().describe("Sandbox purpose marker. `\"eval\"` marks a remote-eval sandbox; `null` for ordinary developer sandboxes."),
|
|
978
|
+
/** URL-safe identifier for the sandbox, unique within the application (e.g. `"my-sandbox"`). */
|
|
979
|
+
slug: z.string().describe("URL-safe identifier for the sandbox, unique within the application (e.g. `\"my-sandbox\"`)."),
|
|
980
|
+
/** When this sandbox was last modified (ISO 8601). */
|
|
981
|
+
updated_at: z.string().optional().describe("When this sandbox was last modified (ISO 8601)."),
|
|
982
|
+
}).describe("An isolated developer sandbox environment used for testing integrations without affecting production data or sending real emails.");
|
|
867
983
|
/** Runtime validator for {@link SlackChannelBinding}. */
|
|
868
984
|
export const slackChannelBindingSchema = z.object({
|
|
869
985
|
/** IDs of every agent attached to this binding, including legacy concierge attachments. Use `resident_agent` and `route_kind` for the effective runtime route. */
|
|
@@ -916,6 +1032,25 @@ export const slackChannelBindingListResponseSchema = z.object({
|
|
|
916
1032
|
/** Total number of pages available at the current `per_page` size. */
|
|
917
1033
|
total_pages: z.number().int().describe("Total number of pages available at the current `per_page` size."),
|
|
918
1034
|
}).describe("Paginated list of Slack channel bindings for the requested integration or team. Use the `page` and `per_page` fields to navigate pages of results.");
|
|
1035
|
+
/** Runtime validator for {@link Trajectory}. */
|
|
1036
|
+
export const trajectorySchema = z.object({
|
|
1037
|
+
/** When the trajectory was recorded (ISO 8601). */
|
|
1038
|
+
created_at: z.string().optional().describe("When the trajectory was recorded (ISO 8601)."),
|
|
1039
|
+
/** ID of the storage file that persists the raw trajectory data (`fil_...`). `null` if the trajectory has not been written to a file. */
|
|
1040
|
+
file: z.string().optional().describe("ID of the storage file that persists the raw trajectory data (`fil_...`). `null` if the trajectory has not been written to a file."),
|
|
1041
|
+
/** Trajectory ID (`trj_...`). */
|
|
1042
|
+
id: z.string().describe("Trajectory ID (`trj_...`)."),
|
|
1043
|
+
/** Serialized message log for this trajectory. Contains the ordered sequence of AI and tool messages produced during the session. */
|
|
1044
|
+
messages: z.record(z.unknown()).optional().describe("Serialized message log for this trajectory. Contains the ordered sequence of AI and tool messages produced during the session."),
|
|
1045
|
+
/** ID of the organization this trajectory belongs to (`org_...`). `null` for trajectories outside an org context. */
|
|
1046
|
+
org: z.string().optional().describe("ID of the organization this trajectory belongs to (`org_...`). `null` for trajectories outside an org context."),
|
|
1047
|
+
/** ID of the developer sandbox this trajectory is scoped to (`sbx_...`). `null` for production trajectories. */
|
|
1048
|
+
sandbox: z.string().optional().describe("ID of the developer sandbox this trajectory is scoped to (`sbx_...`). `null` for production trajectories."),
|
|
1049
|
+
/** ID of the team this trajectory is scoped to (`team_...`). `null` for trajectories not associated with a team. */
|
|
1050
|
+
team: z.string().optional().describe("ID of the team this trajectory is scoped to (`team_...`). `null` for trajectories not associated with a team."),
|
|
1051
|
+
/** When the trajectory record was last updated (ISO 8601). */
|
|
1052
|
+
updated_at: z.string().optional().describe("When the trajectory record was last updated (ISO 8601)."),
|
|
1053
|
+
}).describe("A recorded sequence of AI messages and tool interactions representing a single AI reasoning session. Trajectories are stored as structured message logs and can be replayed or inspected after execution.");
|
|
919
1054
|
/** Runtime validator for {@link ValidationResult}. */
|
|
920
1055
|
export const validationResultSchema = z.object({
|
|
921
1056
|
/** List of human-readable error messages describing why validation failed. Empty or absent when `valid` is `true`. */
|