@promigence/sdk 0.1.0-beta.14 → 0.1.0-beta.15

package/dist/cjs/models.gen.d.ts

@@ -113,6 +113,108 @@ export interface AutoPauseSet {
     ok: boolean;
     sandbox_id: string;
 }
+/**
+ * Auto-reload: when available credits fall below `threshold_usd`, `amount_usd` is charged to
+ * `card` and added as credits.
+ */
+export interface AutoReload {
+    /**
+     * What each reload adds, whole USD.
+     */
+    amount_usd: number;
+    /**
+     * What turning auto-reload on asks the owner to accept.
+     */
+    authorization: AutoReloadAuthorization;
+    /**
+     * The payment method a reload charges.
+     */
+    card?: CardOnFile | null;
+    /**
+     * The latest reload; `null` before the first.
+     */
+    last?: AutoReloadLast | null;
+    /**
+     * Whether auto-reload is on.
+     */
+    on: boolean;
+    /**
+     * Why auto-reload is paused, or `null`: `declined`, `authentication_required`, `daily_limit`,
+     * `disputed`, `amount_over_limit` or `support`.
+     */
+    paused_reason?: string | null;
+    /**
+     * With `paused_reason` `daily_limit`, which limit of the day it reached: `count` (the most
+     * auto-reloads in a day) or `amount` (the most purchases and reloads can add in a day); `null`
+     * otherwise.
+     */
+    paused_why?: string | null;
+    /**
+     * The level that starts a reload, whole USD.
+     */
+    threshold_usd: number;
+    /**
+     * Why auto-reload cannot be turned on for this payment method, or `null`: `card_country`.
+     */
+    unavailable_reason?: string | null;
+}
+/**
+ * The authorization an owner accepts to turn auto-reload on.
+ */
+export interface AutoReloadAuthorization {
+    /**
+     * Its words, with `{card}`, `{amount}`, `{threshold}`, `{n}` and `{day_max}` to fill in.
+     */
+    template: string;
+    /**
+     * Its version: turning auto-reload on sends it back, to say which words were accepted.
+     */
+    version: string;
+}
+/**
+ * The latest auto-reload.
+ */
+export interface AutoReloadLast {
+    /**
+     * USD.
+     */
+    amount_usd: number;
+    /**
+     * When it was charged, RFC 3339.
+     */
+    at: string;
+    /**
+     * While it is unpaid, the page to pay it.
+     */
+    pay_url?: string | null;
+    /**
+     * `pending`, `paid`, `needs_action` (the bank asks you to confirm it) or `failed`.
+     */
+    state: string;
+}
+/**
+ * `PUT /v1/billing/auto-reload`.
+ */
+export interface AutoReloadSet {
+    /**
+     * What each reload adds, whole USD; omitted: unchanged.
+     */
+    amount_usd?: number | null;
+    /**
+     * The version of the authorization the owner accepted (`auto_reload.authorization.version` of
+     * `GET /v1/billing`). Needed to turn auto-reload on, or to change the level, the amount or the
+     * card.
+     */
+    authorization_version?: string | null;
+    /**
+     * Whether auto-reload is on.
+     */
+    on: boolean;
+    /**
+     * The level that starts a reload, whole USD; omitted: unchanged.
+     */
+    threshold_usd?: number | null;
+}
 /**
  * A background command, as `GET /v1/sandboxes/{id}/execs/{exec_id}` reports it, and as the
  * `202` from `POST /v1/sandboxes/{id}/execs` with `background: true` hands it over.
@@ -243,6 +345,37 @@ export interface BackgroundExecList {
     execs: Array<BackgroundExec>;
     sandbox_id: string;
 }
+/**
+ * What the organization's credits can pay for.
+ */
+export interface BillingCredits {
+    /**
+     * What new work can use: the balance less what is held, never below 0, USD.
+     */
+    available_usd: number;
+    /**
+     * Credits on the account, USD.
+     */
+    balance_usd: number;
+    /**
+     * Available credits cannot start new work.
+     */
+    exhausted: boolean;
+    /**
+     * Of the balance, what running and paused work may still use, plus data out sent and not yet
+     * charged and, once storage is priced, the next 7 days of storage, USD.
+     */
+    held_usd: number;
+    /**
+     * Available credits are below the low-balance level.
+     */
+    low: boolean;
+    /**
+     * The credits that expire next: how much and when; `null` when none expire in the next 30
+     * days.
+     */
+    next_expiry?: CreditsExpiry | null;
+}
 /**
  * `GET /v1/billing/history` — your billing history, newest first: every credit you received and
  * every payment, one page at a time.
@@ -273,6 +406,32 @@ export interface BillingHistoryEntry {
      */
     payment?: Payment | null;
 }
