palbase 0.18.6 → 0.19.0

package/types/cloud/src/generated/studio.d.ts

@@ -0,0 +1,1765 @@
+import { type Reply, type Transport } from '../../../internal/src/transport.js';
+/**
+ * Every refusal: the framework's, a handler's HttpError, the database's.
+ */
+export type PalbaseErrorEnvelope = {
+    /**
+     * A stable code, like bad_request
+     */
+    error: string;
+    /**
+     * What went wrong, for a person
+     */
+    error_description: string;
+    /**
+     * The HTTP status
+     */
+    status: number;
+    /**
+     * The request's id, as the app's log has it
+     */
+    request_id: string;
+    /**
+     * Details, when the refusal has them: a validation's fields, a token's reason, a limit's retryAfter
+     */
+    data?: unknown;
+};
+/** Studio's API as an access token calls it: organizations, projects, environments, billing — by namespace. */
+export declare function client(t: Transport): {
+    orgs: {
+        list(input?: {
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            organizations: ({
+                id: string;
+                name: string;
+                role: "owner" | "admin" | "member";
+                created_by: string | null;
+                created_at: string;
+            })[];
+        }>>;
+        get(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            name: string;
+            role: "owner" | "admin" | "member";
+            created_by: string | null;
+            created_at: string;
+        }>>;
+        members(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            members: ({
+                email: string | null;
+                user_id: string;
+                role: "owner" | "admin" | "member";
+                created_at: string;
+            })[];
+            invitations: ({
+                id: string;
+                email: string;
+                role: "admin" | "member";
+                created_at: string;
+            })[];
+        }>>;
+        auditLog(input: {
+            path: {
+                id: string;
+            };
+            query?: {
+                before?: string;
+                limit?: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            entries: ({
+                id: string;
+                at: string;
+                environment_ref: string;
+                actor: string;
+                actor_name: string | null;
+                on_behalf_of?: string;
+                method: string;
+                path: string;
+                status: number;
+            })[];
+            next_before: string | null;
+        }>>;
+    };
+    invitations: {
+        mine(input?: {
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            invitations: ({
+                id: string;
+                organization_id: string;
+                organization_name: string;
+                role: string;
+                created_at: string;
+            })[];
+        }>>;
+        accept(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            organization_id: string;
+            role: string;
+        }>>;
+    };
+    orgWebhooks: {
+        list(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            endpoints: ({
+                id: string;
+                url: string;
+                events: string[];
+                created_at: string;
+                created_by?: {
+                    id: string;
+                    name: string;
+                };
+            })[];
+        }>>;
+        add(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                url: string;
+                events?: string[];
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            url: string;
+            events: string[];
+            created_at: string;
+            created_by?: {
+                id: string;
+                name: string;
+            };
+            secret: string;
+        }>>;
+        remove(input: {
+            path: {
+                id: string;
+                endpoint: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+    };
+    projects: {
+        mine(input?: {
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            projects: ({
+                id: string;
+                organization_id: string;
+                name: string;
+                created_by: string | null;
+                created_at: string;
+                environments: ({
+                    ref: string;
+                    name: string;
+                    slug: string;
+                    platform_id: string;
+                    created_at: string;
+                })[];
+            })[];
+        }>>;
+        environmentsMine(input?: {
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            environments: (({
+                project_id: string;
+                project_name: string;
+                organization_id: string;
+                role: "owner" | "admin" | "member";
+                ref: string;
+                name: string;
+                slug: string;
+                platform_id: string;
+                created_at: string;
+            })[]) | (({
+                project_id: string;
+                project_name: string;
+                organization_id: string;
+                role: "owner" | "admin" | "member";
+                scopes: string[] | null;
+                token_id: string;
+                ref: string;
+                name: string;
+                slug: string;
+                platform_id: string;
+                created_at: string;
+            })[]);
+        }>>;
+        list(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            projects: ({
+                id: string;
+                organization_id: string;
+                name: string;
+                created_by: string | null;
+                created_at: string;
+                environments: ({
+                    ref: string;
+                    name: string;
+                    slug: string;
+                    platform_id: string;
+                    created_at: string;
+                })[];
+            })[];
+        }>>;
+        create(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            project: {
+                id: string;
+                organization_id: string;
+                name: string;
+                created_by: string | null;
+                created_at: string;
+                environments: ({
+                    ref: string;
+                    name: string;
+                    slug: string;
+                    platform_id: string;
+                    created_at: string;
+                })[];
+            };
+        }>>;
+        get(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, ({
+            id: string;
+            organization_id: string;
+            name: string;
+            created_by: string | null;
+            created_at: string;
+            environments: ({
+                ref: string;
+                name: string;
+                slug: string;
+                platform_id: string;
+                created_at: string;
+            })[];
+        }) | null>>;
+        remove(input: {
+            path: {
+                id: string;
+            };
+            query?: {
+                move_credit_to?: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        rename(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, ({
+            id: string;
+            organization_id: string;
+            name: string;
+            created_by: string | null;
+            created_at: string;
+        }) | null>>;
+        addEnvironment(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+                slug?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            environment: {
+                ref: string;
+                name: string;
+                slug: string;
+                platform_id: string;
+                created_at: string;
+            };
+            keys: ({
+                publishable: {
+                    id: string;
+                    kind: "publishable" | "secret";
+                    label: string;
+                    key: string;
+                    expires_at?: string;
+                };
+                secret: {
+                    id: string;
+                    kind: "publishable" | "secret";
+                    label: string;
+                    key: string;
+                    expires_at?: string;
+                };
+            }) | null;
+        }>>;
+        environment(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            project_id: string;
+            role: "owner" | "admin" | "member";
+        }>>;
+        removeEnvironment(input: {
+            path: {
+                ref: string;
+            };
+            query?: {
+                move_credit_to?: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        renameEnvironment(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, ({
+            ref: string;
+            name: string;
+            slug: string;
+            platform_id: string;
+            created_at: string;
+        }) | null>>;
+        keys(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            keys: ({
+                id: string;
+                kind: "publishable" | "secret";
+                label: string;
+                hint: string;
+                created_at: string;
+                expires_at?: string;
+                revoked_at?: string;
+            })[];
+        }>>;
+        usage(input: {
+            path: {
+                ref: string;
+            };
+            query?: {
+                months?: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            months: ({
+                period: string;
+                usage: {
+                    [key: string]: number;
+                };
+            })[];
+            quotas: ({
+                metric: string;
+                limit: number;
+                mode: string;
+                used: number;
+                blocked: boolean;
+            })[];
+        }>>;
+        personalKey(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                host: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            key: string;
+            label: string;
+            expires_at: string;
+        }>>;
+        revokePersonalKey(input: {
+            path: {
+                ref: string;
+                key: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        shareInstallation(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                installation_id: number;
+                from: string;
+                repositories?: string[];
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<number, Response>>;
+    };
+    apps: {
+        list(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            apps: ({
+                id: string;
+                platform: "ios" | "android" | "web";
+                name: string;
+                slug: string;
+                team_id: string | null;
+                app_id_prefix: string | null;
+                created_at: string;
+                deleted_at: string | null;
+                purge_after: string | null;
+                environments: ({
+                    ref: string;
+                    slug: string;
+                    name: string;
+                    ios?: {
+                        team_id: string;
+                        app_id_prefix?: string;
+                        bundle: string;
+                        app_clip?: string;
+                        watch?: string;
+                    };
+                    android?: {
+                        package: string;
+                        fingerprints: ({
+                            label: string;
+                            sha256: string;
+                        })[];
+                    };
+                    web?: {
+                        origins: string[];
+                        redirects?: string[];
+                    };
+                    suspended: boolean;
+                    key?: {
+                        id: string;
+                        key: string;
+                    };
+                    updated_at: string;
+                })[];
+            })[];
+        }>>;
+        create(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                platform: "ios" | "android" | "web";
+                name: string;
+                slug?: string;
+                team_id?: string;
+                app_id_prefix?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            platform: "ios" | "android" | "web";
+            name: string;
+            slug: string;
+            team_id: string | null;
+            app_id_prefix: string | null;
+            created_at: string;
+            deleted_at: string | null;
+            purge_after: string | null;
+            environments: ({
+                ref: string;
+                slug: string;
+                name: string;
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+                suspended: boolean;
+                key?: {
+                    id: string;
+                    key: string;
+                };
+                updated_at: string;
+            })[];
+        }>>;
+        get(input: {
+            path: {
+                id: string;
+                app: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            platform: "ios" | "android" | "web";
+            name: string;
+            slug: string;
+            team_id: string | null;
+            app_id_prefix: string | null;
+            created_at: string;
+            deleted_at: string | null;
+            purge_after: string | null;
+            environments: ({
+                ref: string;
+                slug: string;
+                name: string;
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+                suspended: boolean;
+                key?: {
+                    id: string;
+                    key: string;
+                };
+                updated_at: string;
+            })[];
+        }>>;
+        remove(input: {
+            path: {
+                id: string;
+                app: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            platform: "ios" | "android" | "web";
+            name: string;
+            slug: string;
+            team_id: string | null;
+            app_id_prefix: string | null;
+            created_at: string;
+            deleted_at: string | null;
+            purge_after: string | null;
+            environments: ({
+                ref: string;
+                slug: string;
+                name: string;
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+                suspended: boolean;
+                key?: {
+                    id: string;
+                    key: string;
+                };
+                updated_at: string;
+            })[];
+        }>>;
+        update(input: {
+            path: {
+                id: string;
+                app: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                name?: string;
+                team_id?: string;
+                app_id_prefix?: string | null;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            platform: "ios" | "android" | "web";
+            name: string;
+            slug: string;
+            team_id: string | null;
+            app_id_prefix: string | null;
+            created_at: string;
+            deleted_at: string | null;
+            purge_after: string | null;
+            environments: ({
+                ref: string;
+                slug: string;
+                name: string;
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+                suspended: boolean;
+                key?: {
+                    id: string;
+                    key: string;
+                };
+                updated_at: string;
+            })[];
+        }>>;
+        restore(input: {
+            path: {
+                id: string;
+                app: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            platform: "ios" | "android" | "web";
+            name: string;
+            slug: string;
+            team_id: string | null;
+            app_id_prefix: string | null;
+            created_at: string;
+            deleted_at: string | null;
+            purge_after: string | null;
+            environments: ({
+                ref: string;
+                slug: string;
+                name: string;
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+                suspended: boolean;
+                key?: {
+                    id: string;
+                    key: string;
+                };
+                updated_at: string;
+            })[];
+        }>>;
+        setIn(input: {
+            path: {
+                ref: string;
+                app: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                ios?: {
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints?: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            warnings: string[];
+            ref: string;
+            slug: string;
+            name: string;
+            ios?: {
+                team_id: string;
+                app_id_prefix?: string;
+                bundle: string;
+                app_clip?: string;
+                watch?: string;
+            };
+            android?: {
+                package: string;
+                fingerprints: ({
+                    label: string;
+                    sha256: string;
+                })[];
+            };
+            web?: {
+                origins: string[];
+                redirects?: string[];
+            };
+            suspended: boolean;
+            key?: {
+                id: string;
+                key: string;
+            };
+            updated_at: string;
+        }>>;
+        removeFrom(input: {
+            path: {
+                ref: string;
+                app: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        config(input: {
+            path: {
+                ref: string;
+                app: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            schema: 1;
+            project: {
+                id: string;
+                name: string;
+            };
+            environment: {
+                ref: string;
+                slug: string;
+                name: string;
+                production: boolean;
+            };
+            app: {
+                id: string;
+                name: string;
+                slug: string;
+                platform: "ios" | "android" | "web";
+                ios?: {
+                    team_id: string;
+                    app_id_prefix?: string;
+                    bundle: string;
+                    app_clip?: string;
+                    watch?: string;
+                };
+                android?: {
+                    package: string;
+                    fingerprints: ({
+                        label: string;
+                        sha256: string;
+                    })[];
+                };
+                web?: {
+                    origins: string[];
+                    redirects?: string[];
+                };
+            };
+            url: string;
+            publishable_key: string;
+            keychain_group?: string;
+            auth: {
+                rp_id: string;
+                associated_domains: string[];
+            };
+            realtime: {
+                url: string;
+            };
+            backends: ({
+                machine: string;
+                url: string;
+                contract_digest?: string;
+            })[];
+            digest: string;
+        }>>;
+    };
+    snippets: {
+        list(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            snippets: ({
+                id: string;
+                name: string;
+                sql: string;
+                folder: string | null;
+                createdBy: string | null;
+                createdAt: string;
+            })[];
+        }>>;
+        create(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+                sql: string;
+                folder?: string | null;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            name: string;
+            sql: string;
+            folder: string | null;
+            createdBy: string | null;
+            createdAt: string;
+        }>>;
+        remove(input: {
+            path: {
+                ref: string;
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        change(input: {
+            path: {
+                ref: string;
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                name?: string;
+                folder?: string | null;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            name: string;
+            sql: string;
+            folder: string | null;
+            createdBy: string | null;
+            createdAt: string;
+        }>>;
+    };
+    chartViews: {
+        list(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            views: ({
+                id: string;
+                name: string;
+                chart: string;
+                query: {
+                    range: "custom" | "last_7_days" | "last_28_days" | "last_90_days" | "last_12_months" | "all_time";
+                    from?: string;
+                    to?: string;
+                    resolution: "month" | "day" | "week";
+                    segment?: string;
+                    filters: ({
+                        dimension: string;
+                        value: string;
+                    })[];
+                    sandbox: boolean;
+                    revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+                    window_days?: number;
+                    cohort?: "new_customers" | "new_paying_customers";
+                };
+                createdBy: string | null;
+                createdAt: string;
+            })[];
+        }>>;
+        create(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+                chart: string;
+                query: {
+                    range: "last_7_days" | "last_28_days" | "last_90_days" | "last_12_months" | "all_time" | "custom";
+                    from?: string;
+                    to?: string;
+                    resolution: "day" | "week" | "month";
+                    segment?: string;
+                    filters: ({
+                        dimension: string;
+                        value: string;
+                    })[];
+                    sandbox: boolean;
+                    revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+                    window_days?: number;
+                    cohort?: "new_customers" | "new_paying_customers";
+                };
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            name: string;
+            chart: string;
+            query: {
+                range: "custom" | "last_7_days" | "last_28_days" | "last_90_days" | "last_12_months" | "all_time";
+                from?: string;
+                to?: string;
+                resolution: "month" | "day" | "week";
+                segment?: string;
+                filters: ({
+                    dimension: string;
+                    value: string;
+                })[];
+                sandbox: boolean;
+                revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+                window_days?: number;
+                cohort?: "new_customers" | "new_paying_customers";
+            };
+            createdBy: string | null;
+            createdAt: string;
+        }>>;
+        remove(input: {
+            path: {
+                ref: string;
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+        change(input: {
+            path: {
+                ref: string;
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                name?: string;
+                query?: {
+                    range: "last_7_days" | "last_28_days" | "last_90_days" | "last_12_months" | "all_time" | "custom";
+                    from?: string;
+                    to?: string;
+                    resolution: "day" | "week" | "month";
+                    segment?: string;
+                    filters: ({
+                        dimension: string;
+                        value: string;
+                    })[];
+                    sandbox: boolean;
+                    revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+                    window_days?: number;
+                    cohort?: "new_customers" | "new_paying_customers";
+                };
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            name: string;
+            chart: string;
+            query: {
+                range: "custom" | "last_7_days" | "last_28_days" | "last_90_days" | "last_12_months" | "all_time";
+                from?: string;
+                to?: string;
+                resolution: "month" | "day" | "week";
+                segment?: string;
+                filters: ({
+                    dimension: string;
+                    value: string;
+                })[];
+                sandbox: boolean;
+                revenue_type?: "gross" | "net_of_taxes" | "proceeds";
+                window_days?: number;
+                cohort?: "new_customers" | "new_paying_customers";
+            };
+            createdBy: string | null;
+            createdAt: string;
+        }>>;
+    };
+    webhooks: {
+        list(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            endpoints: ({
+                id: string;
+                url: string;
+                events: string[];
+                created_at: string;
+                machine?: string;
+                created_by?: {
+                    id: string;
+                    name: string;
+                };
+            })[];
+        }>>;
+        add(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                url: string;
+                events?: string[];
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            url: string;
+            events: string[];
+            created_at: string;
+            machine?: string;
+            created_by?: {
+                id: string;
+                name: string;
+            };
+            secret: string;
+        }>>;
+        deliveries(input: {
+            path: {
+                ref: string;
+            };
+            query?: {
+                failed?: "1" | "true";
+                all?: "1" | "true";
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            deliveries: ({
+                id: string;
+                endpoint_id: string;
+                event_id: string;
+                event_type: string;
+                attempts: number;
+                last_error: string;
+                failed_at: string;
+                redeliver_asked_at: string | null;
+                redelivered_at: string | null;
+                redelivery_error: string | null;
+            })[];
+        }>>;
+        redeliver(input: {
+            path: {
+                ref: string;
+                delivery: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            endpoint_id: string;
+            event_id: string;
+            event_type: string;
+            attempts: number;
+            last_error: string;
+            failed_at: string;
+            redeliver_asked_at: string | null;
+            redelivered_at: string | null;
+            redelivery_error: string | null;
+        }>>;
+        change(input: {
+            path: {
+                ref: string;
+                endpoint: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                url: string;
+                events?: string[];
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            url: string;
+            events: string[];
+            created_at: string;
+            machine?: string;
+            created_by?: {
+                id: string;
+                name: string;
+            };
+        }>>;
+        remove(input: {
+            path: {
+                ref: string;
+                endpoint: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+    };
+    environmentTokens: {
+        list(input: {
+            path: {
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            tokens: ({
+                id: string;
+                environment_ref: string;
+                name: string;
+                scopes: ((("machines:read") | ("machines:logs") | ("apps:sync") | ("auth:test-users") | "support")[]) | null;
+                role: ("admin" | "member") | null;
+                on_behalf_of: string | null;
+                hint: string;
+                minted_by: string;
+                created_at: string;
+                expires_at: string;
+                last_used_at: string | null;
+            })[];
+        }>>;
+        mint(input: {
+            path: {
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                name?: string;
+                scopes?: ("machines:read" | "machines:logs" | "apps:sync" | "auth:test-users" | "support")[];
+                expires_in_minutes?: number;
+                role?: "member" | "admin";
+                on_behalf_of?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            id: string;
+            environment_ref: string;
+            name: string;
+            scopes: ((("machines:read") | ("machines:logs") | ("apps:sync") | ("auth:test-users") | "support")[]) | null;
+            role: ("admin" | "member") | null;
+            on_behalf_of: string | null;
+            hint: string;
+            minted_by: string;
+            created_at: string;
+            expires_at: string;
+            last_used_at: string | null;
+            token: string;
+        }>>;
+        revoke(input: {
+            path: {
+                ref: string;
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<204, undefined>>;
+    };
+    billing: {
+        bill(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            environments: ({
+                platform_id: string;
+                ref: string;
+                name: string;
+                project_id: string;
+                project_name: string;
+            })[];
+            organization_id: string;
+            exempt: boolean;
+            has_account: boolean;
+            paying: boolean;
+            enforced: boolean;
+            account: ({
+                stripe_mode: "live" | "test";
+                payment_method: string | null;
+                terms_version: string | null;
+                terms_accepted_at: string | null;
+            }) | null;
+            period: string;
+            charged_micros?: number;
+            gross_micros?: number;
+            taken_micros?: number;
+            projects: ({
+                project_id: string;
+                ref: string;
+                name: string;
+                plan: "free" | "pay_as_you_go";
+                paid: boolean;
+                frozen: boolean;
+                at_limit: boolean;
+                gone: boolean;
+                deleted: boolean;
+                wallet?: {
+                    balance_micros: number;
+                    auto_topup: boolean;
+                    auto_threshold_micros: number;
+                    auto_amount_micros: number;
+                    monthly_limit_micros: number | null;
+                    low_balance_days: number;
+                    exhausted: boolean;
+                    topup_failures: number;
+                };
+                charged_micros?: number;
+                gross_micros?: number;
+                taken_micros?: number;
+                items: ({
+                    item: string;
+                    units: number;
+                    gross_micros?: number;
+                    micros?: number;
+                })[];
+            })[];
+        }>>;
+        confirm(input: {
+            path: {
+                id: string;
+                session: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            paid: boolean;
+            saved: boolean;
+        }>>;
+        cards(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            cards: ({
+                id: string;
+                brand: string;
+                last4: string;
+                exp_month: number;
+                exp_year: number;
+                default: boolean;
+            })[];
+        }>>;
+        defaultCard(input: {
+            path: {
+                id: string;
+                card: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            cards: ({
+                id: string;
+                brand: string;
+                last4: string;
+                exp_month: number;
+                exp_year: number;
+                default: boolean;
+            })[];
+        }>>;
+        removeCard(input: {
+            path: {
+                id: string;
+                card: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            cards: ({
+                id: string;
+                brand: string;
+                last4: string;
+                exp_month: number;
+                exp_year: number;
+                default: boolean;
+            })[];
+        }>>;
+        customer(input: {
+            path: {
+                id: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            name: string;
+            email: string;
+            address: ({
+                line1: string;
+                line2: string;
+                city: string;
+                postal_code: string;
+                state: string;
+                country: string;
+            }) | null;
+            tax_ids: ({
+                id?: string;
+                type: string;
+                value: string;
+                status?: string;
+            })[];
+        }>>;
+        setCustomer(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                name: string;
+                address: {
+                    line1: string;
+                    line2?: string;
+                    city?: string;
+                    postal_code?: string;
+                    state?: string;
+                    country: string;
+                };
+                tax_id: ({
+                    type: string;
+                    value: string;
+                }) | null;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            name: string;
+            email: string;
+            address: ({
+                line1: string;
+                line2: string;
+                city: string;
+                postal_code: string;
+                state: string;
+                country: string;
+            }) | null;
+            tax_ids: ({
+                id?: string;
+                type: string;
+                value: string;
+                status?: string;
+            })[];
+        }>>;
+        charges(input: {
+            path: {
+                id: string;
+            };
+            query?: {
+                period?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            period: string;
+            charges: ({
+                project_id: string;
+                item: string;
+                units: number;
+                gross_micros: number;
+                micros: number;
+                environment: ({
+                    platform_id: string;
+                    ref: string;
+                    name: string;
+                    project_id: string;
+                    project_name: string;
+                }) | null;
+            })[];
+            taken_micros: {
+                [key: string]: number;
+            };
+        }>>;
+        csv(input: {
+            path: {
+                id: string;
+            };
+            query?: {
+                period?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<number, Response>>;
+        invoices(input: {
+            path: {
+                id: string;
+            };
+            query?: {
+                environment?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            invoices: ({
+                id: string;
+                kind: "checkout" | "auto" | "card" | "bank_transfer";
+                project_id: string | null;
+                project_ref: string | null;
+                project_name: string | null;
+                status: string;
+                amount_micros: number;
+                tax_micros: number;
+                refunded_micros: number;
+                hosted_url: string | null;
+                pdf_url: string | null;
+                created_at: string;
+                number: string | null;
+                environment: ({
+                    platform_id: string;
+                    ref: string;
+                    name: string;
+                    project_id: string;
+                    project_name: string;
+                }) | null;
+            })[];
+        }>>;
+        transfer(input: {
+            path: {
+                id: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                from: string;
+                to: string;
+                amount_micros?: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            moved_micros: number;
+            from: string;
+            to: string;
+        }>>;
+        environment(input: {
+            path: {
+                id: string;
+                ref: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            project_id: string;
+            ref: string;
+            name: string;
+            plan: "free" | "pay_as_you_go";
+            paid: boolean;
+            frozen: boolean;
+            at_limit: boolean;
+            gone: boolean;
+            deleted: boolean;
+            wallet?: {
+                balance_micros: number;
+                auto_topup: boolean;
+                auto_threshold_micros: number;
+                auto_amount_micros: number;
+                monthly_limit_micros: number | null;
+                low_balance_days: number;
+                exhausted: boolean;
+                topup_failures: number;
+            };
+            charged_micros?: number;
+            gross_micros?: number;
+            taken_micros?: number;
+            items: ({
+                item: string;
+                units: number;
+                gross_micros?: number;
+                micros?: number;
+            })[];
+            environment: {
+                platform_id: string;
+                ref: string;
+                name: string;
+                project_id: string;
+                project_name: string;
+            };
+        }>>;
+        steer(input: {
+            path: {
+                id: string;
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body?: {
+                plan?: "free" | "pay_as_you_go";
+                frozen?: boolean;
+                monthly_limit_micros?: number | null;
+                auto_topup?: boolean;
+                auto_threshold_micros?: number;
+                auto_amount_micros?: number;
+                low_balance_days?: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            project_id: string;
+            ref: string;
+            name: string;
+            plan: "free" | "pay_as_you_go";
+            paid: boolean;
+            frozen: boolean;
+            at_limit: boolean;
+            gone: boolean;
+            deleted: boolean;
+            wallet?: {
+                balance_micros: number;
+                auto_topup: boolean;
+                auto_threshold_micros: number;
+                auto_amount_micros: number;
+                monthly_limit_micros: number | null;
+                low_balance_days: number;
+                exhausted: boolean;
+                topup_failures: number;
+            };
+            charged_micros?: number;
+            gross_micros?: number;
+            taken_micros?: number;
+            items: ({
+                item: string;
+                units: number;
+                gross_micros?: number;
+                micros?: number;
+            })[];
+            environment: {
+                platform_id: string;
+                ref: string;
+                name: string;
+                project_id: string;
+                project_name: string;
+            };
+        }>>;
+        topUp(input: {
+            path: {
+                id: string;
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                amount_micros: number;
+                payment_method?: string;
+                plan?: "pay_as_you_go";
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            invoice_id: string;
+            status: string;
+            hosted_url?: string;
+        }>>;
+        bankTransfer(input: {
+            path: {
+                id: string;
+                ref: string;
+            };
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                amount_micros: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            invoice_id: string;
+            status: string;
+            hosted_url?: string;
+        }>>;
+        ledger(input: {
+            path: {
+                id: string;
+                ref: string;
+            };
+            query?: {
+                before?: number;
+                kind?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            lines: ({
+                from_environment?: string | null;
+                to_environment?: string | null;
+                id: number;
+                kind: "topup" | "bonus" | "usage" | "expiry" | "refund" | "adjustment" | "transfer" | "forfeit";
+                amount_micros: number;
+                ref: string;
+                remaining_micros: number | null;
+                expires_at: string | null;
+                created_at: string;
+                via: string | null;
+                invoice: string | null;
+                from_project?: string;
+                to_project?: string;
+            })[];
+        }>>;
+    };
+    accessRequests: {
+        request(input: {
+            headers?: {
+                "Idempotency-Key"?: string;
+            };
+            body: {
+                email: string;
+                name?: string;
+                building?: string;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            status: "received";
+        }>>;
+    };
+    docs: {
+        search(input: {
+            query: {
+                q: string;
+                limit?: number;
+            }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+            signal?: AbortSignal;
+        }): Promise<Reply<200, {
+            results: ({
+                title: string;
+                heading: string;
+                url: string;
+                text: string;
+                cut: boolean;
+                score: number;
+            })[];
+        }>>;
+    };
+};
+export type Client = ReturnType<typeof client>;