@stapel/workspaces-react 0.1.0 → 0.4.1

package/src/api/generated/schema.ts

@@ -0,0 +1,761 @@
+// AUTO-GENERATED by scripts/gen-api.mjs — do not edit by hand.
+// Source: the backend module's own docs/schema.json (§17-native per-module contract).
+// Regenerate: pnpm gen:api   ·   Drift gate: pnpm gen:api:check
+export interface paths {
+    "/workspaces/api/v1/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        get: operations["workspaces_api_v1_retrieve"];
+        put?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        post: operations["workspaces_api_v1_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/api/v1/{workspace_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        get: operations["workspaces_api_v1_retrieve_2"];
+        put?: never;
+        post?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        delete: operations["workspaces_api_v1_destroy"];
+        options?: never;
+        head?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        patch: operations["workspaces_api_v1_partial_update"];
+        trace?: never;
+    };
+    "/workspaces/api/v1/{workspace_id}/members": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        get: operations["workspaces_api_v1_members_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/api/v1/{workspace_id}/members/{user_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        delete: operations["workspaces_api_v1_members_destroy"];
+        options?: never;
+        head?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        patch: operations["workspaces_api_v1_members_partial_update"];
+        trace?: never;
+    };
+    "/workspaces/api/v1/{workspace_id}/members/invite": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        post: operations["workspaces_api_v1_members_invite_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/api/v1/internal/{workspace_id}/members/{user_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Allow other services to check membership/role via X-API-KEY.
+         *
+         *     **Permissions:** `OperandHolder`
+         */
+        get: operations["workspaces_api_v1_internal_members_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/api/v1/internal/users/{user_id}/personal": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Get-or-create the personal workspace for a given user_id.
+         *
+         *     **Permissions:** `OperandHolder`
+         */
+        post: operations["workspaces_api_v1_internal_users_personal_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/api/v1/invitations/accept": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Overridable serializer seams for API views.
+         *
+         *     Subclasses (or downstream projects) can swap the request/response
+         *     serializers without copying method bodies:
+         *
+         *         class MyWorkspaceDetailView(WorkspaceDetailView):
+         *             response_serializer_class = MyWorkspaceResponseSerializer
+         *
+         *     **Permissions:** `IsAuthenticated`
+         */
+        post: operations["workspaces_api_v1_invitations_accept_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** @description Get-or-create result for a user's personal workspace (service-to-service). */
+        InternalPersonalWorkspaceResponse: {
+            /**
+             * Format: uuid
+             * @description Personal workspace UUID.
+             */
+            workspace_id: string;
+        };
+        /** @description Accept an invite. */
+        InvitationAcceptRequest: {
+            /** @description Invite token from the email link */
+            token: string;
+        };
+        /** @description InvitationResponse(id: uuid.UUID, workspace_id: uuid.UUID, email: str, role: str, expires_at: str, accepted_at: Optional[str], revoked_at: Optional[str], created_at: str) */
+        InvitationResponse: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            workspace_id: string;
+            email: string;
+            role: string;
+            expires_at: string;
+            accepted_at: string | null;
+            revoked_at: string | null;
+            created_at: string;
+        };
+        /** @description Invite payload. */
+        MemberInviteRequest: {
+            /**
+             * @description One or more emails to invite
+             * @example [
+             *       "alice@example.com"
+             *     ]
+             */
+            emails: string[];
+            /**
+             * @description Role to grant on acceptance
+             * @example member
+             */
+            role?: string;
+        };
+        /** @description MemberInviteResponse(invitations: List[ForwardRef('InvitationResponse')] = <factory>) */
+        MemberInviteResponse: {
+            invitations?: components["schemas"]["InvitationResponse"][];
+        };
+        /** @description Workspace member. */
+        MemberResponse: {
+            /**
+             * Format: uuid
+             * @description Membership UUID
+             * @example 0192...
+             */
+            id: string;
+            /**
+             * Format: uuid
+             * @description Workspace UUID
+             */
+            workspace_id: string;
+            /**
+             * Format: uuid
+             * @description User UUID
+             */
+            user_id: string;
+            /** @description User email (best-effort, from JWT claim cache) */
+            email: string | null;
+            /**
+             * @description owner / admin / member / viewer
+             * @example admin
+             */
+            role: string;
+            /** @description ISO 8601 invite timestamp */
+            invited_at: string;
+            /** @description ISO 8601 acceptance timestamp; null while pending */
+            accepted_at: string | null;
+            /** @description ISO 8601 last access; null if never accessed */
+            last_accessed_at: string | null;
+        };
+        PaginatedMemberResponseList: {
+            items: components["schemas"]["MemberResponse"][];
+            /** @description Anchor value for next page */
+            next_anchor?: string | null;
+            /** @description Anchor value for previous page */
+            prev_anchor?: string | null;
+            /** @description Whether there are more items after this page */
+            has_next: boolean;
+            /** @description Whether there are items before this page */
+            has_prev: boolean;
+            /** @description Number of items in current page */
+            count: number;
+        };
+        /** @description MemberUpdateRequest(role: str) */
+        PatchedMemberUpdateRequest: {
+            role?: string;
+        };
+        /** @description WorkspaceUpdateRequest(name: Optional[str] = None, slug: Optional[str] = None, settings: Optional[dict] = None) */
+        PatchedWorkspaceUpdateRequest: {
+            name?: string | null;
+            slug?: string | null;
+            settings?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /** @description Structured error returned by all Stapel API endpoints. */
+        StapelError: {
+            /**
+             * @description Translation key for client-side localization
+             * @example error.404.not_found
+             */
+            localizable_error: string;
+            /**
+             * @description Human-readable message in English
+             * @example Requested resource not found
+             */
+            error: string;
+            /**
+             * @description Context values for template placeholders
+             * @example {
+             *       "retry_after": 30
+             *     }
+             */
+            params?: {
+                [key: string]: unknown;
+            };
+        };
+        /** @description Create-workspace payload. */
+        WorkspaceCreateRequest: {
+            /**
+             * @description Display name
+             * @example Acme Engineering
+             */
+            name: string;
+            /**
+             * @description URL-safe identifier (auto-generated when omitted)
+             * @example acme-eng
+             */
+            slug?: string | null;
+            /**
+             * @description personal or work
+             * @example work
+             */
+            type?: string;
+        };
+        /** @description WorkspaceListResponse(workspaces: List[stapel_workspaces.dto.WorkspaceResponse] = <factory>) */
+        WorkspaceListResponse: {
+            workspaces?: components["schemas"]["WorkspaceResponse"][];
+        };
+        /** @description Workspace details. */
+        WorkspaceResponse: {
+            /**
+             * Format: uuid
+             * @description Workspace UUID
+             * @example 0192f...
+             */
+            id: string;
+            /**
+             * @description Display name
+             * @example Acme Engineering
+             */
+            name: string;
+            /**
+             * @description URL-safe identifier
+             * @example acme-eng
+             */
+            slug: string;
+            /**
+             * @description Workspace category
+             * @example work
+             */
+            type: string;
+            /**
+             * Format: uuid
+             * @description Owner user UUID
+             * @example 0192a...
+             */
+            owner_id: string;
+            /** @description Workspace settings JSON */
+            settings: {
+                [key: string]: unknown;
+            };
+            /** @description Bytes currently stored */
+            storage_used_bytes: number;
+            /** @description Plan-determined cap */
+            storage_limit_bytes: number;
+            /** @description Number of members */
+            member_count: number;
+            /**
+             * @description Role of the requesting user
+             * @example owner
+             */
+            my_role: string | null;
+            /**
+             * @description ISO 8601 creation time
+             * @example 2026-05-20T10:00:00Z
+             */
+            created_at: string;
+            /**
+             * @description ISO 8601 last update time
+             * @example 2026-05-20T10:00:00Z
+             */
+            updated_at: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    workspaces_api_v1_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkspaceListResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WorkspaceCreateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["WorkspaceCreateRequest"];
+                "multipart/form-data": components["schemas"]["WorkspaceCreateRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkspaceResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_retrieve_2: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkspaceResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_destroy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No response body */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    workspaces_api_v1_partial_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedWorkspaceUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedWorkspaceUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedWorkspaceUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["WorkspaceResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_members_list: {
+        parameters: {
+            query?: {
+                /** @description Anchor value to paginate from (exclusive) */
+                anchor?: string;
+                /** @description Pagination direction */
+                direction?: "next" | "prev" | "center";
+                /** @description Number of items (default 100, max 500) */
+                limit?: number;
+                /** @description Case-insensitive substring filter matched against a member's email OR display name (full name / username). Lets a people-picker filter server-side instead of pulling every member. */
+                search?: string;
+            };
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedMemberResponseList"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_members_destroy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                user_id: string;
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No response body */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    workspaces_api_v1_members_partial_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                user_id: string;
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedMemberUpdateRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedMemberUpdateRequest"];
+                "multipart/form-data": components["schemas"]["PatchedMemberUpdateRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_members_invite_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["MemberInviteRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["MemberInviteRequest"];
+                "multipart/form-data": components["schemas"]["MemberInviteRequest"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberInviteResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_internal_members_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                user_id: string;
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_internal_users_personal_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                user_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalPersonalWorkspaceResponse"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StapelError"];
+                };
+            };
+        };
+    };
+    workspaces_api_v1_invitations_accept_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["InvitationAcceptRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["InvitationAcceptRequest"];
+                "multipart/form-data": components["schemas"]["InvitationAcceptRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MemberResponse"];
+                };
+            };
+        };
+    };
+}