@leaflow/sdk 0.33.0 → 0.35.0

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

@@ -18,6 +18,10 @@ export type ListCreditTransactionsResult = operations["list-credit-transactions"
 export type ReadBillingAccountBalanceResult = operations["read-billing-account-balance"]["responses"][200]["content"]["application/json"];
 /** `PUT /account/v1/billing-accounts/{accountKey}/projects/{projectId}` 成功时的响应体。 */
 export type BindProjectToBillingAccountResult = operations["bind-project-to-billing-account"]["responses"][200]["content"]["application/json"];
+/** `GET /account/v1/billing-accounts/{accountKey}/orders` 成功时的响应体。 */
+export type ListOrdersResult = operations["list-orders"]["responses"][200]["content"]["application/json"];
+/** `GET /account/v1/billing-accounts/{accountKey}/orders/{orderId}` 成功时的响应体。 */
+export type GetOrderResult = operations["get-order"]["responses"][200]["content"]["application/json"];
 /** `GET /account/v1/billing-accounts/{accountKey}/top-ups` 成功时的响应体。 */
 export type ListTopUpsResult = operations["list-top-ups"]["responses"][200]["content"]["application/json"];
 /** `POST /account/v1/billing-accounts/{accountKey}/top-ups` 成功时的响应体。 */

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

@@ -167,6 +167,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/billing-accounts/{accountKey}/orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * My orders
+         * @description Every provisioning request made against the projects this account pays for, newest first.
+         *
+         *     An order that never went through stays here on purpose. Removing it would leave nothing to
+         *     look at in exactly the case someone wants to look: a resource was asked for, was not
+         *     delivered, and the question is what happened.
+         *
+         *     The list carries no lines. An order has only a handful, but shipping them on every page
+         *     means carrying data no column shows.
+         */
+        get: operations["list-orders"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/account/v1/billing-accounts/{accountKey}/orders/{orderId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One order, with its lines
+         * @description Each line names what was asked for and how much of it. This is the only route that carries
+         *     them.
+         */
+        get: operations["get-order"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/billing-accounts/{accountKey}/top-ups": {
         parameters: {
             query?: never;
@@ -638,6 +686,36 @@ export interface components {
         UpdateBillingAccountRequestBody: {
             display_name: string;
         };
+        Order: {
+            id: string;
+            project_id: string;
+            placed_by: string;
+            /**
+             * @description Whether the request went through. It is not the state of what was provisioned: that
+             *     belongs to each resource and outlives the order.
+             * @enum {string}
+             */
+            state: "pending" | "fulfilled" | "failed";
+            failure_reason?: string;
+            /** Format: date-time */
+            created_at: string;
+            /** @description Only present on the single-order route. */
+            lines?: components["schemas"]["OrderLine"][];
+        };
+        OrderLine: {
+            id: string;
+            /** @enum {string} */
+            action: "add" | "renew" | "modify" | "remove";
+            /** @description Which service holds the thing, for example `compute`. */
+            service: string;
+            /** @description That service's own catalogue identifier for what was asked for. */
+            product_id: string;
+            /** Format: int64 */
+            quantity: number;
+        };
+        OrderList: {
+            orders: components["schemas"]["Order"][];
+        };
         TopUpList: {
             top_ups: components["schemas"]["TopUpStatus"][];
         };
@@ -1251,6 +1329,77 @@ export interface operations {
             };
         };
     };
+    "list-orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description The account's key, of the form `u_<user_id>_<seq>`. Ownership is stated by the key itself,
+                 *     which is why the key is what addresses the account.
+                 */
+                accountKey: components["parameters"]["AccountKey"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrderList"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-order": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description The account's key, of the form `u_<user_id>_<seq>`. Ownership is stated by the key itself,
+                 *     which is why the key is what addresses the account.
+                 */
+                accountKey: components["parameters"]["AccountKey"];
+                orderId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Order"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-top-ups": {
         parameters: {
             query?: never;

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

@@ -16,8 +16,12 @@ export type CountUnreadNotificationsQuery = operations["count-unread-notificatio
 export type GetNotificationResult = operations["get-notification"]["responses"][200]["content"]["application/json"];
 /** `POST /api/v1/notifications/{notificationId}/read` 成功时的响应体。 */
 export type MarkNotificationReadResult = operations["mark-notification-read"]["responses"][200]["content"]["application/json"];
+/** `DELETE /api/v1/notifications/{notificationId}/read` 成功时的响应体。 */
+export type MarkNotificationUnreadResult = operations["mark-notification-unread"]["responses"][200]["content"]["application/json"];
 /** `POST /api/v1/notifications/{notificationId}/archive` 成功时的响应体。 */
 export type ArchiveNotificationResult = operations["archive-notification"]["responses"][200]["content"]["application/json"];
+/** `DELETE /api/v1/notifications/{notificationId}/archive` 成功时的响应体。 */
+export type UnarchiveNotificationResult = operations["unarchive-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` 成功时的响应体。 */

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

@@ -14,9 +14,10 @@ export interface paths {
          * List notifications addressed to you
          * @description Returns notifications in reverse chronological order, newest first.
          *
-         *     Announcements published to the whole platform appear here alongside notifications
-         *     addressed to you individually and are distinguished by `kind`. They are read and archived
-         *     through the same operations.
+         *     Announcements are not in this list. They are one row for the whole platform rather than
+         *     one per reader, so they are listed, read and counted by their own operations under
+         *     `/api/v1/announcements`. `kind` is on every item here for clients that merge the two lists
+         *     themselves, and it is `notification` for everything this operation returns.
          */
         get: operations["list-notifications"];
         put?: never;
@@ -107,7 +108,14 @@ export interface paths {
          * @description Marking a notification that is already read succeeds and changes nothing.
          */
         post: operations["mark-notification-read"];
-        delete?: never;
+        /**
+         * Mark one notification as unread
+         * @description Puts it back in the unread count, which is what somebody wants after opening a thing by
+         *     accident and needing it to stay in front of them.
+         *
+         *     Marking one that is already unread succeeds and changes nothing.
+         */
+        delete: operations["mark-notification-unread"];
         options?: never;
         head?: never;
         patch?: never;
@@ -128,7 +136,18 @@ export interface paths {
          *     `include_archived` to see it again. Archiving also marks it read.
          */
         post: operations["archive-notification"];
-        delete?: never;
+        /**
+         * Take one notification out of the archive
+         * @description Returns it to the default listing. Archiving is one click away from anything in the list,
+         *     so undoing it has to be too; without this operation a mistaken archive is permanent, and
+         *     the notification stays reachable only by asking for archived ones.
+         *
+         *     It does not mark it unread again: archiving marked it read, and that it was read is still
+         *     true. Use `mark-notification-unread` for that.
+         *
+         *     Unarchiving one that is not archived succeeds and changes nothing.
+         */
+        delete: operations["unarchive-notification"];
         options?: never;
         head?: never;
         patch?: never;
@@ -1142,6 +1161,38 @@ export interface operations {
             };
         };
     };
+    "mark-notification-unread": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The notification, or the announcement when kind is announcement */
+                notificationId: components["parameters"]["NotificationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "archive-notification": {
         parameters: {
             query?: never;
@@ -1174,6 +1225,38 @@ export interface operations {
             };
         };
     };
+    "unarchive-notification": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The notification, or the announcement when kind is announcement */
+                notificationId: components["parameters"]["NotificationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotificationResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "list-announcements": {
         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 part of this API. They are served by the notification
+         *     service, which owns platform-wide announcements.
          */
         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.33.0",
+  "version": "0.35.0",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {