@boxrouter/sdk 0.0.1-alpha.0 → 0.12.190

package/dist/namespace-artifacts.d.mts

@@ -0,0 +1,46 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { ArtifactsDeleteData, ArtifactsDeleteErrors, ArtifactsDeleteResponses, ArtifactsGetData, ArtifactsGetErrors, ArtifactsGetResponses, ArtifactsUploadData, ArtifactsUploadErrors, ArtifactsUploadResponses } 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 Artifacts extends HeyApiClient {
+    /**
+     * Upload a staged input
+     *
+     * Stream opaque source bytes to workspace-scoped temporary storage. Enforce
+     * workspace upload quotas without buffering the entire request in memory.
+     * Compute the digest server-side; return a handle only after the full upload
+     * succeeds. A failed upload is not a usable artifact. Do not execute or import
+     * uploaded code. Artifact references stay workspace-scoped and can be used across routes.
+     *
+     */
+    upload<ThrowOnError extends boolean = true>(options: Options<ArtifactsUploadData, ThrowOnError>): RequestResult<ArtifactsUploadResponses, ArtifactsUploadErrors, ThrowOnError, 'data'>;
+    /**
+     * Remove a staged artifact
+     *
+     * Delete source storage without deleting resulting provider images. Reject with
+     * 409 while a submitted build, file transfer or credential-factory activation
+     * still needs these bytes. An activated factory uses its retained encrypted
+     * copy; deleting staging bytes does not revoke that credential version. Successful deletion is
+     * idempotent for a known owned record; unowned IDs remain 404.
+     *
+     */
+    delete<ThrowOnError extends boolean = true>(options: Options<ArtifactsDeleteData, ThrowOnError>): RequestResult<ArtifactsDeleteResponses, ArtifactsDeleteErrors, ThrowOnError, 'data'>;
+    /**
+     * Inspect a staged artifact
+     *
+     * Return metadata only. Unknown, unowned and expired artifacts return 404.
+     */
+    get<ThrowOnError extends boolean = true>(options: Options<ArtifactsGetData, ThrowOnError>): RequestResult<ArtifactsGetResponses, ArtifactsGetErrors, ThrowOnError, 'data'>;
+}

package/dist/namespace-artifacts.mjs

@@ -0,0 +1,69 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export class Artifacts extends HeyApiClient {
+    /**
+     * Upload a staged input
+     *
+     * Stream opaque source bytes to workspace-scoped temporary storage. Enforce
+     * workspace upload quotas without buffering the entire request in memory.
+     * Compute the digest server-side; return a handle only after the full upload
+     * succeeds. A failed upload is not a usable artifact. Do not execute or import
+     * uploaded code. Artifact references stay workspace-scoped and can be used across routes.
+     *
+     */
+    upload(options) {
+        return (options.client ?? this.client).post({
+            bodySerializer: null,
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/artifacts',
+            ...options,
+            headers: {
+                'Content-Type': 'application/octet-stream',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Remove a staged artifact
+     *
+     * Delete source storage without deleting resulting provider images. Reject with
+     * 409 while a submitted build, file transfer or credential-factory activation
+     * still needs these bytes. An activated factory uses its retained encrypted
+     * copy; deleting staging bytes does not revoke that credential version. Successful deletion is
+     * idempotent for a known owned record; unowned IDs remain 404.
+     *
+     */
+    delete(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/artifacts/{artifact_id}',
+            ...options
+        });
+    }
+    /**
+     * Inspect a staged artifact
+     *
+     * Return metadata only. Unknown, unowned and expired artifacts return 404.
+     */
+    get(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/artifacts/{artifact_id}',
+            ...options
+        });
+    }
+}

package/dist/namespace-base.d.mts

@@ -0,0 +1,7 @@
+import type { Client } from './client/index.js';
+export declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}

package/dist/namespace-base.mjs

@@ -0,0 +1,7 @@
+import { client } from './client.gen.js';
+export class HeyApiClient {
+    client;
+    constructor(args) {
+        this.client = args?.client ?? client;
+    }
+}

package/dist/namespace-commands.d.mts

