@subscribeflow/sdk 1.2.0 → 1.3.0

package/dist/api-types.d.ts

@@ -1910,6 +1910,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/admin/system-status": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Worker heartbeat and email-queue backlog status
+         * @description Live worker-heartbeat and email-backlog status for the platform-admin GUI (TF-572).
+         *
+         *     ``get_worker_heartbeat_status`` never raises. ``get_email_backlog_status``
+         *     can (a DB error propagates), so it's guarded here specifically: this
+         *     endpoint exists to surface infrastructure problems and must not itself
+         *     500 because of one — a DB hiccup degrades to an "unknown" backlog status
+         *     rather than hiding an otherwise-healthy worker reading behind a 500.
+         */
+        get: operations["get_system_status_api_v1_admin_system_status_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2518,6 +2544,29 @@ export interface components {
              */
             dns_records: components["schemas"]["DnsRecord"][];
         };
+        /**
+         * EmailBacklogStatus
+         * @description Email queue backlog status.
+         *
+         *     ``status == "unknown"`` means the backlog query itself failed (e.g. a DB
+         *     outage) — distinct from ``stuck_count == 0``, which means the query ran
+         *     and found nothing stuck. Conflating the two would let a DB hiccup read as
+         *     "no backlog" instead of "we don't know", the same false-all-clear problem
+         *     ``WorkerHeartbeatStatus`` guards against.
+         */
+        EmailBacklogStatus: {
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: "ok" | "unknown";
+            /** Stuck Count */
+            stuck_count?: number | null;
+            /** Oldest Stuck At */
+            oldest_stuck_at: string | null;
+            /** Threshold Minutes */
+            threshold_minutes: number;
+        };
         /**
          * EmailSendRequest
          * @description Schema for sending a transactional email.
@@ -3665,6 +3714,14 @@ export interface components {
             /** Status */
             status: string;
         };
+        /**
+         * SystemStatusResponse
+         * @description Combined worker-heartbeat and email-backlog status for the admin GUI.
+         */
+        SystemStatusResponse: {
+            worker: components["schemas"]["WorkerHeartbeatStatus"];
+            email_backlog: components["schemas"]["EmailBacklogStatus"];
+        };
         /**
          * TagBrief
          * @description Brief tag information for subscriber responses.
@@ -4456,6 +4513,28 @@ export interface components {
             /** Error */
             error?: string | null;
         };
+        /**
+         * WorkerHeartbeatStatus
+         * @description Worker/beat heartbeat freshness.
+         *
+         *     ``status == "unknown"`` (Redis unreachable, or no heartbeat written yet)
+         *     must come with null timestamps, and every other status must come with
+         *     real ones — the validator below enforces that pairing so a caller cannot
+         *     construct e.g. "healthy" next to a null timestamp, which would render as
+         *     a false all-clear on the one page built to catch exactly that kind of
+         *     misleading state.
+         */
+        WorkerHeartbeatStatus: {
+            /**
+             * Status
+             * @enum {string}
+             */
+            status: "healthy" | "stale" | "unknown";
+            /** Last Heartbeat At */
+            last_heartbeat_at: string | null;
+            /** Seconds Since Heartbeat */
+            seconds_since_heartbeat?: number | null;
+        };
         /** @description RFC 7807 Problem Details for HTTP APIs */
         ProblemDetail: {
             /**
@@ -13412,5 +13491,74 @@ export interface operations {
             };
         };
     };
+    get_system_status_api_v1_admin_system_status_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SystemStatusResponse"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication Required */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Access Denied */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Resource Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Resource Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }
 //# sourceMappingURL=api-types.d.ts.map