@agentuity/core 3.0.0-alpha.7 → 3.0.0-beta.0

package/src/services/coder/types.ts

@@ -113,6 +113,33 @@ export const CoderWorkspaceDetailSchema = z
 		ownerUserId: z.string().describe('Owner user ID'),
 		repos: z.array(CoderSessionRepositoryRefSchema).describe('Repositories in workspace'),
 		repoCount: z.number().describe('Number of repositories'),
+		dependencies: z
+			.array(z.string())
+			.optional()
+			.default([])
+			.describe('APT package dependencies installed into workspace snapshots'),
+		setupScript: z
+			.string()
+			.optional()
+			.default('')
+			.describe('Shell script run while preparing workspace snapshots'),
+		snapshot: z
+			.object({
+				status: z.string().describe('Workspace snapshot build status'),
+				snapshotId: z.string().optional().describe('Created sandbox snapshot ID'),
+				snapshotRef: z.string().optional().describe('Snapshot reference used for sessions'),
+				baseSnapshotRef: z.string().optional().describe('Base session snapshot reference'),
+				baseDriverVersion: z.string().optional().describe('Base driver version stamp'),
+				configHash: z.string().optional().describe('Workspace snapshot input hash'),
+				buildId: z.string().optional().describe('Workspace snapshot build identifier'),
+				requestedAt: z.string().optional().describe('Snapshot build request timestamp'),
+				updatedAt: z.string().optional().describe('Snapshot build update timestamp'),
+				createdAt: z.string().optional().describe('Snapshot creation timestamp'),
+				error: z.string().optional().describe('Snapshot build error message'),
+			})
+			.passthrough()
+			.optional()
+			.describe('Workspace snapshot metadata'),
 		savedSkillIds: z.array(z.string()).describe('Saved skill IDs in workspace'),
 		skillBucketIds: z.array(z.string()).describe('Skill bucket IDs in workspace'),
 		enabledAgents: z
@@ -324,12 +351,16 @@ export type CoderWorkspaceListResponse = z.infer<typeof CoderWorkspaceListRespon
 
 function hasWorkspaceSelections(input: {
 	repos?: unknown[];
+	dependencies?: unknown[];
+	setupScript?: string;
 	savedSkillIds?: unknown[];
 	skillBucketIds?: unknown[];
 	enabledAgents?: unknown[];
 }): boolean {
 	return (
 		(input.repos?.length ?? 0) > 0 ||
+		(input.dependencies?.length ?? 0) > 0 ||
+		Boolean(input.setupScript?.trim()) ||
 		(input.savedSkillIds?.length ?? 0) > 0 ||
 		(input.skillBucketIds?.length ?? 0) > 0 ||
 		(input.enabledAgents?.length ?? 0) > 0
@@ -342,6 +373,14 @@ export const CoderCreateWorkspaceRequestSchema = z
 		description: z.string().optional().describe('Workspace description'),
 		scope: z.enum(['user', 'org']).optional().describe('Workspace scope'),
 		repos: z.array(CoderSessionRepositoryRefSchema).optional().describe('Repositories'),
+		dependencies: z
+			.array(z.string())
+			.optional()
+			.describe('APT package dependencies installed into workspace snapshots'),
+		setupScript: z
+			.string()
+			.optional()
+			.describe('Shell script run while preparing workspace snapshots'),
 		savedSkillIds: z.array(z.string()).optional().describe('Saved skill IDs'),
 		skillBucketIds: z.array(z.string()).optional().describe('Skill bucket IDs'),
 		enabledAgents: z
@@ -350,11 +389,65 @@ export const CoderCreateWorkspaceRequestSchema = z
 			.describe('Effective agent roster to store on the workspace'),
 	})
 	.refine(hasWorkspaceSelections, {
-		message: 'A workspace needs at least one repo, saved skill, skill bucket, or agent',
+		message:
+			'A workspace needs at least one repo, dependency, setup script, saved skill, skill bucket, or agent',
 	})
 	.describe('Request body for creating a workspace');
 export type CoderCreateWorkspaceRequest = z.infer<typeof CoderCreateWorkspaceRequestSchema>;
 