@@ -0,0 +1,57 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { CommandsRunData, CommandsRunErrors, CommandsRunResponses } 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 Commands extends HeyApiClient {
+    /**
+     * Run a buffered command
+     *
+     * **Commands**
+     *
+     * You can rely on:
+     * - Runs in a login Bash, so PATH changes that installers write to ~/.profile apply to later commands.
+     * - Returns the exit status.
+     * - Returns stdout and stderr separately.
+     * - Returns exact bytes in byte mode.
+     * - The timeout ends the command.
+     * - On a timeout the command's process group receives TERM at the deadline and KILL 5 seconds later, in both output modes.
+     * - Returned output is captured after the shell exits, and later writes by background children cannot change it.
+     * - An uncertain outcome is never replayed.
+     * - Output over the limit returns the exit status and the first output_limit_bytes of each stream, marked truncated. Default and maximum: 512 KiB per stream. Processes stream complete large output.
+     *
+     * You can set: command, cwd, env, timeout_seconds, output (text or bytes), output_limit_bytes.
+     *
+     * Not promised: guest disk used by output above the limit; ending children that leave the command's process group (for example setsid daemons).
+     *
+     * **Command stdin**
+     *
+     * You can rely on:
+     * - A command takes no input: it starts with stdin at end-of-file, and login profiles, the command and its children all read empty input.
+     *
+     * You can set: nothing (use process input for interactive input).
+     *
+     * Output over output_limit_bytes is not an error: the result sets stdout_truncated or
+     * stderr_truncated. A nonzero exit is a completed workload result, not an HTTP failure.
+     * A command that reaches timeout_seconds is a result too: the process group is ended and
+     * the answer is 200 with timed_out true, exit_code null and the output written so far.
+     * 504 timeout is left for the case where BoxRouter lost sight of the command and cannot
+     * say whether it ran. A disconnected HTTP client is not promised to end the command; the
+     * timeout ends it. Use process streaming for output without a bound.
+     * Generated clients take an opt-in check argument and raise CommandFailed (the operation's
+     * x-boxrouter-result-check) when exit_code is not 0 or timed_out is true.
+     *
+     */
+    run<ThrowOnError extends boolean = true>(options: Options<CommandsRunData, ThrowOnError>): RequestResult<CommandsRunResponses, CommandsRunErrors, ThrowOnError, 'data'>;
+}

package/dist/namespace-commands.mjs

@@ -0,0 +1,57 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export class Commands extends HeyApiClient {
+    /**
+     * Run a buffered command
+     *
+     * **Commands**
+     *
+     * You can rely on:
+     * - Runs in a login Bash, so PATH changes that installers write to ~/.profile apply to later commands.
+     * - Returns the exit status.
+     * - Returns stdout and stderr separately.
+     * - Returns exact bytes in byte mode.
+     * - The timeout ends the command.
+     * - On a timeout the command's process group receives TERM at the deadline and KILL 5 seconds later, in both output modes.
+     * - Returned output is captured after the shell exits, and later writes by background children cannot change it.
+     * - An uncertain outcome is never replayed.
+     * - Output over the limit returns the exit status and the first output_limit_bytes of each stream, marked truncated. Default and maximum: 512 KiB per stream. Processes stream complete large output.
+     *
+     * You can set: command, cwd, env, timeout_seconds, output (text or bytes), output_limit_bytes.
+     *
+     * Not promised: guest disk used by output above the limit; ending children that leave the command's process group (for example setsid daemons).
+     *
+     * **Command stdin**
+     *
+     * You can rely on:
+     * - A command takes no input: it starts with stdin at end-of-file, and login profiles, the command and its children all read empty input.
+     *
+     * You can set: nothing (use process input for interactive input).
+     *
+     * Output over output_limit_bytes is not an error: the result sets stdout_truncated or
+     * stderr_truncated. A nonzero exit is a completed workload result, not an HTTP failure.
+     * A command that reaches timeout_seconds is a result too: the process group is ended and
+     * the answer is 200 with timed_out true, exit_code null and the output written so far.
+     * 504 timeout is left for the case where BoxRouter lost sight of the command and cannot
+     * say whether it ran. A disconnected HTTP client is not promised to end the command; the
+     * timeout ends it. Use process streaming for output without a bound.
+     * Generated clients take an opt-in check argument and raise CommandFailed (the operation's
+     * x-boxrouter-result-check) when exit_code is not 0 or timed_out is true.
+     *
+     */
+    run(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}/commands',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}

package/dist/namespace-credits.d.mts

@@ -0,0 +1,213 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { CreditsAlertsData, CreditsAlertsErrors, CreditsAlertsResponses, CreditsAutoTopUpData, CreditsAutoTopUpErrors, CreditsAutoTopUpResponses, CreditsBalanceData, CreditsBalanceErrors, CreditsBalanceResponses, CreditsBillingDetailsData, CreditsBillingDetailsErrors, CreditsBillingDetailsResponses, CreditsCancelPurchaseData, CreditsCancelPurchaseErrors, CreditsCancelPurchaseResponses, CreditsDeletePaymentMethodData, CreditsDeletePaymentMethodErrors, CreditsDeletePaymentMethodResponses, CreditsGetPaymentMethodSetupData, CreditsGetPaymentMethodSetupErrors, CreditsGetPaymentMethodSetupResponses, CreditsGetPurchaseData, CreditsGetPurchaseErrors, CreditsGetPurchaseResponses, CreditsPaymentMethodsData, CreditsPaymentMethodsErrors, CreditsPaymentMethodsResponses, CreditsPromotionsData, CreditsPromotionsErrors, CreditsPromotionsResponses, CreditsPurchaseData, CreditsPurchaseErrors, CreditsPurchaseResponses, CreditsPurchasesData, CreditsPurchasesErrors, CreditsPurchasesResponses, CreditsQuotePurchaseData, CreditsQuotePurchaseErrors, CreditsQuotePurchaseResponses, CreditsRedeemData, CreditsRedeemErrors, CreditsRedeemResponses, CreditsReorderPaymentMethodsData, CreditsReorderPaymentMethodsErrors, CreditsReorderPaymentMethodsResponses, CreditsSetDefaultPaymentMethodData, CreditsSetDefaultPaymentMethodErrors, CreditsSetDefaultPaymentMethodResponses, CreditsSetupPaymentMethodData, CreditsSetupPaymentMethodErrors, CreditsSetupPaymentMethodIntentData, CreditsSetupPaymentMethodIntentErrors, CreditsSetupPaymentMethodIntentResponses, CreditsSetupPaymentMethodResponses, CreditsUpdateAlertsData, CreditsUpdateAlertsErrors, CreditsUpdateAlertsResponses, CreditsUpdateAutoTopUpData, CreditsUpdateAutoTopUpErrors, CreditsUpdateAutoTopUpResponses, CreditsUpdateBillingDetailsData, CreditsUpdateBillingDetailsErrors, CreditsUpdateBillingDetailsResponses, CreditsUsageData, CreditsUsageErrors, CreditsUsageResponses } 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 Credits extends HeyApiClient {
+    /**
+     * Get the workspace credit balance
+     *
+     * Requires account-management permission; execution keys receive 403. Returns 503
+     * payments_unavailable while credit purchases are not configured. BYOK work never
+     * depends on this balance.
+     *
+     */
+    balance<ThrowOnError extends boolean = true>(options?: Options<CreditsBalanceData, ThrowOnError>): RequestResult<CreditsBalanceResponses, CreditsBalanceErrors, ThrowOnError, 'data'>;
+    /**
+     * List recent credit purchases
+     *
+     * Workspace-owned purchases in every state, ordered by creation time and ID descending. Invoice and receipt links appear only after confirmed payment. New purchases do not shift subsequent pages. Invalid or another workspace's cursor is a 400.
+     */
+    purchases<ThrowOnError extends boolean = true>(options?: Options<CreditsPurchasesData, ThrowOnError>): RequestResult<CreditsPurchasesResponses, CreditsPurchasesErrors, ThrowOnError, 'data'>;
+    /**
+     * Start a credit purchase through Checkout or a saved card
+     *
+     * Without payment_method_id, records a pending purchase and returns the hosted
+     * Checkout page; success_url and cancel_url are required for this path. The response
+     * reports fee_minor and total_minor before redirect: Checkout charges total_minor
+     * (amount_minor plus BoxRouter's purchase fee, before tax) in two line items, and only
+     * amount_minor is added as credit. A refund returns credit only; the fee is not
+     * refunded. With a
+     * workspace-owned payment_method_id, creates and pays a
+     * Stripe invoice using that card. A verified paid invoice returns confirmed; when
+     * payer authentication is required, returns pending with the hosted invoice
+     * authentication_url. Send the payer there, then poll this purchase after they
+     * return to the dashboard. Credit is added only after BoxRouter fetches and validates
+     * the paid invoice. A definitive card decline returns payment_declined with the
+     * purchase ID and a short safe decline reason in error details, outcome not_started;
+     * the failed purchase remains in history. Repeating a request with the same
+     * Idempotency-Key returns its original result; a different amount or card under that
+     * key is a 409. After a payment_provider_unavailable response with outcome unknown,
+     * retry with the same key.
+     *
+     */
+    purchase<ThrowOnError extends boolean = true>(options: Options<CreditsPurchaseData, ThrowOnError>): RequestResult<CreditsPurchaseResponses, CreditsPurchaseErrors, ThrowOnError, 'data'>;
+    /**
+     * Preview a credit purchase and its tax
+     *
+     * Returns Stripe's current tax preview for the requested top-up amount. Requires account-management permission and is available only when in-page card purchases are enabled.
+     */
+    quotePurchase<ThrowOnError extends boolean = true>(options: Options<CreditsQuotePurchaseData, ThrowOnError>): RequestResult<CreditsQuotePurchaseResponses, CreditsQuotePurchaseErrors, ThrowOnError, 'data'>;
+    /**
+     * List managed-compute credit movements
+     *
+     * Requires account-management permission; execution keys receive 403. Returns
+     * confirmed, nonzero charges from the configured test or live billing book, the later
+     * corrections to them, reservations still held, and reservations released with no
+     * charge, newest first. Results are limited to the calling workspace. BYOK work,
+     * supplier costs, provider account identities, API-key digests and raw usage evidence
+     * are not returned; a row's `key_id` names the workspace API key it belongs to. A
+     * cursor belongs to this workspace and billing mode; invalid or foreign cursors
+     * return 400. New rows do not shift subsequent pages. No provider or payment-provider
+     * calls are made.
+     *
+     */
+    usage<ThrowOnError extends boolean = true>(options?: Options<CreditsUsageData, ThrowOnError>): RequestResult<CreditsUsageResponses, CreditsUsageErrors, ThrowOnError, 'data'>;
+    /**
+     * Get one credit purchase
+     *
+     * The authoritative state to poll after the payer returns from Checkout. Another workspace's purchase is a 404.
+     */
+    getPurchase<ThrowOnError extends boolean = true>(options: Options<CreditsGetPurchaseData, ThrowOnError>): RequestResult<CreditsGetPurchaseResponses, CreditsGetPurchaseErrors, ThrowOnError, 'data'>;
+    /**
+     * Close an unpaid Checkout session
+     *
+     * Expires a known open Checkout session for this workspace-owned purchase. A
+     * completed payment is reconciled and remains confirmed. If Checkout creation
+     * had an unknown outcome and no session ID was recorded, the same stable Stripe
+     * idempotency key recovers that request before BoxRouter expires the session.
+     * Repeating this request is safe. The request needs no body: the return URLs are
+     * optional and unused when closing a purchase.
+     *
+     */
+    cancelPurchase<ThrowOnError extends boolean = true>(options: Options<CreditsCancelPurchaseData, ThrowOnError>): RequestResult<CreditsCancelPurchaseResponses, CreditsCancelPurchaseErrors, ThrowOnError, 'data'>;
+    /**
+     * List redeemed promotion codes
+     *
+     * Promotion codes this workspace redeemed, newest first.
+     */
+    promotions<ThrowOnError extends boolean = true>(options?: Options<CreditsPromotionsData, ThrowOnError>): RequestResult<CreditsPromotionsResponses, CreditsPromotionsErrors, ThrowOnError, 'data'>;
+    /**
+     * Redeem a promotion code for free credit
+     *
+     * Adds the code's credit to the workspace balance, once per workspace. Codes are
+     * case-insensitive and surrounding spaces are ignored. An unknown, expired, disabled
+     * or fully used code is 404 promotion_code_invalid; these cases are not told apart.
+     * A new redemption answers 201. A code this workspace already redeemed is refused
+     * with 409 promotion_already_redeemed and details.redemption containing the original redemption;
+     * its message names the redemption date. No credit is granted again. Promotional
+     * credit does not expire. Requires account-management permission; 503 payments_unavailable while
+     * credits are not configured.
+     *
+     */
+    redeem<ThrowOnError extends boolean = true>(options: Options<CreditsRedeemData, ThrowOnError>): RequestResult<CreditsRedeemResponses, CreditsRedeemErrors, ThrowOnError, 'data'>;
+    /**
+     * Get workspace billing details
+     *
+     * Requires account-management permission. Reads the workspace Stripe customer. When multiple customer tax IDs exist, tax_id is the newest by creation time (ID breaks ties). Unset details are null.
+     */
+    billingDetails<ThrowOnError extends boolean = true>(options?: Options<CreditsBillingDetailsData, ThrowOnError>): RequestResult<CreditsBillingDetailsResponses, CreditsBillingDetailsErrors, ThrowOnError, 'data'>;
+    /**
+     * Replace workspace billing details
+     *
+     * Stores legal name, invoice email, address and one tax ID on the workspace Stripe customer, creating it when absent. Details apply to future invoices. PUT replaces all customer tax IDs with the supplied single ID, adding the replacement before deleting old IDs so a rejected replacement preserves them. Stripe tax ID verification can be pending or unsuccessful. Repeat an uncertain update with the same Idempotency-Key; a changed body under that key returns 409. Stripe rejection returns 502; the update can have partially completed, so read current details before correcting it.
+     */
+    updateBillingDetails<ThrowOnError extends boolean = true>(options: Options<CreditsUpdateBillingDetailsData, ThrowOnError>): RequestResult<CreditsUpdateBillingDetailsResponses, CreditsUpdateBillingDetailsErrors, ThrowOnError, 'data'>;
+    /**
+     * Get workspace credit alert settings
+     *
+     * Requires account-management permission. Returns workspace-owned settings only.
+     */
+    alerts<ThrowOnError extends boolean = true>(options?: Options<CreditsAlertsData, ThrowOnError>): RequestResult<CreditsAlertsResponses, CreditsAlertsErrors, ThrowOnError, 'data'>;
+    /**
+     * Replace workspace credit alert settings
+     *
+     * Atomically replaces the optional trigger level and evaluates the current available balance. Repeating identical settings is idempotent and requires no Idempotency-Key. Sends the owner one alert per crossing below the trigger level and one when available credit is zero or negative; a repeated evaluation does not resend. Re-arms at or above the trigger level and above zero respectively. BYOK work is unaffected by credit balance.
+     */
+    updateAlerts<ThrowOnError extends boolean = true>(options: Options<CreditsUpdateAlertsData, ThrowOnError>): RequestResult<CreditsUpdateAlertsResponses, CreditsUpdateAlertsErrors, ThrowOnError, 'data'>;
+    /**
+     * List saved workspace payment methods
+     *
+     * Returns masked card details only. Saved methods can be charged for a workspace member's purchase or immediately when enabling auto top-up with a trigger level above the current balance.
+     */
+    paymentMethods<ThrowOnError extends boolean = true>(options?: Options<CreditsPaymentMethodsData, ThrowOnError>): RequestResult<CreditsPaymentMethodsResponses, CreditsPaymentMethodsErrors, ThrowOnError, 'data'>;
+    /**
+     * Start hosted setup for a saved payment method
+     *
+     * Creates a Stripe-hosted setup page and returns its URL. Setup does not charge the
+     * payer. The completed method can be charged for a later user-initiated purchase or immediately when enabling auto top-up with a trigger level above the current balance.
+     * Repeating the request with the same Idempotency-Key returns the same page.
+     *
+     */
+    setupPaymentMethod<ThrowOnError extends boolean = true>(options: Options<CreditsSetupPaymentMethodData, ThrowOnError>): RequestResult<CreditsSetupPaymentMethodResponses, CreditsSetupPaymentMethodErrors, ThrowOnError, 'data'>;
+    /**
+     * Start in-page saved card setup
+     *
+     * Creates a Stripe SetupIntent for in-page card collection. Requires account-management permission and the in-page cards feature.
+     */
+    setupPaymentMethodIntent<ThrowOnError extends boolean = true>(options?: Options<CreditsSetupPaymentMethodIntentData, ThrowOnError>): RequestResult<CreditsSetupPaymentMethodIntentResponses, CreditsSetupPaymentMethodIntentErrors, ThrowOnError, 'data'>;
+    /**
+     * Set saved card charge order
+     *
+     * Replaces the order of every saved card and Link method for automatic top-up. Requires account-management permission and the multi-card top-up feature.
+     */
+    reorderPaymentMethods<ThrowOnError extends boolean = true>(options: Options<CreditsReorderPaymentMethodsData, ThrowOnError>): RequestResult<CreditsReorderPaymentMethodsResponses, CreditsReorderPaymentMethodsErrors, ThrowOnError, 'data'>;
+    /**
+     * Get a saved payment method setup status
+     *
+     * Reads Stripe's current setup state after the payer returns. Another workspace's setup is a 404.
+     */
+    getPaymentMethodSetup<ThrowOnError extends boolean = true>(options: Options<CreditsGetPaymentMethodSetupData, ThrowOnError>): RequestResult<CreditsGetPaymentMethodSetupResponses, CreditsGetPaymentMethodSetupErrors, ThrowOnError, 'data'>;
+    /**
+     * Remove a saved workspace payment method
+     *
+     * Detaches a saved card. Another workspace's payment method is a 404. If the card
+     * was the default, the next saved card becomes default; removing the last card
+     * disables auto top-up with disabled_reason payment_method_required.
+     *
+     */
+    deletePaymentMethod<ThrowOnError extends boolean = true>(options: Options<CreditsDeletePaymentMethodData, ThrowOnError>): RequestResult<CreditsDeletePaymentMethodResponses, CreditsDeletePaymentMethodErrors, ThrowOnError, 'data'>;
+    /**
+     * Set the workspace's default saved card
+     *
+     * Makes this workspace-owned saved card the only default card. The first saved
+     * card becomes default automatically. This local setting is used by one-click
+     * purchases and auto top-up; repeating the request is safe. Another workspace's
+     * card is a 404.
+     *
+     */
+    setDefaultPaymentMethod<ThrowOnError extends boolean = true>(options: Options<CreditsSetDefaultPaymentMethodData, ThrowOnError>): RequestResult<CreditsSetDefaultPaymentMethodResponses, CreditsSetDefaultPaymentMethodErrors, ThrowOnError, 'data'>;
+    /**
+     * Get automatic credit top-up settings
+     *
+     * Requires account-management permission. Auto top-up is off until explicitly enabled.
+     */
+    autoTopUp<ThrowOnError extends boolean = true>(options?: Options<CreditsAutoTopUpData, ThrowOnError>): RequestResult<CreditsAutoTopUpResponses, CreditsAutoTopUpErrors, ThrowOnError, 'data'>;
+    /**
+     * Replace automatic credit top-up settings
+     *
+     * Stores the enabled state, trigger level and purchase amount. The amount must be
+     * within current purchase_bounds_minor and the trigger level must be zero or greater.
+     * Enabling requires a default saved card. Enabling with a trigger level above current
+     * available credit evaluates and attempts one top-up immediately. An attempt is
+     * made once per crossing below the trigger level and is never retried automatically. A
+     * decline or required authentication disables auto top-up and records the reason.
+     * Repeating the same settings is idempotent and does not start a second attempt for
+     * the same balance crossing. After a 503 with outcome unknown, retry the identical
+     * settings or GET the settings; inspect last_attempt.purchase_id and poll that
+     * purchase to reconcile the original attempt.
+     *
+     */
+    updateAutoTopUp<ThrowOnError extends boolean = true>(options: Options<CreditsUpdateAutoTopUpData, ThrowOnError>): RequestResult<CreditsUpdateAutoTopUpResponses, CreditsUpdateAutoTopUpErrors, ThrowOnError, 'data'>;
+}