@faable/deploy-sdk 2.8.0 → 2.10.0

package/dist/api/types.d.ts

@@ -267,7 +267,47 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/app/{id}/deploy-workflow": {
+    "/app/{id}/deploy-branch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Change the deploy branch
+         * @description Change the branch the app deploys from. Apps deploying from their own GitHub Actions workflow must update the branch trigger in the workflow file themselves.
+         */
+        post: operations["app/set_deploy_branch"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -275,23 +315,39 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get deploy workflow status
-         * @description Check whether the app’s linked repository has a GitHub Actions workflow that deploys to Faable.
+         * List repository workflow files
+         * @description GitHub Actions workflow files present on the linked repository (deploy branch).
          */
-        get: operations["app/get_deploy_workflow"];
+        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;
+        };
         /**
-         * Set up deploy workflow
-         * @description Commit the Faable deploy GitHub Actions workflow to the app’s linked repository (no-op if already present; upgrades an unmodified legacy workflow).
+         * 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).
          */
-        post: operations["app/setup_deploy_workflow"];
+        get: operations["app/repo_config"];
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/app/{id}/deploy-branch": {
+    "/app/{id}/deploy-mode": {
         parameters: {
             query?: never;
             header?: never;
@@ -301,10 +357,30 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Change the deploy branch
-         * @description Change the branch the app deploys from. Also rewrites the committed deploy workflow to trigger on the new branch, unless the user has customized it.
+         * 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_branch"];
+        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;
@@ -572,6 +648,46 @@ export interface paths {
         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 {
@@ -643,17 +759,6 @@ export interface components {
             deployment_previous: string | {
                 [key: string]: unknown;
             } | null;
-            /**
-             * @description Observed state of the push-to-deploy workflow on the linked repository
-             * @default null
-             */
-            deploy_workflow: {
-                /** @description Whether a Faable deploy workflow exists on the repository */
-                configured: boolean;
-                path: string | null;
-                verified_at: string | null;
-                commit: string | null;
-            } | null;
             /**
              * @description Last commited cache Purge
              * @default null
@@ -737,10 +842,18 @@ export interface components {
              * @enum {unknown}
              */
             region: "gui1" | "poz1" | "ams1";
+            /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
+            notify_deploy_success?: boolean | null;
             status: components["schemas"]["AppStatus"];
             repository?: string;
             github_branch?: string;
             github_installation_id?: string;
+            /** @description Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked. */
+            github_installation_state?: string | null;
+            /** @description Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4). */
+            deploy_trigger?: string | null;
+            /** @description Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green. */
+            deploy_gate?: string | null;
             /** @default {} */
             metadata: {
                 [key: string]: unknown;
@@ -785,16 +898,31 @@ export interface components {
             runtime?: components["schemas"]["AppRuntime"];
             runtime_strategy?: components["schemas"]["AppRuntimeStrategy"];
             instance_type?: string;
-        };
-        DeployWorkflowStatus: {
-            configured: boolean;
-            workflow_path?: string;
-            updated?: boolean;
+            notify_deploy_success?: boolean | null;
         };
         DeployBranchResult: {
             github_branch: string;
             workflow_synced: boolean;
-            workflow_path?: string;
+        };
+        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: {
             /**
@@ -802,7 +930,7 @@ export interface components {
              * @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
@@ -818,12 +946,16 @@ export interface components {
             runtime_image?: string;
         };
         DeploymentSource: {
-            manifest: {
+            manifest?: {
                 path: string;
                 sha: string;
                 size: number;
                 mode?: number;
             }[];
+            git?: {
+                sha: string;
+                ref?: string;
+            };
             plan?: {
                 [key: string]: unknown;
             };
@@ -862,6 +994,9 @@ 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 {} */
             metadata: {
@@ -1346,6 +1481,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;
@@ -1698,10 +1846,18 @@ export interface operations {
                          * @enum {unknown}
                          */
                         region: "gui1" | "poz1" | "ams1";
+                        /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
+                        notify_deploy_success?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
                         github_installation_id?: string;
+                        /** @description Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked. */
+                        github_installation_state?: string | null;
+                        /** @description Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4). */
+                        deploy_trigger?: string | null;
+                        /** @description Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green. */
+                        deploy_gate?: string | null;
                         /** @default {} */
                         metadata: {
                             [key: string]: unknown;
@@ -1763,10 +1919,18 @@ export interface operations {
                          * @enum {unknown}
                          */
                         region: "gui1" | "poz1" | "ams1";
+                        /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
+                        notify_deploy_success?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
                         github_installation_id?: string;
+                        /** @description Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked. */
+                        github_installation_state?: string | null;
+                        /** @description Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4). */
+                        deploy_trigger?: string | null;
+                        /** @description Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green. */
+                        deploy_gate?: string | null;
                         /** @default {} */
                         metadata: {
                             [key: string]: unknown;
@@ -1797,6 +1961,7 @@ export interface operations {
                     runtime?: components["schemas"]["AppRuntime"];
                     runtime_strategy?: components["schemas"]["AppRuntimeStrategy"];
                     instance_type?: string;
+                    notify_deploy_success?: boolean | null;
                 };
             };
         };
@@ -1835,10 +2000,18 @@ export interface operations {
                          * @enum {unknown}
                          */
                         region: "gui1" | "poz1" | "ams1";
+                        /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
+                        notify_deploy_success?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
                         github_installation_id?: string;
+                        /** @description Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked. */
+                        github_installation_state?: string | null;
+                        /** @description Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4). */
+                        deploy_trigger?: string | null;
+                        /** @description Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green. */
+                        deploy_gate?: string | null;
                         /** @default {} */
                         metadata: {
                             [key: string]: unknown;
@@ -1897,10 +2070,18 @@ export interface operations {
                          * @enum {unknown}
                          */
                         region: "gui1" | "poz1" | "ams1";
+                        /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
+                        notify_deploy_success?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
                         github_installation_id?: string;
+                        /** @description Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked. */
+                        github_installation_state?: string | null;
+                        /** @description Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4). */
+                        deploy_trigger?: string | null;
+                        /** @description Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green. */
+                        deploy_gate?: string | null;
                         /** @default {} */
                         metadata: {
                             [key: string]: unknown;
@@ -2148,7 +2329,62 @@ export interface operations {
             };
         };
     };
-    "app/get_deploy_workflow": {
+    "app/set_deploy_branch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    github_branch: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        github_branch: string;
+                        workflow_synced: boolean;
+                    };
+                };
+            };
+        };
+    };
+    "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;
@@ -2166,15 +2402,17 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        configured: boolean;
-                        workflow_path?: string;
-                        updated?: boolean;
+                        workflows: {
+                            name: string;
+                            path: string;
+                        }[];
+                        deploy_workflow: string | null;
                     };
                 };
             };
         };
     };
-    "app/setup_deploy_workflow": {
+    "app/repo_config": {
         parameters: {
             query?: never;
             header?: never;
@@ -2192,15 +2430,14 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        configured: boolean;
-                        workflow_path?: string;
-                        updated?: boolean;
+                        root_dir: string | null;
+                        root_dir_source: "platform" | "faable.json" | null;
                     };
                 };
             };
         };
     };
-    "app/set_deploy_branch": {
+    "app/set_deploy_mode": {
         parameters: {
             query?: never;
             header?: never;
@@ -2212,10 +2449,32 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
-                    github_branch: string;
+                    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: {
@@ -2224,9 +2483,10 @@ export interface operations {
                 };
                 content: {
                     "application/json": {
-                        github_branch: string;
-                        workflow_synced: boolean;
-                        workflow_path?: string;
+                        /** @enum {string} */
+                        status: "created";
+                        commit: string;
+                        branch: string;
                     };
                 };
             };
@@ -2308,6 +2568,9 @@ 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 {} */
                         metadata: {
@@ -2354,6 +2617,9 @@ 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 {} */
                         metadata: {
@@ -2408,6 +2674,9 @@ 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 {} */
                         metadata: {
@@ -2454,6 +2723,9 @@ 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 {} */
                         metadata: {
@@ -2961,5 +3233,56 @@ export interface operations {
             };
         };
     };
+    "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[];
+                    };
+                };
+            };
+        };
+    };
 }
 //# sourceMappingURL=types.d.ts.map