@leaflow/sdk 0.0.0-dev.113.g5d6fb99

package/dist/account/v1/schema.d.ts

@@ -0,0 +1,866 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/account/v1/agreements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出注册必须同意的文件
+         * @description 注册页显示它，用户同意之后把每一项的 `type` 和 `version` 原样回传给 `POST /api/v1/register`。
+         *
+         *     不需要令牌。还没有任何文件生效时返回空数组，那时注册不需要提交 `consents`。
+         */
+        get: operations["list-agreements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me/consents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出我同意过的文件
+         * @description 全部记录，最新的在前，包括已经不是当前版本的那些。
+         */
+        get: operations["list-consents"];
+        put?: never;
+        /**
+         * 同意条款
+         * @description 条款改版之后用它重新同意，`GET /api/v1/me` 的 `pending_agreements` 非空时就该调。
+         *
+         *     只收当前生效的版本，签旧版答 409。重复提交同一版不报错，第一次那条记录会留着。
+         */
+        post: operations["accept-agreements"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/register": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 注册账号
+         * @description 在 auth.leaflow.net 登录之后调它，带上账号令牌。姓名和邮箱取自登录信息，不从请求体收。
+         *
+         *     `consents` 要覆盖 `GET /api/v1/agreements` 返回的每一份，版本号也要一致；漏一份答 400，版本对不上答 409（多半是页面开着的时候条款改版了，重新拉一次清单即可）。已经注册过的答 409。
+         */
+        post: operations["register"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看当前账号
+         * @description `pending_agreements` 是还没同意的文件，非空就要先引导用户同意，再调 `POST /api/v1/me/consents`。
+         */
+        get: operations["get-account"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me/identity-verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 查看实名核验状态
+         * @description 没交过材料时答 UNVERIFIED，不是 404。姓名和证件号不会出现在任何响应里。
+         */
+        get: operations["get-identity-verification"];
+        put?: never;
+        /**
+         * 提交实名核验材料
+         * @description 已经在等人审的和已经核过的都会被拒。被驳回之后可以改了再交。
+         */
+        post: operations["submit-identity-verification"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me/invitations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出寄给我的要约
+         * @description 按当前账号的邮箱查，因为要约是寄给一个地址的——被邀请的人当时可能还没注册。
+         */
+        get: operations["list-my-invitations"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me/invitations/accept": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 顺着邀请链接接受
+         * @description token 对不上和这份要约已经不作数了是同一个回答：持有者对这两种情况能做的事完全一样，分开报会把这个接口变成一个可以拿来试 token 的探针。
+         */
+        post: operations["accept-invitation-by-token"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/me/invitations/{invitationId}/accept": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 接受一份列在我名下的要约
+         * @description 不需要 token：token 证明的是「你就是这份要约寄给的那个人」，而当前账号的邮箱对得上这份要约，证明的是同一件事。
+         */
+        post: operations["accept-invitation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/projects": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 列出我参与的项目
+         * @description 默认不含已删除的项目——那些是已经不存在了的东西，要看必须明确用 status=DELETED 点名。
+         */
+        get: operations["list-projects"];
+        put?: never;
+        /**
+         * 建一个项目
+         * @description 建的人就是所有者。项目会连带预置 OWNER、ADMIN 两个内置角色和一个空权限的 member 角色。
+         */
+        post: operations["create-project"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/projects/{projectId}/token": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * 换一张项目令牌
+         * @description 选定一个项目后，用账号令牌换取该项目的令牌。
+         *
+         *     **只接受 auth.leaflow.net 签发的账号令牌，不接受项目令牌。** 项目令牌过期后，先在 auth.leaflow.net 续期账号令牌，再重新调用这个接口。
+         *
+         *     换取时会确认账号可用、项目存在，且**调用者是该项目的成员**。非成员无法换取。
+         *
+         *     令牌只表明身份（用户与项目），**不包含权限**：权限在每次请求时实时判定，所以角色调整立即生效，不必等待令牌过期。
+         *
+         *     项目处于停用、封禁或删除中时**仍可换取令牌**：这些状态限制的是写入，不影响查看项目当前状况。
+         */
+        post: operations["exchange-project-token"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Error: {
+            code?: string;
+            message: string;
+            meta?: {
+                [key: string]: unknown;
+            };
+            /** Format: int64 */
+            status: number;
+        };
+        AgreementResource: {
+            /**
+             * Format: date-time
+             * @description 从这一刻起注册必须同意这一版
+             */
+            effective_at: string;
+            /** @enum {string} */
+            type: "TERMS" | "PRIVACY" | "DPA";
+            /** @description 正文发布在哪 */
+            url: string;
+            /** @description 同意时原样回传这个值 */
+            version: string;
+        };
+        AgreementListResponseBody: {
+            items: components["schemas"]["AgreementResource"][] | null;
+        };
+        ConsentResource: {
+            /** Format: date-time */
+            consented_at: string;
+            /**
+             * @description OFFLINE 是线下签的，由运营录入
+             * @enum {string}
+             */
+            method: "CLICKWRAP" | "OFFLINE";
+            /** @enum {string} */
+            type: "TERMS" | "PRIVACY" | "DPA";
+            version: string;
+        };
+        ConsentListResponseBody: {
+            items: components["schemas"]["ConsentResource"][] | null;
+        };
+        ConsentBody: {
+            /** @enum {string} */
+            type: "TERMS" | "PRIVACY" | "DPA";
+            version: string;
+        };
+        AcceptConsentsRequestBody: {
+            consents: components["schemas"]["ConsentBody"][] | null;
+        };
+        AccountResource: {
+            /** Format: date-time */
+            created_at: string;
+            email: string;
+            /** Format: date-time */
+            email_verified_at: string | null;
+            /** @description 来自登录信息，可能为空 */
+            first_name: string;
+            /** @description 身份提供方签发的 subject */
+            id: string;
+            /** @description 来自登录信息，可能为空 */
+            last_name: string;
+            pending_agreements: components["schemas"]["AgreementResource"][] | null;
+            /** @enum {string} */
+            status: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING";
+        };
+        RegisterRequestBody: {
+            /** @description 当前生效的必签文件全部要在里面，版本号要和 GET /api/v1/agreements 给的一致 */
+            consents: components["schemas"]["ConsentBody"][] | null;
+        };
+        IdentityVerificationResource: {
+            reject_reason: string;
+            /**
+             * @description PERSONAL 和 ENTERPRISE 是两类主体而不是两个等级，别拿它们比大小
+             * @enum {string}
+             */
+            status: "UNVERIFIED" | "PENDING" | "PERSONAL" | "ENTERPRISE" | "REJECTED";
+            /** Format: date-time */
+            submitted_at: string | null;
+            /** Format: date-time */
+            verified_at: string | null;
+        };
+        SubmitIdentityVerificationRequestBody: {
+            /** @description 证件号码。同上，而且同一个号码不能挂在两个账号上 */
+            id_number: string;
+            /** @description 真实姓名。敏感个人信息，加密入库，任何接口都不会再把它读出来 */
+            real_name: string;
+        };
+        InvitationResource: {
+            /** Format: date-time */
+            created_at: string;
+            email: string;
+            /** Format: date-time */
+            expires_at: string;
+            /** Format: uuid */
+            id: string;
+            invited_by: string;
+            /** Format: uuid */
+            project_id: string;
+            /** @description 兑现时会授予的角色编码 */
+            roles: string[] | null;
+        };
+        LengthAwarePageInvitationResource: {
+            /** @description 这一页的内容 */
+            items: components["schemas"]["InvitationResource"][];
+            /**
+             * Format: int64
+             * @description 这一页最多几条，回显请求里的值
+             */
+            limit: number;
+            /**
+             * Format: int64
+             * @description 跳过了多少条，回显请求里的值
+             */
+            offset: number;
+            /**
+             * Format: int64
+             * @description 命中的总条数，不只是这一页
+             */
+            total: number;
+        };
+        AcceptInvitationByTokenRequestBody: {
+            token: string;
+        };
+        ProjectResource: {
+            ban_reason: string;
+            /** Format: date-time */
+            created_at: string;
+            created_by: string;
+            /**
+             * Format: date-time
+             * @description 盖上墓碑的那一刻
+             */
+            deleted_at: string | null;
+            description: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /**
+             * Format: date-time
+             * @description 欠费的起始时间
+             */
+            overdue_at: string | null;
+            /** @enum {string} */
+            status: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING" | "DELETED";
+            /** @description 给人看的，不参与任何查询 */
+            status_reason: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        AcceptedInvitationResponseBody: {
+            project: components["schemas"]["ProjectResource"];
+        };
+        GrantResource: {
+            admin: boolean;
+            owner: boolean;
+            /** @description 持有的全部自定义角色的权限并集，已去重排序 */
+            permissions: string[] | null;
+            /** @description 持有的角色编码，只用于展示 */
+            roles: string[] | null;
+        };
+        ProjectAccessResource: {
+            grant: components["schemas"]["GrantResource"];
+            project: components["schemas"]["ProjectResource"];
+        };
+        LengthAwarePageProjectAccessResource: {
+            /** @description 这一页的内容 */
+            items: components["schemas"]["ProjectAccessResource"][];
+            /**
+             * Format: int64
+             * @description 这一页最多几条，回显请求里的值
+             */
+            limit: number;
+            /**
+             * Format: int64
+             * @description 跳过了多少条，回显请求里的值
+             */
+            offset: number;
+            /**
+             * Format: int64
+             * @description 命中的总条数，不只是这一页
+             */
+            total: number;
+        };
+        CreateProjectRequestBody: {
+            description?: string;
+            name: string;
+        };
+        ProjectTokenResponseBody: {
+            /**
+             * Format: date-time
+             * @description 过期时刻。到点之前拿用户身份再换一张，别等第一个 401
+             */
+            expires_at: string;
+            /**
+             * Format: int64
+             * @description 还能活多少秒
+             */
+            expires_in: number;
+            /** @description **这一份是此刻的快照，不在令牌里，也不要缓存它。** 它只用来决定界面上画什么；真正的判定每次都要重新问 */
+            grant: components["schemas"]["GrantResource"];
+            /** @description 顺带带上项目本身，省掉换完之后立刻再查一次 */
+            project: components["schemas"]["ProjectResource"];
+            /** @description 项目令牌，放进 Authorization: Bearer 里用 */
+            token: string;
+            /** @description 固定是 Bearer */
+            token_type: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "list-agreements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AgreementListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-consents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ConsentListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "accept-agreements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AcceptConsentsRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    register: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RegisterRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AccountResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-identity-verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["IdentityVerificationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "submit-identity-verification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SubmitIdentityVerificationRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["IdentityVerificationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-my-invitations": {
+        parameters: {
+            query?: {
+                /** @description 这一页最多返回多少条 */
+                limit?: number;
+                /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
+                offset?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LengthAwarePageInvitationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "accept-invitation-by-token": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AcceptInvitationByTokenRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptedInvitationResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "accept-invitation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                invitationId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AcceptedInvitationResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-projects": {
+        parameters: {
+            query?: {
+                /** @description 这一页最多返回多少条 */
+                limit?: number;
+                /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
+                offset?: number;
+                /** @description 按名称或描述模糊匹配 */
+                keyword?: string;
+                /** @description 按对外状态过滤。不传时不返回已删除的项目 */
+                status?: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING" | "DELETED";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LengthAwarePageProjectAccessResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-project": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateProjectRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectAccessResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "exchange-project-token": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                projectId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectTokenResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+}