@leaflow/sdk 0.0.0-dev.216.gab0f521 → 0.0.0-dev.220.g26e832e

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

@@ -17,6 +17,8 @@ export type UpdateBillingAccountResult = operations["update-billing-account"]["r
 export type UpdateBillingAccountBody = NonNullable<operations["update-billing-account"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `GET /account/v1/billing-accounts/{accountId}/balance`. */
 export type GetAccountBalanceResult = operations["get-account-balance"]["responses"][200]["content"]["application/json"];
+/** The success response body of `GET /account/v1/billing-accounts/{accountId}/metered-usage`. */
+export type GetAccountMeteredUsageResult = operations["get-account-metered-usage"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /account/v1/billing-accounts/{accountId}/payment-options`. */
 export type ListPaymentOptionsResult = operations["list-payment-options"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /account/v1/projects`. */
@@ -51,10 +53,18 @@ export type SetDefaultPaymentMethodResult = operations["set-default-payment-meth
 export type PayInvoiceResult = operations["pay-invoice"]["responses"][200]["content"]["application/json"];
 /** The request body of `POST /account/v1/invoices/{invoiceId}/pay`. */
 export type PayInvoiceBody = NonNullable<operations["pay-invoice"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `GET /account/v1/invoices/{invoiceId}/payment-preview`. */
+export type PreviewInvoicePaymentResult = operations["preview-invoice-payment"]["responses"][200]["content"]["application/json"];
+/** The query parameters of `GET /account/v1/invoices/{invoiceId}/payment-preview`. */
+export type PreviewInvoicePaymentQuery = operations["preview-invoice-payment"]["parameters"]["query"];
 /** The success response body of `POST /account/v1/payments`. */
 export type PayTogetherResult = operations["pay-together"]["responses"][200]["content"]["application/json"];
 /** The request body of `POST /account/v1/payments`. */
 export type PayTogetherBody = NonNullable<operations["pay-together"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /account/v1/payments/preview`. */
+export type PreviewPayTogetherResult = operations["preview-pay-together"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/payments/preview`. */
+export type PreviewPayTogetherBody = NonNullable<operations["preview-pay-together"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `GET /account/v1/invoices`. */
 export type ListInvoicesResult = operations["list-invoices"]["responses"][200]["content"]["application/json"];
 /** The query parameters of `GET /account/v1/invoices`. */
@@ -99,6 +109,10 @@ export type ListRenewalPricesResult = operations["list-renewal-prices"]["respons
 export type RenewSubscriptionResult = operations["renew-subscription"]["responses"][200]["content"]["application/json"];
 /** The request body of `POST /account/v1/subscriptions/{subscriptionId}/renew`. */
 export type RenewSubscriptionBody = NonNullable<operations["renew-subscription"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /account/v1/subscriptions/{subscriptionId}/renewal-orders`. */
+export type CreateRenewalOrderResult = operations["create-renewal-order"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/subscriptions/{subscriptionId}/renewal-orders`. */
+export type CreateRenewalOrderBody = NonNullable<operations["create-renewal-order"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `PUT /account/v1/subscriptions/{subscriptionId}/auto-renew`. */
 export type SetAutoRenewResult = operations["set-auto-renew"]["responses"][200]["content"]["application/json"];
 /** The request body of `PUT /account/v1/subscriptions/{subscriptionId}/auto-renew`. */
@@ -117,6 +131,8 @@ export type ListOrdersResult = operations["list-orders"]["responses"][200]["cont
 export type ListOrdersQuery = operations["list-orders"]["parameters"]["query"];
 /** The success response body of `GET /account/v1/orders/{orderId}`. */
 export type GetOrderResult = operations["get-order"]["responses"][200]["content"]["application/json"];
+/** The success response body of `POST /account/v1/orders/{orderId}/cancel`. */
+export type CancelOrderResult = operations["cancel-order"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /account/v1/orders/{orderId}/items`. */
 export type ListOrderItemsResult = operations["list-order-items"]["responses"][200]["content"]["application/json"];
 /** The success response body of `GET /account/v1/entitlements`. */

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

@@ -93,6 +93,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/billing-accounts/{accountId}/metered-usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                accountId: components["parameters"]["AccountId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get account metered usage
+         * @description Whether the account has anything billed by usage, and what that usage has cost over the last
+         *     seven days. Usage is paid from the balance, so this tells how much of the balance it is likely
+         *     to need: the balance divided by `average_daily_amount` is roughly how many days it lasts.
+         */
+        get: operations["get-account-metered-usage"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/billing-accounts/{accountId}/payment-options": {
         parameters: {
             query?: never;
@@ -380,6 +404,34 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/invoices/{invoiceId}/payment-preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                invoiceId: components["parameters"]["InvoiceId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Preview invoice payment
+         * @description What paying this invoice now would take from credit grants, from the balance and, for the rest,
+         *     from a payment gateway. It is computed as paying computes it, so paying with the same options
+         *     straight afterwards takes exactly these amounts unless the account's funds change in between.
+         *     Nothing is charged, reserved or created.
+         *
+         *     Refused with the same errors as paying, except that insufficient funds are not an error here:
+         *     they show as a `gateway_amount` above zero.
+         */
+        get: operations["preview-invoice-payment"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/payments": {
         parameters: {
             query?: never;
@@ -408,6 +460,32 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/payments/preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Preview paying together
+         * @description What paying these invoices together now would take from credit grants and from the balance,
+         *     invoice by invoice in the order they would be paid. It is computed as paying together computes
+         *     it. Nothing is charged, reserved or created.
+         *
+         *     Refused with the same errors as paying together, except that insufficient funds are not an
+         *     error here: they show as a `gateway_amount` above zero, and paying together would then be
+         *     refused with `BILLING_INSUFFICIENT_FUNDS`.
+         */
+        post: operations["preview-pay-together"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/invoices": {
         parameters: {
             query?: never;
@@ -726,6 +804,35 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/subscriptions/{subscriptionId}/renewal-orders": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                subscriptionId: components["parameters"]["SubscriptionId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create renewal order
+         * @description Places a renewal order and issues its invoice without charging anything; pay the invoice to
+         *     renew. The periods and price are chosen as for renewing. The order can be paid until the
+         *     current paid period ends, and never after the end of the first period it renews; unpaid by
+         *     then, it is canceled. While auto-renew is on, the renewal due at the end of the period pays
+         *     this order instead of placing another.
+         *
+         *     Save `order_id` before submitting and read the order after an unknown outcome; creating it a
+         *     second time conflicts.
+         */
+        post: operations["create-renewal-order"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/subscriptions/{subscriptionId}/auto-renew": {
         parameters: {
             query?: never;
@@ -834,6 +941,38 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/account/v1/orders/{orderId}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Cancel order
+         * @description Withdraws an order that is not paid in full, and tells the service that placed it, so that
+         *     nothing is delivered. An order with nothing paid becomes `canceled` and its invoice is voided.
+         *     What was already paid toward it, from credit grants or the balance, is returned the way it was
+         *     paid, and the order becomes `failed`. Either way `cancel_reason` is `requested_by_customer`.
+         *     Canceling an order that is already canceled or failed returns it unchanged.
+         *
+         *     Refused with 409 and `BILLING_PAID_ORDER_NOT_CANCELABLE` once the invoice is paid in full,
+         *     `BILLING_ORDER_ALREADY_ACCEPTED` once the order has been accepted,
+         *     `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for it is in progress, and
+         *     `BILLING_SCHEDULED_CHANGE_NOT_CANCELABLE` for a change that takes effect at the end of the
+         *     period, which only the service that placed it can call off.
+         */
+        post: operations["cancel-order"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/account/v1/orders/{orderId}/items": {
         parameters: {
             query?: never;
@@ -1123,6 +1262,32 @@ export interface components {
              */
             due: components["schemas"]["Money"];
         };
+        MeteredUsage: {
+            /** Format: int64 */
+            billing_account_id: number;
+            currency: string;
+            /** @description Resources still metered in the projects the account currently pays for. */
+            active_resource_count: number;
+            /** @description Subscriptions billed by usage that the account currently pays for and that have not ended. */
+            postpaid_subscription_count: number;
+            /**
+             * Format: date-time
+             * @description The start of the seven days the amounts cover.
+             */
+            window_start: string;
+            /**
+             * Format: date-time
+             * @description The end of those seven days, the time usage was last priced.
+             */
+            window_end: string;
+            /** @description Usage priced in the window, before tax and before credit grants. Usage not yet priced is not included. */
+            amount: components["schemas"]["Money"];
+            /**
+             * @description `amount` per day. Over the window, or over the part of it since the account's usage began
+             *     when that is shorter, counting at least one day.
+             */
+            average_daily_amount: components["schemas"]["Money"];
+        };
         CreditGroup: {
             /** @description What the credit in this group may pay for. No restrictions means anything on the account. */
             applies_to: components["schemas"]["Applicability"];
@@ -1131,6 +1296,11 @@ export interface components {
         ProjectBillingInfo: {
             /** Format: uuid */
             project_id: string;
+            /**
+             * @description The project and its current name, for display. Absent when the project no longer exists or its
+             *     details cannot be read at the moment; `project_id` still identifies it.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             /** Format: int64 */
             billing_account_id: number;
             account_name?: string;
@@ -1385,6 +1555,40 @@ export interface components {
          * @enum {string}
          */
         PaymentStatus: "succeeded" | "processing" | "requires_action" | "failed";
+        /** @description A credit grant and what it would pay. */
+        AppliedCredit: {
+            /** Format: uuid */
+            credit_grant_id: string;
+            name: string;
+            amount: components["schemas"]["Money"];
+        };
+        PaymentPreviewInvoice: {
+            /** Format: uuid */
+            invoice_id: string;
+            /** Format: uuid */
+            order_id?: string | null;
+            amount_due: components["schemas"]["Money"];
+            credit_applied: components["schemas"]["Money"];
+            balance_applied: components["schemas"]["Money"];
+        };
+        /** @description What paying would take, computed as paying computes it. Nothing is charged or reserved. */
+        PaymentPreview: {
+            currency: string;
+            /** @description What is outstanding before paying. */
+            amount_due: components["schemas"]["Money"];
+            /** @description What credit grants would pay. Grants restricted to other purchases pay nothing here. */
+            credit_applied: components["schemas"]["Money"];
+            /** @description The credit grants that would pay, in the order they would be used. */
+            credit_grants: components["schemas"]["AppliedCredit"][];
+            /** @description What the balance would pay. */
+            balance_applied: components["schemas"]["Money"];
+            /** @description What would remain to be paid online. Paying without a gateway is refused with `BILLING_INSUFFICIENT_FUNDS` while this is above zero. */
+            gateway_amount: components["schemas"]["Money"];
+            /** @description The available balance after paying. */
+            balance_after: components["schemas"]["Money"];
+            /** @description Paying together only. Each invoice, in the order it would be paid. */
+            invoices?: components["schemas"]["PaymentPreviewInvoice"][];
+        };
         PaymentResult: {
             transactions: components["schemas"]["Transaction"][];
             /**
@@ -1436,9 +1640,12 @@ export interface components {
          * @description A usage invoice stays `draft` through its month: each charge is added to it as it is priced
          *     and paid from credits and balance as it goes. It is issued at the end of the month, becoming
          *     `paid` when everything was covered and `open` when something is still owed.
+         *
+         *     `refunded` means the invoice was paid and has since been refunded in full; a partial refund
+         *     leaves it `paid`, with the refunded part in `amount_refunded`.
          * @enum {string}
          */
-        InvoiceStatus: "draft" | "open" | "paid" | "void" | "uncollectible";
+        InvoiceStatus: "draft" | "open" | "paid" | "refunded" | "void" | "uncollectible";
         Invoice: {
             /** Format: date-time */
             due_at?: string;
@@ -1524,6 +1731,12 @@ export interface components {
             type?: "usage" | "subscription" | "one_time" | "setup" | "adjustment";
             /** Format: uuid */
             project_id?: string | null;
+            /**
+             * @description The project the charge was for and its current name, for display. Absent when the line is
+             *     not for a project, and when the project no longer exists or its details cannot be read at
+             *     the moment; `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             resource_id?: string;
             /**
              * @description The wording as recorded when the invoice was issued. It is not re-translated
@@ -1675,6 +1888,11 @@ export interface components {
             id: string;
             /** Format: uuid */
             project_id?: string;
+            /**
+             * @description The project and its current name, for display. Absent when the project no longer exists or its
+             *     details cannot be read at the moment; `project_id` still identifies it.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             product: components["schemas"]["Product"];
             /** @description Which resource this was charged for. Empty for charges not tied to one. */
             resource_id?: string;
@@ -1768,6 +1986,12 @@ export interface components {
              *     membership, which belongs to no single project.
              */
             project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             product: components["schemas"]["Product"];
             /** Format: uuid */
             plan_id: string;
@@ -1842,10 +2066,38 @@ export interface components {
             interval?: "day" | "month" | "year";
             /** Format: uuid */
             payment_method_id?: string;
-            /** @default true */
+            /**
+             * @description Whether to pay from the balance, with or without `payment_method_id`.
+             * @default true
+             */
             use_balance?: boolean;
+            /**
+             * @description Whether to pay from eligible credit grants before the balance.
+             * @default true
+             */
+            use_credits?: boolean;
             return_url?: string;
         };
+        /** @description The periods and price of the renewal, chosen as in renewing. */
+        RenewalOrderRequest: {
+            /**
+             * Format: uuid
+             * @description Purchase ID saved before submitting. Duplicate creation conflicts; query this order after an unknown result.
+             */
+            order_id: string;
+            /**
+             * @description As in renewing.
+             * @default 1
+             */
+            periods?: number;
+            /** @description As in renewing. */
+            interval_count?: number;
+            /**
+             * @description As in renewing.
+             * @enum {string}
+             */
+            interval?: "day" | "month" | "year";
+        };
         AutoRenewSet: {
             auto_renew: boolean;
         };
@@ -1890,6 +2142,12 @@ export interface components {
              *     as a membership.
              */
             project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             /**
              * Format: int64
              * @description The billing account the order was placed with. It does not change when the project is later
@@ -2292,6 +2550,21 @@ export interface components {
          * @example 10.2500000000
          */
         Money: string;
+        /**
+         * @description Which object this is, together with what a person currently calls it.
+         *
+         *     The name is for display. It is chosen by whoever owns the object, it changes, it is not unique
+         *     between objects, and it may be empty when nobody has named it yet — so it must not be used to
+         *     address, match or deduplicate anything. Addressing is by id.
+         *
+         *     This differs from an identity carrying a lookup key: a lookup key is written once by an operator,
+         *     is unique, and can be used to fetch the object. A name cannot.
+         */
+        NamedIdentity: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+        };
     };
     responses: {
         /** @description Error */
@@ -2473,6 +2746,29 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "get-account-metered-usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                accountId: components["parameters"]["AccountId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MeteredUsage"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "list-payment-options": {
         parameters: {
             query?: never;
@@ -2826,6 +3122,34 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "preview-invoice-payment": {
+        parameters: {
+            query?: {
+                /** @description As in paying. True when omitted. */
+                use_balance?: boolean;
+                /** @description As in paying. True when omitted. */
+                use_credits?: boolean;
+            };
+            header?: never;
+            path: {
+                invoiceId: components["parameters"]["InvoiceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentPreview"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "pay-together": {
         parameters: {
             query?: never;
@@ -2851,6 +3175,31 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "preview-pay-together": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PayTogetherRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentPreview"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "list-invoices": {
         parameters: {
             query?: {
@@ -3294,6 +3643,42 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "create-renewal-order": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                subscriptionId: components["parameters"]["SubscriptionId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenewalOrderRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Order"];
+                };
+            };
+            /** @description The order already exists or the subscription has a conflicting renewal, change or cancellation. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "set-auto-renew": {
         parameters: {
             query?: never;
@@ -3434,6 +3819,38 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
+    "cancel-order": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                orderId: components["parameters"]["OrderId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The order after the request. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Order"];
+                };
+            };
+            /** @description The order is paid in full, accepted, being paid online, or a scheduled change. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
     "list-order-items": {
         parameters: {
             query?: {

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

@@ -562,8 +562,12 @@ export interface components {
             name: string;
             currency: string;
         };
-        /** @enum {string} */
-        InvoiceStatus: "draft" | "open" | "paid" | "void" | "uncollectible";
+        /**
+         * @description `refunded` means the invoice was paid and has since been refunded in full; a partial refund
+         *     leaves it `paid`, with the refunded part in `amount_refunded`.
+         * @enum {string}
+         */
+        InvoiceStatus: "draft" | "open" | "paid" | "refunded" | "void" | "uncollectible";
         UsageCharge: {
             /** Format: uuid */
             subscription_id?: string;
@@ -571,6 +575,11 @@ export interface components {
             id: string;
             /** Format: uuid */
             project_id?: string;
+            /**
+             * @description The project and its current name, for display. Absent when the project no longer exists or its
+             *     details cannot be read at the moment; `project_id` still identifies it.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             product: components["schemas"]["Product"];
             /** @description Which resource this was charged for. Empty for charges not tied to one. */
             resource_id?: string;
@@ -677,6 +686,12 @@ export interface components {
              *     membership, which belongs to no single project.
              */
             project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             product: components["schemas"]["Product"];
             /** Format: uuid */
             plan_id: string;
@@ -782,6 +797,12 @@ export interface components {
              *     as a membership.
              */
             project_id?: string | null;
+            /**
+             * @description The project and its current name, for display. Absent for a purchase at account level,
+             *     and when the project no longer exists or its details cannot be read at the moment;
+             *     `project_id` still identifies it then.
+             */
+            project?: components["schemas"]["NamedIdentity"] | null;
             /**
              * Format: int64
              * @description The billing account the order was placed with. It does not change when the project is later
@@ -1011,6 +1032,21 @@ export interface components {
          * @example 10.2500000000
          */
         Money: string;
+        /**
+         * @description Which object this is, together with what a person currently calls it.
+         *
+         *     The name is for display. It is chosen by whoever owns the object, it changes, it is not unique
+         *     between objects, and it may be empty when nobody has named it yet — so it must not be used to
+         *     address, match or deduplicate anything. Addressing is by id.
+         *
+         *     This differs from an identity carrying a lookup key: a lookup key is written once by an operator,
+         *     is unique, and can be used to fetch the object. A name cannot.
+         */
+        NamedIdentity: {
+            /** Format: uuid */
+            id: string;
+            name: string;
+        };
     };
     responses: {
         /** @description Error */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.0.0-dev.216.gab0f521",
+  "version": "0.0.0-dev.220.g26e832e",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {