@superartifacts/sdk 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,2389 @@
+declare const VERSION = "0.1.0";
+interface ClientOptions {
+    /** Defaults to the SUPERARTIFACTS_API_KEY environment variable. */
+    apiKey?: string;
+    baseUrl?: string;
+    /** Milliseconds per attempt. */
+    timeout?: number;
+    maxRetries?: number;
+    fetch?: typeof globalThis.fetch;
+    /** The API refuses browsers, so this only helps behind your own proxy. */
+    dangerouslyAllowBrowser?: boolean;
+}
+interface RequestOptions {
+    /** Every POST gets a fresh one. `false` sends none, and a failed POST is then not retried. */
+    idempotencyKey?: string | false;
+    timeout?: number;
+    signal?: AbortSignal;
+    headers?: Record<string, string>;
+}
+/** One operation of the API, as the generated layer describes it. */
+interface Operation {
+    method: string;
+    path: string;
+    /** The path names travel in the path and these in the query; the rest is the body. */
+    query: readonly string[];
+    /** A destructive DELETE repeats this path name as `?confirm=`. */
+    confirm?: string;
+}
+type Body<Op> = Op extends {
+    requestBody?: {
+        content: {
+            'application/json': infer B;
+        };
+    };
+} ? B : object;
+type Path<Op> = Op extends {
+    parameters: {
+        path: infer P;
+    };
+} ? P : object;
+type Query<Op> = Op extends {
+    parameters: {
+        query?: infer Q;
+    };
+} ? [NonNullable<Q>] extends [never] ? object : NonNullable<Q> : object;
+/** Path, query and body fields of an operation, in one object. */
+type Params<Op> = Path<Op> & Query<Op> & Body<Op>;
+type Result<Op> = Op extends {
+    responses: {
+        200: {
+            content: {
+                'application/json': infer R;
+            };
+        };
+    };
+} ? R : unknown;
+declare class Core {
+    #private;
+    constructor(options?: ClientOptions);
+    /** Call one operation with its fields in one object. The generated resources all land here. */
+    call(operation: Operation, params?: object, options?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * PUT staged bytes, one file at a time. The URL is the credential, so no key goes with
+     * it, and it takes the same bytes twice, so it is always safe to repeat.
+     */
+    putFiles(targets: readonly {
+        url: string;
+    }[], files: readonly Blob[], options?: RequestOptions): Promise<void>;
+    /** One request with the retry rules. A 429 ran nothing, so it repeats whatever `repeatable` says. */
+    protected send(url: URL | string, init: RequestInit, repeatable: boolean, options?: RequestOptions): Promise<Record<string, unknown>>;
+}
+
+/** Anything this SDK throws for a failed call. `status` is 0 when no answer arrived. */
+declare class SuperArtifactsError extends Error {
+    readonly status: number;
+    /** Stable and machine-readable; `message` is for a person. */
+    readonly code: string;
+    /** Seconds the API asked to wait. */
+    readonly retryAfter?: number;
+    /** Everything else the API said, e.g. `fix` or `approvalUrl`. */
+    readonly details: Record<string, unknown>;
+    constructor(status: number, code: string, message: string, retryAfter?: number, details?: Record<string, unknown>, options?: ErrorOptions);
+}
+declare class InvalidArgumentsError extends SuperArtifactsError {
+}
+declare class AuthenticationError extends SuperArtifactsError {
+}
+declare class PlanLimitError extends SuperArtifactsError {
+}
+declare class PermissionError extends SuperArtifactsError {
+}
+declare class ScopeRequiredError extends SuperArtifactsError {
+}
+declare class NotFoundError extends SuperArtifactsError {
+}
+declare class ConflictError extends SuperArtifactsError {
+}
+declare class PayloadTooLargeError extends SuperArtifactsError {
+}
+declare class RateLimitError extends SuperArtifactsError {
+}
+declare class InternalError extends SuperArtifactsError {
+}
+/** The request never got an answer. */
+declare class ConnectionError extends SuperArtifactsError {
+}
+declare class TimeoutError extends SuperArtifactsError {
+}
+/** The error for an HTTP refusal. `text` may be anything: a proxy's HTML page is not `{error}`. */
+declare function errorFor(status: number, text: string, retryAfterHeader: string | null): SuperArtifactsError;
+
+interface components {
+    schemas: {
+        Error: {
+            error: {
+                /** @description Stable, machine-readable. */
+                code: string;
+                /** @description For a person. */
+                message: string;
+                fix?: string;
+                retryAfterSeconds?: number;
+            } & {
+                [key: string]: unknown;
+            };
+        };
+    };
+    responses: {
+        /** @description A refusal. 400 invalid arguments, 401 no or bad key, 402 plan limit, 403 forbidden or read-only key, 404 not found, 409 conflict, 413 body over 1 MiB, 429 rate limited (see Retry-After). */
+        Error: {
+            headers: {
+                /** @description On 429: seconds to wait. */
+                'Retry-After'?: number;
+                [name: string]: unknown;
+            };
+            content: {
+                'application/json': components['schemas']['Error'];
+            };
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+interface operations {
+    whoami: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Who this key publishes as */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getHelp: {
+        parameters: {
+            query?: {
+                topic?: 'tools' | 'data' | 'templates' | 'collections' | 'projects' | 'batch';
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description How the operations fit together */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listArtifacts: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List your artifacts, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    publishArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @description Kebab-case, 3–63 chars, under your key’s handle: it updates one there you are Editor on. Another workspace’s artifact: publish from its dashboard. */
+                    slug: string;
+                    /** @description One sentence on why; shown in the gallery. */
+                    prompt: string;
+                    /** @description Complete self-contained index.html. */
+                    html?: string;
+                    /** @description Filled slots for `template`'s runtime, by slot name; `json` slots are schema-checked. */
+                    values?: Record<string, unknown>;
+                    /** @description Instead of `slug`/`values`: several pages of one `template`. */
+                    instances?: {
+                        slug: string;
+                        values: Record<string, unknown>;
+                        title?: string;
+                    }[];
+                    /** @description The template built from (provenance); required with `values` or `instances`. */
+                    template?: {
+                        slug: string;
+                        version?: number;
+                    };
+                    /** @description Under 60 chars. Default: page <title>. */
+                    title?: string;
+                    /** @description Link-preview sentence, under 200 chars. Default: `prompt`. */
+                    description?: string;
+                    /**
+                     * @description Default `page`. `dashboard` labels a page of mostly live data.
+                     * @enum {string}
+                     */
+                    kind?: 'page' | 'slideshow' | 'survey' | 'tracker' | 'video' | 'tool' | 'dashboard';
+                    /** @description Gallery grouping label, not a content collection. */
+                    collection?: string;
+                    /**
+                     * @description From version 1. Default: the workspace default; public is set after.
+                     * @enum {string}
+                     */
+                    visibility?: 'private' | 'organization';
+                    /** @description Data policy v1. Visitors submit to a sheet (perUser single, upsert, a field per question), a log (many, append-only) or a shared doc (shared, key). CMS rows: `collections`. See super_help data. */
+                    policy?: Record<string, unknown>;
+                    /** @description With `values`: overrides the declaration's `dataset.key`. */
+                    dataset?: string;
+                    /** @description With `values`: the dataset key this one succeeds. */
+                    continues?: string;
+                    /** @description uploadId from super_upload; its files ship with the page. */
+                    uploads?: string;
+                    /** @description With `uploads`: the staged JSON file to read `values` from. */
+                    valuesFile?: string;
+                    /** @description With `html`: small assets. ≤200, 5 MiB each, 10 MiB total, decoded. */
+                    files?: {
+                        /** @description Relative, no leading slash. */
+                        path: string;
+                        /** @description Base64 of the bytes. */
+                        content: string;
+                        /** @description Default: from the extension. */
+                        contentType?: string;
+                        /** @description Hex digest of the decoded bytes. */
+                        sha256?: string;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Publish an artifact, or a new version of one */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One artifact: its versions, published version and declaration */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    deleteArtifact: {
+        parameters: {
+            query: {
+                /** @description Repeat the artifact: deleting is permanent. */
+                confirm: string;
+            };
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Delete an artifact with every version, permanently */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    updateArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /**
+                     * @description private: Restricted (default). organization: anyone at the workspace. public: anyone with the link.
+                     * @enum {string}
+                     */
+                    visibility?: 'private' | 'organization' | 'public';
+                    /** @description Gallery grouping label, ≤ 60 chars. Empty clears it. */
+                    collection?: string;
+                    /** @description The name a stream’s `revealAt` waits for; from then on that stream reads as public. */
+                    phase?: string;
+                    notifyOnSubmission?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Change visibility, gallery label, live phase or submission email */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    readArtifactFile: {
+        parameters: {
+            query?: {
+                path?: string;
+                version?: number;
+            };
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Read one file of a version as text (default: the published index.html) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    openArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    version?: number;
+                };
+            };
+        };
+        responses: {
+            /** @description A ten-minute viewer URL for an artifact, private included */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    serveVersion: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+                version: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Serve an existing version again */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    startLiveRoom: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Turn an artifact's live room on */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    stopLiveRoom: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Turn an artifact's live room off, disconnecting every visitor */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    stageUploads: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    files: {
+                        path: string;
+                        /** @description Exact size. */
+                        bytes: number;
+                        /** @description Hex; checked on upload. */
+                        sha256?: string;
+                        /** @description Default: from the extension. */
+                        contentType?: string;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Stage big files for a publish; PUT each to its URL */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listArtifactRows: {
+        parameters: {
+            query?: {
+                /** @description ANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains in, is set, is unset. System: _version _at _status _visitor. */
+                filter?: string[];
+                /** @description ISO-8601 instant or window (7d, 24h). Or a version (v2) when addressing one artifact. */
+                since?: string;
+                until?: string;
+                /** @description By collection time. */
+                sort?: 'newest' | 'oldest';
+                /** @description Per artifact. Default 50. */
+                limit?: number;
+                /** @description The previous cursor.next. */
+                cursor?: string;
+                fields?: string[];
+            };
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Rows visitors submitted to one artifact, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    writeArtifactRows: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    stream?: string;
+                    rows?: Record<string, unknown>[];
+                    ops?: Record<string, unknown>[];
+                    atomic?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Write rows into an artifact you may edit */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listRows: {
+        parameters: {
+            query?: {
+                dataset?: string;
+                /** @description The gallery grouping label set at publish, case-sensitive. Not a content collection. */
+                collection?: string;
+                /** @description ANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains in, is set, is unset. System: _version _at _status _visitor. */
+                filter?: string[];
+                /** @description ISO-8601 instant or window (7d, 24h). Or a version (v2) when addressing one artifact. */
+                since?: string;
+                until?: string;
+                /** @description By collection time. */
+                sort?: 'newest' | 'oldest';
+                /** @description Per artifact. Default 50. */
+                limit?: number;
+                /** @description The previous cursor.next. */
+                cursor?: string;
+                fields?: string[];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Rows submitted to a dataset or a gallery label */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    queryData: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description The union of the forms given. */
+                    scope?: {
+                        series?: string;
+                        datasets?: string[];
+                        /** @description All must match. */
+                        tags?: string[];
+                    };
+                    /** @description Catalog measure names, not field names. */
+                    measures?: string[];
+                    /** @enum {string} */
+                    agg?: 'sum' | 'avg' | 'min' | 'max' | 'count' | 'last';
+                    /** @description Derived columns, in order; operands name a measure or an earlier `as`. */
+                    compute?: {
+                        as: string;
+                        /** @enum {string} */
+                        expr: 'a * b' | 'a / b' | 'a + b';
+                        operands: string[];
+                        unit?: string;
+                    }[];
+                    /** @description ANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= in. Catalog fields only. */
+                    filter?: string[];
+                    /** @description One of dataset, day, week, month, visitor, or "field:{name}". */
+                    group_by?: (string | ('dataset' | 'day' | 'week' | 'month' | 'visitor') | unknown)[];
+                    /** @description ISO-8601 instant or window (7d, 24h). */
+                    since?: string;
+                    until?: string;
+                    limit?: number;
+                    /** @description One artifact's per-field distributions instead of a scoped query. */
+                    distributions?: {
+                        /** @description Artifact id or slug. */
+                        artifact: string;
+                        version?: number;
+                        /** @description A choice, boolean or integer field. */
+                        group_by?: string;
+                        /** @enum {string} */
+                        bucket?: 'day' | 'week';
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description Aggregate what was collected: numbers, never rows */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getSchema: {
+        parameters: {
+            query?: {
+                series?: string;
+                /** @description All must match. */
+                tags?: string[];
+                /** @description Artifact id or slug. */
+                artifact?: string;
+                /** @description Alone: 2+ ids or slugs; their fields side by side, conflicts named. */
+                compare?: string[];
+                /** @description ISO-8601 instant or window (7d, 24h). */
+                since?: string;
+                /** @description Workspace handle. Omit for your own. */
+                workspace?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The data catalog: datasets and content collections, or a comparison */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    defineCollection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description A content collection definition: creates one, or replaces the one with this key. */
+                    define?: {
+                        /** @description Lowercase letters, digits, underscores; starts with a letter. */
+                        key: string;
+                        /** @description 1–80 chars. */
+                        name: string;
+                        description?: string;
+                        /** @description Labels an entry. Default: first text field. */
+                        displayField?: string;
+                        fields: {
+                            name: string;
+                            /** @description text long_text rich_text email url phone color integer decimal rating measurement boolean date datetime time choice multi_choice json reference reference_list */
+                            type: string;
+                            label?: string;
+                            required?: boolean;
+                            unique?: boolean;
+                            /**
+                             * @description contact: masked for non-owners. sensitive: encrypted, no sort/filter/search. secret: write-only credential.
+                             * @enum {string}
+                             */
+                            pii: 'none' | 'contact' | 'sensitive' | 'secret';
+                            description?: string;
+                            /** @description By type: minLength maxLength pattern; min max precision; scale; measure unit; after before; choices minChoices maxChoices; collection onDelete; maxItems; maxBytes. */
+                            rules?: Record<string, unknown>;
+                        }[];
+                    };
+                    /** @description Workspace handle. Omit for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Create or replace a content collection */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listEntries: {
+        parameters: {
+            query?: {
+                /** @description Workspace handle. Omit for your own. */
+                workspace?: string;
+                /** @description ANDed 'field op value' clauses: 'reps >= 5', 'day in mon,tue', 'note is set'. Ops: = != > >= < <= contains starts has in, is set, is empty. System: _created_at _updated_at _status _author. */
+                filter?: string[];
+                /** @description Case-insensitive, over text fields. */
+                search?: string;
+                /** @description Field or system column. Default _created_at. */
+                sort?: string;
+                direction?: 'asc' | 'desc';
+                page?: number;
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                /** @description Content collection key (a content model), not a gallery label. */
+                collection: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One page of a content collection's entries */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    createEntries: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Content collection key (a content model), not a gallery label. */
+                collection: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description Keyed by field name. An array writes a batch. */
+                    values?: Record<string, unknown> | Record<string, unknown>[];
+                    /**
+                     * @description Written entries. Default published.
+                     * @enum {string}
+                     */
+                    status?: 'draft' | 'published' | 'archived';
+                    /** @description Workspace handle. Omit for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Create one entry, or a batch */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    useSecret: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Content collection key (a content model), not a gallery label. */
+                collection: string;
+                /** @description The entry id. */
+                entry: string;
+                /** @description The `pii: secret` field whose value is sent. */
+                field: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @enum {string} */
+                    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+                    /** @description https only; its host must be the approved one. Redirects are returned, never followed. */
+                    url: string;
+                    /** @description Sent as given, except host, authorization, cookie, proxy-* and the grant’s own header. */
+                    headers?: {
+                        [key: string]: string;
+                    };
+                    /** @description ≤64 KiB. */
+                    body?: string;
+                    /** @description Where the value goes; asked for when no grant exists. The approved grant’s header wins. */
+                    header?: {
+                        /** @description e.g. authorization, x-api-key. */
+                        name: string;
+                        /** @description Prefix before the value, e.g. "Bearer ". May be empty. */
+                        scheme?: string;
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description Call an approved API with a stored secret you cannot read (workspace keys) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listTemplates: {
+        parameters: {
+            query?: {
+                /** @description What the person asked for, in their words. */
+                request?: string;
+                /** @description Default installed. */
+                scope?: 'installed' | 'marketplace';
+                /** @description A label, not a capability. */
+                kind?: 'page' | 'slideshow' | 'survey' | 'tracker' | 'video' | 'tool' | 'dashboard';
+                /** @description Default relevance with `request`, else rating. */
+                sort?: 'relevance' | 'rating' | 'uses' | 'installs' | 'recent';
+                /** @description Default 5. */
+                limit?: number;
+                /** @description Any of. */
+                jobs?: ('track' | 'collect' | 'present' | 'report' | 'monitor' | 'prove' | 'document' | 'explain' | 'plan' | 'decide' | 'review' | 'learn' | 'prototype' | 'announce' | 'compute' | 'curate' | 'coordinate' | 'play')[];
+                /** @description Any of. */
+                audience?: ('everyone' | 'engineering' | 'product' | 'design' | 'marketing' | 'sales' | 'ops' | 'people' | 'finance' | 'founders' | 'education' | 'personal' | 'community')[];
+                /** @description All of. `["runtime"]`: ships code. */
+                needs?: ('runtime' | 'data' | 'comments' | 'live')[];
+                /** @description fill: you send a document; write: you write the page; build: page and policy. */
+                cost?: 'fill' | 'write' | 'build';
+                /** @description Marketplace trust tier: Official, Verified or Community. */
+                tier?: 'all' | 'official' | 'verified' | 'community';
+                mine?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Find, rank or list templates */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    saveTemplate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @description Kebab-case, 3–64 chars. Permanent. */
+                    slug: string;
+                    title: string;
+                    description: string;
+                    /**
+                     * @description `dashboard`: a page that mostly shows live data — a label, not a capability.
+                     * @enum {string}
+                     */
+                    kind?: 'page' | 'slideshow' | 'survey' | 'tracker' | 'video' | 'tool' | 'dashboard';
+                    /** @description What a person hires it for; the first is primary. Create default: from `kind`. */
+                    jobs?: ('track' | 'collect' | 'present' | 'report' | 'monitor' | 'prove' | 'document' | 'explain' | 'plan' | 'decide' | 'review' | 'learn' | 'prototype' | 'announce' | 'compute' | 'curate' | 'coordinate' | 'play')[];
+                    /** @description 1–3, or `everyone` alone (the default). */
+                    audience?: ('everyone' | 'engineering' | 'product' | 'design' | 'marketing' | 'sales' | 'ops' | 'people' | 'finance' | 'founders' | 'education' | 'personal' | 'community')[];
+                    /** @description Things to build from it; the build prompt draws on them. */
+                    useCases?: {
+                        title: string;
+                        prompt: string;
+                    }[];
+                    /**
+                     * @description After install: `scenarios` (default) offers three builds; `explainer` builds one from the sample; `interview` asks three questions first.
+                     * @enum {string}
+                     */
+                    installArchetype?: 'scenarios' | 'explainer' | 'interview';
+                    /** @description Your note, appended to the build prompt as a suggestion. */
+                    installAfter?: string;
+                    /** @description The sample may appear on the public listing page. */
+                    samplePublic?: boolean;
+                    /**
+                     * @description Deprecated; read as `jobs` when `jobs` is absent.
+                     * @enum {string}
+                     */
+                    category?: 'trackers' | 'surveys' | 'presentations' | 'dashboards' | 'documents' | 'tools' | 'games' | 'other';
+                    /** @description `slots`, `declaration` (every instance’s policy), optional `comments`, `keywords` (searched), `examplePrompts`. */
+                    spec: {
+                        /** @description The fill schema, an array: [{"name": "headline", "type": "text", "required": true, "max": 120}]. */
+                        slots?: {
+                            name: string;
+                            type: string;
+                        }[];
+                    };
+                    /** @description Optional notes for whoever fills it. */
+                    guidance?: string;
+                    /** @description A prompt a person copies to ask for one. */
+                    prompt?: string;
+                    /** @description `{"values": {…}}`, rendered in the preview. */
+                    sample?: Record<string, unknown>;
+                    /** @description Slug of your artifact to link as the demo (linked once public). "" clears it. */
+                    demo?: string;
+                    /** @description Runtime files, `index.html` required. Omitting them on a revision drops the runtime from that new draft version only. */
+                    files?: {
+                        path: string;
+                        /** @description UTF-8 text, base64-ed for you. Send `text` or `content`. */
+                        text?: string;
+                        /** @description Base64 of the bytes, for binaries. */
+                        content?: string;
+                        contentType?: string;
+                    }[];
+                    /** @description Extra artifacts each publish makes at {slug}-{role}, same values (e.g. a stage for a host). Bind the primary with `source: {artifact: "@primary", streams}`. Released: add, never remove. */
+                    companions?: {
+                        /** @description Kebab-case, unique, not "primary". */
+                        role: string;
+                        title: string;
+                        description?: string;
+                        /** @enum {string} */
+                        kind?: 'page' | 'slideshow' | 'survey' | 'tracker' | 'video' | 'tool' | 'dashboard';
+                        /**
+                         * @description Default inherit: the primary’s.
+                         * @enum {string}
+                         */
+                        visibility?: 'inherit' | 'private' | 'public';
+                        /** @description This part’s policy, or omit. */
+                        declaration?: Record<string, unknown>;
+                        /** @description Slot names whose values this part gets. Default all. */
+                        slots?: string[];
+                        /** @description Runtime files, `index.html` required. Omitting them on a revision drops the runtime from that new draft version only. */
+                        files: {
+                            path: string;
+                            /** @description UTF-8 text, base64-ed for you. Send `text` or `content`. */
+                            text?: string;
+                            /** @description Base64 of the bytes, for binaries. */
+                            content?: string;
+                            contentType?: string;
+                        }[];
+                    }[];
+                    /** @description The version you revised. Present: revise. Absent: create. */
+                    expectedVersion?: number;
+                    /** @description Revisions: one line on why, for the changelog. */
+                    changeNote?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Create or revise a template draft */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getTemplate: {
+        parameters: {
+            query?: {
+                /** @description Default: the released one. */
+                version?: number;
+            };
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One template in full, with its install prompt */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getTemplateHistory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A template's changelog */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getTemplateFeedback: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Comments on a template's artifacts, as themes */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    actOnTemplate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    /** @enum {string} */
+                    action: 'install' | 'uninstall' | 'rate' | 'report' | 'rollback' | 'request_verification';
+                    stars?: number;
+                    version?: number;
+                    /**
+                     * @description Report only.
+                     * @enum {string}
+                     */
+                    kind?: 'spam' | 'harmful' | 'broken' | 'misleading' | 'pii' | 'copyright' | 'other';
+                    /** @description Report only. */
+                    reason?: string;
+                    /** @description Install only: true once the person agreed to this public template. Never set it unasked (`permission_required`). */
+                    confirmedByPerson?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Install, uninstall, rate, report, roll back or request verification */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    releaseTemplate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                slug: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    version: number;
+                    /**
+                     * @description `unlisted` (default): by slug. `public`: marketplace. `workspace`: team shelf, members only.
+                     * @enum {string}
+                     */
+                    visibility?: 'public' | 'unlisted' | 'workspace';
+                    /** @description Default false. Makes the demo artifact, and its data, public. */
+                    demoConsent?: boolean;
+                    /** @description true: show the sample on the public listing. Omit: unchanged. */
+                    sampleConsent?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Release one version of your template */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listProjects: {
+        parameters: {
+            query?: {
+                /** @description Workspace handle. Omit for your own. */
+                workspace?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Your projects */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    createProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description ≤ 120 chars. */
+                    title?: string;
+                    /** @description Artifact ids or slugs, in order. */
+                    artifacts?: string[];
+                    /** @description Heading over these artifacts. */
+                    groupLabel?: string;
+                    /**
+                     * @description organization: anyone at the workspace. Widening over private needs confirm.
+                     * @enum {string}
+                     */
+                    visibility?: 'private' | 'organization' | 'public';
+                    /** @description See super_help projects. null: manual. */
+                    rule?: Record<string, unknown> | null;
+                    /** @description Needed to delete; also to add a private artifact to a shared project, or widen one holding private ones (`confirm_private`). */
+                    confirm?: boolean;
+                    /** @description Workspace handle. Omit for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Create a project, optionally seeded with artifacts */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getProject: {
+        parameters: {
+            query?: {
+                /** @description Workspace handle. Omit for your own. */
+                workspace?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One project and its items */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    deleteProject: {
+        parameters: {
+            query: {
+                /** @description Repeat the project: deleting is permanent. */
+                confirm: string;
+            };
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Delete a project; its artifacts stay */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    updateProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description ≤ 120 chars. */
+                    title?: string;
+                    /**
+                     * @description organization: anyone at the workspace. Widening over private needs confirm.
+                     * @enum {string}
+                     */
+                    visibility?: 'private' | 'organization' | 'public';
+                    /** @description Every item once, in order: ids or slugs. */
+                    order?: string[];
+                    move?: {
+                        /** @description An artifact id or slug, or an item id. */
+                        artifact: string;
+                        /** @description New position; 1 is first. */
+                        to: number;
+                    };
+                    /** @description See super_help projects. null: manual. */
+                    rule?: Record<string, unknown> | null;
+                    /** @description groupLabels shown folded. Whole set. */
+                    collapsedGroups?: string[];
+                    /** @description Needed to delete; also to add a private artifact to a shared project, or widen one holding private ones (`confirm_private`). */
+                    confirm?: boolean;
+                    /** @description Workspace handle. Omit for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Rename, set visibility, reorder, move, fold groups or set a rule */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    addProjectArtifacts: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description Artifact ids or slugs, in order. */
+                    artifacts?: string[];
+                    /** @description Heading over these artifacts. */
+                    groupLabel?: string;
+                    /** @description Needed to delete; also to add a private artifact to a shared project, or widen one holding private ones (`confirm_private`). */
+                    confirm?: boolean;
+                    /** @description Workspace handle. Omit for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Add artifacts to a project */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    removeProjectArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+                /** @description An artifact id or slug, or an item id. */
+                remove: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Remove one artifact (or item) from a project */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    shareArtifact: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    emails: string[];
+                    /**
+                     * @description Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.
+                     * @enum {string}
+                     */
+                    role?: 'viewer' | 'commenter' | 'editor';
+                };
+            };
+        };
+        responses: {
+            /** @description Give named people access to an artifact */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    shareProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Project id, slug or exact title. */
+                project: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    emails: string[];
+                    /**
+                     * @description Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.
+                     * @enum {string}
+                     */
+                    role?: 'viewer' | 'commenter' | 'editor';
+                    /** @description Project only: true shares a project that holds private artifacts (`confirm_private`). */
+                    confirm?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Give named people access to a project */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    shareWorkspace: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': {
+                    emails: string[];
+                    /**
+                     * @description Default viewer; editor for a workspace. An editor's key restores (super_artifact_set version), writes (super_data_write), publishes by slug in its workspace.
+                     * @enum {string}
+                     */
+                    role?: 'viewer' | 'commenter' | 'editor';
+                    /** @description A handle you administer, or "" for your own. */
+                    workspace?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Invite editors to a workspace (returns accept links) */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listComments: {
+        parameters: {
+            query?: {
+                status?: 'all' | 'open' | 'resolved';
+                /** @description A path inside the artifact, e.g. "/pricing". Not pagination. */
+                page?: string;
+                limit?: number;
+                /** @description The previous cursor.next. */
+                cursor?: string;
+            };
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Comment threads on an artifact, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    respondToComments: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    respond?: {
+                        /** @description Thread id, not a message id. */
+                        thread: string;
+                        /** @description A plain-text reply. */
+                        body?: string;
+                        /** @description true resolves, false reopens. */
+                        resolve?: boolean;
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Reply to and/or resolve threads, one outcome each */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getCommentScreenshot: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Artifact id or slug. */
+                artifact: string;
+                /** @description A message id, not a thread id. */
+                screenshot: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One message's screenshot, base64 in `image` */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listMentions: {
+        parameters: {
+            query?: {
+                /** @description Artifact id or slug. */
+                artifact?: string;
+                limit?: number;
+                /** @description The previous cursor.next. */
+                cursor?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Where people @mentioned you; listing marks them seen */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    listSignatureRequests: {
+        parameters: {
+            query?: {
+                /** @description Artifact id or slug. */
+                artifact?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description An artifact's signature requests, newest first */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    requestSignatures: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description Artifact id or slug. */
+                    artifact?: string;
+                    /** @description The version to sign. Default: the published one. */
+                    version?: number;
+                    signers?: {
+                        name: string;
+                        email: string;
+                        /** @description Their role in the agreement, e.g. "Tenant". */
+                        party?: string;
+                    }[];
+                    /** @description A note shown to every signer. */
+                    message?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Ask named people to sign one version of an artifact */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    getSignatureRequest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A signature request id, from request or status. */
+                request: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One signature request and its signers */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    remindSigner: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A signature request id, from request or status. */
+                request: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/json': {
+                    /** @description A signer id, from status. For remind. */
+                    signer?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Email a signer their link again */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+    withdrawSignatureRequest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A signature request id, from request or status. */
+                request: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Close an open signature request */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            default: components['responses']['Error'];
+        };
+    };
+}
+
+declare const OPERATIONS: {
+    readonly whoami: {
+        readonly method: "GET";
+        readonly path: "/v1/whoami";
+        readonly query: readonly [];
+    };
+    readonly getHelp: {
+        readonly method: "GET";
+        readonly path: "/v1/help";
+        readonly query: readonly ["topic"];
+    };
+    readonly listArtifacts: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts";
+        readonly query: readonly [];
+    };
+    readonly publishArtifact: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts";
+        readonly query: readonly [];
+    };
+    readonly getArtifact: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts/{artifact}";
+        readonly query: readonly [];
+    };
+    readonly updateArtifact: {
+        readonly method: "PATCH";
+        readonly path: "/v1/artifacts/{artifact}";
+        readonly query: readonly [];
+    };
+    readonly deleteArtifact: {
+        readonly method: "DELETE";
+        readonly path: "/v1/artifacts/{artifact}";
+        readonly query: readonly [];
+        readonly confirm: "artifact";
+    };
+    readonly readArtifactFile: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts/{artifact}/file";
+        readonly query: readonly ["path", "version"];
+    };
+    readonly openArtifact: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/open";
+        readonly query: readonly [];
+    };
+    readonly serveVersion: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/versions/{version}/serve";
+        readonly query: readonly [];
+    };
+    readonly startLiveRoom: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/live";
+        readonly query: readonly [];
+    };
+    readonly stopLiveRoom: {
+        readonly method: "DELETE";
+        readonly path: "/v1/artifacts/{artifact}/live";
+        readonly query: readonly [];
+    };
+    readonly stageUploads: {
+        readonly method: "POST";
+        readonly path: "/v1/uploads";
+        readonly query: readonly [];
+    };
+    readonly listArtifactRows: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts/{artifact}/data";
+        readonly query: readonly ["filter", "since", "until", "sort", "limit", "cursor", "fields"];
+    };
+    readonly writeArtifactRows: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/data/rows";
+        readonly query: readonly [];
+    };
+    readonly listRows: {
+        readonly method: "GET";
+        readonly path: "/v1/data";
+        readonly query: readonly ["dataset", "collection", "filter", "since", "until", "sort", "limit", "cursor", "fields"];
+    };
+    readonly queryData: {
+        readonly method: "POST";
+        readonly path: "/v1/data/query";
+        readonly query: readonly [];
+    };
+    readonly getSchema: {
+        readonly method: "GET";
+        readonly path: "/v1/schema";
+        readonly query: readonly ["series", "tags", "artifact", "compare", "since", "workspace"];
+    };
+    readonly defineCollection: {
+        readonly method: "PUT";
+        readonly path: "/v1/schema";
+        readonly query: readonly [];
+    };
+    readonly listEntries: {
+        readonly method: "GET";
+        readonly path: "/v1/collections/{collection}/entries";
+        readonly query: readonly ["workspace", "filter", "search", "sort", "direction", "page", "limit"];
+    };
+    readonly createEntries: {
+        readonly method: "POST";
+        readonly path: "/v1/collections/{collection}/entries";
+        readonly query: readonly [];
+    };
+    readonly useSecret: {
+        readonly method: "POST";
+        readonly path: "/v1/collections/{collection}/entries/{entry}/fields/{field}/use";
+        readonly query: readonly [];
+    };
+    readonly listTemplates: {
+        readonly method: "GET";
+        readonly path: "/v1/templates";
+        readonly query: readonly ["request", "scope", "kind", "sort", "limit", "jobs", "audience", "needs", "cost", "tier", "mine"];
+    };
+    readonly saveTemplate: {
+        readonly method: "POST";
+        readonly path: "/v1/templates";
+        readonly query: readonly [];
+    };
+    readonly getTemplate: {
+        readonly method: "GET";
+        readonly path: "/v1/templates/{slug}";
+        readonly query: readonly ["version"];
+    };
+    readonly getTemplateHistory: {
+        readonly method: "GET";
+        readonly path: "/v1/templates/{slug}/history";
+        readonly query: readonly [];
+    };
+    readonly getTemplateFeedback: {
+        readonly method: "GET";
+        readonly path: "/v1/templates/{slug}/feedback";
+        readonly query: readonly [];
+    };
+    readonly actOnTemplate: {
+        readonly method: "POST";
+        readonly path: "/v1/templates/{slug}/actions";
+        readonly query: readonly [];
+    };
+    readonly releaseTemplate: {
+        readonly method: "POST";
+        readonly path: "/v1/templates/{slug}/release";
+        readonly query: readonly [];
+    };
+    readonly listProjects: {
+        readonly method: "GET";
+        readonly path: "/v1/projects";
+        readonly query: readonly ["workspace"];
+    };
+    readonly createProject: {
+        readonly method: "POST";
+        readonly path: "/v1/projects";
+        readonly query: readonly [];
+    };
+    readonly getProject: {
+        readonly method: "GET";
+        readonly path: "/v1/projects/{project}";
+        readonly query: readonly ["workspace"];
+    };
+    readonly updateProject: {
+        readonly method: "PATCH";
+        readonly path: "/v1/projects/{project}";
+        readonly query: readonly [];
+    };
+    readonly deleteProject: {
+        readonly method: "DELETE";
+        readonly path: "/v1/projects/{project}";
+        readonly query: readonly [];
+        readonly confirm: "project";
+    };
+    readonly addProjectArtifacts: {
+        readonly method: "POST";
+        readonly path: "/v1/projects/{project}/artifacts";
+        readonly query: readonly [];
+    };
+    readonly removeProjectArtifact: {
+        readonly method: "DELETE";
+        readonly path: "/v1/projects/{project}/artifacts/{remove}";
+        readonly query: readonly [];
+    };
+    readonly shareArtifact: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/shares";
+        readonly query: readonly [];
+    };
+    readonly shareProject: {
+        readonly method: "POST";
+        readonly path: "/v1/projects/{project}/shares";
+        readonly query: readonly [];
+    };
+    readonly shareWorkspace: {
+        readonly method: "POST";
+        readonly path: "/v1/workspace/shares";
+        readonly query: readonly [];
+    };
+    readonly listComments: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts/{artifact}/comments";
+        readonly query: readonly ["status", "page", "limit", "cursor"];
+    };
+    readonly respondToComments: {
+        readonly method: "POST";
+        readonly path: "/v1/artifacts/{artifact}/comments/responses";
+        readonly query: readonly [];
+    };
+    readonly getCommentScreenshot: {
+        readonly method: "GET";
+        readonly path: "/v1/artifacts/{artifact}/comments/screenshots/{screenshot}";
+        readonly query: readonly [];
+    };
+    readonly listMentions: {
+        readonly method: "GET";
+        readonly path: "/v1/mentions";
+        readonly query: readonly ["artifact", "limit", "cursor"];
+    };
+    readonly listSignatureRequests: {
+        readonly method: "GET";
+        readonly path: "/v1/signatures";
+        readonly query: readonly ["artifact"];
+    };
+    readonly requestSignatures: {
+        readonly method: "POST";
+        readonly path: "/v1/signatures";
+        readonly query: readonly [];
+    };
+    readonly getSignatureRequest: {
+        readonly method: "GET";
+        readonly path: "/v1/signatures/{request}";
+        readonly query: readonly [];
+    };
+    readonly remindSigner: {
+        readonly method: "POST";
+        readonly path: "/v1/signatures/{request}/remind";
+        readonly query: readonly [];
+    };
+    readonly withdrawSignatureRequest: {
+        readonly method: "POST";
+        readonly path: "/v1/signatures/{request}/withdraw";
+        readonly query: readonly [];
+    };
+};
+declare class AccountResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Who this key publishes as */
+    whoami(params?: Params<operations['whoami']>, options?: RequestOptions): Promise<Result<operations['whoami']>>;
+    /** How the operations fit together */
+    help(params?: Params<operations['getHelp']>, options?: RequestOptions): Promise<Result<operations['getHelp']>>;
+}
+declare class ArtifactsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** List your artifacts, newest first */
+    list(params?: Params<operations['listArtifacts']>, options?: RequestOptions): Promise<Result<operations['listArtifacts']>>;
+    /** Publish an artifact, or a new version of one */
+    publish(params: Params<operations['publishArtifact']>, options?: RequestOptions): Promise<Result<operations['publishArtifact']>>;
+    /** One artifact: its versions, published version and declaration */
+    get(params: Params<operations['getArtifact']>, options?: RequestOptions): Promise<Result<operations['getArtifact']>>;
+    /** Change visibility, gallery label, live phase or submission email */
+    update(params: Params<operations['updateArtifact']>, options?: RequestOptions): Promise<Result<operations['updateArtifact']>>;
+    /** Delete an artifact with every version, permanently */
+    delete(params: Omit<Params<operations['deleteArtifact']>, 'confirm'>, options?: RequestOptions): Promise<Result<operations['deleteArtifact']>>;
+    /** Read one file of a version as text (default: the published index.html) */
+    readFile(params: Params<operations['readArtifactFile']>, options?: RequestOptions): Promise<Result<operations['readArtifactFile']>>;
+    /** A ten-minute viewer URL for an artifact, private included */
+    open(params: Params<operations['openArtifact']>, options?: RequestOptions): Promise<Result<operations['openArtifact']>>;
+    /** Serve an existing version again */
+    serveVersion(params: Params<operations['serveVersion']>, options?: RequestOptions): Promise<Result<operations['serveVersion']>>;
+}
+declare class LiveResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Turn an artifact's live room on */
+    start(params: Params<operations['startLiveRoom']>, options?: RequestOptions): Promise<Result<operations['startLiveRoom']>>;
+    /** Turn an artifact's live room off, disconnecting every visitor */
+    stop(params: Params<operations['stopLiveRoom']>, options?: RequestOptions): Promise<Result<operations['stopLiveRoom']>>;
+}
+declare class UploadsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Stage big files for a publish; PUT each to its URL */
+    stage(params: Params<operations['stageUploads']>, options?: RequestOptions): Promise<Result<operations['stageUploads']>>;
+}
+declare class DataResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Rows visitors submitted to one artifact, newest first */
+    listArtifactRows(params: Params<operations['listArtifactRows']>, options?: RequestOptions): Promise<Result<operations['listArtifactRows']>>;
+    /** Write rows into an artifact you may edit */
+    writeArtifactRows(params: Params<operations['writeArtifactRows']>, options?: RequestOptions): Promise<Result<operations['writeArtifactRows']>>;
+    /** Rows submitted to a dataset or a gallery label */
+    listRows(params?: Params<operations['listRows']>, options?: RequestOptions): Promise<Result<operations['listRows']>>;
+    /** Aggregate what was collected: numbers, never rows */
+    query(params?: Params<operations['queryData']>, options?: RequestOptions): Promise<Result<operations['queryData']>>;
+}
+declare class SchemaResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** The data catalog: datasets and content collections, or a comparison */
+    get(params?: Params<operations['getSchema']>, options?: RequestOptions): Promise<Result<operations['getSchema']>>;
+    /** Create or replace a content collection */
+    defineCollection(params?: Params<operations['defineCollection']>, options?: RequestOptions): Promise<Result<operations['defineCollection']>>;
+}
+declare class EntriesResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** One page of a content collection's entries */
+    list(params: Params<operations['listEntries']>, options?: RequestOptions): Promise<Result<operations['listEntries']>>;
+    /** Create one entry, or a batch */
+    create(params: Params<operations['createEntries']>, options?: RequestOptions): Promise<Result<operations['createEntries']>>;
+}
+declare class SecretsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Call an approved API with a stored secret you cannot read (workspace keys) */
+    use(params: Params<operations['useSecret']>, options?: RequestOptions): Promise<Result<operations['useSecret']>>;
+}
+declare class TemplatesResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Find, rank or list templates */
+    list(params?: Params<operations['listTemplates']>, options?: RequestOptions): Promise<Result<operations['listTemplates']>>;
+    /** Create or revise a template draft */
+    save(params: Params<operations['saveTemplate']>, options?: RequestOptions): Promise<Result<operations['saveTemplate']>>;
+    /** One template in full, with its install prompt */
+    get(params: Params<operations['getTemplate']>, options?: RequestOptions): Promise<Result<operations['getTemplate']>>;
+    /** A template's changelog */
+    getHistory(params: Params<operations['getTemplateHistory']>, options?: RequestOptions): Promise<Result<operations['getTemplateHistory']>>;
+    /** Comments on a template's artifacts, as themes */
+    getFeedback(params: Params<operations['getTemplateFeedback']>, options?: RequestOptions): Promise<Result<operations['getTemplateFeedback']>>;
+    /** Install, uninstall, rate, report, roll back or request verification */
+    act(params: Params<operations['actOnTemplate']>, options?: RequestOptions): Promise<Result<operations['actOnTemplate']>>;
+    /** Release one version of your template */
+    release(params: Params<operations['releaseTemplate']>, options?: RequestOptions): Promise<Result<operations['releaseTemplate']>>;
+}
+declare class ProjectsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Your projects */
+    list(params?: Params<operations['listProjects']>, options?: RequestOptions): Promise<Result<operations['listProjects']>>;
+    /** Create a project, optionally seeded with artifacts */
+    create(params?: Params<operations['createProject']>, options?: RequestOptions): Promise<Result<operations['createProject']>>;
+    /** One project and its items */
+    get(params: Params<operations['getProject']>, options?: RequestOptions): Promise<Result<operations['getProject']>>;
+    /** Rename, set visibility, reorder, move, fold groups or set a rule */
+    update(params: Params<operations['updateProject']>, options?: RequestOptions): Promise<Result<operations['updateProject']>>;
+    /** Delete a project; its artifacts stay */
+    delete(params: Omit<Params<operations['deleteProject']>, 'confirm'>, options?: RequestOptions): Promise<Result<operations['deleteProject']>>;
+    /** Add artifacts to a project */
+    addArtifacts(params: Params<operations['addProjectArtifacts']>, options?: RequestOptions): Promise<Result<operations['addProjectArtifacts']>>;
+    /** Remove one artifact (or item) from a project */
+    removeArtifact(params: Params<operations['removeProjectArtifact']>, options?: RequestOptions): Promise<Result<operations['removeProjectArtifact']>>;
+}
+declare class SharesResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Give named people access to an artifact */
+    addToArtifact(params: Params<operations['shareArtifact']>, options?: RequestOptions): Promise<Result<operations['shareArtifact']>>;
+    /** Give named people access to a project */
+    addToProject(params: Params<operations['shareProject']>, options?: RequestOptions): Promise<Result<operations['shareProject']>>;
+    /** Invite editors to a workspace (returns accept links) */
+    addToWorkspace(params: Params<operations['shareWorkspace']>, options?: RequestOptions): Promise<Result<operations['shareWorkspace']>>;
+}
+declare class CommentsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Comment threads on an artifact, newest first */
+    list(params: Params<operations['listComments']>, options?: RequestOptions): Promise<Result<operations['listComments']>>;
+    /** Reply to and/or resolve threads, one outcome each */
+    respond(params: Params<operations['respondToComments']>, options?: RequestOptions): Promise<Result<operations['respondToComments']>>;
+    /** One message's screenshot, base64 in `image` */
+    getScreenshot(params: Params<operations['getCommentScreenshot']>, options?: RequestOptions): Promise<Result<operations['getCommentScreenshot']>>;
+}
+declare class MentionsResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** Where people @mentioned you; listing marks them seen */
+    list(params?: Params<operations['listMentions']>, options?: RequestOptions): Promise<Result<operations['listMentions']>>;
+}
+declare class SignaturesResource {
+    protected readonly client: Core;
+    constructor(client: Core);
+    /** An artifact's signature requests, newest first */
+    list(params?: Params<operations['listSignatureRequests']>, options?: RequestOptions): Promise<Result<operations['listSignatureRequests']>>;
+    /** Ask named people to sign one version of an artifact */
+    request(params?: Params<operations['requestSignatures']>, options?: RequestOptions): Promise<Result<operations['requestSignatures']>>;
+    /** One signature request and its signers */
+    get(params: Params<operations['getSignatureRequest']>, options?: RequestOptions): Promise<Result<operations['getSignatureRequest']>>;
+    /** Email a signer their link again */
+    remind(params: Params<operations['remindSigner']>, options?: RequestOptions): Promise<Result<operations['remindSigner']>>;
+    /** Close an open signature request */
+    withdraw(params: Params<operations['withdrawSignatureRequest']>, options?: RequestOptions): Promise<Result<operations['withdrawSignatureRequest']>>;
+}
+declare class Resources extends Core {
+    readonly account: AccountResource;
+    readonly artifacts: ArtifactsResource;
+    readonly live: LiveResource;
+    readonly uploads: UploadsResource;
+    readonly data: DataResource;
+    readonly schema: SchemaResource;
+    readonly entries: EntriesResource;
+    readonly secrets: SecretsResource;
+    readonly templates: TemplatesResource;
+    readonly projects: ProjectsResource;
+    readonly shares: SharesResource;
+    readonly comments: CommentsResource;
+    readonly mentions: MentionsResource;
+    readonly signatures: SignaturesResource;
+}
+
+type Row = Record<string, unknown>;
+declare class Data extends DataResource {
+    /** Every row `listArtifactRows` matches, page by page. */
+    iterArtifactRows(params: Params<operations['listArtifactRows']>, options?: RequestOptions): AsyncGenerator<Row>;
+    /** Every row `listRows` matches, page by page. */
+    iterRows(params?: Params<operations['listRows']>, options?: RequestOptions): AsyncGenerator<Row>;
+}
+declare class Entries extends EntriesResource {
+    /** Every entry `list` matches, page by page from `params.page` (0 by default). */
+    iter(params: Params<operations['listEntries']>, options?: RequestOptions): AsyncGenerator<Row>;
+}
+declare class Mentions extends MentionsResource {
+    /** Every mention, page by page. Listing marks them seen. */
+    iter(params?: Params<operations['listMentions']>, options?: RequestOptions): AsyncGenerator<Row>;
+}
+interface FileToUpload {
+    /** Where the file lands in the artifact, e.g. `images/hero.png`. */
+    path: string;
+    data: Uint8Array | Blob | string;
+    contentType?: string;
+}
+declare class Uploads extends UploadsResource {
+    /** Stage files and PUT their bytes. Pass the answer's `uploadId` to `artifacts.publish` as `uploads`. */
+    upload(files: FileToUpload[], options?: RequestOptions): Promise<{
+        uploadId: string;
+        expiresAt: string;
+    }>;
+}
+/** The client for the Super Artifacts REST API. Server-side only. */
+declare class SuperArtifacts extends Resources {
+    readonly data: Data;
+    readonly entries: Entries;
+    readonly mentions: Mentions;
+    readonly uploads: Uploads;
+}
+
+export { AuthenticationError, ConflictError, ConnectionError, InternalError, InvalidArgumentsError, NotFoundError, OPERATIONS, PayloadTooLargeError, PermissionError, PlanLimitError, RateLimitError, ScopeRequiredError, SuperArtifacts, SuperArtifactsError, TimeoutError, VERSION, SuperArtifacts as default, errorFor };
+export type { ClientOptions, FileToUpload, Operation, Params, RequestOptions, Result, components, operations };