@thinkai/tai-api-contract 2.147.1 → 2.148.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.147.1
+  version: 2.148.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -9204,15 +9204,42 @@ paths:
     get:
       tags: [Notifications]
       summary: Paginated notifications
+      description: >
+        Inbox for the current user in this workspace. Applies the same notification-type
+        preference filter and routine-title exclusion as the unread badge. `view` defaults to
+        `all` so a client that omits it still receives success rows. Severity is the stored
+        column and is not recomputed per request.
       operationId: listNotifications
       parameters:
         - $ref: "#/components/parameters/WorkspaceId"
         - name: limit
           in: query
-          schema: { type: integer, minimum: 1 }
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 50
         - name: offset
           in: query
-          schema: { type: integer, minimum: 0 }
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - name: view
+          in: query
+          description: >
+            `all` returns every severity. `needs_action` returns only `warning` and
+            `destructive`. Omitted is `all`.
+          schema:
+            type: string
+            enum: [all, needs_action]
+            default: all
+        - name: unread
+          in: query
+          description: >
+            Omit to include read and unread rows. `true` is unread only. `false` is read only.
+          schema:
+            type: boolean
       responses:
         "200":
           description: Page of notifications
@@ -9220,6 +9247,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/NotificationListDto"
+        "400":
+          description: Invalid `view` or `unread`
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
         "401":
           $ref: "#/components/responses/Unauthorized"
 
@@ -9227,6 +9260,10 @@ paths:
     get:
       tags: [Notifications]
       summary: Unread notification count
+      description: >
+        Unread rows for the current user in this workspace after the notification-type
+        preference filter and the routine-title exclusion. `count` is not capped.
+        `hasUnreadCritical` is true when at least one of those rows has severity `destructive`.
       operationId: getNotificationUnreadCount
       parameters:
         - $ref: "#/components/parameters/WorkspaceId"
@@ -9452,7 +9489,7 @@ paths:
       description: >
         Returns the authenticated user's profile, workspace list, and preferences in one response.
         When `workspaceId` is provided and resolves to a workspace the caller belongs to, also
-        returns platform banner, unread notification count, journey progress, and connectors
+        returns platform banner, unread notification count (`count` and `hasUnreadCritical`), journey progress, and connectors
         snapshot. Invalid, unknown, or non-member `workspaceId` values do not produce 403/404 —
         the response is still 200 with only `me`, `workspaces`, and `preferences` (workspace-scoped
         fields omitted).
@@ -18501,7 +18538,7 @@ components:
 
     NotificationDto:
       type: object
-      required: [id, type, title, message, read, createdAt]
+      required: [id, type, title, message, read, createdAt, severity]
       properties:
         id:
           type: string
@@ -18522,6 +18559,8 @@ components:
         severity:
           type: string
           enum: [success, warning, destructive, muted, neutral]
+          description: >
+            Stored on the notification row at fan-out. `destructive` is the only critical severity.
         triggeredBy:
           type: string
           nullable: true
@@ -18539,11 +18578,17 @@ components:
 
     NotificationUnreadCountDto:
       type: object
-      required: [count]
+      required: [count, hasUnreadCritical]
       properties:
         count:
           type: integer
           minimum: 0
+          description: >
+            Unread rows after the type-preference filter and routine-title exclusion. Not capped.
+        hasUnreadCritical:
+          type: boolean
+          description: >
+            True when at least one of those unread rows has severity `destructive`.
 
     EffectiveTaskRowDto:
       type: object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.147.1",
+  "version": "2.148.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",

package/src/generated/openapi.ts

@@ -3708,7 +3708,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Paginated notifications */
+        /**
+         * Paginated notifications
+         * @description Inbox for the current user in this workspace. Applies the same notification-type preference filter and routine-title exclusion as the unread badge. `view` defaults to `all` so a client that omits it still receives success rows. Severity is the stored column and is not recomputed per request.
+         */
         get: operations["listNotifications"];
         put?: never;
         post?: never;
@@ -3725,7 +3728,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Unread notification count */
+        /**
+         * Unread notification count
+         * @description Unread rows for the current user in this workspace after the notification-type preference filter and the routine-title exclusion. `count` is not capped. `hasUnreadCritical` is true when at least one of those rows has severity `destructive`.
+         */
         get: operations["getNotificationUnreadCount"];
         put?: never;
         post?: never;
@@ -3852,7 +3858,7 @@ export interface paths {
         };
         /**
          * App chrome bootstrap payload
-         * @description Returns the authenticated user's profile, workspace list, and preferences in one response. When `workspaceId` is provided and resolves to a workspace the caller belongs to, also returns platform banner, unread notification count, journey progress, and connectors snapshot. Invalid, unknown, or non-member `workspaceId` values do not produce 403/404 — the response is still 200 with only `me`, `workspaces`, and `preferences` (workspace-scoped fields omitted).
+         * @description Returns the authenticated user's profile, workspace list, and preferences in one response. When `workspaceId` is provided and resolves to a workspace the caller belongs to, also returns platform banner, unread notification count (`count` and `hasUnreadCritical`), journey progress, and connectors snapshot. Invalid, unknown, or non-member `workspaceId` values do not produce 403/404 — the response is still 200 with only `me`, `workspaces`, and `preferences` (workspace-scoped fields omitted).
          */
         get: operations["getAppShell"];
         put?: never;
@@ -7880,8 +7886,11 @@ export interface components {
             /** Format: date-time */
             createdAt: string;
             route?: string;
-            /** @enum {string} */
-            severity?: "success" | "warning" | "destructive" | "muted" | "neutral";
+            /**
+             * @description Stored on the notification row at fan-out. `destructive` is the only critical severity.
+             * @enum {string}
+             */
+            severity: "success" | "warning" | "destructive" | "muted" | "neutral";
             triggeredBy?: string | null;
         };
         NotificationListDto: {
@@ -7889,7 +7898,10 @@ export interface components {
             total: number;
         };
         NotificationUnreadCountDto: {
+            /** @description Unread rows after the type-preference filter and routine-title exclusion. Not capped. */
             count: number;
+            /** @description True when at least one of those unread rows has severity `destructive`. */
+            hasUnreadCritical: boolean;
         };
         EffectiveTaskRowDto: {
             id: string;
@@ -20580,6 +20592,10 @@ export interface operations {
             query?: {
                 limit?: number;
                 offset?: number;
+                /** @description `all` returns every severity. `needs_action` returns only `warning` and `destructive`. Omitted is `all`. */
+                view?: "all" | "needs_action";
+                /** @description Omit to include read and unread rows. `true` is unread only. `false` is read only. */
+                unread?: boolean;
             };
             header?: never;
             path: {
@@ -20598,6 +20614,15 @@ export interface operations {
                     "application/json": components["schemas"]["NotificationListDto"];
                 };
             };
+            /** @description Invalid `view` or `unread` */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
             401: components["responses"]["Unauthorized"];
         };
     };