@runlot/api 0.1.0-rc.100

package/dist/index.d.ts

@@ -0,0 +1,903 @@
+import type { components, operations } from "./schema.js";
+export type { components, paths, operations } from "./schema.js";
+export declare const API_VERSION: "v1";
+type Schemas = components["schemas"];
+/**
+ * The success response body of an operation.
+ *
+ * We do not write the method return types by hand because a hand-written type
+ * still compiles after the spec changes — and that drift shows up at runtime as
+ * `undefined`.
+ */
+type Ok<K extends keyof operations> = operations[K]["responses"] extends {
+    200: {
+        content: {
+            "application/json": infer B;
+        };
+    };
+} ? B : operations[K]["responses"] extends {
+    201: {
+        content: {
+            "application/json": infer B;
+        };
+    };
+} ? B : operations[K]["responses"] extends {
+    202: {
+        content: {
+            "application/json": infer B;
+        };
+    };
+} ? B : never;
+export type Session = Schemas["Session"];
+export type User = Schemas["User"];
+export type AuthEmailAccepted = Schemas["AuthEmailAccepted"];
+export type TotpStatus = Schemas["TotpStatus"];
+export type TotpEnrollment = Schemas["TotpEnrollment"];
+export type Org = Schemas["Org"];
+export type Project = Schemas["Project"];
+export type ProjectDetail = Schemas["ProjectDetail"];
+export type Placement = Schemas["Placement"];
+export type Deployment = Schemas["Deployment"];
+export type Preview = Schemas["Preview"];
+export type PreviewState = NonNullable<Preview["state"]>;
+export type PreviewDbMode = NonNullable<Preview["dbMode"]>;
+/**
+ * What `createDeployment` answers to a `?preview=` upload.
+ *
+ * The extra field is written here rather than in the 201 response schema because
+ * the schema is `Deployment` — shared with `listDeployments`, `rollback` and the
+ * overview, none of which have a preview to report. Widening it there would put an
+ * optional `preview` on every deployment a reader ever sees, which reads as "a
+ * deployment may belong to a preview" instead of "this one call returns the
+ * preview it just made". `proto/openapi.yaml` `createDeployment` says the same
+ * thing in prose.
+ */
+export type DeployedPreview = Deployment & {
+    preview?: Preview;
+};
+export type ProjectOverview = Schemas["ProjectOverview"];
+export type OverviewDeployment = Schemas["OverviewDeployment"];
+export type Manifest = Schemas["Manifest"];
+export type CronOverview = Schemas["CronOverview"];
+export type CronSchedule = Schemas["CronSchedule"];
+export type CronRun = Schemas["CronRun"];
+export type CronSummary = Schemas["CronSummary"];
+export type QueueOverview = Schemas["QueueOverview"];
+export type QueueStatus = Schemas["QueueStatus"];
+export type QueueRun = Schemas["QueueRun"];
+export type QueueDepth = Schemas["QueueDepth"];
+export type QueueMessage = Schemas["QueueMessage"];
+export type DurableObjectUsage = Schemas["DurableObjectUsage"];
+export type VectorOverview = Schemas["VectorOverview"];
+export type VectorNamespace = Schemas["VectorNamespace"];
+export type DatabaseConnect = Schemas["DatabaseConnect"];
+export type DatabaseEndpoint = Schemas["DatabaseEndpoint"];
+export type DatabaseToken = Schemas["DatabaseToken"];
+export type DatabaseTokenMeta = Schemas["DatabaseTokenMeta"];
+export type ConnectInfo = DatabaseConnect["connect"];
+export type DatabaseExport = Schemas["DatabaseExport"];
+export type ExportInfo = DatabaseExport["export"];
+export type DatabaseGenerations = Schemas["DatabaseGenerations"];
+export type GenerationRow = Schemas["GenerationRow"];
+export type OperationStarted = Schemas["OperationStarted"];
+export type Operation = Schemas["Operation"];
+export type ErrorEnvelope = Schemas["Error"];
+export type Role = Schemas["Role"];
+export type Member = Schemas["Member"];
+export type Invite = Schemas["Invite"];
+export type OrgHolding = Schemas["OrgHolding"];
+export type InviteView = Schemas["InviteView"];
+export type InviteState = Schemas["InviteState"];
+export type SecretMeta = Schemas["SecretMeta"];
+export type SecretList = Schemas["SecretList"];
+export type LogEvent = Schemas["LogEvent"];
+export type LogHistoryLine = {
+    ts: string;
+    seq: number;
+    epoch?: number;
+    generation?: number;
+    stream: "stdout" | "stderr" | "runlot";
+    line: string;
+};
+export type LogHistoryPage = {
+    lines: LogHistoryLine[];
+    /** Absent means there is nothing older. */
+    cursor?: string | undefined;
+    keepDays: number;
+    linesPerDay: number;
+};
+export type Usage = Schemas["Usage"];
+export type ExecuteResult = Schemas["ExecuteResult"];
+export type StorageStatus = Schemas["StorageStatus"];
+export type BillingStatus = Schemas["BillingStatus"];
+export type PlanLimits = Schemas["PlanLimits"];
+export type EmailStatus = Schemas["EmailStatus"];
+export type EmailDomain = Schemas["EmailDomain"];
+export type EmailDNSRecord = Schemas["EmailDNSRecord"];
+export type EmailDomainState = NonNullable<EmailDomain["state"]>;
+export type MailLogEntry = Schemas["MailLogEntry"];
+export type MailLogPage = Schemas["MailLogPage"];
+export type Repo = Schemas["Repo"];
+export type RepoVisibility = NonNullable<Repo["visibility"]>;
+export type DeployHook = Schemas["DeployHook"];
+export type Build = Schemas["Build"];
+export type BuildState = NonNullable<Build["state"]>;
+export type RefUpdate = Schemas["RefUpdate"];
+export type SSHKey = Schemas["SSHKey"];
+export type AccessToken = Schemas["AccessToken"];
+export type AccessTokenCreated = Schemas["AccessTokenCreated"];
+export type TokenScope = NonNullable<AccessToken["scope"]>;
+/**
+ * One name from the REST scope vocabulary (0067).
+ *
+ * `TokenScope` above is the **git** verdict and stays two-valued; this is the
+ * set a token actually carries. Keeping the two names apart is what stops the
+ * git front end and the REST middleware from drifting into one another.
+ */
+export type ApiScope = Schemas["ApiScope"];
+export declare const API_SCOPES: readonly ApiScope[];
+export type RepoRefs = Schemas["RepoRefs"];
+export type RepoRef = RepoRefs["refs"][number];
+export type RepoTree = Schemas["RepoTree"];
+export type RepoTreeEntry = Schemas["RepoTreeEntry"];
+export type RepoBlob = Schemas["RepoBlob"];
+export type RepoCommit = Schemas["RepoCommit"];
+export type AccessPolicy = Schemas["AccessPolicy"];
+export type AccessBypass = Schemas["AccessBypass"];
+export type AccessAuthorize = Schemas["AccessAuthorize"];
+/** The three policies. The three radio buttons hang off this union (docs/access.md §3.1). */
+export type AccessMode = NonNullable<AccessPolicy["mode"]>;
+export type UsageRow = Schemas["UsageRow"];
+export type Notification = Schemas["Notification"];
+/** The notification kinds. The dashboard's label table hangs off this union (§3.1). */
+export type NotificationKind = NonNullable<Notification["kind"]>;
+export type AuthStatus = Schemas["AuthStatus"];
+export type AuthSettings = Schemas["AuthSettings"];
+export type AuthBrand = Schemas["AuthBrand"];
+export type AuthProviderMeta = Schemas["AuthProviderMeta"];
+/** The three providers. The rows on screen and the CLI's argument hang off this union. */
+export type AuthProvider = Schemas["AuthProvider"];
+/** The PATCH body — a subset of `AuthSettings`. Only the fields given change. */
+export type AuthSettingsInput = NonNullable<Schemas["AuthSettingsPatch"]["settings"]>;
+export type Hostname = Schemas["Hostname"];
+export type HostnameList = Schemas["HostnameList"];
+export type HostnameVerify = Schemas["HostnameVerify"];
+export type HostnameRecord = Schemas["HostnameRecord"];
+/** The four states. The badge on screen hangs off this value (docs/domains.md §3.3). */
+export type HostnameState = NonNullable<Hostname["state"]>;
+export type Zone = Schemas["Zone"];
+export type ZoneDetail = Schemas["ZoneDetail"];
+export type RRset = Schemas["RRset"];
+export type RRsetType = RRset["type"];
+export type Domain = Schemas["Domain"];
+export type DomainDetail = Schemas["DomainDetail"];
+export type DomainList = Schemas["DomainList"];
+export type DomainAvailability = Schemas["DomainAvailability"];
+export type DomainContact = Schemas["DomainContact"];
+export type DomainEvent = Schemas["DomainEvent"];
+/** `Domain["state"]` is exported separately — the screen pins its badge table to this union. */
+export type DomainState = Domain["state"];
+/** The exception that carries the server's error envelope unchanged. */
+export declare class ApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details?: Record<string, unknown>;
+    constructor(status: number, body: ErrorEnvelope | undefined, fallback: string);
+}
+export interface ClientOptions {
+    baseUrl: string;
+    token?: string | undefined;
+}
+export declare class Client {
+    private readonly opts;
+    constructor(opts: ClientOptions);
+    private headers;
+    private request;
+    /** A body that is not JSON (the raw mail). Error handling is the same as request. */
+    private text;
+    private json;
+    devLogin(subject: string): Promise<Ok<"devLogin">>;
+    /**
+     * Takes the sign-up and sends the confirmation mail. Neither a session nor a
+     * password is created here — the password is chosen in `verifyEmail` by
+     * whoever opens the mailbox.
+     */
+    passwordSignUp(email: string, name?: string): Promise<Ok<"passwordSignUp">>;
+    passwordSignIn(email: string, password: string): Promise<Ok<"passwordSignIn">>;
+    /** The same accepted response comes back whether or not the email exists. */
+    passwordForgot(email: string): Promise<Ok<"passwordForgot">>;
+    passwordReset(token: string, password: string): Promise<Ok<"passwordReset">>;
+    /** Uses the confirmation link and sets the account's first password. */
+    verifyEmail(token: string, password: string): Promise<Ok<"verifyEmail">>;
+    /**
+     * Finishes a sign-in that came back `{mfa:"totp"}`.
+     *
+     * Callable without a token: `pending` is the credential, and it is not a
+     * session — no other endpoint accepts it.
+     */
+    completeTotpLogin(pending: string, factor: {
+        code: string;
+    } | {
+        recovery: string;
+    }): Promise<Ok<"completeTotpLogin">>;
+    /** This account's two-factor state, including which orgs require it. */
+    getTotp(): Promise<Ok<"getTotp">>;
+    /**
+     * Draws a secret to scan. It does **not** turn the factor on — `confirmTotp`
+     * does, after the app has proved it can produce a code.
+     */
+    enrollTotp(): Promise<Ok<"enrollTotp">>;
+    /** Turns the factor on and hands back the ten recovery codes. They are shown once. */
+    confirmTotp(code: string): Promise<Ok<"confirmTotp">>;
+    /** Turns it off. A code or a recovery code is required — the session alone is not. */
+    disableTotp(factor: {
+        code: string;
+    } | {
+        recovery: string;
+    }): Promise<void>;
+    /**
+     * The GitHub OAuth start URL. It is a 302 the browser follows, so it goes into
+     * `window.location` rather than being called with fetch. `redirect` has to be
+     * on the server's allow-list.
+     */
+    githubStartUrl(redirect: string): string;
+    /** The Google OAuth start URL. Uses the same dashboard callback shape as GitHub. */
+    googleStartUrl(redirect: string): string;
+    /**
+     * The names of this deployment (app domain, docs address). Callable without auth.
+     *
+     * This exists so the dashboard does not hard-code a domain into the screen
+     * (docs/environments.md §3.2) — hard-coded, the dev screen tells people a
+     * production address, and because that address opens, nobody ever says it is
+     * wrong.
+     */
+    siteConfig(): Promise<Ok<"getSiteConfig">>;
+    me(): Promise<Ok<"getMe">>;
+    listOrgs(): Promise<Ok<"listOrgs">>;
+    /** Changes the display name only (admin). The slug is the name that becomes an address, so it is not on this surface. */
+    /**
+     * `requireTotp` is left out when it is not given, on purpose: the server reads
+     * an absent field as "leave it alone". Sending `false` by default would mean a
+     * rename silently switched the org's second-factor requirement off.
+     */
+    updateOrg(org: string, name: string, requireTotp?: boolean): Promise<Ok<"updateOrg">>;
+    /**
+     * Deletes the organization (admin). **This cannot be undone.**
+     *
+     * `confirm` has to be the organization slug exactly — the confirmation lives on
+     * the server because three places call this surface (the screen, the CLI, and
+     * scripts). If a live project, domain, repository, or DNS zone is left, it is a
+     * 409 `org_not_empty` and `details.holdings` says what is left — **projects
+     * already deleted are not counted.**
+     *
+     * The `purgeAfter` in the answer is when the rows actually disappear. By the
+     * moment it returns the organization is already gone from every surface; what
+     * remains is retention until that time.
+     */
+    deleteOrg(org: string, confirm: string): Promise<Ok<"deleteOrg">>;
+    createOrg(slug: string, name: string): Promise<Ok<"createOrg">>;
+    /**
+     * The organization's recent notifications (docs/limits.md §3.4).
+     *
+     * A row with no `sentAt` is either still queued or has no email address to
+     * reach — and for the second, this list is the only channel, so the screen
+     * draws both states the same way.
+     */
+    listNotifications(org: string, limit?: number): Promise<Ok<"listNotifications">>;
+    /**
+     * The plan and billing state (docs/billing.md). If `enabled` is false, this
+     * deployment has no billing — the screen shows only a contact address.
+     */
+    getBilling(org: string): Promise<Ok<"getBilling">>;
+    /**
+     * A Pro checkout session. Send the browser to the `url` that comes back. Even
+     * once payment finishes, the thing that changes the plan is the webhook, so
+     * read `getBilling` again after the browser returns.
+     */
+    createBillingCheckout(org: string, returnTo: string): Promise<Ok<"createBillingCheckout">>;
+    /** A one-time `url` for the customer portal (payment method, receipts, cancellation). */
+    createBillingPortal(org: string, returnTo: string): Promise<Ok<"createBillingPortal">>;
+    /** The customer session token for the payment-method embed (1 hour). An org with no payment history gets a 404. */
+    createBillingSession(org: string): Promise<Ok<"createBillingSession">>;
+    /** Schedules cancellation at the end of the period (`cancel: true`), or undoes it. There is no immediate revocation. */
+    cancelBilling(org: string, body: {
+        cancel: boolean;
+        reason?: string;
+        comment?: string;
+    }): Promise<Ok<"cancelBilling">>;
+    listProjects(org: string): Promise<Ok<"listProjects">>;
+    createProject(org: string, name: string): Promise<Ok<"createProject">>;
+    getProject(org: string, name: string): Promise<Ok<"getProject">>;
+    /**
+     * Renames the project (admin). **The default address moves with it and there is
+     * no alias** — which is why the response carries the new address. Unlike the
+     * org slug, this name can change because it is the inner label of the org
+     * wildcard certificate.
+     */
+    updateProject(org: string, name: string, next: string): Promise<Ok<"updateProject">>;
+    /**
+     * Starts tearing the project down (admin). **This cannot be undone and leaves
+     * no recovery generation.** `confirm` has to be the project name exactly.
+     */
+    deleteProject(org: string, name: string, confirm: string): Promise<Ok<"deleteProject">>;
+    /**
+     * Disables a project (admin): it stops serving and taking new backups, and
+     * keeps everything it has. A project disabled for a year is deleted for good.
+     */
+    disableProject(org: string, name: string): Promise<Ok<"disableProject">>;
+    /** Enables a disabled project (admin). 409 `project_limit` when there is no room for it. */
+    enableProject(org: string, name: string): Promise<Ok<"enableProject">>;
+    /** Watches the teardown operation to its end even after the project is gone. */
+    getOrgOperation(org: string, opId: string): Promise<Ok<"getOrgOperation">>;
+    /** Everything the project's first screen takes in one call. Usage calls `getUsage` alongside it. */
+    getProjectOverview(org: string, name: string): Promise<Ok<"getProjectOverview">>;
+    listDeployments(org: string, name: string): Promise<Ok<"listDeployments">>;
+    /**
+     * One deployment, with `migrations` when the control plane applied its
+     * `migrations/` — which today means a preview deployed with `db=branch`
+     * (docs/studio.md §6.6 step 2).
+     *
+     * A preview's deployment is read under **the parent project's name**, the name
+     * the caller deployed through: the preview is a project of its own, but the
+     * caller never learns its name.
+     */
+    getDeployment(org: string, name: string, deploymentId: string): Promise<Ok<"getDeployment">>;
+    /**
+     * Scheduled runs: what the live deployment declares, when each fires next, and
+     * the recent history (docs/cron.md §8). `limit` bounds the history rows only —
+     * the schedules and the per-schedule last run are never paged.
+     */
+    getProjectCron(org: string, name: string, limit?: number): Promise<Ok<"getProjectCron">>;
+    /**
+     * Queues: what the live deployment declares, how deep each one is, and the
+     * recent batch history (docs/queues.md §6). The depth is read from the
+     * project's own database; `depthError` on the answer says when it could not be.
+     */
+    getProjectQueues(org: string, name: string, limit?: number): Promise<Ok<"getProjectQueues">>;
+    /**
+     * Durable Objects: how many this project has placed, against the two caps
+     * (docs/durable-objects.md).
+     *
+     * **It answers how much, never which.** There is no actor id in the response
+     * and none is coming — those name individual objects, and a list of them would
+     * be an object enumeration wearing a quota's name. `nodes` is keyed by node id
+     * because `nodeLimit` is a separate bound that can refuse a placement while
+     * the project-wide cap still has room.
+     */
+    getProjectDurableObjects(org: string, name: string): Promise<Ok<"getProjectDurableObjects">>;
+    private queuePath;
+    listQueueRuns(org: string, name: string, queue: string, limit?: number): Promise<Ok<"listQueueRuns">>;
+    /** The head of the queue without leasing it — looking cannot delay a delivery. */
+    peekQueue(org: string, name: string, queue: string, limit?: number): Promise<Ok<"peekQueue">>;
+    /** Irreversible. The confirmation is the caller's — the server holds none. */
+    purgeQueue(org: string, name: string, queue: string): Promise<Ok<"purgeQueue">>;
+    /**
+     * Moves a dead-letter queue's messages back. `to` is required only when the
+     * dead-letter queue belongs to more than one consumer, or to none.
+     */
+    redriveQueue(org: string, name: string, queue: string, to?: string): Promise<Ok<"redriveQueue">>;
+    /**
+     * The vector store: every namespace with its count and width, and the plan's
+     * bounds (docs/vectors.md §4). Read from the project's own database;
+     * `readError` on the answer says when it could not be.
+     */
+    getProjectVectors(org: string, name: string): Promise<Ok<"getProjectVectors">>;
+    /** Irreversible. The confirmation is the caller's — the server holds none. */
+    deleteVectorNamespace(org: string, name: string, namespace: string): Promise<Ok<"deleteVectorNamespace">>;
+    /** The body is the bundle. One digest covers all of the code and the assets. */
+    /**
+     * Uploads the bundle. `headers` carries the provenance headers
+     * (`X-Runlot-Git-*`, openapi createDeployment) — the body is the bundle
+     * itself, so the metadata can only travel in headers.
+     */
+    deploy(org: string, name: string, bundle: Uint8Array, headers?: Record<string, string>): Promise<Ok<"createDeployment">>;
+    /**
+     * The same upload, aimed at a preview (docs/preview.md). **It does not move
+     * production's live pointer** — that is the whole difference, and it is why
+     * this is a named method rather than an optional argument on `deploy`: a
+     * caller that forgets the argument deploys to production.
+     *
+     * `db` picks what `env.db` points at (`branch` by default, `shared` at
+     * production's own database, `none` for no database), and `from` pours the
+     * branch from a named generation instead of the newest one.
+     */
+    deployPreview(org: string, name: string, bundle: Uint8Array, opts: {
+        preview: string;
+        db?: string | undefined;
+        from?: string | undefined;
+    }, headers?: Record<string, string>): Promise<DeployedPreview>;
+    /** The parent's live previews (viewer). A deleted preview is not listed. */
+    listPreviews(org: string, name: string): Promise<Ok<"listPreviews">>;
+    /**
+     * Deletes a preview and its branch (member).
+     *
+     * No confirmation string, unlike `deleteProject`: a branch is a copy taken at a
+     * moment and nothing in it is the only copy of anything.
+     */
+    deletePreview(org: string, name: string, preview: string): Promise<void>;
+    /**
+     * Makes the preview's artifact the parent's live deployment (member).
+     *
+     * **The code, never the data** (docs/preview.md §7). The branch is not merged
+     * and production's database is not replaced. The preview stays alive.
+     */
+    promotePreview(org: string, name: string, preview: string): Promise<Ok<"promotePreview">>;
+    /**
+     * The project's share link — `<label>.share.<app-domain>`, the one address
+     * Studio hands to somebody who is not a developer (docs/studio.md §6.9).
+     *
+     * 404 when the project has never been shared: a link is minted by
+     * `putShareLink`, never as a side effect of reading.
+     */
+    getShareLink(org: string, name: string): Promise<Ok<"getShareLink">>;
+    /**
+     * Points the share link at a preview, minting the label if there is none.
+     *
+     * Idempotent: the label is kept across shares, so somebody holding the link
+     * keeps working. `rotate` mints a new label and retires the old name in the
+     * same request ("링크 재발급"), so the project never has two live links.
+     */
+    putShareLink(org: string, name: string, opts?: {
+        preview?: string;
+        rotate?: boolean;
+    }): Promise<Ok<"putShareLink">>;
+    /** Stops the link answering and forgets the label. The preview keeps running. */
+    deleteShareLink(org: string, name: string): Promise<void>;
+    /** Idempotent. Called twice, the password is not rolled and the same connection details come back. */
+    createDatabase(org: string, name: string): Promise<Ok<"createDatabase">>;
+    getDatabase(org: string, name: string): Promise<Ok<"getDatabase">>;
+    /**
+     * The connection credentials as well. The route is split from `getDatabase`
+     * because of roles — a viewer may know whether there is a database, but not
+     * the password (proto/openapi.yaml).
+     */
+    getDatabaseConnect(org: string, name: string): Promise<Ok<"getDatabaseConnect">>;
+    /** The endpoint only — no credentials. A viewer gets it too. Used by `runlot port-forward`. */
+    getDatabaseEndpoint(org: string, name: string): Promise<Ok<"getDatabaseEndpoint">>;
+    /** Issues a short-lived machine credential. The password is carried in this response and nowhere else. */
+    createDatabaseToken(org: string, name: string, ttlSeconds?: number): Promise<Ok<"createDatabaseToken">>;
+    listDatabaseTokens(org: string, name: string): Promise<Ok<"listDatabaseTokens">>;
+    deleteDatabaseToken(org: string, name: string, user: string): Promise<void>;
+    /**
+     * Makes one diagnostic image.
+     *
+     * **Not idempotent** — every call makes another image. And it is slow: the
+     * response comes after the dump finishes, and that project's actor is held
+     * for the whole of it (proto/openapi.yaml).
+     */
+    exportDatabase(org: string, name: string): Promise<Ok<"exportDatabase">>;
+    /**
+     * Every generation a restore can choose, newest first. `lastCheckedAt` is the
+     * heartbeat of the no-change skip — it is what tells "no new generations"
+     * apart from "the backup is dead".
+     */
+    listGenerations(org: string, name: string): Promise<Ok<"listGenerations">>;
+    /**
+     * Runs one statement in the project's database (the dashboard console).
+     *
+     * `readOnly` is **omitted, not sent as false**, when the caller wants the safe
+     * mode: the server treats an absent field as read-only, so leaving it out is the
+     * one spelling that cannot be misread. Sending `false` is the explicit ask for
+     * write mode, and only then does the server run outside a transaction.
+     *
+     * SQL failures arrive as an `ApiError` whose body carries `details.sqlstate` —
+     * PostgreSQL's own code, which is what the error panel shows.
+     */
+    executeSQL(org: string, name: string, sql: string, opts?: {
+        readOnly?: boolean;
+        params?: unknown[];
+    }): Promise<Ok<"executeSQL">>;
+    /**
+     * Rolls back to a generation. **Writes made since then are lost.**
+     *
+     * It ends at 202 — what comes back is an operation id, and progress is read
+     * through `getDatabaseOperation`. The server does not resolve `latest`: the
+     * `(epoch, seq)` chosen from the list is carried as-is (proto/openapi.yaml).
+     */
+    restoreDatabase(org: string, name: string, epoch: number, seq: number): Promise<Ok<"restoreDatabase">>;
+    /**
+     * Rolls back to a restore point **inside** a backup (pg-feather docs/37):
+     * `txnId` is that commit, `at` is the last commit at or before that time. One
+     * backup carries the commits in between in order, so the place you can roll
+     * back to is not tied to a backup boundary. Everything else is as in
+     * restoreDatabase — 202, an operation id, and one safety backup before the
+     * rollback.
+     */
+    restoreDatabaseTo(org: string, name: string, target: {
+        txnId: number;
+    } | {
+        at: string;
+    }): Promise<Ok<"restoreDatabase">>;
+    /**
+     * Removes the database. `confirm` has to match the project name **exactly**;
+     * if it does not, the server refuses with 400 `confirm_mismatch`.
+     */
+    deleteDatabase(org: string, name: string, confirm: string): Promise<Ok<"deleteDatabase">>;
+    /** The progress of one operation. The operation id is not a credential; it lives under the project path. */
+    getDatabaseOperation(org: string, name: string, opId: string): Promise<Ok<"getDatabaseOperation">>;
+    /** Aborts an operation that has not yet reached a phase it cannot come back from. */
+    abortDatabaseOperation(org: string, name: string, opId: string): Promise<Ok<"abortDatabaseOperation">>;
+    /**
+     * A live tail of the logs. It is **a stream, not JSON**, so it does not go
+     * through `request` — what comes back is an async iterable of line-by-line
+     * `LogEvent`, and aborting `signal` closes the connection. An error response
+     * (4xx/5xx) is the same `ApiError` as in every other method.
+     */
+    tailLogs(org: string, name: string, opts?: {
+        tail?: number;
+        follow?: boolean;
+        signal?: AbortSignal;
+    }): AsyncGenerator<LogEvent, void, undefined>;
+    /**
+     * The stored lane (0062). It is a plain JSON page, not a stream: the history
+     * does not reach a node, so it answers for a project that is cold, parked, or
+     * has moved since the lines were written — every one of which is a 409 on
+     * `tailLogs`.
+     *
+     * `q` is a plain substring, matched case-insensitively. It is not a regular
+     * expression — `%` and `_` match themselves.
+     *
+     * Paging is keyset: pass the `cursor` from a page back to get the next, older
+     * one. A page with no `cursor` is the end of what is kept.
+     */
+    getLogHistory(org: string, name: string, opts?: {
+        since?: string | undefined;
+        until?: string | undefined;
+        q?: string | undefined;
+        stream?: "stdout" | "stderr" | "runlot" | undefined;
+        limit?: number | undefined;
+        cursor?: string | undefined;
+    }): Promise<LogHistoryPage>;
+    listSecrets(org: string, name: string): Promise<Ok<"listSecrets">>;
+    /** The value travels in this call only. It is in no response at all. */
+    setSecret(org: string, name: string, secret: string, value: string): Promise<Ok<"setSecret">>;
+    deleteSecret(org: string, name: string, secret: string): Promise<void>;
+    getUsage(org: string, name: string, hours?: number): Promise<Ok<"getUsage">>;
+    /** Grant, prefix, quota, usage. `usedBytes` lags by the node's reporting interval. */
+    getStorage(org: string, name: string): Promise<Ok<"getStorage">>;
+    /**
+     * Grants storage. It is idempotent, so pressing twice leaves the prefix as it
+     * was. Taking neither the prefix nor the quota as an argument is the point —
+     * the prefix is the isolation boundary and the quota is set by the plan
+     * (proto/openapi.yaml).
+     */
+    grantStorage(org: string, name: string): Promise<Ok<"grantStorage">>;
+    /** Removes the grant. **The objects are not deleted** (docs/storage.md §7). */
+    revokeStorage(org: string, name: string): Promise<void>;
+    /**
+     * The key prefixes this project serves unsigned (docs/storage.md §4.7).
+     *
+     * A prefix is stored normalized — `assets` becomes `assets/`, and `/` becomes
+     * the empty string, which means every key. The value that comes back is the
+     * value that governs, so a screen must render the response rather than what
+     * the user typed.
+     */
+    listStoragePublic(org: string, name: string): Promise<Ok<"listStoragePublic">>;
+    /** Publishes a prefix. Idempotent. All three verbs answer with the whole list. */
+    addStoragePublic(org: string, name: string, prefix: string): Promise<Ok<"addStoragePublic">>;
+    /**
+     * Unpublishes a prefix. Idempotent.
+     *
+     * **The world keeps reading for up to a minute.** The object front caches the
+     * list, so this call is not a revocation that takes effect at the instant it
+     * returns — a screen that says "no longer public" the moment this resolves is
+     * telling a small lie.
+     */
+    removeStoragePublic(org: string, name: string, prefix: string): Promise<Ok<"removeStoragePublic">>;
+    /** Grant, address, sender, limits, recent counts. The address comes back as a preview even without a grant. */
+    getEmail(org: string, name: string): Promise<Ok<"getEmail">>;
+    /** Turns it on. **Idempotent** — we choose the address. The deploy reads `"email": true` and calls this. */
+    grantEmail(org: string, name: string): Promise<Ok<"grantEmail">>;
+    /** Turns it off. Mail arriving at that address now gets a 550. */
+    revokeEmail(org: string, name: string): Promise<void>;
+    /** The project's own sending domains, each with the records to publish. */
+    listEmailDomains(org: string, name: string): Promise<Ok<"listEmailDomains">>;
+    /**
+     * Creates the provider identity and answers with the records to publish.
+     * `publish` writes them into the zone when we host one covering the domain.
+     */
+    addEmailDomain(org: string, name: string, domain: string, publish?: boolean): Promise<Ok<"addEmailDomain">>;
+    /** Re-checks now. The background loop does the same once a minute while pending. */
+    verifyEmailDomain(org: string, name: string, domain: string): Promise<Ok<"verifyEmailDomain">>;
+    /** Deletes the identity and the row. Sending from it is refused from the next convergence. */
+    removeEmailDomain(org: string, name: string, domain: string): Promise<void>;
+    /**
+     * The model catalogue. **Being logged in is enough to see it** — what you can
+     * buy is not an organization's secret, and this list is the price table.
+     *
+     * Prices are integer **micro-cents** per million tokens (1 µ¢ = 1e-8 USD).
+     * Not letting the server pick the decimal place is the point — a small call
+     * rounded to cents becomes 0.
+     */
+    listAIModels(): Promise<Ok<"listAIModels">>;
+    /** Grant, limits, the org balance, 24 h usage. The limits come back as a preview even without a grant. */
+    getAI(org: string, name: string): Promise<Ok<"getAI">>;
+    /** Turns it on. **Idempotent.** The deploy reads `"ai": true` and calls this. */
+    grantAI(org: string, name: string): Promise<Ok<"grantAI">>;
+    /** Turns it off. **The ledger and the balance are untouched** — the balance belongs to the org and the grant belongs to the project. */
+    revokeAI(org: string, name: string): Promise<void>;
+    /** The org's credit balance and its automatic top-up settings. The balance is in micro-cents and can be negative. */
+    getAICredit(org: string): Promise<Ok<"getAICredit">>;
+    /** One page of the org ledger. The cursor is `ledger_id` — cutting on time splits the same millisecond. */
+    listAILedger(org: string, opts?: {
+        limit?: number;
+        before?: number;
+    }): Promise<Ok<"listAILedger">>;
+    /**
+     * The credit top-up checkout. **A browser coming back is not evidence** — the
+     * one thing that raises the balance is the `order.paid` webhook, and the
+     * screen polls the balance after the success event.
+     */
+    createAICreditCheckout(org: string, microCents: number, returnTo: string): Promise<Ok<"createAICreditCheckout">>;
+    /**
+     * Turns automatic top-up on or off. **Turning it on is explicit consent**
+     * (docs/ai.md §3.5) — the screen shows the charging terms verbatim and calls
+     * this only after the box is checked.
+     */
+    setAIAutoTopup(org: string, body: {
+        enabled: boolean;
+        belowMicroCents?: number;
+        microCents?: number;
+    }): Promise<Ok<"setAIAutoTopup"> | void>;
+    /** One page of the mail log (docs/email.md §6.1). Newest first, cursor-paged. */
+    listMailLog(org: string, name: string, opts?: {
+        direction?: "in" | "out";
+        cursor?: string;
+        limit?: number;
+    }): Promise<Ok<"listMailLog">>;
+    /** The metadata of one message. */
+    getMailLog(org: string, name: string, mailId: string): Promise<Ok<"getMailLog">>;
+    /** The URL of the raw message — the screen uses it as a download link (.eml). */
+    mailLogRawURL(org: string, name: string, mailId: string): string;
+    /** The raw text. What the detail view draws the headers and body from. */
+    getMailLogRaw(org: string, name: string, mailId: string): Promise<string>;
+    /**
+     * Grant, settings, providers, hosts. **The signed-up users do not come** —
+     * that table is inside the project DB (docs/auth.md §6) and only the worker's
+     * `env.auth` sees it.
+     *
+     * `providers` carries the client id only. The client secret is sealed and
+     * appears in no response.
+     */
+    getAuth(org: string, name: string): Promise<Ok<"getAuth">>;
+    /**
+     * Turns auth on (member). Idempotent.
+     *
+     * **With no database it is 409 `database_required`** — the user table lives
+     * inside the project DB, so standing up the grant alone leaves no table the
+     * moment the worker starts. The caller catches that code and points at the
+     * `"database": true` declaration — the deploy never sees this code, because
+     * its ordering rules it out.
+     */
+    grantAuth(org: string, name: string): Promise<Ok<"grantAuth">>;
+    /**
+     * Changes the settings (member). **A partial update** — only the fields given
+     * change. Sending the whole thing on one switch means that when two people
+     * touch the same card, the later save overwrites the earlier one. With no
+     * grant it is 404 `not_granted`.
+     */
+    updateAuthSettings(org: string, name: string, settings: AuthSettingsInput): Promise<Ok<"updateAuthSettings">>;
+    /**
+     * Turns auth off (admin). **The signed-up users are not deleted** — the
+     * `runlot_auth` tables stay in the project DB, and turning it back on lets the
+     * same people log in unchanged.
+     */
+    revokeAuth(org: string, name: string): Promise<void>;
+    /**
+     * Registers or replaces a social provider (admin). It is the same PUT, so it
+     * is idempotent.
+     *
+     * **`clientSecret` cannot be read back.** The callback URL is
+     * `https://<host>/__runlot/auth/callback/<provider>` for each host, and the
+     * list of hosts is in the response's `hosts`.
+     */
+    setAuthProvider(org: string, name: string, provider: AuthProvider, clientId: string, clientSecret: string): Promise<Ok<"setAuthProvider">>;
+    /**
+     * Removes a provider (admin). Someone who signed up only through that provider
+     * loses their way in, but the user row stays — register it again and they come
+     * back to the same account.
+     */
+    deleteAuthProvider(org: string, name: string, provider: AuthProvider): Promise<void>;
+    /**
+     * Who can reach this deployment. **No values** — both the password and the
+     * bypass secret live only as hashes, and what comes back here is the fact that
+     * there is one: `hasPassword` and `hasBypass`.
+     *
+     * A project that has never set a policy is `mode: "public"` with no
+     * `updatedAt`. The screen tells those two apart for the reason in §7 — a
+     * sentence about the state instead of an empty state.
+     */
+    getAccess(org: string, name: string): Promise<Ok<"getAccess">>;
+    /**
+     * Changes the policy (admin). Without a `password`, **the existing password
+     * stays** — if a save that only changes the mode wiped the password, coming
+     * back to that mode would mean setting it again.
+     */
+    setAccess(org: string, name: string, mode: AccessMode, password?: string): Promise<Ok<"setAccess">>;
+    /**
+     * Makes a bypass secret for automation (admin). **The value is in this answer
+     * and nowhere else** — the screen shows it once on arrival and can never fetch
+     * it again. Calling again kills the old value.
+     */
+    newAccessBypass(org: string, name: string): Promise<Ok<"newAccessBypass">>;
+    /** Removes the bypass (admin). Removing one that does not exist also succeeds. */
+    revokeAccessBypass(org: string, name: string): Promise<void>;
+    /**
+     * Gets a one-time address back into a protected deployment (docs/access.md §3.4-3).
+     *
+     * It is **not** under the project path: all the calling screen knows is the
+     * hostname (the original request went there), and the server derives the org
+     * and project names from it. Doing `location.replace` with the `redirect` that
+     * comes back is the caller's job.
+     */
+    authorizeAccess(to: string, next?: string): Promise<Ok<"authorizeAccess">>;
+    listMembers(org: string): Promise<Ok<"listMembers">>;
+    /** This is not an invite — the user must already have logged in once (404 `user_not_found`). */
+    addMember(org: string, provider: "dev" | "github", subject: string, role: Role): Promise<Ok<"addMember">>;
+    setMemberRole(org: string, userId: string, role: Role): Promise<Ok<"setMemberRole">>;
+    /**
+     * Removing someone else is admin; **removing yourself is leaving**, which
+     * anyone can do (docs/members.md). The last admin can do neither
+     * (409 `last_admin`).
+     */
+    removeMember(org: string, userId: string): Promise<void>;
+    /** Pending and expired invites (admin). Accepted and revoked ones are history, so they do not come. */
+    listInvites(org: string): Promise<Ok<"listInvites">>;
+    /**
+     * Invites by email (admin). **Calling again with the same address is a
+     * resend** — the same row is updated rather than a new one created, and the
+     * server gives 200 instead of 201.
+     */
+    createInvite(org: string, email: string, role: Role): Promise<Ok<"createInvite">>;
+    /** Revokes an invite (admin). Mail that has not gone out yet does not go out. */
+    revokeInvite(org: string, inviteId: string): Promise<void>;
+    /**
+     * A preview of the invite. **No session needed** — whoever got the link has
+     * not logged in yet, and they need to know what they are accepting before
+     * they do.
+     */
+    getInvite(token: string): Promise<Ok<"getInvite">>;
+    /** Accepts (login required). If they are already a member the role does not change. */
+    acceptInvite(token: string): Promise<Ok<"acceptInvite">>;
+    /** The default hostname and the custom domains come together (viewer). */
+    listHostnames(org: string, name: string): Promise<Ok<"listHostnames">>;
+    /**
+     * Attaches a custom domain (member).
+     *
+     * Idempotent — sending the same name again returns the existing row
+     * unchanged. The response's `verify` is the CNAME and TXT the customer has to
+     * add.
+     */
+    addHostname(org: string, name: string, hostname: string): Promise<Ok<"addHostname">>;
+    /** Runs the same check the background verifier makes, right now (member). */
+    verifyHostname(org: string, name: string, host: string): Promise<Ok<"verifyHostname">>;
+    /** Detaches a custom domain (member). The default hostname gives a 400. */
+    deleteHostname(org: string, name: string, host: string): Promise<void>;
+    /** The organization's zones. No `rrsets` — those ride only on a single-zone lookup. */
+    listZones(org: string): Promise<Ok<"listZones">>;
+    /** Idempotent. A zone that already exists comes back unchanged. */
+    createZone(org: string, name: string): Promise<Ok<"createZone">>;
+    getZone(org: string, zone: string): Promise<Ok<"getZone">>;
+    deleteZone(org: string, zone: string): Promise<void>;
+    /**
+     * Replaces one rrset **whole**. `records` is the complete new set for that
+     * (name, type), so adding a single value means sending the current ones with
+     * it.
+     */
+    putRRset(org: string, zone: string, name: string, type: RRsetType, ttl: number, records: string[]): Promise<Ok<"putRRset">>;
+    deleteRRset(org: string, zone: string, name: string, type: RRsetType): Promise<void>;
+    setZoneDNSSEC(org: string, zone: string, enabled: boolean): Promise<Ok<"setZoneDNSSEC">>;
+    setZoneDS(org: string, zone: string, ds: string[]): Promise<Ok<"setZoneDS">>;
+    /** The shared prefix of the DNS surface. */
+    private dnsPath;
+    /** Both `@` and `*` arrive as a name. Keeps the same string out of four places. */
+    private rrsetPath;
+    /**
+     * Looks a name up (member or above).
+     *
+     * `priceCents` is the first year of registration; `renewalCents` is one year
+     * of renewal. They are separate because a first-year discount is common —
+     * folded into one, the screen cannot say "buy it for $1, then $15 next year".
+     */
+    checkDomains(org: string, names: string[]): Promise<Ok<"checkDomains">>;
+    /**
+     * Buys a domain (admin — this spends money).
+     *
+     * **The ICANN verification mail goes to `contact.email`.** The screen has to
+     * say so before the purchase (docs/domains.md §5.5).
+     *
+     * Sending the same request again is safe — a finished domain comes back
+     * unchanged, and a purchase that stopped part way resumes from where it
+     * stopped.
+     */
+    purchaseDomain(org: string, body: {
+        name: string;
+        years?: number;
+        contact: DomainContact;
+        projectId?: string;
+    }): Promise<Ok<"purchaseDomain">>;
+    /** Imports a domain you already own (admin). Creates the zone only; the registrar is not called. */
+    importDomain(org: string, name: string): Promise<Ok<"importDomain">>;
+    listDomains(org: string): Promise<Ok<"listDomains">>;
+    getDomain(org: string, name: string): Promise<Ok<"getDomain">>;
+    renewDomain(org: string, name: string, years: number): Promise<Ok<"renewDomain">>;
+    /**
+     * Changes only the **intent** to auto-renew.
+     *
+     * Auto-renew at the registrar stays on — a domain is an asset you lose if you
+     * are a day late, so we renew first and bill afterwards. The screen has to say
+     * this alongside.
+     */
+    setDomainAutoRenew(org: string, name: string, enabled: boolean): Promise<Ok<"setDomainAutoRenew">>;
+    setDomainLock(org: string, name: string, locked: boolean): Promise<Ok<"setDomainLock">>;
+    /** The transfer auth code. The audit records that one was issued and **not the code itself**. */
+    domainAuthCode(org: string, name: string): Promise<Ok<"getDomainAuthCode">>;
+    /** Re-reads from the registrar right now (member). */
+    syncDomain(org: string, name: string): Promise<Ok<"syncDomain">>;
+    /** The shared prefix of the domain surface. Keeps the same string out of ten places. */
+    private domainsPath;
+    private domainPath;
+    /** The shared prefix of the project surface. */
+    private projectPath;
+    /** The shared prefix of the database surface. Keeps the same string out of five places. */
+    private dbPath;
+    listRepos(org: string, project: string): Promise<Ok<"listRepos">>;
+    createRepo(org: string, project: string, body: {
+        name: string;
+        visibility?: RepoVisibility | undefined;
+        defaultBranch?: string | undefined;
+    }): Promise<Ok<"createRepo">>;
+    getRepo(org: string, project: string, name: string): Promise<Ok<"getRepo">>;
+    updateRepo(org: string, project: string, name: string, body: {
+        name?: string | undefined;
+        visibility?: RepoVisibility | undefined;
+        defaultBranch?: string | undefined;
+    }): Promise<void>;
+    deleteRepo(org: string, project: string, name: string): Promise<void>;
+    /** The ref history. The lead for recovering a commit lost to a force-push is here. */
+    listRefUpdates(org: string, project: string, name: string): Promise<Ok<"listRefUpdates">>;
+    getDeployHook(org: string, project: string, name: string): Promise<Ok<"getDeployHook">>;
+    setDeployHook(org: string, project: string, name: string, body: {
+        enabled?: boolean | undefined;
+        branch?: string | undefined;
+        rootDir?: string | undefined;
+    }): Promise<Ok<"setDeployHook">>;
+    deleteDeployHook(org: string, project: string, name: string): Promise<void>;
+    /** Build a commit without pushing. Omit `commitSha` for the hooked branch's tip. */
+    deployRepoNow(org: string, project: string, name: string, commitSha?: string): Promise<Ok<"deployRepoNow">>;
+    listBuilds(org: string, project: string, limit?: number): Promise<Ok<"listBuilds">>;
+    getBuild(org: string, project: string, buildId: string): Promise<Ok<"getBuild">>;
+    /**
+     * A build's output. It comes back as **text**, not JSON — see the endpoint's
+     * description. `json()` would try to parse it and fail on the first line.
+     */
+    getBuildLog(org: string, project: string, buildId: string): Promise<string>;
+    cancelBuild(org: string, project: string, buildId: string): Promise<void>;
+    listSSHKeys(): Promise<Ok<"listSSHKeys">>;
+    addSSHKey(publicKey: string, name?: string): Promise<Ok<"addSSHKey">>;
+    deleteSSHKey(keyId: string): Promise<void>;
+    listAccessTokens(): Promise<Ok<"listAccessTokens">>;
+    /** The plaintext is carried in this response **once** and never again. */
+    createAccessToken(body: {
+        name: string;
+        /** 0032's single-valued field. `scopes` is the one to send. */
+        scope?: TokenScope | undefined;
+        scopes?: readonly ApiScope[] | undefined;
+        /** Restrict the token to one org, and optionally to one project inside it. */
+        org?: string | undefined;
+        project?: string | undefined;
+        ttlHours?: number | undefined;
+        /** Days until expiry. The server defaults to 90 and refuses more than 365. */
+        expiresInDays?: number | undefined;
+        noExpiry?: boolean | undefined;
+    }): Promise<Ok<"createAccessToken">>;
+    revokeAccessToken(tokenId: string): Promise<void>;
+    getRepoRefs(org: string, project: string, name: string): Promise<Ok<"getRepoRefs">>;
+    getRepoTree(org: string, project: string, name: string, ref?: string, path?: string): Promise<Ok<"getRepoTree">>;
+    getRepoBlob(org: string, project: string, name: string, ref?: string, path?: string): Promise<Ok<"getRepoBlob">>;
+    getRepoCommits(org: string, project: string, name: string, ref?: string, limit?: number): Promise<Ok<"getRepoCommits">>;
+    /** The shared prefix of the repository surface. It sits under the project (§19). */
+    private repoPath;
+    rollback(org: string, name: string, version: number): Promise<Ok<"rollback">>;
+}
+//# sourceMappingURL=index.d.ts.map