+/**
+ * A hold that refuses new work.
+ */
+export interface BillingHold {
+    /**
+     * The disputed payment, or the unpaid invoice, USD.
+     */
+    amount_usd: number;
+    /**
+     * The disputed payment's id, for `POST /v1/billing/disputes/{dispute_id}/repay`; `null` for an
+     * invoice.
+     */
+    dispute_id?: string | null;
+    /**
+     * `dispute_open`, `dispute_lost`, `pre_move_unpaid` or `invoice_unpaid`.
+     */
+    kind: string;
+    /**
+     * Why, in words.
+     */
+    reason: string;
+    /**
+     * The page that lifts it: the invoice's page to pay it; `null` for a disputed payment.
+     */
+    url?: string | null;
+}
 /**
  * The billing period `usage` covers.
  */
@@ -291,11 +450,16 @@ export interface BillingPeriod {
     start: string;
 }
 /**
- * `GET /v1/billing` — plan, card on file, this month's usage, and the upcoming invoice preview.
- * Never fails because the payment provider is slow: the estimate is the only part that asks it,
- * and its failure is a field, not a status.
+ * `GET /v1/billing` — plan, credits, auto-reload, card on file, this month's usage, and the next
+ * plan invoice. Never fails because the payment provider is slow: the estimate is the only part
+ * that asks it, and its failure is a field, not a status.
  */
 export interface BillingStatus {
+    /**
+     * Auto-reload: when available credits fall below `threshold_usd`, `amount_usd` is charged to
+     * `card` and added as credits.
+     */
+    auto_reload: AutoReload;
     /**
      * False while card billing is not available.
      */
@@ -311,30 +475,82 @@ export interface BillingStatus {
      */
     card_note?: string | null;
     card_on_file: boolean;
+    /**
+     * What the organization's credits can pay for.
+     */
+    credits: BillingCredits;
     /**
      * True once a billing customer exists for the organisation.
      */
     customer: boolean;
+    /**
+     * A hold that refuses new work, or `null`: `kind`, `reason`, `amount_usd`, `dispute_id` for a
+     * disputed payment, and `url`, the page that lifts it.
+     */
+    hold?: BillingHold | null;
     /**
      * The $1 that confirms the payment method on file when it has no stable payer (Apple Pay,
      * Google Pay, Amazon Pay); `null` when it needed none.
      */
     method_check?: MethodCheckView | null;
+    /**
+     * How usage is paid: `credits` (from credits bought in advance) or `postpaid` (billed after use,
+     * until `switch.at`).
+     */
+    model: string;
     notice?: TrialNotice | null;
     org_id: string;
     period: BillingPeriod;
     plan: string;
+    /**
+     * The plan in force: `id`, `name`, `renews_at`, and `renewal` while a renewal payment is in
+     * trouble.
+     */
+    plan_status: PlanStatus;
     suspend_reason?: string | null;
     suspended: boolean;
+    /**
+     * For a `postpaid` organization: `at`, when it moves to credits, and `credits_waiting_usd`, the
+     * credits bought before then, ready at the move.
+     */
+    switch?: BillingSwitch | null;
     trial: TrialStatus;
     /**
-     * The payment provider's estimate of the next invoice; `null` when there is no
-     * subscription, or when the estimate could not be fetched (see `upcoming_invoice_error`).
+     * The most this organization can buy now.
+     */
+    trust: TrustLimits;
+    /**
+     * The next invoice, estimated: a plan's fee, and for an organization not yet on credits, its
+     * usage. `null` when there is neither, or when the estimate could not be fetched (see
+     * `upcoming_invoice_error`).
      */
     upcoming_invoice?: UpcomingInvoice | null;
     upcoming_invoice_error?: string | null;
     usage: PeriodUsage;
 }
+/**
+ * When a `postpaid` organization moves to credits.
+ */
+export interface BillingSwitch {
+    /**
+     * When it moves to credits, RFC 3339.
+     */
+    at: string;
+    /**
+     * The credits bought before then, ready at the move, USD.
+     */
+    credits_waiting_usd: number;
+}
+/**
+ * What one build holds of the credits.
+ */
+export interface BuildCreditHold {
+    build_id: string;
+    /**
+     * What it may still use, USD.
+     */
+    held_usd: number;
+}
 /**
  * An identical build that was already in progress, answered as if it were the caller's own.
  */
@@ -829,7 +1045,7 @@ export interface CheckoutSession {
     mode: string;
     session_id?: string | null;
     /**
-     * Open this. Adding a card keeps any trial credit that is left.
+     * Open this. Your credits are kept.
      */
     url: string;
 }
@@ -925,7 +1141,7 @@ export interface CliTokenCreate {
 /**
  * Every error and failure code the API returns.
  */
-export type Code = "fork_failed" | "start_timeout" | "readiness_failed" | "verify_too_slow" | "verify_each_failed" | "sandbox_unresponsive" | "oom_within_tier" | "disk_full_within_tier" | "sandbox_interrupted" | "integrity_mismatch" | "egress_unavailable" | "service_timeout" | "capacity_busy" | "verify_did_not_cover" | "nonzero_exit" | "task_timeout" | "oom_over_tier" | "disk_over_tier" | "cap_killed" | "cap_exceeded" | "aborted_by_client" | "expired" | "not_started" | "superseded" | "usage" | "internal" | "auth" | "not_found" | "unreachable" | "rate_limited" | "timeout" | "not_verified" | "enoent" | "trial_credits_exhausted" | "card_required" | "concurrency_limit" | "egress_cap_reached" | "network_policy_unsupported" | "network_host_refused" | "toolchain_mismatch" | "resume_unavailable" | "sandbox_unreachable" | "region_at_capacity" | "tier_unavailable" | "snapshot_unavailable" | "capacity_limit" | "build_timeout" | "builder_unavailable" | "builder_busy" | "overloaded" | "preempted" | "grader_failed" | "grade_not_passed" | "shutdown_by_task" | "modified_by_task" | "cap_paused" | "credits_paused" | "stopped_by_support" | "forbidden" | "snapshot_incompatible" | "storage_limit_reached" | "dockerfile_build_failed" | "image_unresolvable" | "registry_unavailable" | "credit_unclaimed" | "billing_unavailable" | "project_cap_reached" | "spend_limit_reached" | "billing_hold" | "tier_over_plan" | "secrets_in_snapshot" | "secrets_unavailable" | "secret_binding_unsupported" | "idempotency_key_reused" | "idempotency_key_in_use" | "repo_credentials_not_supported" | "account_exists" | "invite_invalid" | "invite_required" | "key_expired" | "account_blocked" | "setup_required";
+export type Code = "fork_failed" | "start_timeout" | "readiness_failed" | "verify_too_slow" | "verify_each_failed" | "sandbox_unresponsive" | "oom_within_tier" | "disk_full_within_tier" | "sandbox_interrupted" | "integrity_mismatch" | "egress_unavailable" | "service_timeout" | "capacity_busy" | "verify_did_not_cover" | "nonzero_exit" | "task_timeout" | "oom_over_tier" | "disk_over_tier" | "cap_killed" | "cap_exceeded" | "aborted_by_client" | "expired" | "not_started" | "superseded" | "usage" | "internal" | "auth" | "not_found" | "unreachable" | "rate_limited" | "timeout" | "not_verified" | "enoent" | "trial_credits_exhausted" | "credits_exhausted" | "card_required" | "purchase_limit" | "purchases_blocked" | "card_needed" | "auto_reload_unavailable" | "concurrency_limit" | "egress_cap_reached" | "network_policy_unsupported" | "network_host_refused" | "toolchain_mismatch" | "resume_unavailable" | "sandbox_unreachable" | "region_at_capacity" | "tier_unavailable" | "snapshot_unavailable" | "capacity_limit" | "build_timeout" | "builder_unavailable" | "builder_busy" | "overloaded" | "preempted" | "grader_failed" | "grade_not_passed" | "shutdown_by_task" | "modified_by_task" | "cap_paused" | "credits_paused" | "stopped_by_support" | "forbidden" | "snapshot_incompatible" | "storage_limit_reached" | "dockerfile_build_failed" | "image_unresolvable" | "registry_unavailable" | "credit_unclaimed" | "billing_unavailable" | "project_cap_reached" | "spend_limit_reached" | "billing_hold" | "tier_over_plan" | "secrets_in_snapshot" | "secrets_unavailable" | "secret_binding_unsupported" | "idempotency_key_reused" | "idempotency_key_in_use" | "repo_credentials_not_supported" | "account_exists" | "invite_invalid" | "invite_required" | "key_expired" | "account_blocked" | "setup_required";
 export interface Concurrency {
 }
 /**
@@ -1024,7 +1240,7 @@ export interface CreditGrant {
      */
     granted_at: string;
     /**
-     * USD.
+     * USD. For `credit_taken_back`, what was taken back.
      */
     granted_usd: number;
     /**
@@ -1032,7 +1248,10 @@ export interface CreditGrant {
      * `referral` (a referral reward), `plan` (usage included with a paid plan),
      * `from_promigence` (credit Promigence added to your account), `service_restart` (credit
      * for a command a service restart stopped), `confirmation_credit` (a $1 charge that
-     * confirmed a payment method, added back as credit), or `other`.
+     * confirmed a payment method, added back as credit), `credits_bought` (credits bought on a
+     * payment page), `auto_reload` (credits added by auto-reload), `credit_taken_back` (credits
+     * taken back after a refund or a dispute), `credit_regranted` (credits given back after a
+     * dispute was decided for you, withdrawn or closed), or `other`.
      */
     kind: string;
     /**
@@ -1046,6 +1265,33 @@ export interface CreditGrant {
      */
     status: string;
 }
+/**
+ * `GET /v1/billing/holds` — What each running or paused sandbox holds of the organization's
+ * credits.
+ */
+export interface CreditHolds {
+    /**
+     * Each build still running, and what it holds.
+     */
+    builds: Array<BuildCreditHold>;
+    /**
+     * Data out sent and not yet charged, USD.
+     */
+    data_out_usd: number;
+    /**
+     * Of the balance, what running and paused work may still use, plus data out sent and not yet
+     * charged and, once storage is priced, the next 7 days of storage, USD.
+     */
+    held_usd: number;
+    /**
+     * Each running or paused sandbox, and what it holds.
+     */
+    sandboxes: Array<SandboxCreditHold>;
+    /**
+     * The next 7 days of storage, once storage is priced, USD.
+     */
+    storage_usd: number;
+}
 /**
  * The account's free credit (`GET /v1/credits/offer`, and the answer to a claim). The credit is
  * claimed in the browser, where the terms are accepted: `POST /v1/credits/claim-link` makes the
@@ -1083,6 +1329,52 @@ export interface CreditOffer {
      */
     state: string;
 }