+export const CoderUpdateWorkspaceRequestSchema = z
+	.object({
+		name: z.string().optional().describe('Workspace name'),
+		description: z.string().optional().describe('Workspace description'),
+		scope: z.enum(['user', 'org']).optional().describe('Workspace scope'),
+		repos: z.array(CoderSessionRepositoryRefSchema).optional().describe('Repositories'),
+		dependencies: z
+			.array(z.string())
+			.optional()
+			.describe('APT package dependencies installed into workspace snapshots'),
+		setupScript: z
+			.string()
+			.optional()
+			.describe('Shell script run while preparing workspace snapshots'),
+		savedSkillIds: z.array(z.string()).optional().describe('Saved skill IDs'),
+		skillBucketIds: z.array(z.string()).optional().describe('Skill bucket IDs'),
+		enabledAgents: z
+			.array(z.string())
+			.optional()
+			.describe('Effective agent roster to store on the workspace'),
+	})
+	.refine((input) => Object.keys(input).length > 0, {
+		message: 'At least one workspace field must be provided',
+	})
+	.describe('Request body for updating a workspace');
+export type CoderUpdateWorkspaceRequest = z.infer<typeof CoderUpdateWorkspaceRequestSchema>;
+
+export const CoderWorkspaceDependencyValidationResponseSchema = z
+	.object({
+		valid: z.array(z.string()).describe('Valid dependency package specs'),
+		invalid: z
+			.array(
+				z
+					.object({
+						package: z.string().describe('Invalid dependency package spec'),
+						error: z.string().describe('Validation error'),
+						requestedVersion: z.string().optional().describe('Requested package version'),
+						availableVersions: z
+							.array(z.string())
+							.optional()
+							.describe('Available package versions returned by validation'),
+						searchUrl: z.string().describe('Package search URL'),
+					})
+					.passthrough()
+			)
+			.describe('Invalid dependency package specs'),
+	})
+	.passthrough()
+	.describe('Workspace dependency validation result');
+export type CoderWorkspaceDependencyValidationResponse = z.infer<
+	typeof CoderWorkspaceDependencyValidationResponseSchema
+>;
+
 export const CoderCreateCustomAgentRequestSchema = z
 	.object({
 		slug: z.string().describe('Stable custom agent slug'),

package/src/services/coder/workspaces.ts

@@ -2,9 +2,13 @@ import { z } from 'zod/v4';
 import { type APIClient } from '../api.ts';
 import {
 	CoderCreateWorkspaceRequestSchema,
+	CoderUpdateWorkspaceRequestSchema,
+	CoderWorkspaceDependencyValidationResponseSchema,
 	CoderWorkspaceDetailSchema,
 	CoderWorkspaceListResponseSchema,
 	type CoderCreateWorkspaceRequest,
+	type CoderUpdateWorkspaceRequest,
+	type CoderWorkspaceDependencyValidationResponse,
 	type CoderWorkspaceDetail,
 	type CoderWorkspaceListResponse,
 } from './types.ts';
@@ -25,6 +29,34 @@ const WorkspaceCreateResponseSchema = z
 	.passthrough()
 	.describe('Wrapped workspace create response from coder hub');
 
+const WorkspaceUpdateResponseSchema = z
+	.object({
+		workspace: CoderWorkspaceDetailSchema.describe(
+			'Updated workspace payload returned by coder hub'
+		),
+	})
+	.passthrough()
+	.describe('Wrapped workspace update response from coder hub');
+
+const WorkspaceSnapshotRefreshResponseSchema = z
+	.object({
+		workspace: CoderWorkspaceDetailSchema.describe(
+			'Workspace payload returned after refreshing its snapshot'
+		),
+	})
+	.passthrough()
+	.describe('Wrapped workspace snapshot refresh response from coder hub');
+
+const WorkspaceDependencyValidationWrappedResponseSchema = z
+	.object({
+		success: z.boolean().describe('Validation request success indicator'),
+		data: CoderWorkspaceDependencyValidationResponseSchema.describe(
+			'Dependency validation result'
+		),
+	})
+	.passthrough()
+	.describe('Wrapped workspace dependency validation response from coder hub');
+
 const OkResponseSchema = z
 	.object({
 		ok: z.boolean().describe('Operation success indicator'),
@@ -68,6 +100,48 @@ export async function coderCreateWorkspace(
 	return resp.workspace;
 }
 
+export async function coderUpdateWorkspace(
+	client: APIClient,
+	params: { workspaceId: string; body: CoderUpdateWorkspaceRequest }
+): Promise<CoderWorkspaceDetail> {
+	const path = `/hub/workspaces/${encodeURIComponent(params.workspaceId)}`;
+	const resp = await client.patch<
+		z.infer<typeof WorkspaceUpdateResponseSchema>,
+		CoderUpdateWorkspaceRequest
+	>(path, params.body, WorkspaceUpdateResponseSchema, CoderUpdateWorkspaceRequestSchema);
+
+	return resp.workspace;
+}
+
+export async function coderRefreshWorkspaceSnapshot(
+	client: APIClient,
+	params: { workspaceId: string }
+): Promise<CoderWorkspaceDetail> {
+	const path = `/hub/workspaces/${encodeURIComponent(params.workspaceId)}/snapshot/refresh`;
+	const resp = await client.post<z.infer<typeof WorkspaceSnapshotRefreshResponseSchema>>(
+		path,
+		undefined,
+		WorkspaceSnapshotRefreshResponseSchema
+	);
+
+	return resp.workspace;
+}
+
+export async function coderValidateWorkspaceDependencies(
+	client: APIClient,
+	params: { dependencies: string[] }
+): Promise<CoderWorkspaceDependencyValidationResponse> {
+	const resp = await client.post<
+		z.infer<typeof WorkspaceDependencyValidationWrappedResponseSchema>
+	>(
+		'/hub/workspaces/dependencies/validate',
+		{ dependencies: params.dependencies },
+		WorkspaceDependencyValidationWrappedResponseSchema
+	);
+
+	return resp.data;
+}
+
 export async function coderDeleteWorkspace(
 	client: APIClient,
 	params: { workspaceId: string }

package/src/services/keyvalue/service.ts

@@ -317,12 +317,18 @@ export interface KeyValueStorage {
 	 *
 	 * @param name - the name of the key value storage
 	 * @param keyword - the keyword to search for
-	 * @returns map of keys to items with metadata
+	 * @returns a Map of keys to items with metadata, in the order returned by the server.
+	 *
+	 * @remarks
+	 * Returns a `Map` (not a plain object) for consistency with other multi-result
+	 * SDK methods such as `vector.getMany()`. Iterate with `for (const [key, item] of results)`
+	 * or `results.entries()` / `results.keys()` / `results.values()`. Use `results.size`
+	 * for the count and `results.get(key)` for direct lookup.
 	 */
 	search<T = unknown>(
 		name: string,
 		keyword: string
-	): Promise<Record<string, KeyValueItemWithMetadata<T>>>;
+	): Promise<Map<string, KeyValueItemWithMetadata<T>>>;
 
 	/**
 	 * get all keys in a namespace
@@ -361,7 +367,8 @@ function base64ToBytes(base64: string): Uint8Array {
 }
 
 /**
- * Deserializes search result values from the server's wire format.
+ * Deserializes search result values from the server's wire format and
+ * returns them as a Map preserving insertion order.
  *
  * The Go server stores values as []byte, which Go's json.Marshal
  * base64-encodes when embedding in a JSON response. This function
@@ -370,8 +377,9 @@ function base64ToBytes(base64: string): Uint8Array {
  */
 function deserializeSearchResults<T>(
 	data: Record<string, KeyValueItemWithMetadata<T>>
-): Record<string, KeyValueItemWithMetadata<T>> {
-	for (const item of Object.values(data)) {
+): Map<string, KeyValueItemWithMetadata<T>> {
+	const out = new Map<string, KeyValueItemWithMetadata<T>>();
+	for (const [key, item] of Object.entries(data)) {
 		if (typeof item.value === 'string') {
 			try {
 				const bytes = base64ToBytes(item.value);
@@ -389,8 +397,9 @@ function deserializeSearchResults<T>(
 				// If base64 decoding or parsing fails, leave value as-is
 			}
 		}
+		out.set(key, item);
 	}
-	return data;
+	return out;
 }
 
 export class KeyValueStorageService implements KeyValueStorage {
@@ -601,7 +610,7 @@ export class KeyValueStorageService implements KeyValueStorage {
 	async search<T = unknown>(
 		name: string,
 		keyword: string
-	): Promise<Record<string, KeyValueItemWithMetadata<T>>> {
+	): Promise<Map<string, KeyValueItemWithMetadata<T>>> {
 		const url = buildUrl(
 			this.#baseUrl,
 			`/kv/search/${encodeURIComponent(name)}/${encodeURIComponent(keyword)}`

package/src/services/sandbox/api-reference.ts

@@ -613,7 +613,7 @@ const service: Service = {
 			],
 			requestBody: {
 				description: 'Snapshot creation payload.',
-				fields: { schema: SnapshotCreateOptionsSchema },
+				fields: { schema: SnapshotCreateOptionsSchema.omit({ orgId: true }) },
 			},
 			responseDescription: 'Returns the created snapshot.',
 			statuses: [
@@ -887,15 +887,15 @@ const service: Service = {
 			exampleHeaders: { 'Content-Type': 'application/gzip' },
 			exampleBody: '<binary gzip data>',
 		},
-		// ── Disk Checkpoints ──────────────────────────────────────────────
+		// ── Sandbox Checkpoints ───────────────────────────────────────────
 		{
 			id: 'create-checkpoint',
 			title: 'Create Checkpoint',
-			sectionTitle: 'Disk Checkpoints',
+			sectionTitle: 'Sandbox Checkpoints',
 			method: 'POST',
 			path: '/sandbox/{sandboxId}/checkpoint',
 			description:
-				'Create a named checkpoint of the sandbox filesystem. Checkpoint names must be unique — creating a checkpoint with a name that already exists returns 409 Conflict. Disk checkpoints are persisted across pause/resume cycles.',
+				'Create a named checkpoint of the sandbox filesystem. Checkpoint names must be unique — creating a checkpoint with a name that already exists returns 409 Conflict. Checkpoints are persisted across pause/resume cycles.',
 			pathParams: [
 				{ name: 'sandboxId', type: 'string', description: 'Sandbox ID', required: true },
 			],
@@ -923,11 +923,11 @@ const service: Service = {
 		{
 			id: 'list-checkpoints',
 			title: 'List Checkpoints',
-			sectionTitle: 'Disk Checkpoints',
+			sectionTitle: 'Sandbox Checkpoints',
 			method: 'GET',
 			path: '/sandbox/checkpoints/{sandboxId}',
 			description:
-				'List checkpoints for a specific sandbox. Disk checkpoints are persisted across pause/resume cycles.',
+				'List checkpoints for a specific sandbox. Checkpoints are persisted across pause/resume cycles.',
 			pathParams: [
 				{ name: 'sandboxId', type: 'string', description: 'Sandbox ID', required: true },
 			],
@@ -947,7 +947,7 @@ const service: Service = {
 		{
 			id: 'restore-checkpoint',
 			title: 'Restore Checkpoint',
-			sectionTitle: 'Disk Checkpoints',
+			sectionTitle: 'Sandbox Checkpoints',
 			method: 'POST',
 			path: '/sandbox/{sandboxId}/checkpoint/{checkpointId}/restore',
 			description: 'Restore the sandbox filesystem to a checkpoint state.',
@@ -971,7 +971,7 @@ const service: Service = {
 		{
 			id: 'delete-checkpoint',
 			title: 'Delete Checkpoint',
-			sectionTitle: 'Disk Checkpoints',
+			sectionTitle: 'Sandbox Checkpoints',
 			method: 'DELETE',
 			path: '/sandbox/{sandboxId}/checkpoint/{checkpointId}',
 			description: 'Delete a checkpoint.',

package/src/services/sandbox/client.ts

@@ -34,7 +34,7 @@ import {
 	sandboxRmDir,
 	sandboxSetEnv,
 } from './files.ts';
-import { sandboxPause } from './pause.ts';
+import { sandboxPause, type SandboxPauseResult } from './pause.ts';
 import { sandboxResume } from './resume.ts';
 import { sandboxRun } from './run.ts';
 import {
@@ -281,7 +281,7 @@ export interface SandboxInstance {
 	/**
 	 * Pause the sandbox, creating a checkpoint of its current state
 	 */
-	pause(): Promise<void>;
+	pause(): Promise<SandboxPauseResult>;
 
 	/**
 	 * Resume the sandbox from a paused or evacuated state
@@ -399,7 +399,7 @@ function createSandboxInstanceMethods(
 			return sandboxGet(client, { sandboxId, orgId });
 		},
 
-		async pause(): Promise<void> {
+		async pause(): Promise<SandboxPauseResult> {
 			return sandboxPause(client, { sandboxId, orgId });
 		},
 
@@ -725,7 +725,7 @@ export class SandboxClient {
 	 *
 	 * @param sandboxId - The sandbox ID to pause
 	 */
-	async pause(sandboxId: string): Promise<void> {
+	async pause(sandboxId: string): Promise<SandboxPauseResult> {
 		return sandboxPause(this.#client, { sandboxId, orgId: this.#orgId });
 	}
 

package/src/services/sandbox/create.ts

@@ -49,6 +49,12 @@ export const SandboxCreateRequestSchema = z
 			.object({
 				idle: z.string().optional().describe('Idle timeout duration (e.g., "5m", "1h")'),
 				execution: z.string().optional().describe('Maximum execution time (e.g., "30m", "2h")'),
+				paused: z
+					.string()
+					.optional()
+					.describe(
+						'Maximum time sandbox can remain paused before termination (e.g., "24h", "0s" for infinite)'
+					),
 			})
 			.optional()
 			.describe('Timeout settings for the sandbox'),
@@ -139,6 +145,10 @@ export const SandboxCreateDataSchema = z
 				'failed',
 			])
 			.describe('Current status of the sandbox'),
+		executionId: z
+			.string()
+			.optional()
+			.describe('Initial execution identifier for oneshot sandbox creation'),
 		url: z
 			.string()
 			.optional()

package/src/services/sandbox/get.ts

@@ -156,7 +156,7 @@ export const SandboxInfoDataSchema = z
 		user: SandboxUserInfoSchema.optional().describe('User who created the sandbox'),
 		agent: SandboxAgentInfoSchema.optional().describe('Agent associated with the sandbox'),
 		project: SandboxProjectInfoSchema.optional().describe('Project associated with the sandbox'),
-		org: SandboxOrgInfoSchema.describe('Organization associated with the sandbox'),
+		org: SandboxOrgInfoSchema.nullish().describe('Organization associated with the sandbox'),
 		timeout: z
 			.object({
 				idle: z.string().optional().describe('Idle timeout duration (e.g., "5m", "1h").'),
@@ -164,6 +164,10 @@ export const SandboxInfoDataSchema = z
 					.string()
 					.optional()
 					.describe('Execution timeout duration (e.g., "30m", "2h").'),
+				paused: z
+					.string()
+					.optional()
+					.describe('Paused timeout duration (e.g., "24h", "0s" for infinite).'),
 			})
 			.optional()
 			.describe('Timeout configuration for the sandbox.'),
@@ -189,6 +193,16 @@ export const SandboxGetParamsSchema = z.object({
 		.boolean()
 		.optional()
 		.describe('Whether deleted sandboxes should be included in lookup'),
+	waitForStatus: z
+		.union([z.string(), z.array(z.string())])
+		.optional()
+		.describe('Optional desired status or statuses to wait for before responding'),
+	waitMs: z
+		.number()
+		.int()
+		.nonnegative()
+		.optional()
+		.describe('Maximum time in milliseconds to wait for the desired status'),
 });
 
 export type SandboxGetParams = z.infer<typeof SandboxGetParamsSchema>;
@@ -205,7 +219,7 @@ export async function sandboxGet(
 	client: APIClient,
 	params: SandboxGetParams
 ): Promise<SandboxInfo> {
-	const { sandboxId, orgId, includeDeleted } = params;
+	const { sandboxId, orgId, includeDeleted, waitForStatus, waitMs } = params;
 	const queryParams = new URLSearchParams();
 	if (orgId) {
 		queryParams.set('orgId', orgId);
@@ -213,6 +227,15 @@ export async function sandboxGet(
 	if (includeDeleted) {
 		queryParams.set('includeDeleted', 'true');
 	}
+	if (waitForStatus) {
+		queryParams.set(
+			'waitForStatus',
+			Array.isArray(waitForStatus) ? waitForStatus.join(',') : waitForStatus
+		);
+	}
+	if (waitMs != null) {
+		queryParams.set('waitMs', String(waitMs));
+	}
 	const queryString = queryParams.toString();
 	const url = `/sandbox/${encodeURIComponent(sandboxId)}${queryString ? `?${queryString}` : ''}`;
 
@@ -222,6 +245,12 @@ export async function sandboxGet(
 	);
 
 	if (resp.success) {
+		// Newly created sandboxes can be served from the server's pending cache before
+		// the backing row and related org hydration are fully available. That response
+		// serializes `org: null`, so normalize it to a placeholder object instead of
+		// failing response validation for an otherwise valid sandbox status poll.
+		const org = resp.data.org ?? { id: orgId ?? '', name: '' };
+
 		return {
 			sandboxId: resp.data.sandboxId,
 			identifier: resp.data.identifier,
@@ -252,7 +281,7 @@ export async function sandboxGet(
 			user: resp.data.user,
 			agent: resp.data.agent,
 			project: resp.data.project,
-			org: resp.data.org,
+			org,
 			timeout: resp.data.timeout,
 			command: resp.data.command,
 		};

package/src/services/sandbox/getStatus.ts

@@ -13,6 +13,17 @@ const SandboxStatusResponseSchema = APIResponseSchema(SandboxStatusDataSchema);
 export const SandboxGetStatusParamsSchema = z.object({
 	sandboxId: z.string().describe('Sandbox ID to retrieve status for'),
 	orgId: z.string().optional().describe('Optional org id for CLI auth context'),
+	waitForStatus: z
+		.union([z.string(), z.array(z.string())])
+		.optional()
+		.describe('Optional desired status or statuses to wait for before responding'),
+	waitMs: z
+		.number()
+		.int()
+		.nonnegative()
+		.optional()
+		.describe('Maximum time in milliseconds to wait for the desired status'),
+	signal: z.custom<AbortSignal>().optional().describe('abort signal for cancellation'),
 });
 
 export type SandboxGetStatusParams = z.infer<typeof SandboxGetStatusParamsSchema>;
@@ -26,17 +37,27 @@ export async function sandboxGetStatus(
 	client: APIClient,
 	params: SandboxGetStatusParams
 ): Promise<SandboxStatusResult> {
-	const { sandboxId, orgId } = params;
+	const { sandboxId, orgId, waitForStatus, waitMs, signal } = params;
 	const queryParams = new URLSearchParams();
 	if (orgId) {
 		queryParams.set('orgId', orgId);
 	}
+	if (waitForStatus) {
+		queryParams.set(
+			'waitForStatus',
+			Array.isArray(waitForStatus) ? waitForStatus.join(',') : waitForStatus
+		);
+	}
+	if (waitMs != null) {
+		queryParams.set('waitMs', String(waitMs));
+	}
 	const queryString = queryParams.toString();
 	const url = `/sandbox/status/${sandboxId}${queryString ? `?${queryString}` : ''}`;
 
 	const resp = await client.get<z.infer<typeof SandboxStatusResponseSchema>>(
 		url,
-		SandboxStatusResponseSchema
+		SandboxStatusResponseSchema,
+		signal
 	);
 
 	if (resp.success) {

package/src/services/sandbox/index.ts

@@ -52,7 +52,7 @@ export {
 	diskCheckpointRestore,
 	diskCheckpointDelete,
 } from './disk-checkpoint.ts';
-export type { SandboxPauseParams } from './pause.ts';
+export type { SandboxPauseParams, SandboxPauseResult } from './pause.ts';
 export { PauseResponseSchema, SandboxPauseParamsSchema, sandboxPause } from './pause.ts';
 export type { SandboxResumeParams } from './resume.ts';
 export { ResumeResponseSchema, SandboxResumeParamsSchema, sandboxResume } from './resume.ts';

package/src/services/sandbox/list.ts

@@ -112,6 +112,10 @@ export const SandboxInfoSchema = z
 					.string()
 					.optional()
 					.describe('Execution timeout duration (e.g., "30m", "2h").'),
+				paused: z
+					.string()
+					.optional()
+					.describe('Paused timeout duration (e.g., "24h", "0s" for infinite).'),
 			})
 			.optional()
 			.describe('Timeout configuration for the sandbox.'),
@@ -225,6 +229,7 @@ export async function sandboxList(
 				networkPort: s.networkPort,
 				url: s.url,
 				org: s.org,
+				timeout: s.timeout,
 			})),
 			total: resp.data.total,
 		};

package/src/services/sandbox/pause.ts

@@ -1,8 +1,21 @@
 import { z } from 'zod';
-import { type APIClient, APIResponseSchemaNoData } from '../api.ts';
+import { type APIClient } from '../api.ts';
 import { throwSandboxError } from './util.ts';
 
-export const PauseResponseSchema = APIResponseSchemaNoData();
+export const PauseResponseSchema = z.discriminatedUnion('success', [
+	z.object({
+		success: z.literal<false>(false),
+		message: z.string(),
+		code: z.string().optional(),
+	}),
+	z.object({
+		success: z.literal<true>(true),
+		sandboxId: z.string(),
+		status: z.string(),
+		checkpointId: z.string().optional(),
+		terminatesAt: z.string().optional(),
+	}),
+]);
 
 export const SandboxPauseParamsSchema = z.object({
 	sandboxId: z.string().describe('Sandbox ID to pause'),
@@ -11,14 +24,30 @@ export const SandboxPauseParamsSchema = z.object({
 
 export type SandboxPauseParams = z.infer<typeof SandboxPauseParamsSchema>;
 
+/** Result returned from pausing a sandbox */
+export interface SandboxPauseResult {
+	/** The sandbox ID that was paused */
+	sandboxId: string;
+	/** New status (typically "suspended") */
+	status: string;
+	/** Checkpoint ID created during pause */
+	checkpointId?: string;
+	/** ISO 8601 timestamp when sandbox will auto-terminate if not resumed (omitted if no paused timeout) */
+	terminatesAt?: string;
+}
+
 /**
  * Pauses a running sandbox, creating a checkpoint of its current state.
  *
  * @param client - The API client to use for the request
  * @param params - Parameters including the sandbox ID to pause
+ * @returns Pause result including terminatesAt if a paused timeout is configured
  * @throws {SandboxResponseError} If the sandbox is not found or pause fails
  */
-export async function sandboxPause(client: APIClient, params: SandboxPauseParams): Promise<void> {
+export async function sandboxPause(
+	client: APIClient,
+	params: SandboxPauseParams
+): Promise<SandboxPauseResult> {
 	const { sandboxId, orgId } = params;
 	const queryParams = new URLSearchParams();
 	if (orgId) {
@@ -34,7 +63,12 @@ export async function sandboxPause(client: APIClient, params: SandboxPauseParams
 	);
 
 	if (resp.success) {
-		return;
+		return {
+			sandboxId: resp.sandboxId,
+			status: resp.status,
+			checkpointId: resp.checkpointId,
+			terminatesAt: resp.terminatesAt,
+		};
 	}
 
 	throwSandboxError(resp, { sandboxId });