@faable/deploy-sdk 2.9.0 → 2.11.0

package/dist/api/types.d.ts

@@ -287,6 +287,106 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/app/{id}/repo/branches": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List repository branches
+         * @description Branch names of the linked repository.
+         */
+        get: operations["app/repo_branches"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{id}/repo/workflows": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List repository workflow files
+         * @description GitHub Actions workflow files present on the linked repository (deploy branch).
+         */
+        get: operations["app/repo_workflows"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{id}/repo/config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get effective repository build config
+         * @description Effective build configuration read from the repository: the monorepo Root Directory and its source (platform override or the repo's faable.json).
+         */
+        get: operations["app/repo_config"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{id}/deploy-mode": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Set the deploy mode
+         * @description Choose how pushes deploy: 'push' = every push deploys directly; 'ci' = deploy once the commit's CI checks pass. Both are platform-managed (webhook) triggers.
+         */
+        post: operations["app/set_deploy_mode"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{id}/deploy": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Deploy the latest commit now
+         * @description Build and deploy the current head of the deploy branch, without waiting for a push. Same path as a push webhook, including the same-commit dedupe.
+         */
+        post: operations["app/deploy_now"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/deployment": {
         parameters: {
             query?: never;
@@ -548,6 +648,63 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/usage/traffic": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get metered traffic usage per team for the current period */
+        get: operations["usage/traffic"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/deploy-quota": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the team's daily deploy quota status
+         * @description Daily deploy allowance of the current team: how much was used today, when it resets, and how many builds are held waiting for it.
+         */
+        get: operations["deploy_quota/get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/deploy-quota/release": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Roll out the builds held by the daily deploy quota
+         * @description Releases the team's held deployments if its current plan allows it (per app, only the newest held build rolls out; older ones are canceled). Safe to call at any time — it does nothing while the quota is still spent.
+         */
+        post: operations["deploy_quota/release"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -764,13 +921,33 @@ export interface components {
             github_branch: string;
             workflow_synced: boolean;
         };
+        RepoBranches: {
+            branches: string[];
+        };
+        RepoWorkflows: {
+            workflows: {
+                name: string;
+                path: string;
+            }[];
+            deploy_workflow: string | null;
+        };
+        RepoConfig: {
+            root_dir: string | null;
+            root_dir_source: "platform" | "faable.json" | null;
+        };
+        DeployNowResult: {
+            /** @enum {string} */
+            status: "created";
+            commit: string;
+            branch: string;
+        };
         DeploymentStatus: {
             /**
              * @description High-level summary of where the Deployment is in its lifecycle
              * @default QUEUED
              * @enum {unknown}
              */
-            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING" | "SUPERSEDED";
+            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING" | "SUPERSEDED" | "QUOTA_HOLD";
             /**
              * Format: date-time
              * @description When a controller took control of this deployment
@@ -834,6 +1011,8 @@ export interface components {
             /** Format: date-time */
             artifact_ready_at?: string;
             redeploy_of?: string;
+            /** Format: date-time */
+            quota_released_at?: string;
             trigger?: string | null;
             status: components["schemas"]["DeploymentStatus"];
             /** @default {} */
@@ -1319,6 +1498,19 @@ export interface components {
         ApiKeyUpdate: {
             description?: string;
         };
+        DeployQuota: {
+            limited: boolean;
+            over: boolean;
+            used: number;
+            limit: number | null;
+            /** Format: date-time */
+            resets_at: string;
+            held: number;
+        };
+        DeployQuotaRelease: {
+            released: string[];
+            canceled: string[];
+        };
         AppChecknameResponse: {
             name: string;
             slug: string;
@@ -2185,6 +2377,138 @@ export interface operations {
             };
         };
     };
+    "app/repo_branches": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        branches: string[];
+                    };
+                };
+            };
+        };
+    };
+    "app/repo_workflows": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        workflows: {
+                            name: string;
+                            path: string;
+                        }[];
+                        deploy_workflow: string | null;
+                    };
+                };
+            };
+        };
+    };
+    "app/repo_config": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        root_dir: string | null;
+                        root_dir_source: "platform" | "faable.json" | null;
+                    };
+                };
+            };
+        };
+    };
+    "app/set_deploy_mode": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    mode: "push" | "ci" | "workflow";
+                };
+            };
+        };
+        responses: {
+            /** @description App */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["App"];
+                };
+            };
+        };
+    };
+    "app/deploy_now": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        status: "created";
+                        commit: string;
+                        branch: string;
+                    };
+                };
+            };
+        };
+    };
     "deployment/list": {
         parameters: {
             query?: {
@@ -2261,6 +2585,8 @@ export interface operations {
                         /** Format: date-time */
                         artifact_ready_at?: string;
                         redeploy_of?: string;
+                        /** Format: date-time */
+                        quota_released_at?: string;
                         trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
@@ -2308,6 +2634,8 @@ export interface operations {
                         /** Format: date-time */
                         artifact_ready_at?: string;
                         redeploy_of?: string;
+                        /** Format: date-time */
+                        quota_released_at?: string;
                         trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
@@ -2363,6 +2691,8 @@ export interface operations {
                         /** Format: date-time */
                         artifact_ready_at?: string;
                         redeploy_of?: string;
+                        /** Format: date-time */
+                        quota_released_at?: string;
                         trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
@@ -2410,6 +2740,8 @@ export interface operations {
                         /** Format: date-time */
                         artifact_ready_at?: string;
                         redeploy_of?: string;
+                        /** Format: date-time */
+                        quota_released_at?: string;
                         trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
@@ -2866,7 +3198,9 @@ export interface operations {
     };
     "usage/summary": {
         parameters: {
-            query?: never;
+            query?: {
+                traffic?: boolean;
+            };
             header?: never;
             path?: never;
             cookie?: never;
@@ -2888,7 +3222,7 @@ export interface operations {
                         traffic: {
                             used_gb: number;
                             cost_estimate_cents: number;
-                        };
+                        } | null;
                         teams: {
                             id: string;
                             name: string;
@@ -2913,6 +3247,91 @@ export interface operations {
                                 cost_estimate_cents: number;
                             } | null;
                         }[];
+                        billing_available: boolean;
+                    };
+                };
+            };
+        };
+    };
+    "usage/traffic": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        traffic: {
+                            used_gb: number;
+                            cost_estimate_cents: number;
+                        } | null;
+                        teams: {
+                            id: string;
+                            traffic: {
+                                used_gb: number;
+                                cost_estimate_cents: number;
+                            } | null;
+                        }[];
+                        billing_available: boolean;
+                    };
+                };
+            };
+        };
+    };
+    "deploy_quota/get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        limited: boolean;
+                        over: boolean;
+                        used: number;
+                        limit: number | null;
+                        /** Format: date-time */
+                        resets_at: string;
+                        held: number;
+                    };
+                };
+            };
+        };
+    };
+    "deploy_quota/release": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        released: string[];
+                        canceled: string[];
                     };
                 };
             };