@faable/deploy-sdk 2.2.0 → 2.3.0

package/dist/api/types.d.ts

@@ -282,7 +282,7 @@ export interface paths {
         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).
+         * @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;
@@ -291,6 +291,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/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. Also rewrites the committed deploy workflow to trigger on the new branch, unless the user has customized it.
+         */
+        post: operations["app/set_deploy_branch"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/deployment": {
         parameters: {
             query?: never;
@@ -328,7 +348,11 @@ export interface paths {
          */
         get: operations["deployment/get"];
         put?: never;
-        post?: never;
+        /**
+         * Update Deployment
+         * @description Update Deployment
+         */
+        post: operations["deployment/update"];
         /**
          * Delete Deployment
          * @description Delete Deployment
@@ -339,6 +363,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/deployment/{deployment_id}/logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get deployment build logs
+         * @description Get the CLI build/deploy output attached to a deployment
+         */
+        get: operations["deployment/get_logs"];
+        put?: never;
+        /**
+         * Upload deployment build logs
+         * @description Attach the CLI build/deploy output to a deployment
+         */
+        post: operations["deployment/upload_logs"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/domain": {
         parameters: {
             query?: never;
@@ -639,74 +687,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/stripe/billing-portal": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Redirect to Stripe billing portal */
-        get: operations["stripe/billingPortal"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/stripe/payment-methods": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** List Stripe payment methods */
-        get: operations["stripe/paymentMethods"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/stripe/setup-intent": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Create a Stripe setup intent */
-        get: operations["stripe/setupIntent"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/stripe/invoices": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** List Stripe invoices */
-        get: operations["stripe/invoices"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/github/setup": {
         parameters: {
             query?: never;
@@ -896,6 +876,17 @@ 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
@@ -911,6 +902,20 @@ export interface components {
              * @default null
              */
             last_commited_purge_service: string | null;
+            /**
+             * @description Live versions of the app: the promoted one plus any draining (coexistence) versions
+             * @default null
+             */
+            versions: {
+                /** @description Deployment id of this version */
+                deployment: string;
+                /** @description promoted = current production; coexisting = draining */
+                role: "promoted" | "coexisting";
+                /** @description ISO date this version was promoted */
+                promoted_at: string;
+                /** @description GC-eligibility deadline for a coexisting version (demotion + drain window). Null on the promoted entry. */
+                drain_until: string | null;
+            }[] | null;
             /**
              * @description Opaque revision token; changes whenever the app secrets change
              * @default null
@@ -920,6 +925,16 @@ export interface components {
         AppRuntimeStrategy: string;
         /** @enum {unknown} */
         AppRuntime: "node" | "php";
+        /**
+         * @default standard
+         * @enum {unknown}
+         */
+        AppMode: "standard" | "coexistence";
+        /**
+         * @default cookie
+         * @enum {unknown}
+         */
+        AppCoexistenceRouting: "cookie" | "path";
         /** @description App */
         App: {
             /** @description App ID */
@@ -930,8 +945,14 @@ export interface components {
             slug: string;
             url: string;
             active: boolean;
+            /** @description Reason the app was administratively disabled. Null when the app is active. */
+            disabled_reason?: string | null;
             runtime: components["schemas"]["AppRuntime"];
             runtime_strategy: string | null;
+            mode: components["schemas"]["AppMode"];
+            coexistence_routing?: ("cookie" | "path") | null;
+            coexistence_keep_versions?: number | null;
+            coexistence_drain_hours?: number | null;
             /** @description Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. */
             instance_type: string;
             /**
@@ -992,14 +1013,29 @@ export interface components {
         DeployWorkflowStatus: {
             configured: boolean;
             workflow_path?: string;
+            updated?: boolean;
+        };
+        DeployBranchResult: {
+            github_branch: string;
+            workflow_synced: boolean;
+            workflow_path?: string;
         };
         DeploymentStatus: {
             /**
              * @description High-level summary of where the Deployment is in its lifecycle
-             * @default UNKNOWN
+             * @default QUEUED
              * @enum {unknown}
              */
-            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING";
+            phase: "UNKNOWN" | "QUEUED" | "BUILDING" | "ERROR" | "BUILD_ERROR" | "INITIALIZING" | "READY" | "CANCELED" | "TERMINATING";
+            /**
+             * Format: date-time
+             * @description When a controller took control of this deployment
+             */
+            controlled_at?: string;
+            /** @description INSTANCE_NAME of the controller that claimed it */
+            controlled_by?: string;
+            /** @description Why the deployment failed (shown to the user on ERROR) */
+            reason?: string;
         };
         /** @description Deployment */
         Deployment: {
@@ -1055,6 +1091,9 @@ export interface components {
             github_commit_message?: string;
             type?: string;
         };
+        DeploymentUpdate: {
+            image: string;
+        };
         DomainStatus: {
             /**
              * @description Outcome of the latest DNS verification check
@@ -1702,8 +1741,14 @@ export interface operations {
                         slug: string;
                         url: string;
                         active: boolean;
+                        /** @description Reason the app was administratively disabled. Null when the app is active. */
+                        disabled_reason?: string | null;
                         runtime: components["schemas"]["AppRuntime"];
                         runtime_strategy: string | null;
+                        mode: components["schemas"]["AppMode"];
+                        coexistence_routing?: ("cookie" | "path") | null;
+                        coexistence_keep_versions?: number | null;
+                        coexistence_drain_hours?: number | null;
                         /** @description Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. */
                         instance_type: string;
                         /**
@@ -1758,8 +1803,14 @@ export interface operations {
                         slug: string;
                         url: string;
                         active: boolean;
+                        /** @description Reason the app was administratively disabled. Null when the app is active. */
+                        disabled_reason?: string | null;
                         runtime: components["schemas"]["AppRuntime"];
                         runtime_strategy: string | null;
+                        mode: components["schemas"]["AppMode"];
+                        coexistence_routing?: ("cookie" | "path") | null;
+                        coexistence_keep_versions?: number | null;
+                        coexistence_drain_hours?: number | null;
                         /** @description Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. */
                         instance_type: string;
                         /**
@@ -1821,8 +1872,14 @@ export interface operations {
                         slug: string;
                         url: string;
                         active: boolean;
+                        /** @description Reason the app was administratively disabled. Null when the app is active. */
+                        disabled_reason?: string | null;
                         runtime: components["schemas"]["AppRuntime"];
                         runtime_strategy: string | null;
+                        mode: components["schemas"]["AppMode"];
+                        coexistence_routing?: ("cookie" | "path") | null;
+                        coexistence_keep_versions?: number | null;
+                        coexistence_drain_hours?: number | null;
                         /** @description Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. */
                         instance_type: string;
                         /**
@@ -1874,8 +1931,14 @@ export interface operations {
                         slug: string;
                         url: string;
                         active: boolean;
+                        /** @description Reason the app was administratively disabled. Null when the app is active. */
+                        disabled_reason?: string | null;
                         runtime: components["schemas"]["AppRuntime"];
                         runtime_strategy: string | null;
+                        mode: components["schemas"]["AppMode"];
+                        coexistence_routing?: ("cookie" | "path") | null;
+                        coexistence_keep_versions?: number | null;
+                        coexistence_drain_hours?: number | null;
                         /** @description Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. */
                         instance_type: string;
                         /**
@@ -2155,6 +2218,7 @@ export interface operations {
                     "application/json": {
                         configured: boolean;
                         workflow_path?: string;
+                        updated?: boolean;
                     };
                 };
             };
@@ -2180,6 +2244,39 @@ export interface operations {
                     "application/json": {
                         configured: boolean;
                         workflow_path?: string;
+                        updated?: boolean;
+                    };
+                };
+            };
+        };
+    };
+    "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;
+                        workflow_path?: string;
                     };
                 };
             };
@@ -2309,6 +2406,53 @@ export interface operations {
             };
         };
     };
+    "deployment/update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    image: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Deployment */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Deployment ID */
+                        id: string;
+                        team: string;
+                        app_id: string;
+                        image?: string;
+                        github_commit?: string;
+                        github_ref?: string;
+                        github_actor?: string;
+                        github_commit_message?: string;
+                        status: components["schemas"]["DeploymentStatus"];
+                        /** @default {} */
+                        metadata: {
+                            [key: string]: unknown;
+                        };
+                        /** @description Deployment creation date */
+                        createdAt: string;
+                        /** @description Deployment updated date */
+                        updatedAt?: string;
+                    };
+                };
+            };
+        };
+    };
     "deployment/delete": {
         parameters: {
             query?: never;
@@ -2350,6 +2494,73 @@ export interface operations {
             };
         };
     };
+    "deployment/get_logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deployment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        id: string;
+                        deployment_id: string;
+                        app_id: string;
+                        team: string;
+                        content: string;
+                        truncated: boolean;
+                        size: number;
+                        createdAt?: string;
+                        updatedAt?: string;
+                    };
+                };
+            };
+        };
+    };
+    "deployment/upload_logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deployment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    content: string;
+                    /** @default false */
+                    truncated?: boolean;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        id: string;
+                        deployment_id: string;
+                        truncated: boolean;
+                        size: number;
+                    };
+                };
+            };
+        };
+    };
     "domain/list": {
         parameters: {
             query?: {
@@ -3193,80 +3404,6 @@ export interface operations {
             };
         };
     };
-    "stripe/billingPortal": {
-        parameters: {
-            query: {
-                return_to: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    "stripe/paymentMethods": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    "stripe/setupIntent": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
-    "stripe/invoices": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Default Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-        };
-    };
     "github/setup": {
         parameters: {
             query?: {