+/**
+ * `POST /v1/billing/credits`.
+ */
+export interface CreditsBuy {
+    /**
+     * What to buy, in whole dollars, from 5.
+     */
+    amount_usd: number;
+}
+/**
+ * Credits that expire, and when.
+ */
+export interface CreditsExpiry {
+    /**
+     * USD.
+     */
+    amount_usd: number;
+    /**
+     * RFC 3339.
+     */
+    at: string;
+}
+/**
+ * `POST /v1/billing/credits/{session_id}/settle` — Check a credits payment and add its credits if it
+ * went through. Safe to call more than once.
+ */
+export interface CreditsSettled {
+    /**
+     * USD.
+     */
+    amount_usd: number;
+    /**
+     * With `paid`: what new work can use now, USD.
+     */
+    available_usd?: number | null;
+    /**
+     * `paid` (the credits were added), `paid_awaiting_switch` (paid; the credits are added at
+     * `switch_at`), `open` (not paid yet), `processing` (paid; the payment is still being
+     * confirmed), `expired` (no payment was made) or `failed` (the payment did not go through).
+     */
+    state: string;
+    /**
+     * With `paid_awaiting_switch`: when the credits are added, RFC 3339.
+     */
+    switch_at?: string | null;
+}
 /**
  * One entry of a directory listing.
  */
@@ -1106,7 +1398,7 @@ export interface DirEntry {
     /**
      * The exact bytes of `path`, base64, when the name is not UTF-8: `name` and `path` then show
      * U+FFFD where those bytes are, and name no file. A directory holding such names is fetched
-     * exactly as an archive (`GET …/files/archive`).
+     * exactly as an archive (`POST …/files/archive`).
      */
     path_b64?: string | null;
     /**
@@ -1210,7 +1502,7 @@ export interface ErrorBody {
 /**
  * Every error code the API returns. `category` decides whether the failure is billed: `env` is ours (not billed before hand-over; after it, the time since the sandbox's last snapshot is credited back, up to 24 hours, when our side shows the cause), `task` is your command and is billed. The full table is `x-promigence-error-codes` at the document root.
  */
-export type ErrorCode = "fork_failed" | "start_timeout" | "readiness_failed" | "verify_too_slow" | "verify_each_failed" | "toolchain_mismatch" | "sandbox_unresponsive" | "oom_within_tier" | "disk_full_within_tier" | "sandbox_interrupted" | "integrity_mismatch" | "egress_unavailable" | "service_timeout" | "preempted" | "verify_did_not_cover" | "grader_failed" | "nonzero_exit" | "grade_not_passed" | "task_timeout" | "oom_over_tier" | "disk_over_tier" | "shutdown_by_task" | "modified_by_task" | "cap_killed" | "cap_exceeded" | "cap_paused" | "credits_paused" | "aborted_by_client" | "stopped_by_support" | "expired" | "not_started" | "superseded" | "usage" | "internal" | "auth" | "forbidden" | "not_found" | "unreachable" | "rate_limited" | "timeout" | "not_verified" | "snapshot_incompatible" | "storage_limit_reached" | "resume_unavailable" | "sandbox_unreachable" | "capacity_busy" | "region_at_capacity" | "builder_unavailable" | "builder_busy" | "overloaded" | "tier_unavailable" | "snapshot_unavailable" | "capacity_limit" | "build_timeout" | "dockerfile_build_failed" | "image_unresolvable" | "registry_unavailable" | "enoent" | "trial_credits_exhausted" | "credit_unclaimed" | "setup_required" | "card_required" | "billing_unavailable" | "concurrency_limit" | "egress_cap_reached" | "project_cap_reached" | "spend_limit_reached" | "billing_hold" | "tier_over_plan" | "network_host_refused" | "network_policy_unsupported" | "secrets_in_snapshot" | "secrets_unavailable" | "secret_binding_unsupported" | "idempotency_key_reused" | "idempotency_key_in_use" | "repo_credentials_not_supported" | "account_exists" | "invite_invalid" | "invite_required" | "key_expired" | "account_blocked";
+export type ErrorCode = "fork_failed" | "start_timeout" | "readiness_failed" | "verify_too_slow" | "verify_each_failed" | "toolchain_mismatch" | "sandbox_unresponsive" | "oom_within_tier" | "disk_full_within_tier" | "sandbox_interrupted" | "integrity_mismatch" | "egress_unavailable" | "service_timeout" | "preempted" | "verify_did_not_cover" | "grader_failed" | "nonzero_exit" | "grade_not_passed" | "task_timeout" | "oom_over_tier" | "disk_over_tier" | "shutdown_by_task" | "modified_by_task" | "cap_killed" | "cap_exceeded" | "cap_paused" | "credits_paused" | "aborted_by_client" | "stopped_by_support" | "expired" | "not_started" | "superseded" | "usage" | "internal" | "auth" | "forbidden" | "not_found" | "unreachable" | "rate_limited" | "timeout" | "not_verified" | "snapshot_incompatible" | "storage_limit_reached" | "resume_unavailable" | "sandbox_unreachable" | "capacity_busy" | "region_at_capacity" | "builder_unavailable" | "builder_busy" | "overloaded" | "tier_unavailable" | "snapshot_unavailable" | "capacity_limit" | "build_timeout" | "dockerfile_build_failed" | "image_unresolvable" | "registry_unavailable" | "enoent" | "trial_credits_exhausted" | "credits_exhausted" | "credit_unclaimed" | "setup_required" | "card_required" | "billing_unavailable" | "purchase_limit" | "card_needed" | "auto_reload_unavailable" | "purchases_blocked" | "concurrency_limit" | "egress_cap_reached" | "project_cap_reached" | "spend_limit_reached" | "billing_hold" | "tier_over_plan" | "network_host_refused" | "network_policy_unsupported" | "secrets_in_snapshot" | "secrets_unavailable" | "secret_binding_unsupported" | "idempotency_key_reused" | "idempotency_key_in_use" | "repo_credentials_not_supported" | "account_exists" | "invite_invalid" | "invite_required" | "key_expired" | "account_blocked";
 /**
  * `POST /v1/sandboxes/{id}/execs`, and the `exec` of `POST /v1/runs`: one command. `argv` (a
  * non-empty list) or `sh` (a shell line) is required.
@@ -1531,6 +1823,13 @@ export interface FileCopy {
     recursive?: boolean | null;
     to: string;
 }
+/**
+ * `DELETE /v1/sandboxes/{id}/files`: a path, and `recursive` for a directory with something in it.
+ */
+export interface FileDeleteRequest {
+    path: string;
+    recursive?: boolean | null;
+}
 /**
  * `DELETE /v1/sandboxes/{id}/files`. Idempotent: a path that was not there is a 200 with
  * `existed: false`, not a 404.
@@ -1570,7 +1869,32 @@ export interface FileInfo {
     size: number;
 }
 /**
- * The reply to `GET /v1/sandboxes/:id/files/list`.
+ * `POST /v1/sandboxes/{id}/files/list`: one directory, or a walk below it.
+ */
+export interface FileListRequest {
+    /**
+     * How many levels a recursive walk goes down.
+     */
+    depth?: number | null;
+    /**
+     * `false` leaves out names starting with `.`; they are listed by default.
+     */
+    hidden?: boolean | null;
+    /**
+     * At most this many entries; past it the answer says `truncated: true`.
+     */
+    limit?: number | null;
+    /**
+     * The directory (absolute). Default: `/`.
+     */
+    path?: string | null;
+    /**
+     * Walk below the directory too.
+     */
+    recursive?: boolean | null;
+}
+/**
+ * The reply to `POST /v1/sandboxes/:id/files/list`.
  */
 export interface FileListing {
     entries: Array<DirEntry>;
@@ -1607,6 +1931,42 @@ export interface FileMove {
     overwrite?: boolean | null;
     to: string;
 }
+/**
+ * `POST /v1/sandboxes/{id}/files/read` and `POST /v1/sandboxes/{id}/files/stat`: one path,
+ * absolute, inside the sandbox.
+ */
+export interface FilePathRequest {
+    path: string;
+}
+/**
+ * `POST /v1/sandboxes/{id}/files/search`: `pattern`, `contains`, or both.
+ */
+export interface FileSearchRequest {
+    /**
+     * Literal text to find inside the files that match; a match carries its line.
+     */
+    contains?: string | null;
+    /**
+     * `false` leaves out names starting with `.`; they are searched by default.
+     */
+    hidden?: boolean | null;
+    /**
+     * Match `contains` without regard to case.
+     */
+    ignore_case?: boolean | null;
+    /**
+     * At most this many matches; past it the answer says `truncated: true`.
+     */
+    limit?: number | null;
+    /**
+     * The directory to search (absolute). Default: `/`.
+     */
+    path?: string | null;
+    /**
+     * A glob over the file name, e.g. `*.py`.
+     */
+    pattern?: string | null;
+}
 /**
  * Size, mode, modification time and kind for one path, as the sandbox reports them.
  */
@@ -1625,7 +1985,7 @@ export interface FileStat {
     size?: number | null;
 }
 /**
- * `GET /v1/sandboxes/{id}/files/stat`.
+ * `POST /v1/sandboxes/{id}/files/stat`.
  */
 export interface FileStatView {
     path: string;
@@ -1633,7 +1993,7 @@ export interface FileStatView {
     stat: FileStat;
 }
 /**
- * The answer to `PUT /v1/sandboxes/{id}/files` (the request body is the file's bytes).
+ * The answer to `PUT /v1/sandboxes/{id}/files` (a form: `path`, `mode`, `offset` and the `file`).
  */
 export interface FileWritten {
     /**
@@ -1645,12 +2005,12 @@ export interface FileWritten {
      */
     chunks: number;
     /**
-     * The file's permission bits after the write, octal (`644`). Without `?mode=` a file that
+     * The file's permission bits after the write, octal (`644`). Without `mode` a file that
      * already existed keeps its own, and a new file is `644`.
      */
     mode: string;
     /**
-     * Where this request's bytes start in the file (`?offset=`, else 0).
+     * Where this request's bytes start in the file (`offset`, else 0).
      */
     offset: number;
     ok: boolean;
@@ -2857,14 +3217,27 @@ export interface OrgList {
     orgs: Array<OrgView>;
 }
 /**
- * `PATCH /v1/orgs/{org}`: rename the organization. Its id never changes; anything that names
- * it by the old name (a script, `--org`, a saved URL) must use the new one.
+ * `PATCH /v1/orgs/{org}`: rename the organization, set how long its command output is kept, or
+ * both: at least one field. Its id never changes; anything that names it by the old name (a
+ * script, `--org`, a saved URL) must use the new one.
  */
 export interface OrgPatch {
+    /**
+     * Keep a failed sandbox so it can be reopened where it broke, when a run does not say
+     * (`capture`): `true` or `false`; `null` = the next level's setting. Set by an owner, on its
+     * own (no other field in the same request).
+     */
+    failure_captures?: boolean | null;
     /**
      * 1–40 lowercase letters, digits and dashes.
      */
-    name: string;
+    name?: string | null;
+    /**
+     * Days the organization's command output (what its commands ran and printed) is kept after
+     * its sandbox ends, 1–30; `null` = the default, 7. A project may name its own. Set by an
+     * owner.
+     */
+    output_retention_days?: number | null;
 }
 /**
  * One organization you belong to. Billing, members and credits belong to it.
@@ -2882,9 +3255,19 @@ export interface OrgView {
      * True for the organization a sign-in and the CLI use when none is named.
      */
     default: boolean;
+    /**
+     * Whether a failed sandbox is kept so you can reopen it where it broke, when a run does not
+     * say (`capture`); `null` = the default. A project may name its own.
+     */
+    failure_captures?: boolean | null;
     members: number;
     name: string;
     org_id: string;
+    /**
+     * Days command output is kept after a sandbox ends; `null` = the default, 7. A project may
+     * name its own.
+     */
+    output_retention_days?: number | null;
     projects: number;
     /**
      * Your role in it: `owner` or `member`.
@@ -2985,24 +3368,38 @@ export interface Payment {
      * The invoice's number, as the invoice shows it; `null` when not known.
      */
     invoice_number?: string | null;
+    /**
+     * The invoice, as a PDF.
+     */
+    invoice_pdf?: string | null;
     /**
      * The invoice's page: its receipt once it is paid, where to pay it while a payment has
      * failed; `null` when not known.
      */
     invoice_url?: string | null;
     /**
-     * `invoice_paid`, `payment_failed`, `refund`, or `method_check` (a charge, usually $1, that
-     * confirmed a payment method; it comes back as credit).
+     * `invoice_paid`, `payment_failed`, `refund`, `method_check` (a charge, usually $1, that
+     * confirmed a payment method; it comes back as credit), `credits_bought` (credits bought on a
+     * payment page), `auto_reload` (credits added by auto-reload), `plan_invoice` (a plan's fee),
+     * or `dispute_repaid` (a disputed payment, repaid).
      */
     kind: string;
     /**
      * `method_check`: the payment method it confirmed, by name (`Apple Pay`); `null` otherwise.
      */
     method?: string | null;
+    /**
+     * While it is unpaid, the page to pay it.
+     */
+    pay_url?: string | null;
     /**
      * The plan whose fee the invoice billed; `null` when it billed usage alone.
      */
     plan?: string | null;
+    /**
+     * The receipt.
+     */
+    receipt_url?: string | null;
     /**
      * `paid` (for a payment that failed: paid since), `retrying` (it failed and will be tried
      * again), `failed` (it failed and will not be tried again; for `method_check`, the method
@@ -3010,6 +3407,27 @@ export interface Payment {
      */
     status: string;
 }
+/**
+ * A payment page to open (buying credits, or repaying a disputed payment).
+ */
+export interface PaymentPage {
+    /**
+     * What it charges, USD.
+     */
+    amount_usd: number;
+    /**
+     * When the page stops working, RFC 3339.
+     */
+    expires_at: string;
+    /**
+     * The page's id: `POST /v1/billing/credits/{session_id}/settle` checks it.
+     */
+    session_id: string;
+    /**
+     * Open this to pay.
+     */
+    url: string;
+}
 export interface Percentiles {
     p50: number;
     p95: number;
@@ -3023,12 +3441,12 @@ export interface Percentiles {
  */
 export interface PeriodUsage {
     /**
-     * What is left for the card.
+     * Usage billed after use, for an organization not yet on credits; 0 on credits.
      */
     billable: number;
     builds: BuildUsage;
     /**
-     * Of `total`, what trial credits paid.
+     * Of `total`, what credits paid.
      */
     credits_applied: number;
     /**
@@ -3048,15 +3466,59 @@ export interface PeriodUsage {
      * Sandbox time by tier.
      */
     sandboxes: Record<string, SandboxUsage>;
+    /**
+     * Storage, USD; absent when it is $0.
+     */
+    storage?: number | null;
     /**
      * USD.
      */
     total: number;
     /**
-     * Charges not yet reported to the payment provider.
+     * Charges not yet billed, for an organization not yet on credits; 0 on credits.
      */
     unreported_entries: number;
 }
+/**
+ * A renewal payment in trouble. The plan stays in force while it is tried again.
+ */
+export interface PlanRenewal {
+    /**
+     * When it is tried again, RFC 3339; `null` when no try is due.
+     */
+    next_try_at?: string | null;
+    /**
+     * The page to pay or confirm it.
+     */
+    pay_url?: string | null;
+    /**
+     * `past_due` (the payment did not go through and is tried again) or `action_required` (your
+     * bank asks you to confirm it).
+     */
+    state: string;
+}
+/**
+ * The plan in force.
+ */
+export interface PlanStatus {
+    /**
+     * The plan's id, as `plan` names it.
+     */
+    id: string;
+    /**
+     * The plan's name.
+     */
+    name: string;
+    /**
+     * While a renewal payment is in trouble: what stands and the page that settles it; `null`
+     * otherwise.
+     */
+    renewal?: PlanRenewal | null;
+    /**
+     * When it renews, RFC 3339; `null` for a plan that does not renew.
+     */
+    renews_at?: string | null;
+}
 /**
  * One preview URL. Anyone holding the URL can reach the port behind it — it is a bearer token in
  * a link.
@@ -3201,8 +3663,8 @@ export interface PricingLimits {
 export interface PricingPlan {
     display_name: string;
     /**
-     * Trial rules apply: work is paid from free credit, within the trial's limits, until a card is
-     * added.
+     * The trial's limits apply until a card not already used by another organization is added, or
+     * credits are bought.
      */
     on_trial: boolean;
     /**
@@ -3311,7 +3773,12 @@ export interface PricingView {
      */
     granularity_seconds: number;
     /**
-     * Usage the monthly fee includes each month, USD.
+     * For how many paid months the plan adds `included_credits_usd`; `null` when it adds them every
+     * paid month.
+     */
+    included_credits_promo_months?: number | null;
+    /**
+     * Credits the plan adds each paid month, USD.
      */
     included_credits_usd: number;
     limits: PricingLimits;
@@ -3386,11 +3853,22 @@ export interface ProjectMoved {
  * `PATCH /v1/orgs/{org}/projects/{project}`: at least one field.
  */
 export interface ProjectPatch {
+    /**
+     * Keep a failed sandbox so it can be reopened where it broke, when a run does not say
+     * (`capture`): `true` or `false`; `null` = the next level's setting. Set by an owner, on its
+     * own (no other field in the same request).
+     */
+    failure_captures?: boolean | null;
     /**
      * A monthly spending cap in USD, 0–1000000; `null` removes the cap.
      */
     monthly_cap_usd?: number | null;
     name?: string | null;
+    /**
+     * Days this project's command output (what its commands ran and printed) is kept after its
+     * sandbox ends, 1–30; `null` = the organization's setting. Set by an owner.
+     */
+    output_retention_days?: number | null;
 }
 /**
  * One project. API keys belong to a project; a project holds any number of repositories.
@@ -3404,6 +3882,11 @@ export interface ProjectView {
      * True for the project every organization starts with. It cannot be renamed or deleted.
      */
     default: boolean;
+    /**
+     * Whether this project's failed sandboxes are kept to reopen, when a run does not say
+     * (`capture`); `null` = the organization's setting. Set by an owner.
+     */
+    failure_captures?: boolean | null;
     /**
      * Keys that still work.
      */
@@ -3425,6 +3908,11 @@ export interface ProjectView {
     monthly_cap_usd?: number | null;
     name: string;
     org_id: string;
+    /**
+     * Days this project's command output is kept after a sandbox ends; `null` = the
+     * organization's setting. Set by an owner.
+     */
+    output_retention_days?: number | null;
     project_id: string;
 }
 export interface Provenance {
@@ -3522,12 +4010,13 @@ export interface ReferralApplied {
      */
     qualifying_plans: Array<string>;
     /**
-     * Compute credit this organization gets when it pays its first plan invoice, USD.
+     * Compute credit this organization gets (or got) once it first pays at least this much, for
+     * credits or a plan, USD.
      */
     reward_usd: number;
     /**
-     * `pending` (your credit comes with your first paid plan invoice), `under_review`, or — at
-     * sign-in only — `not_applied`.
+     * `pending` (your credit comes with your first payment of at least the reward), `under_review`,
+     * or — at sign-in only — `not_applied`.
      */
     status: string;
 }
@@ -3582,7 +4071,8 @@ export interface ReferralOffer {
      */
     get_usd: number;
     /**
-     * Compute credit the friend gets when they pay their first plan invoice, USD.
+     * Compute credit the friend gets once they first pay at least this much, for credits or a plan,
+     * USD.
      */
     give_usd: number;
     /**
@@ -3638,7 +4128,8 @@ export interface ReferralStatus {
  */
 export interface ReferredBy {
     /**
-     * Compute credit this organization gets (or got) when it pays its first plan invoice, USD.
+     * Compute credit this organization gets (or got) once it first pays at least this much, for
+     * credits or a plan, USD.
      */
     reward_usd: number;
     /**
@@ -4284,6 +4775,33 @@ export interface Sandbox {
     warm_measured?: WarmMeasured | null;
     warnings?: Array<string>;
 }
+/**
+ * What one sandbox holds of the credits.
+ */
+export interface SandboxCreditHold {
+    /**
+     * How long it has run, in milliseconds.
+     */
+    elapsed_ms: number;
+    /**
+     * When its timeout ends it, RFC 3339; `null` while it is paused.
+     */
+    ends_at?: string | null;
+    /**
+     * What it may still use, USD.
+     */
+    held_usd: number;
+    sandbox_id: string;
+    /**
+     * `running` or `paused`.
+     */
+    state: string;
+    /**
+     * Its timeout, in milliseconds, counted from its hand-over: `PATCH /v1/sandboxes/{id}`
+     * `timeout_ms` shortens it.
+     */
+    timeout_ms: number;
+}
 /**
  * The sandbox's new lifetime and what it costs.
  */
@@ -4406,7 +4924,8 @@ export interface SandboxPatch {
      */
     auto_pause_s?: number | null;
     /**
-     * The new lifetime in milliseconds, counted from now.
+     * The sandbox's new lifetime in milliseconds, counted from its hand-over. A longer one extends
+     * it; a shorter one is accepted down to the time it has run plus 60 seconds.
      */
     timeout_ms?: number | null;
 }
@@ -4777,6 +5296,29 @@ export interface SandboxView {
     verify_each_ms?: number | null;
     warnings: Array<string>;
 }
+/**
+ * `POST /v1/sandboxes/resume`.
+ */
+export interface SandboxesResume {
+    /**
+     * `credits`: every sandbox paused because credits ran out.
+     */
+    paused_for: string;
+}
+/**
+ * `POST /v1/sandboxes/resume` — Resume every sandbox paused because credits ran out. Each resume
+ * is checked like new work. The answer says how many resumed and how many still need credits.
+ */
+export interface SandboxesResumed {
+    /**
+     * The sandboxes that resumed.
+     */
+    resumed: Array<string>;
+    /**
+     * The sandboxes still paused because credits do not cover them.
+     */
+    still_need_credits: Array<string>;
+}
 /**
  * How the grader's result is read.
  */
@@ -4842,7 +5384,7 @@ export interface SearchMatch {
     text?: string | null;
 }
 /**
- * The reply to `GET /v1/sandboxes/:id/files/search`.
+ * The reply to `POST /v1/sandboxes/:id/files/search`.
  */
 export interface SearchResult {
     matches: Array<SearchMatch>;
@@ -6002,8 +6544,8 @@ export interface TrialStatus {
      */
     credits_reserved: number;
     /**
-     * Data out included this month, in GiB: the plan's allowance. Above it, data out is billed,
-     * or stopped when the org cannot be billed (no card); `null` when the plan includes none.
+     * Data out included this month, in GiB: the plan's allowance. Above it, data out is paid from
+     * credits and is cut when they run out; `null` when the plan includes none.
      */
     egress_gb_cap?: number | null;
     /**
@@ -6021,6 +6563,27 @@ export interface TrialStatus {
     on_trial: boolean;
     policy: TrialPolicy;
 }
+/**
+ * What this organization can buy now.
+ */
+export interface TrustLimits {
+    /**
+     * The most purchases and reloads can add today, USD.
+     */
+    per_day_max_usd: number;
+    /**
+     * The most one purchase can be now, a plan's fee included, USD.
+     */
+    per_purchase_max_usd: number;
+    /**
+     * The most one auto-reload can add, USD.
+     */
+    reload_max_usd: number;
+    /**
+     * The most auto-reloads in a day.
+     */
+    reloads_per_day: number;
+}
 /**
  * The payment provider's estimate of the next invoice. Amounts are USD; each is `null` when
  * the provider did not state it.