@thinkai/tai-api-contract 2.5.16 → 2.5.17

package/dist/generated/openapi.d.ts

@@ -68,7 +68,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** List workspace team members */
+        /**
+         * List workspace team members
+         * @description Returns active workspace members (`tai_workspace_members` with `deleted_at` null). Any workspace member may list; invite and role changes require admin.
+         */
         get: operations["listTenantMembers"];
         put?: never;
         post?: never;
@@ -87,7 +90,10 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Invite member to workspace */
+        /**
+         * Invite member to workspace
+         * @description Workspace admin only. Upserts `tai_users` by email and adds or reactivates `tai_workspace_members`. Idempotent when the email is already an active member: returns **201** with the existing row and **does not change** their role if the request body role differs. Does not send email; optional `tai_workspace_invitations` row may be recorded (no accept/link flow yet).
+         */
         post: operations["inviteTenantMember"];
         delete?: never;
         options?: never;
@@ -105,11 +111,17 @@ export interface paths {
         get?: never;
         put?: never;
         post?: never;
-        /** Remove member from workspace */
+        /**
+         * Remove member from workspace
+         * @description Workspace admin only. Soft-deletes the membership (`deleted_at` set). Cannot remove the workspace owner or the last admin.
+         */
         delete: operations["removeTenantMember"];
         options?: never;
         head?: never;
-        /** Update workspace member role */
+        /**
+         * Update workspace member role
+         * @description Workspace admin only. `memberId` is `tai_users.id` (UUID), not the auth subject.
+         */
         patch: operations["updateTenantMemberRole"];
         trace?: never;
     };
@@ -1328,8 +1340,11 @@ export interface components {
     schemas: {
         ErrorMessageDto: {
             error: string;
+            /** @description Machine-readable error code when present (for example `last_admin`). */
+            code?: string;
         };
         TeamMemberDto: {
+            /** Format: uuid */
             id: string;
             name: string;
             email: string;
@@ -2448,6 +2463,8 @@ export interface components {
         RepoId: string;
         ProjectId: string;
         NotificationId: string;
+        /** @description Workspace member user id (`tai_users.id`). */
+        WorkspaceMemberId: string;
         FixId: string;
         /** @description Department filter; send `All departments` to include every department. Scoped using imported `thinkai_org_structure` members when present, otherwise SPA org chart `department` nodes and their descendant teams. When neither source defines the requested department, insights return no scoped teams or contributors (not org-wide data). */
         InsightsDepartmentFilter: string;
@@ -2588,6 +2605,7 @@ export type ParameterWorkspaceId = components['parameters']['WorkspaceId'];
 export type ParameterRepoId = components['parameters']['RepoId'];
 export type ParameterProjectId = components['parameters']['ProjectId'];
 export type ParameterNotificationId = components['parameters']['NotificationId'];
+export type ParameterWorkspaceMemberId = components['parameters']['WorkspaceMemberId'];
 export type ParameterFixId = components['parameters']['FixId'];
 export type ParameterInsightsDepartmentFilter = components['parameters']['InsightsDepartmentFilter'];
 export type $defs = Record<string, never>;
@@ -2717,11 +2735,32 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
+                    /**
+                     * @example {
+                     *       "members": [
+                     *         {
+                     *           "id": "11111111-1111-4111-8111-111111111111",
+                     *           "name": "Alex Admin",
+                     *           "email": "alex@example.com",
+                     *           "role": "admin"
+                     *         }
+                     *       ]
+                     *     }
+                     */
                     "application/json": components["schemas"]["TeamMemberListDto"];
                 };
             };
             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"];
+                };
+            };
         };
     };
     inviteTenantMember: {
@@ -2735,6 +2774,12 @@ export interface operations {
         };
         requestBody: {
             content: {
+                /**
+                 * @example {
+                 *       "email": "new.member@example.com",
+                 *       "role": "editor"
+                 *     }
+                 */
                 "application/json": components["schemas"]["InviteTeamMemberBodyDto"];
             };
         };
@@ -2748,8 +2793,26 @@ export interface operations {
                     "application/json": components["schemas"]["TeamMemberDto"];
                 };
             };
+            /** @description Invalid email or role */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
             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"];
+                };
+            };
         };
     };
     removeTenantMember: {
@@ -2758,7 +2821,8 @@ export interface operations {
             header?: never;
             path: {
                 workspaceId: components["parameters"]["WorkspaceId"];
-                memberId: string;
+                /** @description Workspace member user id (`tai_users.id`). */
+                memberId: components["parameters"]["WorkspaceMemberId"];
             };
             cookie?: never;
         };
@@ -2773,12 +2837,23 @@ export interface operations {
             };
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
-            /** @description Member not found */
+            /** @description Member not found or invalid memberId */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Cannot remove workspace owner or last admin */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
             };
         };
     };
@@ -2788,12 +2863,18 @@ export interface operations {
             header?: never;
             path: {
                 workspaceId: components["parameters"]["WorkspaceId"];
-                memberId: string;
+                /** @description Workspace member user id (`tai_users.id`). */
+                memberId: components["parameters"]["WorkspaceMemberId"];
             };
             cookie?: never;
         };
         requestBody: {
             content: {
+                /**
+                 * @example {
+                 *       "role": "viewer"
+                 *     }
+                 */
                 "application/json": components["schemas"]["UpdateTeamMemberRoleBodyDto"];
             };
         };
@@ -2807,14 +2888,34 @@ export interface operations {
                     "application/json": components["schemas"]["TeamMemberDto"];
                 };
             };
+            /** @description Invalid role payload */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
             401: components["responses"]["Unauthorized"];
             403: components["responses"]["Forbidden"];
-            /** @description Member not found */
+            /** @description Member not found or invalid memberId */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Cannot demote the last workspace admin */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
             };
         };
     };