@faable/deploy-sdk 2.1.0 → 2.2.0

package/dist/api/generated-client.d.ts

@@ -0,0 +1,895 @@
+import type { operations } from "./types.js";
+import { FaableApi } from "@faable/sdk-base";
+type OpBody<K extends keyof operations> = operations[K] extends {
+    requestBody: {
+        content: {
+            "application/json": infer B;
+        };
+    };
+} ? B : never;
+type OpQuery<K extends keyof operations> = operations[K] extends {
+    parameters: {
+        query?: infer Q;
+    };
+} ? NonNullable<Q> : Record<string, never>;
+/**
+ * Auto-generated deploy-API methods, one per secured operation in the OpenAPI
+ * spec. `DeployApi` extends this and adds the constructor, custom-logic
+ * helpers, and deprecated aliases.
+ */
+export declare abstract class GeneratedFaableDeployApi extends FaableApi {
+    /**
+     * `GET /app/checkname` — operationId: `app/checkname`
+     *
+     * Check if an app name is availiable
+     */
+    appCheckname(params?: OpQuery<"app/checkname">): Promise<{
+        name: string;
+        slug: string;
+        url?: string;
+        availiable: boolean;
+        error?: string;
+    }>;
+    /**
+     * `POST /app` — operationId: `app/create`
+     *
+     * Create App
+     */
+    appCreate(data: OpBody<"app/create">): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `DELETE /app/{id}` — operationId: `app/delete`
+     *
+     * Delete App
+     */
+    appDelete(id: string): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /app/{id}` — operationId: `app/get`
+     *
+     * Get App
+     */
+    appGet(id: string, params?: OpQuery<"app/get">): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /app/{id}/deploy-workflow` — operationId: `app/get_deploy_workflow`
+     *
+     * Get deploy workflow status
+     */
+    appGetDeployWorkflow(id: string): Promise<{
+        configured: boolean;
+        workflow_path?: string;
+    }>;
+    /**
+     * `GET /app/{app_id}/registry` — operationId: `app/get_registry`
+     *
+     * Get app registry
+     */
+    appGetRegistry(app_id: string): Promise<{
+        id: string;
+        app_id: string;
+        hostname: string;
+        image: string;
+        user: string;
+        password: string;
+    }>;
+    /**
+     * `POST /app/{id}/link-repository` — operationId: `app/link_repository`
+     *
+     * Link a GitHub repository to an app
+     */
+    appLinkRepository(id: string, data: OpBody<"app/link_repository">): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /app` — operationId: `app/list`
+     *
+     * List Apps
+     */
+    appList(params?: Omit<OpQuery<"app/list">, "cursor" | "next">): {
+        all: () => Promise<{
+            id: string;
+            team: string;
+            name: string;
+            description: string;
+            slug: string;
+            url: string;
+            active: boolean;
+            runtime: import("./types.js").components["schemas"]["AppRuntime"];
+            runtime_strategy: string | null;
+            instance_type: string;
+            region: "gui1" | "poz1" | "ams1";
+            status: import("./types.js").components["schemas"]["AppStatus"];
+            repository?: string;
+            github_branch?: string;
+            github_installation_id?: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }[]>;
+        first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            name: string;
+            description: string;
+            slug: string;
+            url: string;
+            active: boolean;
+            runtime: import("./types.js").components["schemas"]["AppRuntime"];
+            runtime_strategy: string | null;
+            instance_type: string;
+            region: "gui1" | "poz1" | "ams1";
+            status: import("./types.js").components["schemas"]["AppStatus"];
+            repository?: string;
+            github_branch?: string;
+            github_installation_id?: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+        pass: (params?: {
+            cursor?: string;
+            pageSize?: string;
+        }) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            name: string;
+            description: string;
+            slug: string;
+            url: string;
+            active: boolean;
+            runtime: import("./types.js").components["schemas"]["AppRuntime"];
+            runtime_strategy: string | null;
+            instance_type: string;
+            region: "gui1" | "poz1" | "ams1";
+            status: import("./types.js").components["schemas"]["AppStatus"];
+            repository?: string;
+            github_branch?: string;
+            github_installation_id?: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+    };
+    /**
+     * `GET /app/{app_id}/logs` — operationId: `app/logs`
+     *
+     * Get app logs
+     */
+    appLogs(app_id: string, params?: OpQuery<"app/logs">): Promise<void>;
+    /**
+     * `POST /app/{id}/deploy-workflow` — operationId: `app/setup_deploy_workflow`
+     *
+     * Set up deploy workflow
+     */
+    appSetupDeployWorkflow(id: string): Promise<{
+        configured: boolean;
+        workflow_path?: string;
+    }>;
+    /**
+     * `GET /app/slug/{slug}` — operationId: `app/slug`
+     *
+     * Get App by unique slug
+     */
+    appSlug(slug: string): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /app/{app_id}/traffic` — operationId: `app/traffic`
+     *
+     * Get App Traffic
+     */
+    appTraffic(app_id: string, params?: OpQuery<"app/traffic">): Promise<{
+        range: {
+            from: number;
+            to: number;
+            interval: number;
+            deployment_id?: string;
+        };
+        top_endpoints: {
+            path: string;
+            requests: number;
+            req_bytes: number;
+            resp_bytes: number;
+        }[];
+        error_endpoints: {
+            path: string;
+            status: number;
+            errors: number;
+        }[];
+        status_codes: {
+            status: number;
+            requests: number;
+        }[];
+        methods: {
+            method: string;
+            requests: number;
+        }[];
+        transfer: {
+            ts: string;
+            inbound_bytes: number;
+            outbound_bytes: number;
+            requests: number;
+            p50_ms: number;
+            p95_ms: number;
+        }[];
+        origin_status_codes: {
+            status: number;
+            requests: number;
+        }[];
+        latency: {
+            p50: number;
+            p95: number;
+            p99: number;
+            samples: number;
+        };
+        top_referrers: {
+            referer: string;
+            requests: number;
+        }[];
+        top_user_agents: {
+            user_agent: string;
+            requests: number;
+        }[];
+    }>;
+    /**
+     * `POST /app/{id}/unlink-repository` — operationId: `app/unlink_repository`
+     *
+     * Unlink the GitHub repository from an app
+     */
+    appUnlinkRepository(id: string): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `POST /app/{id}` — operationId: `app/update`
+     *
+     * Update App
+     */
+    appUpdate(id: string, data: OpBody<"app/update">): Promise<{
+        id: string;
+        team: string;
+        name: string;
+        description: string;
+        slug: string;
+        url: string;
+        active: boolean;
+        runtime: import("./types.js").components["schemas"]["AppRuntime"];
+        runtime_strategy: string | null;
+        instance_type: string;
+        region: "gui1" | "poz1" | "ams1";
+        status: import("./types.js").components["schemas"]["AppStatus"];
+        repository?: string;
+        github_branch?: string;
+        github_installation_id?: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `POST /deployment` — operationId: `deployment/create`
+     *
+     * Create Deployment
+     */
+    deploymentCreate(data: OpBody<"deployment/create">): Promise<{
+        id: string;
+        team: string;
+        app_id: string;
+        image?: string;
+        github_commit?: string;
+        github_ref?: string;
+        github_actor?: string;
+        github_commit_message?: string;
+        status: import("./types.js").components["schemas"]["DeploymentStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `DELETE /deployment/{id}` — operationId: `deployment/delete`
+     *
+     * Delete Deployment
+     */
+    deploymentDelete(id: string): Promise<{
+        id: string;
+        team: string;
+        app_id: string;
+        image?: string;
+        github_commit?: string;
+        github_ref?: string;
+        github_actor?: string;
+        github_commit_message?: string;
+        status: import("./types.js").components["schemas"]["DeploymentStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /deployment/{id}` — operationId: `deployment/get`
+     *
+     * Get Deployment
+     */
+    deploymentGet(id: string): Promise<{
+        id: string;
+        team: string;
+        app_id: string;
+        image?: string;
+        github_commit?: string;
+        github_ref?: string;
+        github_actor?: string;
+        github_commit_message?: string;
+        status: import("./types.js").components["schemas"]["DeploymentStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /deployment` — operationId: `deployment/list`
+     *
+     * List Deployments
+     */
+    deploymentList(params?: Omit<OpQuery<"deployment/list">, "cursor" | "next">): {
+        all: () => Promise<{
+            id: string;
+            team: string;
+            app_id: string;
+            image?: string;
+            github_commit?: string;
+            github_ref?: string;
+            github_actor?: string;
+            github_commit_message?: string;
+            status: import("./types.js").components["schemas"]["DeploymentStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }[]>;
+        first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            app_id: string;
+            image?: string;
+            github_commit?: string;
+            github_ref?: string;
+            github_actor?: string;
+            github_commit_message?: string;
+            status: import("./types.js").components["schemas"]["DeploymentStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+        pass: (params?: {
+            cursor?: string;
+            pageSize?: string;
+        }) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            app_id: string;
+            image?: string;
+            github_commit?: string;
+            github_ref?: string;
+            github_actor?: string;
+            github_commit_message?: string;
+            status: import("./types.js").components["schemas"]["DeploymentStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+    };
+    /**
+     * `POST /domain` — operationId: `domain/create`
+     *
+     * Create Domain
+     */
+    domainCreate(data: OpBody<"domain/create">): Promise<{
+        id: string;
+        team: string;
+        fqdn: string;
+        tls: boolean;
+        app_id: string | null;
+        verified: boolean;
+        active: boolean;
+        dns_alias: string | null;
+        status: import("./types.js").components["schemas"]["DomainStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `DELETE /domain/{id}` — operationId: `domain/delete`
+     *
+     * Delete Domain
+     */
+    domainDelete(id: string): Promise<{
+        id: string;
+        team: string;
+        fqdn: string;
+        tls: boolean;
+        app_id: string | null;
+        verified: boolean;
+        active: boolean;
+        dns_alias: string | null;
+        status: import("./types.js").components["schemas"]["DomainStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /domain/fqdn/{fqdn}` — operationId: `domain/fqdn`
+     *
+     * Get domain by FQDN
+     */
+    domainFqdn(fqdn: string): Promise<{
+        id: string;
+        team: string;
+        fqdn: string;
+        tls: boolean;
+        app_id: string | null;
+        verified: boolean;
+        active: boolean;
+        dns_alias: string | null;
+        status: import("./types.js").components["schemas"]["DomainStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /domain/{id}` — operationId: `domain/get`
+     *
+     * Get Domain
+     */
+    domainGet(id: string): Promise<{
+        id: string;
+        team: string;
+        fqdn: string;
+        tls: boolean;
+        app_id: string | null;
+        verified: boolean;
+        active: boolean;
+        dns_alias: string | null;
+        status: import("./types.js").components["schemas"]["DomainStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /domain` — operationId: `domain/list`
+     *
+     * List Domains
+     */
+    domainList(params?: Omit<OpQuery<"domain/list">, "cursor" | "next">): {
+        all: () => Promise<{
+            id: string;
+            team: string;
+            fqdn: string;
+            tls: boolean;
+            app_id: string | null;
+            verified: boolean;
+            active: boolean;
+            dns_alias: string | null;
+            status: import("./types.js").components["schemas"]["DomainStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }[]>;
+        first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            fqdn: string;
+            tls: boolean;
+            app_id: string | null;
+            verified: boolean;
+            active: boolean;
+            dns_alias: string | null;
+            status: import("./types.js").components["schemas"]["DomainStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+        pass: (params?: {
+            cursor?: string;
+            pageSize?: string;
+        }) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            team: string;
+            fqdn: string;
+            tls: boolean;
+            app_id: string | null;
+            verified: boolean;
+            active: boolean;
+            dns_alias: string | null;
+            status: import("./types.js").components["schemas"]["DomainStatus"];
+            metadata: {
+                [key: string]: unknown;
+            };
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+    };
+    /**
+     * `POST /domain/{id}` — operationId: `domain/update`
+     *
+     * Update Domain
+     */
+    domainUpdate(id: string, data: OpBody<"domain/update">): Promise<{
+        id: string;
+        team: string;
+        fqdn: string;
+        tls: boolean;
+        app_id: string | null;
+        verified: boolean;
+        active: boolean;
+        dns_alias: string | null;
+        status: import("./types.js").components["schemas"]["DomainStatus"];
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `POST /project` — operationId: `project/create`
+     *
+     * Create Project
+     */
+    projectCreate(data: OpBody<"project/create">): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        slug: string;
+        team: string;
+        user_id?: string;
+        collaborators: string[];
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `DELETE /project/{id}` — operationId: `project/delete`
+     *
+     * Delete Project
+     */
+    projectDelete(id: string): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        slug: string;
+        team: string;
+        user_id?: string;
+        collaborators: string[];
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /project/{id}` — operationId: `project/get`
+     *
+     * Get Project
+     */
+    projectGet(id: string): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        slug: string;
+        team: string;
+        user_id?: string;
+        collaborators: string[];
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `POST /project/{id}/invite` — operationId: `project/invite`
+     *
+     * Invite collaborators to project
+     */
+    projectInvite(id: string, data: OpBody<"project/invite">): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        slug: string;
+        team: string;
+        user_id?: string;
+        collaborators: string[];
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /project` — operationId: `project/list`
+     *
+     * List Projects
+     */
+    projectList(params?: Omit<OpQuery<"project/list">, "cursor" | "next">): {
+        all: () => Promise<{
+            id: string;
+            name: string;
+            description: string;
+            slug: string;
+            team: string;
+            user_id?: string;
+            collaborators: string[];
+            createdAt: string;
+            updatedAt?: string;
+        }[]>;
+        first: () => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            name: string;
+            description: string;
+            slug: string;
+            team: string;
+            user_id?: string;
+            collaborators: string[];
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+        pass: (params?: {
+            cursor?: string;
+            pageSize?: string;
+        }) => Promise<import("@faable/sdk-base/dist/helpers/paginator.js").Page<{
+            id: string;
+            name: string;
+            description: string;
+            slug: string;
+            team: string;
+            user_id?: string;
+            collaborators: string[];
+            createdAt: string;
+            updatedAt?: string;
+        }>>;
+    };
+    /**
+     * `POST /project/{id}` — operationId: `project/update`
+     *
+     * Update Project
+     */
+    projectUpdate(id: string, data: OpBody<"project/update">): Promise<{
+        id: string;
+        name: string;
+        description: string;
+        slug: string;
+        team: string;
+        user_id?: string;
+        collaborators: string[];
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `POST /secret/createbatch` — operationId: `secrets/create_batch`
+     *
+     * Create secrets in batch
+     */
+    secretsCreateBatch(data: OpBody<"secrets/create_batch">): Promise<{
+        id: string;
+        team: string;
+        app_id?: string;
+        profile_id?: string;
+        related: string;
+        related_model: string;
+        name: string;
+        value: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }[]>;
+    /**
+     * `DELETE /secret/{secret_id}` — operationId: `secrets/delete`
+     *
+     * Delete a secret
+     */
+    secretsDelete(secret_id: string): Promise<void>;
+    /**
+     * `GET /secret/{context_id}` — operationId: `secrets/list_app`
+     *
+     * List all secrets assigned to an App or Profile contexts
+     */
+    secretsListApp(context_id: string, params?: OpQuery<"secrets/list_app">): Promise<{
+        next: string | null;
+        results: import("./types.js").components["schemas"]["Secret"][];
+    }>;
+    /**
+     * `POST /secret` — operationId: `secrets/upsert`
+     *
+     * Upsert a secret
+     */
+    secretsUpsert(data: OpBody<"secrets/upsert">): Promise<{
+        id: string;
+        team: string;
+        app_id?: string;
+        profile_id?: string;
+        related: string;
+        related_model: string;
+        name: string;
+        value: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string;
+    }>;
+    /**
+     * `GET /usage/summary` — operationId: `usage/summary`
+     *
+     * Get team usage summary for the current billing period
+     */
+    usageSummary(): Promise<{
+        resources: {
+            apps: number;
+            domains: number;
+            deployments: number;
+        };
+        traffic: {
+            used_gb: number;
+            cost_estimate_cents: number;
+        };
+        teams: {
+            id: string;
+            name: string;
+            slug: string;
+            period: {
+                start: string;
+                end: string;
+            };
+            subscription: {
+                plan: string | null;
+                status: string;
+            } | null;
+            resources: {
+                apps: number;
+                domains: number;
+                deployments: number;
+            };
+            traffic: {
+                used_gb: number;
+                cost_estimate_cents: number;
+            } | null;
+        }[];
+    }>;
+}
+export {};
+//# sourceMappingURL=generated-client.d.ts.map