@thinkai/tai-api-contract 2.147.1 → 2.149.0

package/dist/generated/openapi.d.ts

@@ -3707,7 +3707,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;
@@ -3724,7 +3727,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;
@@ -3813,9 +3819,15 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get preferences for current user */
+        /**
+         * Get preferences for current user
+         * @description Returns saved preferences, including `notificationChannels`. An empty or missing profile returns defaults (`email.status` is `digest`; every other channel cell is `off`).
+         */
         get: operations["getMyPreferences"];
-        /** Upsert preferences */
+        /**
+         * Upsert preferences
+         * @description Replaces the saved preferences object. Omitting `notificationChannels` keeps the stored cells, or the defaults when none are stored. A body that includes `notificationChannels` replaces those cells; any missing key inside it uses the default (`email.status` = `digest`, every other cell = `off`). Setting `email.status` to `off` returns 400 `notification_channel_required`. In-app `notifications` booleans are independent of these cells.
+         */
         put: operations["putMyPreferences"];
         post?: never;
         delete?: never;
@@ -3851,7 +3863,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 (including `notificationChannels`) 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;
@@ -7879,8 +7891,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: {
@@ -7888,7 +7903,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;
@@ -7966,6 +7984,59 @@ export interface components {
             /** @description System / platform announcements. */
             system: boolean;
         };
+        /**
+         * @description Status email delivery. `digest` (default) is the weekly mail. `immediate` sends as events arrive. `off` is not allowed.
+         * @enum {string}
+         */
+        NotificationEmailStatusMode: "immediate" | "digest";
+        /**
+         * @description Email delivery for comment, activity, or system. Default `off`. `immediate` sends as events arrive. `digest` is the weekly mail.
+         * @enum {string}
+         */
+        NotificationEmailDeliveryMode: "off" | "immediate" | "digest";
+        /**
+         * @description Slack or Teams delivery for one category. Default `off` until that member changes the cell. `dm` is a direct message. `channel` posts to the workspace channel an admin saved. Connecting chat does not turn cells on.
+         * @enum {string}
+         */
+        NotificationChatDeliveryMode: "off" | "dm" | "channel";
+        NotificationEmailChannelsDto: {
+            status: components["schemas"]["NotificationEmailStatusMode"];
+            comment: components["schemas"]["NotificationEmailDeliveryMode"];
+            activity: components["schemas"]["NotificationEmailDeliveryMode"];
+            system: components["schemas"]["NotificationEmailDeliveryMode"];
+        };
+        NotificationChatChannelsDto: {
+            status: components["schemas"]["NotificationChatDeliveryMode"];
+            comment: components["schemas"]["NotificationChatDeliveryMode"];
+            activity: components["schemas"]["NotificationChatDeliveryMode"];
+            system: components["schemas"]["NotificationChatDeliveryMode"];
+        };
+        /** @description Delivery cells beside the in-app Message Center switches. Defaults: `email.status` is `digest`; every other cell is `off`. Inbox rows whose type is `integration` use the `status` cell. */
+        NotificationChannelsDto: {
+            email: components["schemas"]["NotificationEmailChannelsDto"];
+            slack: components["schemas"]["NotificationChatChannelsDto"];
+            teams: components["schemas"]["NotificationChatChannelsDto"];
+        };
+        /** @description Partial email cells. Omitted keys are filled with defaults on save (`status` = `digest`, other keys = `off`). */
+        PutNotificationEmailChannelsDto: {
+            status?: components["schemas"]["NotificationEmailStatusMode"];
+            comment?: components["schemas"]["NotificationEmailDeliveryMode"];
+            activity?: components["schemas"]["NotificationEmailDeliveryMode"];
+            system?: components["schemas"]["NotificationEmailDeliveryMode"];
+        };
+        /** @description Partial chat cells. Omitted keys default to `off` on save. */
+        PutNotificationChatChannelsDto: {
+            status?: components["schemas"]["NotificationChatDeliveryMode"];
+            comment?: components["schemas"]["NotificationChatDeliveryMode"];
+            activity?: components["schemas"]["NotificationChatDeliveryMode"];
+            system?: components["schemas"]["NotificationChatDeliveryMode"];
+        };
+        /** @description Replaces stored channel cells when present on `PUT /me/preferences`. Omitted `email`, `slack`, or `teams` objects are filled with defaults. */
+        PutNotificationChannelsDto: {
+            email?: components["schemas"]["PutNotificationEmailChannelsDto"];
+            slack?: components["schemas"]["PutNotificationChatChannelsDto"];
+            teams?: components["schemas"]["PutNotificationChatChannelsDto"];
+        };
         PreferencesDto: {
             theme: components["schemas"]["ThemePreference"];
             sidebarCollapsed: boolean;
@@ -7978,6 +8049,28 @@ export interface components {
              * @default false
              */
             buddyEnabled: boolean;
+            notificationChannels: components["schemas"]["NotificationChannelsDto"];
+        };
+        /** @description Body for `PUT /me/preferences`. `notificationChannels` may be omitted to keep stored cells. */
+        PutPreferencesBodyDto: {
+            theme: components["schemas"]["ThemePreference"];
+            sidebarCollapsed: boolean;
+            /** @description IANA timezone name */
+            timezone: string;
+            dataRefreshInterval: components["schemas"]["DataRefreshInterval"];
+            notifications: components["schemas"]["NotificationPreferencesDto"];
+            /**
+             * @description When true, show the ThinkAI Buddy mascot. Default and missing stored values are false (opt-in only).
+             * @default false
+             */
+            buddyEnabled: boolean;
+            notificationChannels?: components["schemas"]["PutNotificationChannelsDto"];
+        };
+        NotificationChannelRequiredErrorDto: {
+            /** @description Status email cannot be turned off. */
+            error: string;
+            /** @enum {string} */
+            code: "notification_channel_required";
         };
         ValidationIssueDto: {
             path: (string | number)[];
@@ -10707,7 +10800,18 @@ export type JourneyProgressUpdateDto = components['schemas']['JourneyProgressUpd
 export type ThemePreference = components['schemas']['ThemePreference'];
 export type DataRefreshInterval = components['schemas']['DataRefreshInterval'];
 export type NotificationPreferencesDto = components['schemas']['NotificationPreferencesDto'];
+export type NotificationEmailStatusMode = components['schemas']['NotificationEmailStatusMode'];
+export type NotificationEmailDeliveryMode = components['schemas']['NotificationEmailDeliveryMode'];
+export type NotificationChatDeliveryMode = components['schemas']['NotificationChatDeliveryMode'];
+export type NotificationEmailChannelsDto = components['schemas']['NotificationEmailChannelsDto'];
+export type NotificationChatChannelsDto = components['schemas']['NotificationChatChannelsDto'];
+export type NotificationChannelsDto = components['schemas']['NotificationChannelsDto'];
+export type PutNotificationEmailChannelsDto = components['schemas']['PutNotificationEmailChannelsDto'];
+export type PutNotificationChatChannelsDto = components['schemas']['PutNotificationChatChannelsDto'];
+export type PutNotificationChannelsDto = components['schemas']['PutNotificationChannelsDto'];
 export type PreferencesDto = components['schemas']['PreferencesDto'];
+export type PutPreferencesBodyDto = components['schemas']['PutPreferencesBodyDto'];
+export type NotificationChannelRequiredErrorDto = components['schemas']['NotificationChannelRequiredErrorDto'];
 export type ValidationIssueDto = components['schemas']['ValidationIssueDto'];
 export type PreferencesValidationErrorDto = components['schemas']['PreferencesValidationErrorDto'];
 export type ConsentCategoriesDto = components['schemas']['ConsentCategoriesDto'];
@@ -20579,6 +20683,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: {
@@ -20597,6 +20705,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"];
         };
     };
@@ -20811,7 +20928,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PreferencesDto"];
+                "application/json": components["schemas"]["PutPreferencesBodyDto"];
             };
         };
         responses: {
@@ -20824,13 +20941,13 @@ export interface operations {
                     "application/json": components["schemas"]["PreferencesDto"];
                 };
             };
-            /** @description Validation failed */
+            /** @description Validation failed, or Status email was set to off (`code` `notification_channel_required`). */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PreferencesValidationErrorDto"];
+                    "application/json": components["schemas"]["PreferencesValidationErrorDto"] | components["schemas"]["NotificationChannelRequiredErrorDto"];
                 };
             };
             401: components["responses"]["Unauthorized"];