@boatdev/sdk 1.7.0 → 1.9.0

package/.openapi-generator/FILES

@@ -68,6 +68,10 @@ docs/NamedSnapshotInfoResponse.md
 docs/NamedSnapshotListResponse.md
 docs/NamedSnapshotSaveRequest.md
 docs/NamedSnapshotSavingResponse.md
+docs/NamedSnapshotShare.md
+docs/NamedSnapshotShareCreatedResponse.md
+docs/NamedSnapshotShareListResponse.md
+docs/NamedSnapshotShareRevokedResponse.md
 docs/Org.md
 docs/OrgListResponse.md
 docs/PageInfo.md
@@ -79,6 +83,7 @@ docs/PromptRequest.md
 docs/PromptResponse.md
 docs/PromptRun.md
 docs/PromptRunResponse.md
+docs/Recover200Response.md
 docs/RepoSelectionRequest.md
 docs/RepoSelectionResponse.md
 docs/ReposResponse.md
@@ -122,6 +127,7 @@ docs/SteerEventData.md
 docs/SteerRequest.md
 docs/SteerResponse.md
 docs/StopOperation.md
+docs/StopOperationResponse.md
 docs/StopRequest.md
 docs/SuccessBase.md
 docs/UnknownEvent.md
@@ -210,6 +216,10 @@ src/models/NamedSnapshotInfoResponse.ts
 src/models/NamedSnapshotListResponse.ts
 src/models/NamedSnapshotSaveRequest.ts
 src/models/NamedSnapshotSavingResponse.ts
+src/models/NamedSnapshotShare.ts
+src/models/NamedSnapshotShareCreatedResponse.ts
+src/models/NamedSnapshotShareListResponse.ts
+src/models/NamedSnapshotShareRevokedResponse.ts
 src/models/Org.ts
 src/models/OrgListResponse.ts
 src/models/PageInfo.ts
@@ -221,6 +231,7 @@ src/models/PromptRequest.ts
 src/models/PromptResponse.ts
 src/models/PromptRun.ts
 src/models/PromptRunResponse.ts
+src/models/Recover200Response.ts
 src/models/RepoSelectionRequest.ts
 src/models/RepoSelectionResponse.ts
 src/models/ReposResponse.ts
@@ -264,6 +275,7 @@ src/models/SteerEventData.ts
 src/models/SteerRequest.ts
 src/models/SteerResponse.ts
 src/models/StopOperation.ts
+src/models/StopOperationResponse.ts
 src/models/StopRequest.ts
 src/models/SuccessBase.ts
 src/models/UnknownEvent.ts

package/dist/apis/BoatApi.d.ts

@@ -46,10 +46,14 @@ import { type NamedSnapshotInfoResponse } from '../models/NamedSnapshotInfoRespo
 import { type NamedSnapshotListResponse } from '../models/NamedSnapshotListResponse';
 import { type NamedSnapshotSaveRequest } from '../models/NamedSnapshotSaveRequest';
 import { type NamedSnapshotSavingResponse } from '../models/NamedSnapshotSavingResponse';
+import { type NamedSnapshotShareCreatedResponse } from '../models/NamedSnapshotShareCreatedResponse';
+import { type NamedSnapshotShareListResponse } from '../models/NamedSnapshotShareListResponse';
+import { type NamedSnapshotShareRevokedResponse } from '../models/NamedSnapshotShareRevokedResponse';
 import { type OrgListResponse } from '../models/OrgListResponse';
 import { type PromptRequest } from '../models/PromptRequest';
 import { type PromptResponse } from '../models/PromptResponse';
 import { type PromptRunResponse } from '../models/PromptRunResponse';
+import { type Recover200Response } from '../models/Recover200Response';
 import { type RepoSelectionRequest } from '../models/RepoSelectionRequest';
 import { type RepoSelectionResponse } from '../models/RepoSelectionResponse';
 import { type ReposResponse } from '../models/ReposResponse';
