@leaflow/sdk 0.32.0 → 0.34.0

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

@@ -2,6 +2,8 @@ export type { paths, components, operations, webhooks } from "./schema.js";
 import type { operations } from "./schema.js";
 /** `GET /account/v1/settings` 成功时的响应体。 */
 export type GetSettingsResult = operations["get-settings"]["responses"][200]["content"]["application/json"];
+/** `GET /account/v1/locales` 成功时的响应体。 */
+export type ListLocalesResult = operations["list-locales"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/agreements` 成功时的响应体。 */
 export type ListAgreementsResult = operations["list-agreements"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/me/consents` 成功时的响应体。 */
@@ -16,6 +18,10 @@ export type RegisterResult = operations["register"]["responses"][201]["content"]
 export type RegisterBody = NonNullable<operations["register"]["requestBody"]>["content"]["application/json"];
 /** `GET /account/v1/me` 成功时的响应体。 */
 export type GetAccountResult = operations["get-account"]["responses"][200]["content"]["application/json"];
+/** `PATCH /account/v1/me` 成功时的响应体。 */
+export type UpdateAccountResult = operations["update-account"]["responses"][200]["content"]["application/json"];
+/** `PATCH /account/v1/me` 的请求体。 */
+export type UpdateAccountBody = NonNullable<operations["update-account"]["requestBody"]>["content"]["application/json"];
 /** `GET /account/v1/me/identity-verification` 成功时的响应体。 */
 export type GetIdentityVerificationResult = operations["get-identity-verification"]["responses"][200]["content"]["application/json"];
 /** `POST /account/v1/me/identity-verification` 成功时的响应体。 */

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

@@ -27,6 +27,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/locales": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 注册页要用的国家/地区和语言清单
+         * @description 免认证：注册页在还没有账号的时候就要画出这两个下拉框。
+         *     国家名和排序都跟着 `Accept-Language` 走——一个英文用户看到的是 China 而不是「中国」， 而顺序按那种语言自己的规则（中文按拼音，英文按字母），不是按码点。头缺失时用简体中文。
+         *     清单来自 CLDR，不是我们自己维护的一份：ISO 3166 每年都改，而抄下来的那份不会跟着改。 已经退役的代码（苏联、南斯拉夫）和不是地方的代码（欧盟、联合国）都不在里面。
+         */
+        get: operations["list-locales"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/agreements": {
         parameters: {
             query?: never;
@@ -114,7 +136,11 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * 改当前账号的国家/地区和语言
+         * @description 姓名和邮箱不在这里改：它们来自身份提供方，改了会在下一次登录同步时被覆盖回去。
+         */
+        patch: operations["update-account"];
         trace?: never;
     };
     "/account/v1/me/identity-verification": {
@@ -339,6 +365,10 @@ export interface components {
             id: string;
             /** @description 来自登录信息，可能为空 */
             last_name: string;
+            /** @description ISO 3166-1 alpha-2。这两个字段是后加的，注册时才开始要求填——已经注册过的人这里 是空串，让他们在设置里补，补之前一切照常。 */
+            country?: string;
+            /** @description 为空表示没设过，那时按请求头（Accept-Language）走，两者都没有才用平台默认 */
+            locale?: string;
             pending_agreements: components["schemas"]["AgreementResource"][] | null;
             /** @enum {string} */
             status: "ACTIVE" | "SUSPENDED" | "BANNED" | "DELETING";
@@ -346,6 +376,35 @@ export interface components {
         RegisterRequestBody: {
             /** @description 当前生效的必签文件全部要在里面，版本号要和 GET /api/v1/agreements 给的一致 */
             consents: components["schemas"]["ConsentBody"][] | null;
+            /** @description ISO 3166-1 alpha-2（CN、HK、US）。必须是现实世界里真实存在的国家或地区——EU、ZZ 这类在标准里有位置但不是国家的代码会被拒。存代码不存名字：名字是本地化的，存下来 的那份只会是某一种语言的。 */
+            country: string;
+            locale: components["schemas"]["Locale"];
+        };
+        LocaleOptionsResource: {
+            countries: components["schemas"]["CountryOption"][];
+            languages: components["schemas"]["LanguageOption"][];
+        };
+        CountryOption: {
+            /** @description ISO 3166-1 alpha-2，注册时原样回传 */
+            code: string;
+            /** @description 按 Accept-Language 渲染的名字 */
+            name: string;
+        };
+        LanguageOption: {
+            code: components["schemas"]["Locale"];
+            /** @description 这种语言的自称，用它自己写（「简体中文」「繁體中文（香港）」「English」）。不跟着 Accept-Language 变——一个只看得懂繁体的人，在一个全简体的列表里找不到自己那一项。 */
+            name: string;
+        };
+        /**
+         * @description 界面和邮件用哪种语言。它和 country 是两件事，不能互相推——一个在香港的人可能读简体， 一个在美国的人可能读繁体。
+         * @enum {string}
+         */
+        Locale: "zh-Hans" | "zh-Hant-HK" | "en";
+        /** @description 两个字段都是「不传就不动」。设置页上它们是两个独立的控件，用户可能只改其中一个；做成 整体替换的话，一次只想改语言的提交会把国家清掉，而那种丢失不报错。 */
+        UpdateAccountRequestBody: {
+            /** @description 同注册时那个 country */
+            country?: string;
+            locale?: components["schemas"]["Locale"];
         };
         IdentityVerificationResource: {
             reject_reason: string;
@@ -523,6 +582,35 @@ export interface operations {
             };
         };
     };
+    "list-locales": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LocaleOptionsResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-agreements": {
         parameters: {
             query?: never;
@@ -676,6 +764,39 @@ export interface operations {
             };
         };
     };
+    "update-account": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateAccountRequestBody"];
+            };
+        };
+        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;

package/dist/notification/v1/index.d.ts

@@ -18,6 +18,10 @@ export type GetNotificationResult = operations["get-notification"]["responses"][
 export type MarkNotificationReadResult = operations["mark-notification-read"]["responses"][200]["content"]["application/json"];
 /** `POST /api/v1/notifications/{notificationId}/archive` 成功时的响应体。 */
 export type ArchiveNotificationResult = operations["archive-notification"]["responses"][200]["content"]["application/json"];
+/** `GET /api/v1/announcements` 成功时的响应体。 */
+export type ListAnnouncementsResult = operations["list-announcements"]["responses"][200]["content"]["application/json"];
+/** `POST /api/v1/announcements/read` 成功时的响应体。 */
+export type ReadAllAnnouncementsResult = operations["read-all-announcements"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/notification-types` 成功时的响应体。 */
 export type ListNotificationTypesResult = operations["list-notification-types"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/preferences` 成功时的响应体。 */

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

@@ -134,6 +134,80 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/announcements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List platform announcements
+         * @description Announcements the platform published for everyone, filtered to the ones you can still see:
+         *     published, not expired, and targeted at you.
+         *
+         *     They are not part of `GET /api/v1/notifications`. A notification is addressed to you and has
+         *     a row per recipient; an announcement is one row for the whole platform and never fans out —
+         *     a hundred thousand users would be a hundred thousand rows, and almost none of them would
+         *     ever be read. Whether you have read one is recorded separately, so unread means "no such
+         *     record" rather than "a record with a null timestamp".
+         *
+         *     The list is short by design: expired announcements drop out of it. There is no paging.
+         *
+         *     Text comes back in the language on your preferences. An announcement that has no text in
+         *     that language falls back to the platform default — a readable announcement in the wrong
+         *     language beats a blank title.
+         */
+        get: operations["list-announcements"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/announcements/read": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mark every visible announcement as read
+         * @description Idempotent. Announcements you had already read stay read, and the count only covers the ones this call changed.
+         */
+        post: operations["read-all-announcements"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/announcements/{announcementId}/read": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Mark one announcement as read
+         * @description Idempotent: marking one twice is the same as marking it once. There is no way to mark it
+         *     unread — having read something is a fact, not a state.
+         */
+        post: operations["read-announcement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/notification-types": {
         parameters: {
             query?: never;
@@ -525,6 +599,38 @@ export interface components {
          * @enum {string}
          */
         NotificationAudience: "explicit" | "account" | "address" | "project_members" | "project_owner" | "project_admins" | "broadcast";
+        /** @description One announcement, with its text in the language on your preferences. */
+        AnnouncementResource: {
+            /** Format: uuid */
+            id: string;
+            title: string;
+            /** @description The text as a fragment of HTML, same rules as a notification body */
+            body: string;
+            severity: components["schemas"]["NotificationSeverity"];
+            /** @description You cannot dismiss this one. It is a property of the announcement rather than a second type, because what the operator judges when writing it is "is this important enough to push", and that is the question this asks. */
+            critical: boolean;
+            /** Format: date-time */
+            published_at: string;
+            /**
+             * Format: date-time
+             * @description When it drops out of this list; null means it stays
+             */
+            expires_at?: string | null;
+            /**
+             * Format: date-time
+             * @description When you read it; null means you have not
+             */
+            read_at?: string | null;
+        };
+        AnnouncementListResource: {
+            items: components["schemas"]["AnnouncementResource"][];
+            /** @description How many of them you have not read */
+            unread: number;
+        };
+        AnnouncementReadResultResource: {
+            /** @description How many this call changed; already-read ones are not counted */
+            marked: number;
+        };
         /**
          * @description One notification, with its text rendered in the language on your preferences at the moment
          *     it was read.
@@ -1068,6 +1174,93 @@ export interface operations {
             };
         };
     };
+    "list-announcements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AnnouncementListResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "read-all-announcements": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AnnouncementReadResultResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "read-announcement": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                announcementId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-notification-types": {
         parameters: {
             query?: never;

package/dist/support/v1/index.d.ts

@@ -38,16 +38,6 @@ export type UploadAttachmentResult = operations["upload-attachment"]["responses"
 export type UploadAttachmentQuery = operations["upload-attachment"]["parameters"]["query"];
 /** `GET /api/v1/attachments/{attachmentId}/download-url` 成功时的响应体。 */
 export type DescribeAttachmentDownloadResult = operations["describe-attachment-download"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/announcements` 成功时的响应体。 */
-export type ListAnnouncementsResult = operations["list-announcements"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/announcements` 的查询参数。 */
-export type ListAnnouncementsQuery = operations["list-announcements"]["parameters"]["query"];
-/** `GET /api/v1/announcements/unread-count` 成功时的响应体。 */
-export type CountUnreadAnnouncementsResult = operations["count-unread-announcements"]["responses"][200]["content"]["application/json"];
-/** `GET /api/v1/announcements/{announcementId}` 成功时的响应体。 */
-export type GetAnnouncementResult = operations["get-announcement"]["responses"][200]["content"]["application/json"];
-/** `POST /api/v1/announcements/{announcementId}/read` 成功时的响应体。 */
-export type MarkAnnouncementReadResult = operations["mark-announcement-read"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/maintenances` 成功时的响应体。 */
 export type ListMaintenancesResult = operations["list-maintenances"]["responses"][200]["content"]["application/json"];
 /** `GET /api/v1/maintenances` 的查询参数。 */

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

@@ -11,16 +11,15 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * List announcements and maintenance in effect right now
-         * @description Returns the announcements published for general visibility and the maintenance windows that
-         *     have not finished yet.
+         * List the maintenance in effect right now
+         * @description Returns the maintenance windows that have not finished yet.
          *
          *     **This operation requires no credentials.** It is intended for sign-in pages and status
          *     pages, which are reached before a project has been selected. It returns a narrower shape
          *     than the authenticated operations and is not paginated.
          *
-         *     Announcements appear here only when an operator has published them for general visibility;
-         *     the authenticated `GET /api/v1/announcements` returns more of them.
+         *     Platform announcements are not served here. They belong to the notification service, which
+         *     owns announcements for the whole platform.
          */
         get: operations["list-notices"];
         put?: never;
@@ -226,90 +225,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/v1/announcements": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * List announcements
-         * @description Returns the announcements in effect for the current user, most recently published first.
-         *     Announcements that are scheduled but not yet published, and those that have expired, are
-         *     omitted.
-         *
-         *     `read_at` is null when this user has not marked the announcement as read.
-         */
-        get: operations["list-announcements"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/api/v1/announcements/unread-count": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Count the announcements this user has not read */
-        get: operations["count-unread-announcements"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/api/v1/announcements/{announcementId}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get an announcement
-         * @description Returns 404 for an announcement that is not in effect for this user.
-         */
-        get: operations["get-announcement"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    "/api/v1/announcements/{announcementId}/read": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Mark an announcement as read
-         * @description Marking an announcement that is already marked succeeds and changes nothing; `read_at` keeps
-         *     its original value.
-         *
-         *     Read state is per person, not per project.
-         */
-        post: operations["mark-announcement-read"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/v1/maintenances": {
         parameters: {
             query?: never;
@@ -403,11 +318,6 @@ export interface components {
          * @enum {string}
          */
         TicketAuthorType: "USER" | "OPERATOR";
-        /**
-         * @description How prominently an announcement should be presented.
-         * @enum {string}
-         */
-        AnnouncementSeverity: "INFO" | "WARNING" | "CRITICAL";
         /**
          * @description `SCHEDULED` has been announced but has not started. `IN_PROGRESS` is under way. `COMPLETED`
          *     has finished. `CANCELLED` was announced and then called off, and never took place.
@@ -490,22 +400,6 @@ export interface components {
             /** Format: int64 */
             score: number;
         };
-        /** @description A platform announcement. */
-        AnnouncementResource: {
-            /** @description Markdown */
-            body: string;
-            /** Format: uuid */
-            id: string;
-            /** Format: date-time */
-            published_at: string;
-            /**
-             * Format: date-time
-             * @description When this user marked the announcement as read; null when they have not
-             */
-            read_at: string | null;
-            severity: components["schemas"]["AnnouncementSeverity"];
-            title: string;
-        };
         /** @description A scheduled maintenance notice published by platform operators. */
         MaintenanceResource: {
             /** @description Markdown */
@@ -557,19 +451,8 @@ export interface components {
          *     state.
          */
         NoticeResource: {
-            announcements: components["schemas"]["NoticeAnnouncementResource"][];
             maintenances: components["schemas"]["NoticeMaintenanceResource"][];
         };
-        NoticeAnnouncementResource: {
-            /** @description Markdown */
-            body: string;
-            /** Format: uuid */
-            id: string;
-            /** Format: date-time */
-            published_at: string;
-            severity: components["schemas"]["AnnouncementSeverity"];
-            title: string;
-        };
         NoticeMaintenanceResource: {
             /** @description Markdown */
             body: string;
@@ -595,10 +478,6 @@ export interface components {
             /** @description A temporary address serving the file */
             url: string;
         };
-        UnreadCountResource: {
-            /** Format: int64 */
-            count: number;
-        };
         CreateTicketRequestBody: {
             /** @description Attachments to reference from the first message. Each must have been uploaded in this project and not yet referenced */
             attachment_ids?: string[];
@@ -659,16 +538,6 @@ export interface components {
             /** Format: int64 */
             total: number;
         };
-        LengthAwarePageAnnouncementResource: {
-            /** @description The contents of this page */
-            items: components["schemas"]["AnnouncementResource"][];
-            /** Format: int64 */
-            limit: number;
-            /** Format: int64 */
-            offset: number;
-            /** Format: int64 */
-            total: number;
-        };
         LengthAwarePageMaintenanceResource: {
             /** @description The contents of this page */
             items: components["schemas"]["MaintenanceResource"][];
@@ -1102,131 +971,6 @@ export interface operations {
             };
         };
     };
-    "list-announcements": {
-        parameters: {
-            query?: {
-                /** @description Maximum number of items to return in this page */
-                limit?: number;
-                /** @description Number of items to skip */
-                offset?: number;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["LengthAwarePageAnnouncementResource"];
-                };
-            };
-            /** @description Error */
-            default: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
-        };
-    };
-    "count-unread-announcements": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["UnreadCountResource"];
-                };
-            };
-            /** @description Error */
-            default: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
-        };
-    };
-    "get-announcement": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                announcementId: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["AnnouncementResource"];
-                };
-            };
-            /** @description Error */
-            default: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
-        };
-    };
-    "mark-announcement-read": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                announcementId: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["AnnouncementResource"];
-                };
-            };
-            /** @description Error */
-            default: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
-        };
-    };
     "list-maintenances": {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {