@boxrouter/sdk 0.0.1-alpha.0 → 0.12.190

package/dist/namespace-credits.mjs

@@ -0,0 +1,476 @@
+import { HeyApiClient } from './namespace-base.mjs';
+export 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(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/purchases',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/purchases',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/purchases/quote',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/usage',
+            ...options
+        });
+    }
+    /**
+     * Get one credit purchase
+     *
+     * The authoritative state to poll after the payer returns from Checkout. Another workspace's purchase is a 404.
+     */
+    getPurchase(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/purchases/{purchase_id}',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/purchases/{purchase_id}/cancel',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List redeemed promotion codes
+     *
+     * Promotion codes this workspace redeemed, newest first.
+     */
+    promotions(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/promotions',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/promotions',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/billing-details',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).put({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/billing-details',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get workspace credit alert settings
+     *
+     * Requires account-management permission. Returns workspace-owned settings only.
+     */
+    alerts(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/alerts',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).put({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/alerts',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods/setup',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options?.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods/setup-intent',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).put({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods/order',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-method-setups/{setup_id}',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods/{payment_method_id}',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/payment-methods/{payment_method_id}/default',
+            ...options
+        });
+    }
+    /**
+     * Get automatic credit top-up settings
+     *
+     * Requires account-management permission. Auto top-up is off until explicitly enabled.
+     */
+    autoTopUp(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/auto-top-up',
+            ...options
+        });
+    }
+    /**
+     * 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(options) {
+        return (options.client ?? this.client).put({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }, {
+                    in: 'cookie',
+                    name: '__Host-boxrouter_session',
+                    type: 'apiKey'
+                }],
+            url: '/credits/auto-top-up',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}

package/dist/namespace-files.d.mts

@@ -0,0 +1,203 @@
+import type { BinaryStreamResponses } from "./core/binaryStream.js";
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
+import { HeyApiClient } from './namespace-base.mjs';
+import type { FilesAbortUploadData, FilesAbortUploadErrors, FilesAbortUploadResponses, FilesCompleteUploadData, FilesCompleteUploadErrors, FilesCompleteUploadResponses, FilesCreateDownloadData, FilesCreateDownloadErrors, FilesCreateDownloadResponses, FilesCreateUploadData, FilesCreateUploadErrors, FilesCreateUploadResponses, FilesExistsData, FilesExistsErrors, FilesExistsResponses, FilesListData, FilesListErrors, FilesListResponses, FilesMkdirData, FilesMkdirErrors, FilesMkdirResponses, FilesReadData, FilesReadErrors, FilesReadResponses, FilesRemoveData, FilesRemoveErrors, FilesRemoveResponses, FilesWriteData, FilesWriteErrors, FilesWriteResponses } 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 Files extends HeyApiClient {
+    /**
+     * Read exact file bytes
+     *
+     * You can rely on:
+     * - Returns complete bytes, or resource_limit with no prefix returned.
+     * - Reading a directory or another path that is not a regular file fails and returns no data.
+     * - An absent path is not_found, outcome failed: a read has no effect, so its outcome is never unknown.
+     *
+     * You can set: path.
+     *
+     * Not promised: consistency while another writer changes the file.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. Bytes are not text-decoded.
+     * Closing the transfer does not destroy the sandbox. A stream that ends before
+     * Content-Length is an incomplete transfer, not a successful file read.
+     *
+     */
+    read<ThrowOnError extends boolean = true>(options: Options<FilesReadData, ThrowOnError>): RequestResult<FilesReadResponses, FilesReadErrors, ThrowOnError, 'data'>;
+    /**
+     * Read exact file bytes
+     *
+     * You can rely on:
+     * - Returns complete bytes, or resource_limit with no prefix returned.
+     * - Reading a directory or another path that is not a regular file fails and returns no data.
+     * - An absent path is not_found, outcome failed: a read has no effect, so its outcome is never unknown.
+     *
+     * You can set: path.
+     *
+     * Not promised: consistency while another writer changes the file.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. Bytes are not text-decoded.
+     * Closing the transfer does not destroy the sandbox. A stream that ends before
+     * Content-Length is an incomplete transfer, not a successful file read.
+     *
+     */
+    readStream<ThrowOnError extends boolean = true>(options: Omit<Options<FilesReadData, ThrowOnError>, "parseAs" | "responseStyle">): RequestResult<BinaryStreamResponses<FilesReadResponses>, FilesReadErrors, ThrowOnError, "fields">;
+    /**
+     * Write exact file bytes
+     *
+     * You can rely on:
+     * - Writes exact bytes.
+     * - Creates missing parents.
+     * - A new file is readable and writable by the command user.
+     * - The size limit is enforced.
+     *
+     * You can set: path, data.
+     *
+     * Not promised: owner, mode or executable bit; atomic replace; whether a symbolic link at the path is followed or replaced.
+     *
+     * The limit is the advertised limits.file_transfer_bytes. A failed transfer may leave
+     * partial data; the error's outcome describes what is known. SDK text helpers must encode
+     * text as UTF-8 before transfer.
+     *
+     */
+    write<ThrowOnError extends boolean = true>(options: Options<FilesWriteData, ThrowOnError>): RequestResult<FilesWriteResponses, FilesWriteErrors, ThrowOnError, 'data'>;
+    /**
+     * Create a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Starts an upload of a file of known size to an absolute path in a running sandbox. Send
+     * every returned part as described by its `TransferPart`, then call `completeSandboxUpload`
+     * with each part's response `ETag`, if any. BoxRouter chooses the `route`; it is
+     * informational and clients must not branch on it. Upload links and the session last up to
+     * six hours after creation; `expires_at` says when they end. Launch behaviour is always
+     * exactly one part. Idempotency-Key is required on create, complete and abort; repeat an
+     * uncertain call with the same key.
+     *
+     */
+    createUpload<ThrowOnError extends boolean = true>(options: Options<FilesCreateUploadData, ThrowOnError>): RequestResult<FilesCreateUploadResponses, FilesCreateUploadErrors, ThrowOnError, 'data'>;
+    /**
+     * Complete a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Supply each part number exactly once with the `ETag` header returned by its request, if
+     * it returned one. Repeating the call with the same idempotency key returns the same result.
+     *
+     */
+    completeUpload<ThrowOnError extends boolean = true>(options: Options<FilesCompleteUploadData, ThrowOnError>): RequestResult<FilesCompleteUploadResponses, FilesCompleteUploadErrors, ThrowOnError, 'data'>;
+    /**
+     * Abort a sandbox file upload
+     *
+     * You can rely on:
+     * - A completed upload leaves exactly the declared bytes at the path; a body of another length is refused.
+     *
+     * You can set: path, size.
+     *
+     * Not promised: removing bytes already written when an upload is aborted.
+     *
+     * Idempotent.
+     *
+     */
+    abortUpload<ThrowOnError extends boolean = true>(options: Options<FilesAbortUploadData, ThrowOnError>): RequestResult<FilesAbortUploadResponses, FilesAbortUploadErrors, ThrowOnError, 'data'>;
+    /**
+     * Create a sandbox file download
+     *
+     * You can rely on:
+     * - A complete download returns exactly the file's bytes; a transfer that ends short fails instead of returning a prefix.
+     *
+     * You can set: path.
+     *
+     * Not promised: the file's size before the download starts.
+     *
+     * Creates a temporary download link for a file in a running sandbox. The link lasts up to
+     * one hour after creation; `expires_at` says when it ends. `route` is informational and
+     * clients must not branch on it.
+     *
+     */
+    createDownload<ThrowOnError extends boolean = true>(options: Options<FilesCreateDownloadData, ThrowOnError>): RequestResult<FilesCreateDownloadResponses, FilesCreateDownloadErrors, ThrowOnError, 'data'>;
+    /**
+     * List the immediate entries of a directory
+     *
+     * You can rely on:
+     * - Returns every immediate entry, including hidden ones and broken symbolic links, sorted by name.
+     * - Each entry has its type (file, directory, symlink, other); a link is not followed.
+     * - More entries than the advertised limit fail; the list is never truncated.
+     *
+     * You can set: path.
+     *
+     * Not promised: metadata beyond the type; a consistent snapshot while the directory changes.
+     *
+     * An unreadable or missing directory fails; it does not appear empty. No recursion.
+     *
+     */
+    list<ThrowOnError extends boolean = true>(options: Options<FilesListData, ThrowOnError>): RequestResult<FilesListResponses, FilesListErrors, ThrowOnError, 'data'>;
+    /**
+     * Create a directory
+     *
+     * You can rely on:
+     * - parents=true (the default) creates missing parents and accepts an existing directory.
+     * - parents=false requires the parent and refuses an existing path.
+     *
+     * You can set: path, parents.
+     *
+     * Not promised: mode and owner beyond command-user usability.
+     *
+     * A failure may leave some parent directories created. An uncertain mutation is never automatically replayed.
+     *
+     */
+    mkdir<ThrowOnError extends boolean = true>(options: Options<FilesMkdirData, ThrowOnError>): RequestResult<FilesMkdirResponses, FilesMkdirErrors, ThrowOnError, 'data'>;
+    /**
+     * Check for an accessible filesystem target
+     *
+     * You can rely on:
+     * - Follows symbolic links. True when the target exists; false when it is missing, the link is broken, or the target is not accessible.
+     * - A failure to check raises an error; it never reads as false.
+     *
+     * You can set: path.
+     *
+     * Not promised: whether the answer still holds after the call.
+     *
+     * Transport and command-startup failures remain errors. This read does not reserve the path or guarantee it remains present.
+     *
+     */
+    exists<ThrowOnError extends boolean = true>(options: Options<FilesExistsData, ThrowOnError>): RequestResult<FilesExistsResponses, FilesExistsErrors, ThrowOnError, 'data'>;
+    /**
+     * Remove a file, symbolic link or directory
+     *
+     * You can rely on:
+     * - Removes only the named entry.
+     * - A nonempty directory needs recursive.
+     * - A symbolic link, broken or not, is unlinked and its target kept.
+     * - A missing path fails.
+     * - The sandbox root is refused.
+     *
+     * You can set: path, recursive.
+     *
+     * Not promised: atomicity; partial progress after a failure.
+     *
+     * A final slash does not change which entry is removed. Failures may leave partial changes. An uncertain mutation is never automatically replayed.
+     *
+     */
+    remove<ThrowOnError extends boolean = true>(options: Options<FilesRemoveData, ThrowOnError>): RequestResult<FilesRemoveResponses, FilesRemoveErrors, ThrowOnError, 'data'>;
+}