@boxrouter/sdk 0.0.0-stage → 0.12.190

package/dist/namespace-files.mjs

@@ -0,0 +1,334 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export class Files extends HeyApiClient {
+    /**
+     * Read exact file bytes
+     *
+     * You can rely on:
+     * - Returns complete bytes, or resource_limit with no prefix returned.
+     * - Reading a directory or another path that is not a regular file fails and returns no data.
+     * - An absent path is not_found, outcome failed: a read has no effect, so its outcome is never unknown.
+     *
+     * You can set: path.
+     *
+     * Not promised: consistency while another writer changes the file.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. Bytes are not text-decoded.
+     * Closing the transfer does not destroy the sandbox. A stream that ends before
+     * Content-Length is an incomplete transfer, not a successful file read.
+     *
+     */
+    read(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/content',
+            ...options
+        });
+    }
+    /**
+     * Read exact file bytes
+     *
+     * You can rely on:
+     * - Returns complete bytes, or resource_limit with no prefix returned.
+     * - Reading a directory or another path that is not a regular file fails and returns no data.
+     * - An absent path is not_found, outcome failed: a read has no effect, so its outcome is never unknown.
+     *
+     * You can set: path.
+     *
+     * Not promised: consistency while another writer changes the file.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. Bytes are not text-decoded.
+     * Closing the transfer does not destroy the sandbox. A stream that ends before
+     * Content-Length is an incomplete transfer, not a successful file read.
+     *
+     */
+    readStream(options) {
+        return (options.client ?? this.client).get({
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/content',
+            ...options,
+            parseAs: "binaryStream",
+            responseStyle: "fields"
+        });
+    }
+    /**
+     * Write exact file bytes
+     *
+     * You can rely on:
+     * - Writes exact bytes.
+     * - Creates missing parents.
+     * - A new file is readable and writable by the command user.
+     * - The size limit is enforced.
+     *
+     * You can set: path, data.
+     *
+     * Not promised: owner, mode or executable bit; atomic replace; whether a symbolic link at the path is followed or replaced.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. A failed transfer may leave
+     * partial data; the error's outcome describes what is known. SDK text helpers must encode
+     * text as UTF-8 before transfer.
+     *
+     */
+    write(options) {
+        return (options.client ?? this.client).put({
+            bodySerializer: null,
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/content',
+            ...options,
+            headers: {
+                'Content-Type': 'application/octet-stream',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Create a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Starts an upload of a file of known size to an absolute path in a running sandbox. Send
+     * every returned part as described by its `TransferPart`, then call `completeSandboxUpload`
+     * with each part's response `ETag`, if any. BoxRouter chooses the `route`; it is
+     * informational and clients must not branch on it. Upload links and the session last up to
+     * six hours after creation; `expires_at` says when they end. Launch behaviour is always
+     * exactly one part. Idempotency-Key is required on create, complete and abort; repeat an
+     * uncertain call with the same key.
+     *
+     */
+    createUpload(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/uploads',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Complete a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Supply each part number exactly once with the `ETag` header returned by its request, if
+     * it returned one. Repeating the call with the same idempotency key returns the same result.
+     *
+     */
+    completeUpload(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/uploads/{upload_id}/complete',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Abort a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Idempotent.
+     *
+     */
+    abortUpload(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/uploads/{upload_id}',
+            ...options
+        });
+    }
+    /**
+     * Create a sandbox file download
+     *
+     * You can rely on:
+     * - A complete download returns exactly the file's bytes; a transfer that ends short fails instead of returning a prefix.
+     *
+     * You can set: path.
+     *
+     * Not promised: the file's size before the download starts.
+     *
+     * Creates a temporary download link for a file in a running sandbox. The link lasts up to
+     * one hour after creation; `expires_at` says when it ends. `route` is informational and
+     * clients must not branch on it.
+     *
+     */
+    createDownload(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/downloads',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List the immediate entries of a directory
+     *
+     * You can rely on:
+     * - Returns every immediate entry, including hidden ones and broken symbolic links, sorted by name.
+     * - Each entry has its type (file, directory, symlink, other); a link is not followed.
+     * - More entries than the advertised limit fail; the list is never truncated.
+     *
+     * You can set: path.
+     *
+     * Not promised: metadata beyond the type; a consistent snapshot while the directory changes.
+     *
+     * An unreadable or missing directory fails; it does not appear empty. No recursion.
+     *
+     */
+    list(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/directories',
+            ...options
+        });
+    }
+    /**
+     * Create a directory
+     *
+     * You can rely on:
+     * - parents=true (the default) creates missing parents and accepts an existing directory.
+     * - parents=false requires the parent and refuses an existing path.
+     *
+     * You can set: path, parents.
+     *
+     * Not promised: mode and owner beyond command-user usability.
+     *
+     * A failure may leave some parent directories created. An uncertain mutation is never automatically replayed.
+     *
+     */
+    mkdir(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/directories',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Check for an accessible filesystem target
+     *
+     * You can rely on:
+     * - Follows symbolic links. True when the target exists; false when it is missing, the link is broken, or the target is not accessible.
+     * - A failure to check raises an error; it never reads as false.
+     *
+     * You can set: path.
+     *
+     * Not promised: whether the answer still holds after the call.
+     *
+     * Transport and command-startup failures remain errors. This read does not reserve the path or guarantee it remains present.
+     *
+     */
+    exists(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/exists',
+            ...options
+        });
+    }
+    /**
+     * Remove a file, symbolic link or directory
+     *
+     * You can rely on:
+     * - Removes only the named entry.
+     * - A nonempty directory needs recursive.
+     * - A symbolic link, broken or not, is unlinked and its target kept.
+     * - A missing path fails.
+     * - The sandbox root is refused.
+     *
+     * You can set: path, recursive.
+     *
+     * Not promised: atomicity; partial progress after a failure.
+     *
+     * A final slash does not change which entry is removed. Failures may leave partial changes. An uncertain mutation is never automatically replayed.
+     *
+     */
+    remove(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/sandboxes/{sandbox_id}/files/remove',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}

package/dist/namespace-github.d.mts

@@ -0,0 +1,50 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { GithubListInstallationsData, GithubListInstallationsErrors, GithubListInstallationsResponses, GithubListRepositoriesData, GithubListRepositoriesErrors, GithubListRepositoriesResponses, GithubUnlinkInstallationData, GithubUnlinkInstallationErrors, GithubUnlinkInstallationResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+export declare class Github extends HeyApiClient {
+    /**
+     * List GitHub App installations linked to this workspace
+     *
+     * Requires read authority in the authenticated workspace. Results include only
+     * installations linked to that workspace; an installation ID supplied by a caller
+     * is not authority. Empty workspaces return an empty page. This is a read and never
+     * installs, uninstalls or relinks the App.
+     *
+     */
+    listInstallations<ThrowOnError extends boolean = true>(options?: Options<GithubListInstallationsData, ThrowOnError>): RequestResult<GithubListInstallationsResponses, GithubListInstallationsErrors, ThrowOnError, 'data'>;
+    /**
+     * Unlink a GitHub App installation from this workspace
+     *
+     * Requires workspace administrator authority. Browser-session calls require the CSRF
+     * token and configured Origin. An Idempotency-Key identifies this one unlink request;
+     * an identical replay returns its recorded result, a changed request under that key
+     * conflicts, and an unknown GitHub or storage outcome is reconciled without replay.
+     * Unlinking prevents new Actions work and does not uninstall the shared App from
+     * GitHub or cancel already accepted workflow runs.
+     *
+     */
+    unlinkInstallation<ThrowOnError extends boolean = true>(options: Options<GithubUnlinkInstallationData, ThrowOnError>): RequestResult<GithubUnlinkInstallationResponses, GithubUnlinkInstallationErrors, ThrowOnError, 'data'>;
+    /**
+     * List repositories visible through a linked installation
+     *
+     * Requires read authority in the authenticated workspace. The installation must be
+     * linked to that workspace and its current GitHub permissions are revalidated; names
+     * are descriptive while stable repository IDs bind settings and work. Results contain
+     * no installation access credentials. Empty installations return an empty page.
+     *
+     */
+    listRepositories<ThrowOnError extends boolean = true>(options: Options<GithubListRepositoriesData, ThrowOnError>): RequestResult<GithubListRepositoriesResponses, GithubListRepositoriesErrors, ThrowOnError, 'data'>;
+}

package/dist/namespace-github.mjs

@@ -0,0 +1,68 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export class Github extends HeyApiClient {
+    /**
+     * List GitHub App installations linked to this workspace
+     *
+     * Requires read authority in the authenticated workspace. Results include only
+     * installations linked to that workspace; an installation ID supplied by a caller
+     * is not authority. Empty workspaces return an empty page. This is a read and never
+     * installs, uninstalls or relinks the App.
+     *
+     */
+    listInstallations(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/github/installations',
+            ...options
+        });
+    }
+    /**
+     * Unlink a GitHub App installation from this workspace
+     *
+     * Requires workspace administrator authority. Browser-session calls require the CSRF
+     * token and configured Origin. An Idempotency-Key identifies this one unlink request;
+     * an identical replay returns its recorded result, a changed request under that key
+     * conflicts, and an unknown GitHub or storage outcome is reconciled without replay.
+     * Unlinking prevents new Actions work and does not uninstall the shared App from
+     * GitHub or cancel already accepted workflow runs.
+     *
+     */
+    unlinkInstallation(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/github/installations/{installation_id}',
+            ...options
+        });
+    }
+    /**
+     * List repositories visible through a linked installation
+     *
+     * Requires read authority in the authenticated workspace. The installation must be
+     * linked to that workspace and its current GitHub permissions are revalidated; names
+     * are descriptive while stable repository IDs bind settings and work. Results contain
+     * no installation access credentials. Empty installations return an empty page.
+     *
+     */
+    listRepositories(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/github/repositories',
+            ...options
+        });
+    }
+}