@@ -73,6 +77,7 @@ import { type SshKeyRequest } from '../models/SshKeyRequest';
 import { type SshKeyResponse } from '../models/SshKeyResponse';
 import { type SteerRequest } from '../models/SteerRequest';
 import { type SteerResponse } from '../models/SteerResponse';
+import { type StopOperationResponse } from '../models/StopOperationResponse';
 import { type StopRequest } from '../models/StopRequest';
 import { type UpdateSandboxEnvironmentRequest } from '../models/UpdateSandboxEnvironmentRequest';
 import { type UpdateSandboxRequest } from '../models/UpdateSandboxRequest';
@@ -119,6 +124,9 @@ export interface CreateEnvironmentRequest {
 export interface CreateScopedApiKeyOperationRequest {
     createScopedApiKeyRequest: CreateScopedApiKeyRequest;
 }
+export interface CreateSnapshotShareRequest {
+    name: string;
+}
 export interface CreateWebhookRequest {
     webhookCreateRequest: WebhookCreateRequest;
 }
@@ -196,6 +204,10 @@ export interface GetSnapshotFileRequest {
 export interface GetSnapshotTreeRequest {
     snapshotId: string;
 }
+export interface GetStopRequest {
+    sandboxId: string;
+    stopId: string;
+}
 export interface GetWebhookRequest {
     webhookId: string;
 }
@@ -218,6 +230,9 @@ export interface ListSandboxSnapshotsRequest {
     cursor?: string | null;
     sort?: ListSandboxSnapshotsSortEnum;
 }
+export interface ListSnapshotSharesRequest {
+    name: string;
+}
 export interface ListSnapshotsRequest {
     limit?: number;
     cursor?: string | null;
@@ -236,6 +251,9 @@ export interface ReadFileRequest {
     path: string;
     encoding?: ReadFileEncodingEnum;
 }
+export interface RecoverRequest {
+    sandboxId: string;
+}
 export interface ReposRequest {
     sync?: boolean;
     limit?: number;
@@ -251,6 +269,10 @@ export interface ResumeOperationRequest {
 export interface RevokeApiKeyRequest {
     apiKeyId: string;
 }
+export interface RevokeSnapshotShareRequest {
+    name: string;
+    shareId: string;
+}
 export interface RotateApiKeyRequest {
     apiKeyId: string;
 }
@@ -381,10 +403,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     artifactRequestOpts(requestParameters: ArtifactRequest): Promise<runtime.RequestOpts>;
     /**
+     * Downloads one file of up to 50 MiB, under /home/user or /tmp, as raw bytes.
      * Download a sandbox artifact
      */
     artifactRaw(requestParameters: ArtifactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
     /**
+     * Downloads one file of up to 50 MiB, under /home/user or /tmp, as raw bytes.
      * Download a sandbox artifact
      */
     artifact(requestParameters: ArtifactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
@@ -470,6 +494,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Create a scoped API key
      */
     createScopedApiKey(requestParameters: CreateScopedApiKeyOperationRequest | runtime.FlatBody<CreateScopedApiKeyOperationRequest, 'createScopedApiKeyRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeySecretResponse>;
+    /**
+     * Creates request options for createSnapshotShare without sending the request
+     */
+    createSnapshotShareRequestOpts(requestParameters: CreateSnapshotShareRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Make a secret code that lets any Boat account create a sandbox from this named snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
+     * Share a named snapshot
+     */
+    createSnapshotShareRaw(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotShareCreatedResponse>>;
+    /**
+     * Make a secret code that lets any Boat account create a sandbox from this named snapshot (`boat snapshot share <name>` in the CLI). The response shows the code once; Boat stores only a hash. Re-saving the name changes what the code deploys. Removing the name removes its codes. Everything on the disk is shared, so do not keep secrets in files on it. Needs `snapshot.write`.
+     * Share a named snapshot
+     */
+    createSnapshotShare(requestParameters: CreateSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareCreatedResponse>;
     /**
      * Creates request options for createWebhook without sending the request
      */
@@ -776,6 +814,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Get snapshot file tree
      */
     getSnapshotTree(requestParameters: GetSnapshotTreeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SnapshotTreeResponse>;
+    /**
+     * Creates request options for getStop without sending the request
+     */
+    getStopRequestOpts(requestParameters: GetStopRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns one stop of this sandbox by the id that `POST /sandboxes/{sandboxId}/stop` returned. Old stops stay readable after a resume or a later stop. Returns 404 when the id is unknown or belongs to another sandbox.
+     * Get a stop by id
+     */
+    getStopRaw(requestParameters: GetStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StopOperationResponse>>;
+    /**
+     * Returns one stop of this sandbox by the id that `POST /sandboxes/{sandboxId}/stop` returned. Old stops stay readable after a resume or a later stop. Returns 404 when the id is unknown or belongs to another sandbox.
+     * Get a stop by id
+     */
+    getStop(requestParameters: GetStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StopOperationResponse>;
     /**
      * Creates request options for getWebhook without sending the request
      */
@@ -874,6 +926,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * List boat snapshots
      */
     listSandboxSnapshots(requestParameters: ListSandboxSnapshotsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SnapshotListResponse>;
+    /**
+     * Creates request options for listSnapshotShares without sending the request
+     */
+    listSnapshotSharesRequestOpts(requestParameters: ListSnapshotSharesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the share codes of a named snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
+     * List share codes of a named snapshot
+     */
+    listSnapshotSharesRaw(requestParameters: ListSnapshotSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotShareListResponse>>;
+    /**
+     * List the share codes of a named snapshot, active and revoked (`boat snapshot shares <name>` in the CLI). The full codes are not returned. Needs `snapshot.read`.
+     * List share codes of a named snapshot
+     */
+    listSnapshotShares(requestParameters: ListSnapshotSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareListResponse>;
     /**
      * Creates request options for listSnapshots without sending the request
      */
@@ -949,13 +1015,29 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     readFileRequestOpts(requestParameters: ReadFileRequest): Promise<runtime.RequestOpts>;
     /**
+     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
      * Read a file from a sandbox
      */
     readFileRaw(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileReadResponse>>;
     /**
+     * Files up to 5 MiB. Use `GET /sandboxes/{sandboxId}/artifacts` for files up to 50 MiB, and SCP over SSH for larger ones.
      * Read a file from a sandbox
      */
     readFile(requestParameters: ReadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileReadResponse>;
+    /**
+     * Creates request options for recover without sending the request
+     */
+    recoverRequestOpts(requestParameters: RecoverRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does.  Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to   answer, or resume it from its last snapshot. - `reset_failed`: the power-cycle failed. Reply to the incident email.
+     * Recover a sandbox that stopped responding
+     */
+    recoverRaw(requestParameters: RecoverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Recover200Response>>;
+    /**
+     * Power-cycle the machine of a sandbox that stopped answering. The disk is not touched. The sandbox usually answers again within 1-2 minutes and then saves your work by itself; `sandbox.recovered` fires when it does.  Refused with `409`: - `sandbox_is_reachable`: the sandbox answers normally. - `too_soon`: a recover started less than 10 minutes ago. - `no_machine`: the sandbox has no machine. Resume it instead. - `recover_unsupported`: its machine cannot be power-cycled. Wait for it to   answer, or resume it from its last snapshot. - `reset_failed`: the power-cycle failed. Reply to the incident email.
+     * Recover a sandbox that stopped responding
+     */
+    recover(requestParameters: RecoverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Recover200Response>;
     /**
      * Creates request options for repos without sending the request
      */
@@ -996,6 +1078,20 @@ export declare class BoatApi extends runtime.BaseAPI {
      * Revoke an API key
      */
     revokeApiKey(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyRevokeResponse>;
+    /**
+     * Creates request options for revokeSnapshotShare without sending the request
+     */
+    revokeSnapshotShareRequestOpts(requestParameters: RevokeSnapshotShareRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Revoke a share code (`boat snapshot unshare <name> <share-id>` in the CLI). The code stops creating new sandboxes. Sandboxes already created from it keep their own copy. Needs `snapshot.write`.
+     * Revoke a share code
+     */
+    revokeSnapshotShareRaw(requestParameters: RevokeSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NamedSnapshotShareRevokedResponse>>;
+    /**
+     * Revoke a share code (`boat snapshot unshare <name> <share-id>` in the CLI). The code stops creating new sandboxes. Sandboxes already created from it keep their own copy. Needs `snapshot.write`.
+     * Revoke a share code
+     */
+    revokeSnapshotShare(requestParameters: RevokeSnapshotShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NamedSnapshotShareRevokedResponse>;
     /**
      * Creates request options for rotateApiKey without sending the request
      */
@@ -1155,12 +1251,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     steerRequestOpts(input: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>): Promise<runtime.RequestOpts>;
     /**
-     * Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
+     * Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. `error.details.reason` says why: `turn_ended` (with `error.details.lastTurn.status` and `.error` of the newest turn), `turn_not_started` (the turn is starting; retry in a moment), `no_turn`, `not_running` (the sandbox is not running) or `delivery_failed` (the sandbox did not accept the steer; check the turn before sending more work). The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
      * Steer a running turn
      */
     steerRaw(requestParameters: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SteerResponse>>;
     /**
-     * Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
+     * Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.  Where the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.  Refused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. `error.details.reason` says why: `turn_ended` (with `error.details.lastTurn.status` and `.error` of the newest turn), `turn_not_started` (the turn is starting; retry in a moment), `no_turn`, `not_running` (the sandbox is not running) or `delivery_failed` (the sandbox did not accept the steer; check the turn before sending more work). The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).
      * Steer a running turn
      */
     steer(requestParameters: SteerOperationRequest | runtime.FlatBody<SteerOperationRequest, 'steerRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SteerResponse>;
@@ -1169,12 +1265,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     stopRequestOpts(input: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>): Promise<runtime.RequestOpts>;
     /**
-     * Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, accepting the loss of everything written since the last successful snapshot. This is irreversible; only reach for it after a stop has already failed.
+     * Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, keeping the last successful snapshot and losing everything written since then. This is irreversible; only reach for it after a stop has already failed. A force on a stop that is already pending escalates that stop.
      * Stop and archive sandbox
      */
     stopRaw(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SandboxActionResponse>>;
     /**
-     * Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, accepting the loss of everything written since the last successful snapshot. This is irreversible; only reach for it after a stop has already failed.
+     * Stop active work and archive/snapshot the sandbox for later resume or fork.  A stop always saves the sandbox\'s disk first. If that save is failing, the stop is refused and the sandbox keeps running so your work is not discarded, we retry automatically and email you. You are not billed for time spent in that state.  The stop is an operation: the response and the sandbox carry it as `stop`, with an `id` and a `status`. Poll `GET /sandboxes/{sandboxId}` until `stop.status` is `completed`. A failed attempt shows `failing` with its `error` and is retried until the sandbox archives; commands and prompts you send meanwhile do not cancel it. Only a resume ends it early (`superseded`). Calling stop again while one is pending returns the same `id`.  Set `force: true` to stop anyway, keeping the last successful snapshot and losing everything written since then. This is irreversible; only reach for it after a stop has already failed. A force on a stop that is already pending escalates that stop.
      * Stop and archive sandbox
      */
     stop(requestParameters: StopOperationRequest | runtime.FlatBody<StopOperationRequest, 'stopRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SandboxActionResponse>;
@@ -1277,10 +1373,12 @@ export declare class BoatApi extends runtime.BaseAPI {
      */
     writeFileRequestOpts(input: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>): Promise<runtime.RequestOpts>;
     /**
+     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
      * Write a file in a sandbox
      */
     writeFileRaw(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileWriteResponse>>;
     /**
+     * Files up to 5 MiB after decoding. Use SCP over SSH for larger files.
      * Write a file in a sandbox
      */
     writeFile(requestParameters: WriteFileRequest | runtime.FlatBody<WriteFileRequest, 'fileWriteRequest'>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileWriteResponse>;