@faable/deploy-sdk 2.7.1 → 2.9.0

package/dist/api/types.d.ts

@@ -267,30 +267,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/app/{id}/deploy-workflow": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get deploy workflow status
-         * @description Check whether the app’s linked repository has a GitHub Actions workflow that deploys to Faable.
-         */
-        get: operations["app/get_deploy_workflow"];
-        put?: 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).
-         */
-        post: operations["app/setup_deploy_workflow"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/app/{id}/deploy-branch": {
         parameters: {
             query?: never;
@@ -302,7 +278,7 @@ export interface paths {
         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.
+         * @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;
@@ -643,17 +619,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
@@ -683,6 +648,8 @@ export interface components {
                 /** @description GC-eligibility deadline for a coexisting version (demotion + drain window). Null on the promoted entry. */
                 drain_until: string | null;
             }[] | null;
+            /** @description Scale-to-zero sub-state of the promoted deployment (admin-only) */
+            cold_state?: "asleep" | "waking" | null;
             /**
              * @description Opaque revision token; changes whenever the app secrets change
              * @default null
@@ -735,10 +702,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;
@@ -783,16 +758,11 @@ 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;
         };
         DeploymentStatus: {
             /**
@@ -800,7 +770,7 @@ export interface components {
              * @default QUEUED
              * @enum {unknown}
              */
-            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING";
+            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING" | "SUPERSEDED";
             /**
              * Format: date-time
              * @description When a controller took control of this deployment
@@ -810,16 +780,22 @@ export interface components {
             controlled_by?: string;
             /** @description Why the deployment failed (shown to the user on ERROR) */
             reason?: string;
+            /** @description Scale-to-zero sub-state (admin-only): asleep, waking or null */
+            cold_state?: "asleep" | "waking" | null;
             /** @description Digest-pinned runtime image stamped at first materialization (artifact deploys) */
             runtime_image?: string;
         };
         DeploymentSource: {
-            manifest: {
+            manifest?: {
                 path: string;
                 sha: string;
                 size: number;
                 mode?: number;
             }[];
+            git?: {
+                sha: string;
+                ref?: string;
+            };
             plan?: {
                 [key: string]: unknown;
             };
@@ -849,12 +825,16 @@ export interface components {
             team: string;
             app_id: string;
             image?: string;
+            release?: string;
             github_commit?: string;
             github_ref?: string;
             github_actor?: string;
             github_commit_message?: string;
-            source?: components["schemas"]["DeploymentSource"];
-            artifact?: components["schemas"]["DeploymentArtifact"];
+            artifact_id?: string;
+            /** Format: date-time */
+            artifact_ready_at?: string;
+            redeploy_of?: string;
+            trigger?: string | null;
             status: components["schemas"]["DeploymentStatus"];
             /** @default {} */
             metadata: {
@@ -892,6 +872,7 @@ export interface components {
         DeploymentCreate: {
             app_id: string;
             image?: string;
+            release?: string;
             github_commit?: string;
             github_ref?: string;
             github_actor?: string;
@@ -1690,10 +1671,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;
@@ -1755,10 +1744,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;
@@ -1789,6 +1786,7 @@ export interface operations {
                     runtime?: components["schemas"]["AppRuntime"];
                     runtime_strategy?: components["schemas"]["AppRuntimeStrategy"];
                     instance_type?: string;
+                    notify_deploy_success?: boolean | null;
                 };
             };
         };
@@ -1827,10 +1825,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;
@@ -1889,10 +1895,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;
@@ -2140,58 +2154,6 @@ export interface operations {
             };
         };
     };
-    "app/get_deploy_workflow": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        configured: boolean;
-                        workflow_path?: string;
-                        updated?: boolean;
-                    };
-                };
-            };
-        };
-    };
-    "app/setup_deploy_workflow": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        configured: boolean;
-                        workflow_path?: string;
-                        updated?: boolean;
-                    };
-                };
-            };
-        };
-    };
     "app/set_deploy_branch": {
         parameters: {
             query?: never;
@@ -2218,7 +2180,6 @@ export interface operations {
                     "application/json": {
                         github_branch: string;
                         workflow_synced: boolean;
-                        workflow_path?: string;
                     };
                 };
             };
@@ -2268,6 +2229,7 @@ export interface operations {
                 "application/json": {
                     app_id: string;
                     image?: string;
+                    release?: string;
                     github_commit?: string;
                     github_ref?: string;
                     github_actor?: string;
@@ -2290,12 +2252,16 @@ export interface operations {
                         team: string;
                         app_id: string;
                         image?: string;
+                        release?: string;
                         github_commit?: string;
                         github_ref?: string;
                         github_actor?: string;
                         github_commit_message?: string;
-                        source?: components["schemas"]["DeploymentSource"];
-                        artifact?: components["schemas"]["DeploymentArtifact"];
+                        artifact_id?: string;
+                        /** Format: date-time */
+                        artifact_ready_at?: string;
+                        redeploy_of?: string;
+                        trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
                         metadata: {
@@ -2333,12 +2299,16 @@ export interface operations {
                         team: string;
                         app_id: string;
                         image?: string;
+                        release?: string;
                         github_commit?: string;
                         github_ref?: string;
                         github_actor?: string;
                         github_commit_message?: string;
-                        source?: components["schemas"]["DeploymentSource"];
-                        artifact?: components["schemas"]["DeploymentArtifact"];
+                        artifact_id?: string;
+                        /** Format: date-time */
+                        artifact_ready_at?: string;
+                        redeploy_of?: string;
+                        trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
                         metadata: {
@@ -2384,12 +2354,16 @@ export interface operations {
                         team: string;
                         app_id: string;
                         image?: string;
+                        release?: string;
                         github_commit?: string;
                         github_ref?: string;
                         github_actor?: string;
                         github_commit_message?: string;
-                        source?: components["schemas"]["DeploymentSource"];
-                        artifact?: components["schemas"]["DeploymentArtifact"];
+                        artifact_id?: string;
+                        /** Format: date-time */
+                        artifact_ready_at?: string;
+                        redeploy_of?: string;
+                        trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
                         metadata: {
@@ -2427,12 +2401,16 @@ export interface operations {
                         team: string;
                         app_id: string;
                         image?: string;
+                        release?: string;
                         github_commit?: string;
                         github_ref?: string;
                         github_actor?: string;
                         github_commit_message?: string;
-                        source?: components["schemas"]["DeploymentSource"];
-                        artifact?: components["schemas"]["DeploymentArtifact"];
+                        artifact_id?: string;
+                        /** Format: date-time */
+                        artifact_ready_at?: string;
+                        redeploy_of?: string;
+                        trigger?: string | null;
                         status: components["schemas"]["DeploymentStatus"];
                         /** @default {} */
                         metadata: {