package/dist/namespace-images.d.mts

@@ -0,0 +1,52 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { ImagesPrepareData, ImagesPrepareErrors, ImagesPrepareResponses, ImagesStatusData, ImagesStatusErrors, ImagesStatusResponses, ImagesUnprepareData, ImagesUnprepareErrors, ImagesUnprepareResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+export declare class Images extends HeyApiClient {
+    /**
+     * Prepare an image on selected providers
+     *
+     * Start background preparation using this workspace's payer-account rules, on the named
+     * `providers` or on the `top` providers a create with the `match` body would pick now.
+     * A named provider that cannot run the image reports its fit reason immediately; a
+     * `match` body that no route can run is refused as that create would be. With `match`,
+     * the response lists the picked providers in rank order, and each reason says how it
+     * was ranked. A ready result means a usable copy existed when preparation completed;
+     * it does not keep the copy awake afterward. Read progress from GET /images/preparations.
+     * OCI and Dockerfile inputs use the same declared preparation capabilities as a create.
+     * A Dockerfile response returns a content selector for status and unprepare. If no selected
+     * offering declares prepared Dockerfile/context support, it is refused before reading the
+     * context or starting provider work. Existing provider artifacts are already prepared.
+     * The request JSON is limited to 64 KiB; uploaded contexts retain the artifacts API limits.
+     *
+     */
+    prepare<ThrowOnError extends boolean = true>(options: Options<ImagesPrepareData, ThrowOnError>): RequestResult<ImagesPrepareResponses, ImagesPrepareErrors, ThrowOnError, 'data'>;
+    /**
+     * Read image preparation status
+     *
+     * Reads preparation state recorded for the requested image in this workspace. The providers query can limit the result; omitted returns every recorded provider. A content selector reads the workspace's recorded copy without contacting a registry.
+     */
+    status<ThrowOnError extends boolean = true>(options: Options<ImagesStatusData, ThrowOnError>): RequestResult<ImagesStatusResponses, ImagesStatusErrors, ThrowOnError, 'data'>;
+    /**
+     * Remove this workspace's prepared image copies
+     *
+     * Remove only copies Cloud recorded for this workspace. Copies on managed accounts
+     * that other workspaces still use remain available, while this workspace's use is
+     * dropped. The image itself is not deleted. A provider reports gone only after it
+     * confirms removal. A later sandbox create may prepare the image again.
+     *
+     */
+    unprepare<ThrowOnError extends boolean = true>(options: Options<ImagesUnprepareData, ThrowOnError>): RequestResult<ImagesUnprepareResponses, ImagesUnprepareErrors, ThrowOnError, 'data'>;
+}

package/dist/namespace-images.mjs

@@ -0,0 +1,78 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export class Images extends HeyApiClient {
+    /**
+     * Prepare an image on selected providers
+     *
+     * Start background preparation using this workspace's payer-account rules, on the named
+     * `providers` or on the `top` providers a create with the `match` body would pick now.
+     * A named provider that cannot run the image reports its fit reason immediately; a
+     * `match` body that no route can run is refused as that create would be. With `match`,
+     * the response lists the picked providers in rank order, and each reason says how it
+     * was ranked. A ready result means a usable copy existed when preparation completed;
+     * it does not keep the copy awake afterward. Read progress from GET /images/preparations.
+     * OCI and Dockerfile inputs use the same declared preparation capabilities as a create.
+     * A Dockerfile response returns a content selector for status and unprepare. If no selected
+     * offering declares prepared Dockerfile/context support, it is refused before reading the
+     * context or starting provider work. Existing provider artifacts are already prepared.
+     * The request JSON is limited to 64 KiB; uploaded contexts retain the artifacts API limits.
+     *
+     */
+    prepare(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/images/prepare',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Read image preparation status
+     *
+     * Reads preparation state recorded for the requested image in this workspace. The providers query can limit the result; omitted returns every recorded provider. A content selector reads the workspace's recorded copy without contacting a registry.
+     */
+    status(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/images/preparations',
+            ...options
+        });
+    }
+    /**
+     * Remove this workspace's prepared image copies
+     *
+     * Remove only copies Cloud recorded for this workspace. Copies on managed accounts
+     * that other workspaces still use remain available, while this workspace's use is
+     * dropped. The image itself is not deleted. A provider reports gone only after it
+     * confirms removal. A later sandbox create may prepare the image again.
+     *
+     */
+    unprepare(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/images/unprepare',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}

package/dist/namespace-launch_runs.d.mts

@@ -0,0 +1,89 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { LaunchRunsCreateData, LaunchRunsCreateErrors, LaunchRunsCreateResponses, LaunchRunsDestroyCopyData, LaunchRunsDestroyCopyErrors, LaunchRunsDestroyCopyResponses, LaunchRunsGetData, LaunchRunsGetErrors, LaunchRunsGetResponses, LaunchRunsListData, LaunchRunsListErrors, LaunchRunsListResponses, LaunchRunsStopData, LaunchRunsStopErrors, LaunchRunsStopResponses } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+export declare class LaunchRuns extends HeyApiClient {
+    /**
+     * List launch runs
+     *
+     * List the authenticated workspace's launch runs, newest first, as lightweight summaries.
+     * Rows contain no copy items, specs, command data or outputs; read getLaunchRun for one
+     * run's copies. `total_copies` and `live_copies` cover every run in the workspace, not
+     * only the returned page. A live copy is one whose sandbox has not been confirmed absent,
+     * including copies that are stopping. The read uses stored metadata only and makes no
+     * provider calls. Responses are private to the workspace and must not be cached.
+     *
+     * If launch-run copies are not available to you, the read still answers 200, with `available`
+     * false, no runs and zero totals.
+     *
+     * `next_cursor` is an opaque, workspace-scoped value for the next page and is null on the
+     * last page. A cursor from another workspace or a malformed cursor is invalid_request.
+     *
+     */
+    list<ThrowOnError extends boolean = true>(options?: Options<LaunchRunsListData, ThrowOnError>): RequestResult<LaunchRunsListResponses, LaunchRunsListErrors, ThrowOnError, 'data'>;
+    /**
+     * Start an unattended launch run
+     *
+     * Reserve one workspace-owned run and all requested copies atomically. The existing
+     * launch request fields select exactly one catalog agent or inline manifest; `copies`
+     * is required. Acceptance returns 202 with a Location for metadata polling and makes
+     * no provider create before the executor claims each copy. Reuse the same
+     * Idempotency-Key and identical body to recover an uncertain acceptance; a changed
+     * body conflicts and never creates another run.
+     *
+     * Credential selectors are resolved at each copy claim. Secret values and provider
+     * tokens are never stored. Saved secrets are re-read by name, so rotation can affect
+     * later copies. Inline secret_values, interactive launches, and unsupported manifest
+     * features are refused before reservation. The feature remains opt-in until compatible
+     * clients are released.
+     *
+     */
+    create<ThrowOnError extends boolean = true>(options: Options<LaunchRunsCreateData, ThrowOnError>): RequestResult<LaunchRunsCreateResponses, LaunchRunsCreateErrors, ThrowOnError, 'data'>;
+    /**
+     * Read launch run metadata
+     *
+     * Read the stored run row and copy rows only. This response excludes command data and
+     * output fields and makes no provider calls. `include=command` opts into bounded state
+     * and exit-code observations for active copies; the server uses at most eight
+     * observations at once and one five-second response deadline. Unknown, hung, saturated,
+     * or failed observations return `unknown`. Neither variant exposes command text,
+     * outputs, process handles, or credentials. Foreign and missing IDs have the same 404
+     * response.
+     *
+     */
+    get<ThrowOnError extends boolean = true>(options: Options<LaunchRunsGetData, ThrowOnError>): RequestResult<LaunchRunsGetResponses, LaunchRunsGetErrors, ThrowOnError, 'data'>;
+    /**
+     * Stop a launch run
+     *
+     * Set the workspace-owned run's desired state to stopped and request copy cancellation. The request is idempotent; repeating stop returns the original stop timestamp. This does not imply that the provider sandbox was destroyed. Foreign and missing IDs have the same 404 response.
+     */
+    stop<ThrowOnError extends boolean = true>(options: Options<LaunchRunsStopData, ThrowOnError>): RequestResult<LaunchRunsStopResponses, LaunchRunsStopErrors, ThrowOnError, 'data'>;
+    /**
+     * Destroy one launch-run copy
+     *
+     * Durably request cleanup of one copy of a workspace-owned run; the run and its other
+     * copies keep running. Acceptance records the request only: no provider call is made
+     * during the request, and `stopping` does not mean the sandbox is gone. The copy's
+     * status in getLaunchRun becomes `stopped` only after its absence is confirmed; a queued
+     * copy that was never dispatched has no sandbox and stops at once.
+     *
+     * The request is idempotent. Retrying it, or destroying a copy that is already stopping
+     * or stopped, returns the same 202 and leaves the copy's state and timestamps unchanged.
+     * Foreign and missing run IDs and copy indexes have the same 404 response. Responses are
+     * private and must not be cached.
+     *
+     */
+    destroyCopy<ThrowOnError extends boolean = true>(options: Options<LaunchRunsDestroyCopyData, ThrowOnError>): RequestResult<LaunchRunsDestroyCopyResponses, LaunchRunsDestroyCopyErrors, ThrowOnError, 'data'>;
+}