@solarisdk/runloop-compat 0.0.0-stage → 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,920 @@
+import type * as Shared from './shared-types.js';
+/** Cursor-pagination params shared by the list calls (mirrors Runloop's pagination.d.ts). */
+export interface CursorIDPageParams {
+    starting_after?: string;
+    limit?: number;
+}
+export type DevboxesCursorIDPageParams = CursorIDPageParams;
+export type DiskSnapshotsCursorIDPageParams = CursorIDPageParams;
+/** Anything `uploadFile` accepts as file content. */
+export type Uploadable = Blob | Response | Uint8Array | ArrayBuffer | string;
+export interface DevboxAsyncExecutionDetailView {
+    /**
+     * Devbox id where command was executed.
+     */
+    devbox_id: string;
+    /**
+     * Ephemeral id of the execution in progress.
+     */
+    execution_id: string;
+    /**
+     * Current status of the execution.
+     */
+    status: 'queued' | 'running' | 'completed';
+    /**
+     * Exit code of command execution. This field will remain unset until the execution
+     * has completed.
+     */
+    exit_status?: number | null;
+    /**
+     * Shell name.
+     */
+    shell_name?: string | null;
+    /**
+     * Standard error generated by command. This field will remain unset until the
+     * execution has completed.
+     */
+    stderr?: string | null;
+    /**
+     * Indicates whether the stderr was truncated due to size limits.
+     */
+    stderr_truncated?: boolean | null;
+    /**
+     * Standard out generated by command. This field will remain unset until the
+     * execution has completed.
+     */
+    stdout?: string | null;
+    /**
+     * Indicates whether the stdout was truncated due to size limits.
+     */
+    stdout_truncated?: boolean | null;
+}
+export interface DevboxEvictionEventView {
+    /**
+     * The ID of the Devbox with a pending eviction.
+     */
+    devbox_id: string;
+    /**
+     * Unix timestamp (milliseconds) after which the Devbox will be suspended. Advisory
+     * and best-effort.
+     */
+    eviction_deadline_ms: number;
+}
+export interface DevboxExecutionDetailView {
+    /**
+     * Devbox id where command was executed.
+     */
+    devbox_id: string;
+    /**
+     * Exit status of command execution.
+     */
+    exit_status: number;
+    /**
+     * Standard error generated by command.
+     */
+    stderr: string;
+    /**
+     * Standard out generated by command.
+     */
+    stdout: string;
+    /**
+     * Shell name.
+     */
+    shell_name?: string | null;
+}
+export interface DevboxKillExecutionRequest {
+    /**
+     * Whether to kill the entire process group (default: false). If true, kills all
+     * processes in the same process group as the target process.
+     */
+    kill_process_group?: boolean | null;
+}
+export interface DevboxListView {
+    /**
+     * List of devboxes matching filter.
+     */
+    devboxes: Array<DevboxView>;
+    has_more: boolean;
+    total_count?: number | null;
+}
+export interface DevboxResourceUsageView {
+    /**
+     * The devbox ID.
+     */
+    id: string;
+    /**
+     * Disk usage in GB-seconds (total_elapsed_seconds multiplied by disk size in GB).
+     * Disk is billed for elapsed time since storage is consumed even when suspended.
+     */
+    disk_gb_seconds: number;
+    /**
+     * Memory usage in GB-seconds (total_active_seconds multiplied by memory in GB).
+     */
+    memory_gb_seconds: number;
+    /**
+     * The devbox creation time in milliseconds since epoch.
+     */
+    start_time_ms: number;
+    /**
+     * The current status of the devbox.
+     */
+    status: string;
+    /**
+     * Total time in seconds the devbox was actively running (excludes time spent
+     * suspended).
+     */
+    total_active_seconds: number;
+    /**
+     * Total elapsed time in seconds from devbox creation to now (or end time if
+     * terminated). Includes all time regardless of devbox state.
+     */
+    total_elapsed_seconds: number;
+    /**
+     * vCPU usage in vCPU-seconds (total_active_seconds multiplied by the number of
+     * vCPUs).
+     */
+    vcpu_seconds: number;
+    /**
+     * The devbox end time in milliseconds since epoch, or null if still running.
+     */
+    end_time_ms?: number | null;
+}
+export interface DevboxSendStdInRequest {
+    /**
+     * Signal to send to std in of the running execution.
+     */
+    signal?: 'EOF' | 'INTERRUPT' | null;
+    /**
+     * Text to send to std in of the running execution.
+     */
+    text?: string | null;
+}
+export interface DevboxSendStdInResult {
+    /**
+     * Devbox id where command is executing.
+     */
+    devbox_id: string;
+    /**
+     * Execution id that received the stdin.
+     */
+    execution_id: string;
+    /**
+     * Whether the stdin was successfully sent.
+     */
+    success: boolean;
+}
+export interface DevboxSnapshotListView {
+    has_more: boolean;
+    /**
+     * List of snapshots matching filter.
+     */
+    snapshots: Array<DevboxSnapshotView>;
+    total_count?: number | null;
+}
+/**
+ * View of a Devbox disk snapshot.
+ *
+ * @category Snapshot Types
+ */
+export interface DevboxSnapshotView {
+    /**
+     * The unique identifier of the snapshot.
+     */
+    id: string;
+    /**
+     * Creation time of the Snapshot (Unix timestamp milliseconds).
+     */
+    create_time_ms: number;
+    /**
+     * User defined metadata associated with the snapshot.
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * The source Devbox ID this snapshot was created from.
+     */
+    source_devbox_id: string;
+    /**
+     * (Optional) The commit message of the snapshot (max 1000 characters).
+     */
+    commit_message?: string | null;
+    /**
+     * (Optional) The custom name of the snapshot.
+     */
+    name?: string | null;
+    /**
+     * (Optional) The size of the snapshot in bytes, relative to the base blueprint.
+     */
+    size_bytes?: number | null;
+    /**
+     * (Optional) The source Blueprint ID this snapshot was created from.
+     */
+    source_blueprint_id?: string | null;
+}
+/**
+ * A Devbox represents a virtual development environment. It is an isolated sandbox
+ * that can be given to agents and used to run arbitrary code such as AI generated
+ * code.
+ *
+ * @category Devbox Types
+ */
+export interface DevboxView {
+    /**
+     * The ID of the Devbox.
+     */
+    id: string;
+    /**
+     * A list of capability groups this devbox has access to.
+     */
+    capabilities: Array<'unknown' | 'docker_in_docker'>;
+    /**
+     * Creation time of the Devbox (Unix timestamp milliseconds).
+     */
+    create_time_ms: number;
+    /**
+     * The time the Devbox finished execution (Unix timestamp milliseconds). Present if
+     * the Devbox is in a terminal state.
+     */
+    end_time_ms: number | null;
+    /**
+     * The launch parameters used to create the Devbox.
+     */
+    launch_parameters: Shared.LaunchParameters;
+    /**
+     * The user defined Devbox metadata.
+     */
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * A list of state transitions in order with durations
+     */
+    state_transitions: Array<DevboxView.StateTransition>;
+    /**
+     * The current status of the Devbox.
+     */
+    status: 'scheduled' | 'queued' | 'provisioning' | 'initializing' | 'running' | 'suspending' | 'suspended' | 'resuming' | 'failure' | 'shutdown';
+    /**
+     * The Blueprint ID used in creation of the Devbox, if the devbox was created from
+     * a Blueprint.
+     */
+    blueprint_id?: string | null;
+    /**
+     * The category of failure experienced by the Devbox.
+     *
+     * out_of_memory: The Devbox ran out of memory at runtime. Use launch parameters to
+     * request a larger resource size. out_of_disk: The Devbox ran out of disk at
+     * runtime. Please reach out to support for us to better support your use case.
+     * execution_failed: The Devbox failed at runtime. Please use the dashboard to look
+     * at the logs of the failure. health_check_failed: The Devbox failed its health
+     * checks. This may indicate resource utilization is close to the maximum. Consider
+     * requesting a larger resource size.
+     */
+    failure_reason?: 'out_of_memory' | 'out_of_disk' | 'execution_failed' | 'health_check_failed' | null;
+    /**
+     * Gateway specifications configured for this devbox. Map key is the environment
+     * variable prefix (e.g., 'GWS_ANTHROPIC').
+     */
+    gateway_specs?: {
+        [key: string]: DevboxView.GatewaySpecs;
+    } | null;
+    /**
+     * The ID of the initiator that created the Devbox.
+     */
+    initiator_id?: string | null;
+    /**
+     * The type of initiator that created the Devbox.
+     */
+    initiator_type?: 'unknown' | 'api' | 'reflex';
+    /**
+     * [Beta] MCP specifications configured for this devbox. Map key is the environment
+     * variable name for the MCP token envelope. Each spec links an MCP config to a
+     * secret for MCP server access through the MCP hub.
+     */
+    mcp_specs?: {
+        [key: string]: DevboxView.McpSpecs;
+    } | null;
+    /**
+     * The name of the Devbox.
+     */
+    name?: string | null;
+    /**
+     * The reason that caused the transition of the Devbox to the shutown state.
+     *
+     * api_shutdown: The Devbox shutdown due to API request. entrypoint_exit: The
+     * Devbox entrypoint program completed. idle: The Devbox shutdown due to configured
+     * action on idle configuration. ttl_expired: The Devbox shutdown due to TTL
+     * expiration.
+     */
+    shutdown_reason?: 'api_shutdown' | 'keep_alive_timeout' | 'entrypoint_exit' | 'idle' | 'ttl_expired' | null;
+    /**
+     * The Snapshot ID used in creation of the Devbox, if the devbox was created from a
+     * Snapshot.
+     */
+    snapshot_id?: string | null;
+    /**
+     * A V2 tunnel provides secure HTTP access to services running on a Devbox. Tunnels
+     * allow external clients to reach web servers, APIs, or other HTTP services
+     * running inside a Devbox without requiring direct network access. Each tunnel is
+     * uniquely identified by an encrypted tunnel_key and can be configured for either
+     * open (public) or authenticated access. Usage:
+     * https://{port}-{tunnel_key}.tunnel.runloop.ai. Authenticated tunnels should pass
+     * auth_token as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.
+     */
+    tunnel?: TunnelView | null;
+}
+export declare namespace DevboxView {
+    interface StateTransition {
+        /**
+         * The failure that caused this state transition, if applicable.
+         */
+        failure_reason?: string | null;
+        /**
+         * The status of the Devbox.
+         *
+         * scheduled: Deprecated. The Devbox is waiting for infrastructure allocation to
+         * start. Use queued. queued: The Devbox is waiting for infrastructure allocation
+         * to start. provisioning: Runloop is allocating and booting the necessary
+         * infrastructure resources. initializing: Runloop defined boot scripts are running
+         * to enable the environment for interaction. running: The Devbox is ready for
+         * interaction. suspending: The Devbox disk is being snapshotted as part of
+         * suspension. suspended: The Devbox disk is saved and no more active compute is
+         * being used for the Devbox. resuming: The Devbox disk is being loaded as part of
+         * booting a suspended Devbox. failure: The Devbox failed as part of booting or
+         * running user requested actions. shutdown: The Devbox was successfully shutdown
+         * and no more active compute is being used.
+         */
+        status?: 'scheduled' | 'queued' | 'provisioning' | 'initializing' | 'running' | 'suspending' | 'suspended' | 'resuming' | 'failure' | 'shutdown';
+        /**
+         * The time the status change occurred
+         */
+        transition_time_ms?: unknown;
+    }
+    interface GatewaySpecs {
+        /**
+         * The ID of the gateway config (e.g., gwc_123abc).
+         */
+        gateway_config_id: string;
+        /**
+         * The ID of the secret containing the credential.
+         */
+        secret_id: string;
+    }
+    interface McpSpecs {
+        /**
+         * The ID of the MCP config (e.g., mcp_123abc).
+         */
+        mcp_config_id: string;
+        /**
+         * The ID of the secret containing the credential.
+         */
+        secret_id: string;
+    }
+}
+export interface GatewayTokenView {
+    /**
+     * The token to send to the gateway as a Bearer token in the Authorization header.
+     * Only accepted for requests originating from the bound Devbox.
+     */
+    token: string;
+    /**
+     * How the gateway applies the credential to proxied requests.
+     */
+    auth_mechanism: Shared.AuthMechanism;
+    /**
+     * The Devbox the token is bound to.
+     */
+    devbox_id: string;
+    /**
+     * The target API endpoint the gateway proxies to.
+     */
+    endpoint: string;
+    /**
+     * The ID of the gateway config the token proxies through.
+     */
+    gateway_config_id: string;
+    /**
+     * The gateway URL to send requests to. Matches the value of the
+     * &#123;prefix&#125;\_URL environment variable inside the Devbox.
+     */
+    url: string;
+}
+export interface McpTokenView {
+    /**
+     * The token to send to the MCP hub as a Bearer token in the Authorization header.
+     * Only accepted for requests originating from the bound Devbox.
+     */
+    token: string;
+    /**
+     * Glob patterns for the tools the token permits.
+     */
+    allowed_tools: Array<string>;
+    /**
+     * The Devbox the token is bound to.
+     */
+    devbox_id: string;
+    /**
+     * The upstream MCP server endpoint the hub proxies to.
+     */
+    endpoint: string;
+    /**
+     * The ID of the MCP config the token grants access to.
+     */
+    mcp_config_id: string;
+    /**
+     * The MCP hub URL the token authenticates against. Matches the RL_MCP_URL
+     * environment variable inside the Devbox.
+     */
+    url: string;
+}
+/**
+ * An ephemeral PTY tunnel providing authenticated terminal access to a Devbox.
+ * These tunnels are not stored on the Devbox and are generated fresh on each
+ * request. Usage: https://{port}-{tunnel_key}.tunnel.runloop.ai with
+ * X-Runloop-Tunnel-Authorization: Bearer {auth_token}.
+ */
+export interface PtyTunnelView {
+    /**
+     * Bearer token for tunnel authentication. Always required for PTY tunnels. Pass as
+     * X-Runloop-Tunnel-Authorization: Bearer {auth_token}.
+     */
+    auth_token: string;
+    /**
+     * The encrypted tunnel key used to construct the tunnel URL. URL format:
+     * https://{port}-{tunnel_key}.tunnel.runloop.{domain}
+     */
+    tunnel_key: string;
+}
+/**
+ * A V2 tunnel provides secure HTTP access to services running on a Devbox. Tunnels
+ * allow external clients to reach web servers, APIs, or other HTTP services
+ * running inside a Devbox without requiring direct network access. Each tunnel is
+ * uniquely identified by an encrypted tunnel_key and can be configured for either
+ * open (public) or authenticated access. Usage:
+ * https://{port}-{tunnel_key}.tunnel.runloop.ai. Authenticated tunnels should pass
+ * auth_token as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.
+ */
+export interface TunnelView {
+    /**
+     * The authentication mode for the tunnel.
+     */
+    auth_mode: 'open' | 'authenticated';
+    /**
+     * Creation time of the tunnel (Unix timestamp milliseconds).
+     */
+    create_time_ms: number;
+    /**
+     * When true, HTTP traffic through the tunnel counts as activity for idle lifecycle
+     * policies, resetting the idle timer.
+     */
+    http_keep_alive: boolean;
+    /**
+     * The encrypted tunnel key used to construct the tunnel URL. URL format:
+     * https://{port}-{tunnel_key}.tunnel.runloop.{domain}
+     */
+    tunnel_key: string;
+    /**
+     * When true, HTTP traffic to a suspended devbox will automatically trigger a
+     * resume.
+     */
+    wake_on_http: boolean;
+    /**
+     * Bearer token for tunnel authentication. Only present when auth_mode is
+     * 'authenticated'. Pass as X-Runloop-Tunnel-Authorization: Bearer {auth_token}.
+     */
+    auth_token?: string | null;
+}
+export interface DevboxCreateSSHKeyResponse {
+    /**
+     * The ID of the Devbox.
+     */
+    id: string;
+    /**
+     * The ssh private key, in PEM format.
+     */
+    ssh_private_key: string;
+    /**
+     * The Linux user to use for SSH connections to this Devbox.
+     */
+    ssh_user: string;
+    /**
+     * The host url of the Devbox that can be used for SSH.
+     */
+    url: string;
+}
+export type DevboxDeleteDiskSnapshotResponse = unknown;
+export type DevboxKeepAliveResponse = unknown;
+export type DevboxReadFileContentsResponse = string;
+export type DevboxRemoveTunnelResponse = unknown;
+export type DevboxUploadFileResponse = unknown;
+/**
+ * Parameters for creating a new Devbox.
+ *
+ * @category Devbox Types
+ */
+export interface DevboxCreateParams {
+    /**
+     * Blueprint ID to use for the Devbox. If none set, the Devbox will be created with
+     * the default Runloop Devbox image. Only one of (Snapshot ID, Blueprint ID,
+     * Blueprint name) should be specified.
+     */
+    blueprint_id?: string | null;
+    /**
+     * Name of Blueprint to use for the Devbox. When set, this will load the latest
+     * successfully built Blueprint with the given name. Only one of (Snapshot ID,
+     * Blueprint ID, Blueprint name) should be specified.
+     */
+    blueprint_name?: string | null;
+    /**
+     * A list of code mounts to be included in the Devbox. Use mounts instead.
+     */
+    code_mounts?: Array<Shared.CodeMountParameters> | null;
+    /**
+     * (Optional) When specified, the Devbox will run this script as its main
+     * executable. The devbox lifecycle will be bound to entrypoint, shutting down when
+     * the process is complete.
+     */
+    entrypoint?: string | null;
+    /**
+     * (Optional) Environment variables used to configure your Devbox.
+     */
+    environment_variables?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Map of paths and file contents to write before setup. Use mounts instead.
+     */
+    file_mounts?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * (Optional) Agent gateway specifications for credential proxying. Map key is the
+     * environment variable prefix (e.g., 'GWS_ANTHROPIC'). The agent gateway will
+     * proxy requests to external APIs using the specified credential without exposing
+     * the real API key. Example: {'GWS_ANTHROPIC': {'gateway': 'anthropic', 'secret':
+     * 'my_claude_key'}}
+     */
+    gateways?: {
+        [key: string]: DevboxCreateParams.Gateways;
+    } | null;
+    /**
+     * LaunchParameters enable you to customize the resources available to your Devbox
+     * as well as the environment set up that should be completed before the Devbox is
+     * marked as 'running'.
+     */
+    launch_parameters?: Shared.LaunchParameters | null;
+    /**
+     * [Beta] (Optional) MCP specifications for MCP server access. Map key is the
+     * environment variable name for the MCP token envelope. Each spec links an MCP
+     * config to a secret. The devbox will also receive RL_MCP_URL for the MCP hub
+     * endpoint. Example: {'MCP_SECRET': {'mcp_config': 'github-readonly', 'secret':
+     * 'MY_GITHUB_TOKEN'}}
+     */
+    mcp?: {
+        [key: string]: DevboxCreateParams.Mcp;
+    } | null;
+    /**
+     * User defined metadata to attach to the devbox for organization.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * A list of mounts to be included in the Devbox.
+     */
+    mounts?: Array<Shared.Mount> | null;
+    /**
+     * (Optional) A user specified name to give the Devbox.
+     */
+    name?: string | null;
+    /**
+     * (Optional) Map of environment variable names to secret names. The secret values
+     * will be securely injected as environment variables in the Devbox. Example:
+     * {"DB_PASS": "DATABASE_PASSWORD"} sets environment variable 'DB_PASS' to the
+     * value of secret 'DATABASE_PASSWORD'.
+     */
+    secrets?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Snapshot ID to use for the Devbox. Only one of (Snapshot ID, Blueprint ID,
+     * Blueprint name) should be specified.
+     */
+    snapshot_id?: string | null;
+    /**
+     * Configuration for creating a V2 tunnel. When specified at Devbox creation, a
+     * tunnel will be automatically provisioned.
+     */
+    tunnel?: DevboxCreateParams.Tunnel | null;
+}
+export declare namespace DevboxCreateParams {
+    /**
+     * GatewaySpec links an agent gateway configuration to a secret for credential
+     * proxying in a devbox. The agent gateway will proxy requests to external APIs
+     * using the specified credential without exposing the real API key.
+     */
+    interface Gateways {
+        /**
+         * The gateway config to use. Can be a gateway config ID (gwc_xxx) or name. A name
+         * binds the most recently created config with that name.
+         */
+        gateway: string;
+        /**
+         * The secret containing the credential. Can be a secret ID or name.
+         */
+        secret: string;
+    }
+    /**
+     * [Beta] McpSpec links an MCP configuration to a secret for MCP server access in a
+     * devbox. The MCP hub will proxy requests to upstream MCP servers using the
+     * specified credential, with tool-level access control based on the MCP config's
+     * allowed_tools.
+     */
+    interface Mcp {
+        /**
+         * The MCP config to use. Can be an MCP config ID (mcp_xxx) or name. A name binds
+         * the most recently created config with that name.
+         */
+        mcp_config: string;
+        /**
+         * The secret containing the MCP server credential. Can be a secret ID or name.
+         */
+        secret: string;
+    }
+    /**
+     * Configuration for creating a V2 tunnel. When specified at Devbox creation, a
+     * tunnel will be automatically provisioned.
+     */
+    interface Tunnel {
+        /**
+         * Authentication mode for the tunnel. Defaults to open if omitted: the hostname is
+         * a public capability and does not require a tunnel bearer token.
+         */
+        auth_mode?: 'open' | 'authenticated' | null;
+        /**
+         * When true, HTTP traffic through the tunnel counts as activity for idle lifecycle
+         * policies, resetting the idle timer. Defaults to true if not specified.
+         */
+        http_keep_alive?: boolean | null;
+        /**
+         * When true, HTTP traffic to a suspended devbox will automatically trigger a
+         * resume. Defaults to false if not specified. Prefer
+         * lifecycle.resume_triggers.http on launch_parameters for new integrations. If
+         * both are set, lifecycle.resume_triggers.http takes precedence.
+         */
+        wake_on_http?: boolean | null;
+    }
+}
+export interface DevboxUpdateParams {
+    /**
+     * User defined metadata to replace the Devbox metadata. Omit to leave unchanged or
+     * set to an empty map to clear it.
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * A user specified name to give the Devbox. Omit to leave unchanged or set to an
+     * empty string to clear it.
+     */
+    name?: string | null;
+}
+export interface DevboxListParams extends DevboxesCursorIDPageParams {
+    /**
+     * If true (default), includes total_count in the response. Set to false to skip
+     * the count query for better performance on large datasets.
+     */
+    include_total_count?: boolean;
+    /**
+     * Filter by status
+     */
+    status?: 'scheduled' | 'queued' | 'provisioning' | 'initializing' | 'running' | 'suspending' | 'suspended' | 'resuming' | 'failure' | 'shutdown';
+}
+export interface DevboxCreateGatewayTokenParams {
+    /**
+     * The gateway config to use. Can be a gateway config ID (gwc_xxx) or name.
+     */
+    gateway: string;
+    /**
+     * The secret containing the credential. Can be a secret ID or name.
+     */
+    secret: string;
+}
+export interface DevboxCreateMcpTokenParams {
+    /**
+     * The MCP config to use. Can be an MCP config ID (mcp_xxx) or name.
+     */
+    mcp_config: string;
+    /**
+     * The secret containing the MCP server credential. Can be a secret ID or name.
+     */
+    secret: string;
+}
+export interface DevboxDownloadFileParams {
+    /**
+     * The path on the Devbox filesystem to read the file from. Path is relative to
+     * user home directory.
+     */
+    path: string;
+}
+export interface DevboxEnableTunnelParams {
+    /**
+     * Authentication mode for the tunnel. Defaults to open if omitted: the hostname is
+     * a public capability and does not require a tunnel bearer token.
+     */
+    auth_mode?: 'open' | 'authenticated' | null;
+    /**
+     * When true, HTTP traffic through the tunnel counts as activity for idle lifecycle
+     * policies, resetting the idle timer. Defaults to true if not specified.
+     */
+    http_keep_alive?: boolean | null;
+    /**
+     * When true, HTTP traffic to a suspended devbox will automatically trigger a
+     * resume. Defaults to false if not specified. Prefer
+     * lifecycle.resume_triggers.http on launch_parameters for new integrations. If
+     * both are set, lifecycle.resume_triggers.http takes precedence.
+     */
+    wake_on_http?: boolean | null;
+}
+/**
+ * Parameters for executing a command on a Devbox.
+ *
+ * @category Devbox Types
+ */
+export interface DevboxExecuteParams {
+    /**
+     * Body param: The command to execute via the Devbox shell. By default, commands
+     * are run from the user home directory unless shell_name is specified. If
+     * shell_name is specified the command is run from the directory based on the
+     * recent state of the persistent shell.
+     */
+    command: string;
+    /**
+     * Body param: The command ID in UUIDv7 string format for idempotency and tracking
+     */
+    command_id?: string;
+    /**
+     * Query param: Last n lines of standard error / standard out to return
+     * (default: 100)
+     */
+    last_n?: string;
+    /**
+     * Body param: Timeout in seconds to wait for command completion, up to 25 seconds.
+     * Defaults to 25 seconds. Operation is not killed.
+     */
+    optimistic_timeout?: number | null;
+    /**
+     * Body param: The name of the persistent shell to create or use if already
+     * created. When using a persistent shell, the command will run from the directory
+     * at the end of the previous command and environment variables will be preserved.
+     */
+    shell_name?: string | null;
+}
+export interface DevboxExecuteAsyncParams {
+    /**
+     * The command to execute via the Devbox shell. By default, commands are run from
+     * the user home directory unless shell_name is specified. If shell_name is
+     * specified the command is run from the directory based on the recent state of the
+     * persistent shell.
+     */
+    command: string;
+    /**
+     * Whether to attach stdin streaming for async commands. Not valid for execute_sync
+     * endpoint. Defaults to false if not specified.
+     */
+    attach_stdin?: boolean | null;
+    /**
+     * The name of the persistent shell to create or use if already created. When using
+     * a persistent shell, the command will run from the directory at the end of the
+     * previous command and environment variables will be preserved.
+     */
+    shell_name?: string | null;
+}
+export interface DevboxExecuteSyncParams {
+    /**
+     * The command to execute via the Devbox shell. By default, commands are run from
+     * the user home directory unless shell_name is specified. If shell_name is
+     * specified the command is run from the directory based on the recent state of the
+     * persistent shell.
+     */
+    command: string;
+    /**
+     * Whether to attach stdin streaming for async commands. Not valid for execute_sync
+     * endpoint. Defaults to false if not specified.
+     */
+    attach_stdin?: boolean | null;
+    /**
+     * The name of the persistent shell to create or use if already created. When using
+     * a persistent shell, the command will run from the directory at the end of the
+     * previous command and environment variables will be preserved.
+     */
+    shell_name?: string | null;
+}
+export interface DevboxListDiskSnapshotsParams extends DiskSnapshotsCursorIDPageParams {
+    /**
+     * Devbox ID to filter by.
+     */
+    devbox_id?: string;
+    /**
+     * If true (default), includes total_count in the response. Set to false to skip
+     * the count query for better performance on large datasets.
+     */
+    include_total_count?: boolean;
+    /**
+     * Filter snapshots by metadata key-value pair. Can be used multiple times for
+     * different keys.
+     */
+    'metadata[key]'?: string;
+    /**
+     * Filter snapshots by metadata key with multiple possible values (OR condition).
+     */
+    'metadata[key][in]'?: string;
+    /**
+     * Source Blueprint ID to filter snapshots by.
+     */
+    source_blueprint_id?: string;
+}
+export interface DevboxReadFileContentsParams {
+    /**
+     * The path on the Devbox filesystem to read the file from. Path is relative to
+     * user home directory.
+     */
+    file_path: string;
+}
+export interface DevboxShutdownParams {
+    /**
+     * If true, force shutdown even if snapshots are in progress. Defaults to false.
+     */
+    force?: string;
+}
+export interface DevboxSnapshotDiskParams {
+    /**
+     * (Optional) Commit message associated with the snapshot (max 1000 characters)
+     */
+    commit_message?: string | null;
+    /**
+     * (Optional) Metadata used to describe the snapshot
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * (Optional) A user specified name to give the snapshot
+     */
+    name?: string | null;
+}
+export interface DevboxSnapshotDiskAsyncParams {
+    /**
+     * (Optional) Commit message associated with the snapshot (max 1000 characters)
+     */
+    commit_message?: string | null;
+    /**
+     * (Optional) Metadata used to describe the snapshot
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * (Optional) A user specified name to give the snapshot
+     */
+    name?: string | null;
+}
+export interface DevboxUploadFileParams {
+    /**
+     * The path to write the file to on the Devbox. Path is relative to user home
+     * directory.
+     */
+    path: string;
+    file?: Uploadable;
+}
+export interface DevboxWaitForCommandParams {
+    /**
+     * Body param: The command execution statuses to wait for. At least one status must
+     * be provided. The command will be returned as soon as it reaches any of the
+     * provided statuses.
+     */
+    statuses: Array<'queued' | 'running' | 'completed'>;
+    /**
+     * Query param: Last n lines of standard error / standard out to return
+     * (default: 100)
+     */
+    last_n?: string;
+    /**
+     * Body param: (Optional) Timeout in seconds to wait for the status, up to 25
+     * seconds. Defaults to 25 seconds.
+     */
+    timeout_seconds?: number | null;
+}
+export interface DevboxWriteFileContentsParams {
+    /**
+     * The UTF-8 string contents to write to the file.
+     */
+    contents: string;
+    /**
+     * The path to write the file to on the Devbox. Path is relative to user home
+     * directory.
+     */
+    file_path: string;
+}
+//# sourceMappingURL=types.d.ts.map