@thinkai/tai-api-contract 2.148.0 → 2.150.0

package/src/generated/openapi.ts

@@ -3701,6 +3701,114 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/notifications/email/unsubscribe": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Confirm a Message Center email unsubscribe (public)
+         * @description **Unauthenticated.** Mail scanners prefetch GET, so this page does not change preferences. Status email cannot be turned off; the page says so. Other categories show a button that POSTs the same token. An unknown or expired token is `400` HTML.
+         */
+        get: operations["getNotificationEmailUnsubscribe"];
+        put?: never;
+        /**
+         * Apply a Message Center email unsubscribe (public)
+         * @description **Unauthenticated.** Sets that category's email cell to `off` when the category allows off. A status token leaves status email unchanged. Redirects `303` to `{spa}/settings?tab=preferences`. An unknown or expired token is `400` HTML and does not change preferences.
+         */
+        post: operations["postNotificationEmailUnsubscribe"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/slack/install-url": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Slack install URL for Message Center
+         * @description Workspace admin only. Returns the Slack OAuth authorize URL. State is stored server-side and names this workspace and the signed-in admin. Editor or viewer is `403` with `code` `workspace_admin_required`. Missing Slack app settings are `503` with `code` `slack_not_configured`.
+         */
+        get: operations["getSlackInstallUrl"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/integrations/slack/callback": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Slack OAuth callback
+         * @description Browser return from Slack. The provider redirect does not include the API bearer token. `state` was issued by `getSlackInstallUrl` to a signed-in admin and is single-use. The bot token is stored encrypted only when that user is still a workspace admin. Success redirects to `{spa}/settings?tab=preferences&chat=slack`. Failures redirect to the same page with `slack=error`. The token is never in the redirect.
+         */
+        get: operations["getSlackOauthCallback"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/slack": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Slack connection status
+         * @description Any workspace member. `{ connected, channelName }`. `channelName` is null until an admin saves a channel. The bot token is never returned.
+         */
+        get: operations["getSlackIntegration"];
+        put?: never;
+        post?: never;
+        /**
+         * Disconnect Slack
+         * @description Workspace admin only. Removes the bot token and saved channel. Later Message Center delivery does not post to Slack.
+         */
+        delete: operations["deleteSlackIntegration"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/slack/channel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Save the Slack channel for Message Center
+         * @description Workspace admin only. Body `{ channelId }`. Slack must already be connected. The response is the same status object as `getSlackIntegration`, with the channel name Slack returned. Unknown or malformed `channelId` is `400` `invalid_slack_channel`. Not connected is `409` `slack_not_connected`.
+         */
+        put: operations["putSlackChannel"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/notifications": {
         parameters: {
             query?: never;
@@ -3820,9 +3928,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;
@@ -3858,7 +3972,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 (`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).
+         * @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;
@@ -7979,6 +8093,71 @@ 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"];
+        };
+        SlackInstallUrlDto: {
+            /** @description Slack OAuth authorize URL. The bot token is not included. */
+            url: string;
+        };
+        SlackIntegrationStatusDto: {
+            connected: boolean;
+            /** @description Saved channel name. Null until an admin saves a channel, and when disconnected. */
+            channelName: string | null;
+        };
+        SlackChannelBodyDto: {
+            channelId: string;
+        };
+        /** @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;
@@ -7991,6 +8170,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)[];
@@ -10720,7 +10921,21 @@ 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 SlackInstallUrlDto = components['schemas']['SlackInstallUrlDto'];
+export type SlackIntegrationStatusDto = components['schemas']['SlackIntegrationStatusDto'];
+export type SlackChannelBodyDto = components['schemas']['SlackChannelBodyDto'];
+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'];
@@ -20587,6 +20802,347 @@ export interface operations {
             };
         };
     };
+    getNotificationEmailUnsubscribe: {
+        parameters: {
+            query: {
+                /** @description Opaque unsubscribe token from the email. Only its SHA-256 hash is stored. */
+                token: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Confirm page. Preferences are unchanged. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/html": string;
+                };
+            };
+            /** @description Unknown or expired token */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/html": string;
+                };
+            };
+        };
+    };
+    postNotificationEmailUnsubscribe: {
+        parameters: {
+            query: {
+                /** @description Opaque unsubscribe token from the email. Only its SHA-256 hash is stored. */
+                token: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Preference updated when no SPA origin is configured. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/html": string;
+                };
+            };
+            /** @description Preference updated, or left unchanged for status email. */
+            303: {
+                headers: {
+                    /** @description `{spa}/settings?tab=preferences` */
+                    Location?: string;
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unknown or expired token */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/html": string;
+                };
+            };
+        };
+    };
+    getSlackInstallUrl: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Slack authorize URL */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SlackInstallUrlDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            /** @description Caller is not a workspace admin */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Forbidden",
+                     *       "code": "workspace_admin_required"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Workspace does not exist or malformed workspaceId */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Slack app client id, secret, API origin, or SPA origin is unset */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Slack is not configured",
+                     *       "code": "slack_not_configured"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    getSlackOauthCallback: {
+        parameters: {
+            query: {
+                code?: string;
+                state: string;
+                error?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Redirect to Settings → Preferences */
+            302: {
+                headers: {
+                    Location?: string;
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Slack app settings are unset and no SPA origin is available */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    getSlackIntegration: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Slack connection status */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SlackIntegrationStatusDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            /** @description Workspace does not exist or malformed workspaceId */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    deleteSlackIntegration: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Slack disconnected */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            /** @description Caller is not a workspace admin */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Forbidden",
+                     *       "code": "workspace_admin_required"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Workspace does not exist or malformed workspaceId */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    putSlackChannel: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SlackChannelBodyDto"];
+            };
+        };
+        responses: {
+            /** @description Channel saved */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SlackIntegrationStatusDto"];
+                };
+            };
+            /** @description channelId is missing, malformed, or unknown to Slack */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Slack channel was not found",
+                     *       "code": "invalid_slack_channel"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            /** @description Caller is not a workspace admin */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Forbidden",
+                     *       "code": "workspace_admin_required"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Workspace does not exist or malformed workspaceId */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Slack is not connected */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Slack is not connected",
+                     *       "code": "slack_not_connected"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Slack rejected the lookup */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "error": "Slack did not accept the channel",
+                     *       "code": "slack_request_failed"
+                     *     }
+                     */
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
     listNotifications: {
         parameters: {
             query?: {
@@ -20837,7 +21393,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PreferencesDto"];
+                "application/json": components["schemas"]["PutPreferencesBodyDto"];
             };
         };
         responses: {
@@ -20850,13 +21406,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"];