@leaflow/sdk 0.57.1 → 0.59.0

package/README.md

@@ -7,7 +7,7 @@ Leaflow 平台的 TypeScript SDK(`@leaflow/sdk`),由
 npm i @leaflow/sdk openapi-fetch
 ```
 
-当前只含类型。请求由 `openapi-fetch` 发出,路径与参数由契约约束。
+包含 Node.js 可用的 JavaScript 客户端和 TypeScript 类型。请求由 `openapi-fetch` 发出，路径与参数由契约约束。
 
 ```ts
 import createClient from 'openapi-fetch';
@@ -32,3 +32,15 @@ npm run generate
 ```
 
 契约版本记在 `CONTRACTS_REF`。
+
+## Billing
+
+```ts
+import { client } from "@leaflow/sdk/billing/v1";
+
+const billing = client({ baseUrl: billingBaseUrl, headers });
+```
+
+公共目录、账户和项目接口使用 `@leaflow/sdk`，运营管理接口使用 `@leaflow/sdk-admin`。服务间 Proto 使用独立的 `@leaflow/billing` 包。
+
+本地契约可通过 `CONTRACTS_DIR=/absolute/path/to/contracts npm run generate` 生成。发布时将契约提交号写入 `CONTRACTS_REF`，再使用默认生成命令。

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

@@ -0,0 +1,6 @@
+import { type ClientOptions } from "openapi-fetch";
+import type { paths } from "./schema.js";
+/** A client for the billing service. Pass baseUrl to override the address. */
+export declare function client(options: ClientOptions & {
+    baseUrl: string;
+}): import("openapi-fetch").Client<paths, `${string}/${string}`>;

package/dist/billing/v1/client.js

@@ -0,0 +1,6 @@
+// Code generated from the contract's servers[0]. DO NOT EDIT.
+import createClient, {} from "openapi-fetch";
+/** A client for the billing service. Pass baseUrl to override the address. */
+export function client(options) {
+    return createClient(options);
+}

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

@@ -1,4 +1,5 @@
 export type { paths, components, operations, webhooks } from "./schema.js";
+export { client } from "./client.js";
 import type { operations } from "./schema.js";
 /** The success response body of `GET /catalog/v1/products`. */
 export type ListCatalogProductsResult = operations["list-catalog-products"]["responses"][200]["content"]["application/json"];

package/dist/billing/v1/index.js

@@ -2,4 +2,4 @@
 //
 // The aliases replace the operations[...] subscript chain with a name. The raw paths /
 // components / operations are exported as well: paths is what createClient<paths>() takes.
-export {};
+export { client } from "./client.js";

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

@@ -1361,6 +1361,10 @@ export interface components {
             total_count?: number;
         };
         CatalogPrice: {
+            /** @description External lookup alias within the service. Existing references use the price ID. */
+            lookup_key?: string;
+            /** Format: uuid */
+            product_id?: string;
             /** Format: uuid */
             id: string;
             /** Format: uuid */
@@ -1425,8 +1429,7 @@ export interface components {
             total_count?: number;
         };
         CatalogRate: {
-            /** @description What is being measured. */
-            meter_key: string;
+            meter: components["schemas"]["ObjectIdentity"];
             /** @description The unit readings arrive in, such as `core-second`. */
             unit?: string;
             /** @description The attributes this rate applies to, such as region and machine type. */
@@ -1455,22 +1458,12 @@ export interface components {
             /** Format: int64 */
             total_count?: number;
         };
-        /**
-         * @description Identify what to price either by `price_id`, or by `product_key` together with
-         *     `service_product_id`. Supplying both, or neither, is refused.
-         */
+        /** @description Identify a price directly, or select a price for a plan. Lookup keys are scoped to the product. Account quotes apply applicable contract prices. */
         QuoteLine: {
-            /** Format: uuid */
-            price_id?: string;
-            /** @description The service, such as `compute`. */
-            product_key?: string;
-            /** @description How the owning service identifies the item, such as a machine type. */
-            service_product_id?: string;
-            /**
-             * @description Required for a metered price whose price list covers more than one meter, so that
-             *     the intended one is unambiguous.
-             */
-            meter_key?: string;
+            price?: components["schemas"]["ObjectReference"];
+            product?: components["schemas"]["ObjectReference"];
+            plan?: components["schemas"]["ObjectReference"];
+            meter?: components["schemas"]["ObjectReference"];
             /**
              * @description The attributes the price depends on — region, instance type, token class.
              *
@@ -1485,13 +1478,7 @@ export interface components {
                 [key: string]: string;
             };
             /**
-             * @description Which way of buying. Required when the item is sold in more than one way — the
-             *     same item may be offered metered, prepaid and as a one-off pack, and the pair
-             *     `product_key` + `service_product_id` names only the item, not the way.
-             *
-             *     Omit it when the item is sold one way only. If what is given matches no price, or
-             *     still leaves more than one candidate, the request is refused rather than resolved
-             *     by guessing.
+             * @description Narrows the selection when a plan offers more than one billing type.
              * @enum {string}
              */
             price_type?: "metered" | "prepaid" | "one_time";
@@ -1508,25 +1495,15 @@ export interface components {
              */
             duration_seconds?: number;
         };
-        /**
-         * @description Price a change to something already running, rather than a new purchase.
-         *
-         *     The result states what is still owed for the period already paid for, what the new
-         *     configuration costs for the remainder, and the difference in either direction.
-         */
+        /** @description Estimate a change to a subscription item using a target plan or price. */
         QuoteChange: {
             /**
              * Format: uuid
              * @description What is being changed.
              */
             subscription_item_id: string;
-            /**
-             * Format: uuid
-             * @description The price to move to. Identify it here, or by `service_product_id` below. Supplying
-             *     both, or neither, is refused.
-             */
-            price_id?: string;
-            service_product_id?: string;
+            price?: components["schemas"]["ObjectReference"];
+            plan?: components["schemas"]["ObjectReference"];
             /** @description The new quantity. The current one is kept when omitted. */
             quantity?: string;
             /**
@@ -1550,6 +1527,10 @@ export interface components {
             lines: components["schemas"]["QuoteLine"][];
         };
         QuoteLineResult: {
+            /** @description Tax included in the account quote. Absent in public catalogue estimates. */
+            tax_amount?: components["schemas"]["Money"];
+            /** @description Tax already included in the displayed price. */
+            tax_included_amount?: components["schemas"]["Money"];
             /** @description Which line of the request this answers. */
             index: number;
             /**
@@ -1587,6 +1568,10 @@ export interface components {
             currency: string;
         };
         QuoteChangeResult: {
+            /** @description Tax included in the account quote. Absent in public catalogue estimates. */
+            tax_amount?: components["schemas"]["Money"];
+            /** @description Tax already included in the displayed price. */
+            tax_included_amount?: components["schemas"]["Money"];
             index: number;
             /** Format: uuid */
             subscription_item_id: string;
@@ -2008,6 +1993,11 @@ export interface components {
         /** @enum {string} */
         InvoiceStatus: "draft" | "open" | "paid" | "void" | "uncollectible";
         Invoice: {
+            /**
+             * Format: uuid
+             * @description The purchase that produced this invoice. Absent on usage invoices.
+             */
+            order_id?: string;
             /** Format: uuid */
             id: string;
             /** Format: int64 */
@@ -2058,6 +2048,17 @@ export interface components {
             total_count?: number;
         };
         InvoiceItem: {
+            /** @description Discount applied to this line before tax. */
+            discount_amount?: string;
+            /** @description Tax on the discounted line, including tax already included in the price. */
+            tax_amount?: string;
+            /** @description The part of tax_amount already included in amount. */
+            tax_included_amount?: string;
+            /**
+             * Format: uuid
+             * @description The original order line. Refunds follow that line's original payment sources.
+             */
+            order_item_id?: string;
             /** Format: uuid */
             id: string;
             /** @enum {string} */
@@ -2301,11 +2302,10 @@ export interface components {
             id: string;
             /** Format: uuid */
             project_id?: string;
-            product_key: string;
+            product: components["schemas"]["ObjectIdentity"];
             /** @description Which resource this was charged for. Empty for charges not tied to one. */
             resource_id?: string;
-            /** @description What was measured, such as `instance_seconds`. */
-            meter_key: string;
+            meter: components["schemas"]["ObjectIdentity"];
             unit?: string;
             /** @description The attributes the rate was chosen by, such as region and machine type. */
             dimensions?: {
@@ -2339,7 +2339,7 @@ export interface components {
             total_count?: number;
         };
         SpendRow: {
-            product_key?: string;
+            product?: components["schemas"]["ObjectIdentity"];
             /** Format: uuid */
             plan_id?: string;
             plan_name?: string;
@@ -2369,7 +2369,7 @@ export interface components {
             billing_account_id?: number;
             /** Format: uuid */
             product_id: string;
-            product_key?: string;
+            product?: components["schemas"]["ObjectIdentity"];
             /**
              * @description `pending` is a subscription created by an order that has not completed, so it
              *     appears in the list before anything under it is running.
@@ -2395,7 +2395,7 @@ export interface components {
              *     membership, which belongs to no single project.
              */
             project_id?: string | null;
-            product_key?: string;
+            product?: components["schemas"]["ObjectIdentity"];
             /** Format: uuid */
             plan_id: string;
             plan_name?: string;
@@ -2440,10 +2440,10 @@ export interface components {
         /** @description A resource currently accruing charges by the second. */
         ActiveResource: {
             resource_id: string;
-            product_key: string;
+            product: components["schemas"]["ObjectIdentity"];
             /** @description What it is, as its own service names it. */
             resource_type?: string;
-            meter_key: string;
+            meter: components["schemas"]["ObjectIdentity"];
             unit?: string;
             /** @description How much is held — cores, MiB, cards. Not how much has been used. */
             quantity: string;
@@ -2468,6 +2468,10 @@ export interface components {
         /** @enum {string} */
         OrderState: "pending" | "paid" | "fulfilled" | "failed" | "canceled";
         Order: {
+            /** @description Total tax after discounts, including any tax already included in the price. */
+            tax_amount?: string;
+            /** @description The part of tax_amount already included in gross_amount; it is not charged again. */
+            tax_included_amount?: string;
             /** Format: uuid */
             id: string;
             /**
@@ -2638,8 +2642,8 @@ export interface components {
          *     measured against **the qualifying lines only**, not the order total.
          */
         Applicability: {
-            product_keys?: string[];
-            plan_keys?: string[];
+            product_ids?: string[];
+            plan_ids?: string[];
             price_types?: string[];
             operations?: components["schemas"]["PurchaseOperation"][];
             /** @description Restricted to your first purchase of a covered product. */
@@ -2676,6 +2680,10 @@ export interface components {
             flat_amount?: components["schemas"]["Money"];
         };
         OrderItem: {
+            /** @description Total tax after discounts, including any tax already included in the price. */
+            tax_amount?: string;
+            /** @description The part of tax_amount already included in gross_amount; it is not charged again. */
+            tax_included_amount?: string;
             /** Format: uuid */
             id: string;
             /** Format: uuid */
@@ -2687,11 +2695,7 @@ export interface components {
              * @description Which service this line belongs to.
              */
             product_id?: string;
-            /**
-             * @description How that service is named, such as `compute`. Read from the catalogue rather than
-             *     recorded on the line, so it always matches the service it points at.
-             */
-            product_key?: string;
+            product?: components["schemas"]["ObjectIdentity"];
             /**
              * Format: uuid
              * @description Which plan was bought.
@@ -2720,18 +2724,20 @@ export interface components {
             total_count?: number;
         };
         Allowance: {
+            /**
+             * @description Allowed values for selected meter dimensions, such as region or storage class.
+             *     Every specified dimension must match one listed value. Omitted dimensions are
+             *     unrestricted. An empty map covers all dimensions of this meter.
+             */
+            dimension_values?: {
+                [key: string]: string[];
+            };
             /** Format: uuid */
             id: string;
             /** Format: int64 */
             billing_account_id?: number;
-            /**
-             * @description Which service it covers, such as `compute`. Read it alongside `meter_key`: a meter
-             *     name is unique only within its own service, so two allowances for `egress_bytes`
-             *     may belong to different services and cover different traffic.
-             */
-            product_key: string;
-            /** @description What it covers, such as `egress_bytes`. */
-            meter_key: string;
+            product: components["schemas"]["ObjectIdentity"];
+            meter: components["schemas"]["ObjectIdentity"];
             /** @description The unit it is counted in, such as `MiB`. */
             unit?: string;
             /**
@@ -2768,7 +2774,7 @@ export interface components {
             id: string;
             /** Format: uuid */
             usage_charge_id?: string;
-            meter_key?: string;
+            meter?: components["schemas"]["ObjectIdentity"];
             quantity: string;
             /** Format: date-time */
             consumed_at: string;
@@ -2781,7 +2787,15 @@ export interface components {
             total_count?: number;
         };
         IncludedAllowance: {
-            meter_key: string;
+            /**
+             * @description Allowed values for selected meter dimensions, such as region or storage class.
+             *     Every specified dimension must match one listed value. Omitted dimensions are
+             *     unrestricted. An empty map covers all dimensions of this meter.
+             */
+            dimension_values?: {
+                [key: string]: string[];
+            };
+            meter: components["schemas"]["ObjectIdentity"];
             unit?: string;
             /** @description How much is included. */
             quantity: string;
@@ -2795,7 +2809,7 @@ export interface components {
             valid_days?: number;
         };
         IncludedFeature: {
-            feature_key: string;
+            feature: components["schemas"]["ObjectIdentity"];
             name: string;
             name_translations?: components["schemas"]["Translations"];
             description?: string;
@@ -2815,13 +2829,8 @@ export interface components {
             unit?: string;
         };
         Entitlement: {
-            /**
-             * @description Which service. Read it alongside `feature_key`, which is unique only within its
-             *     service.
-             */
-            product_key: string;
-            /** @description What calling code tests against. */
-            feature_key: string;
+            product: components["schemas"]["ObjectIdentity"];
+            feature: components["schemas"]["ObjectIdentity"];
             name?: string;
             enabled: boolean;
             /**
@@ -2857,6 +2866,17 @@ export interface components {
             /** Format: int64 */
             total_count?: number;
         };
+        /** @description Identify an object by ID or lookup key, exactly one. A lookup key requires the owning product. */
+        ObjectReference: {
+            /** Format: uuid */
+            id?: string;
+            lookup_key?: string;
+        };
+        ObjectIdentity: {
+            /** Format: uuid */
+            id: string;
+            lookup_key?: string;
+        };
     };
     responses: {
         /** @description Unchanged since the `ETag` that was sent. No body. */
@@ -3050,7 +3070,8 @@ export interface operations {
                 page?: components["parameters"]["Page"];
                 /** @description How many per page, 100 at most. */
                 page_size?: components["parameters"]["PageSize"];
-                meter_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                meter?: components["schemas"]["ObjectReference"];
                 /** @description Return the rates in effect at this moment. Defaults to now. */
                 at?: string;
             };
@@ -3872,8 +3893,8 @@ export interface operations {
                 /** @description Restrict to one of your accounts. All of them when omitted. */
                 billing_account_id?: components["parameters"]["AccountIdQuery"];
                 project_id?: string;
-                /** @description Restrict to one service, such as `compute`. */
-                product_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
                 resource_id?: string;
                 from?: components["parameters"]["From"];
                 /** @description Exclusive. */
@@ -4096,7 +4117,8 @@ export interface operations {
                  *     the owning service and not here.
                  */
                 group_by?: "product" | "plan" | "resource";
-                product_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
                 /** @description 1-based page number; the first page when omitted. */
                 page?: components["parameters"]["Page"];
                 /** @description How many per page, 100 at most. */
@@ -4130,13 +4152,10 @@ export interface operations {
                 /** @description How many per page, 100 at most. */
                 page_size?: components["parameters"]["PageSize"];
                 resource_id?: string;
-                /**
-                 * @description Restrict to one service, such as `compute`. Give it alongside `meter_key`: a meter
-                 *     name is unique only within its own service, and more than one service may measure
-                 *     `traffic_bytes`, so `meter_key` on its own can return charges from several.
-                 */
-                product_key?: string;
-                meter_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                meter?: components["schemas"]["ObjectReference"];
                 from?: components["parameters"]["From"];
                 /** @description Exclusive. */
                 to?: components["parameters"]["To"];
@@ -4367,8 +4386,11 @@ export interface operations {
                 page_size?: components["parameters"]["PageSize"];
                 /** @description Restrict to one of your accounts. All of them when omitted. */
                 billing_account_id?: components["parameters"]["AccountIdQuery"];
-                meter_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                meter?: components["schemas"]["ObjectReference"];
                 status?: "active" | "depleted" | "expired" | "voided";
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
             };
             header?: never;
             path?: never;
@@ -4582,7 +4604,10 @@ export interface operations {
                 page?: components["parameters"]["Page"];
                 /** @description How many per page, 100 at most. */
                 page_size?: components["parameters"]["PageSize"];
-                meter_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                meter?: components["schemas"]["ObjectReference"];
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
             };
             header?: never;
             path: {
@@ -4644,7 +4669,8 @@ export interface operations {
                 page?: components["parameters"]["Page"];
                 /** @description How many per page, 100 at most. */
                 page_size?: components["parameters"]["PageSize"];
-                product_key?: string;
+                /** @description Filter by ID or lookup key. A lookup key is scoped to the product. */
+                product?: components["schemas"]["ObjectReference"];
             };
             header?: never;
             path: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.57.1",
+  "version": "0.59.0",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {
@@ -23,6 +23,10 @@
       "types": "./dist/assistant/v1/index.d.ts",
       "default": "./dist/assistant/v1/index.js"
     },
+    "./billing/v1": {
+      "types": "./dist/billing/v1/index.d.ts",
+      "default": "./dist/billing/v1/index.js"
+    },
     "./canopy/v1": {
       "types": "./dist/canopy/v1/index.d.ts",
       "default": "./dist/canopy/v1/index.js"
@@ -31,6 +35,14 @@
       "types": "./dist/compute/v1/index.d.ts",
       "default": "./dist/compute/v1/index.js"
     },
+    "./dns/v1": {
+      "types": "./dist/dns/v1/index.d.ts",
+      "default": "./dist/dns/v1/index.js"
+    },
+    "./fleet/v1": {
+      "types": "./dist/fleet/v1/index.d.ts",
+      "default": "./dist/fleet/v1/index.js"
+    },
     "./iam/v1": {
       "types": "./dist/iam/v1/index.d.ts",
       "default": "./dist/iam/v1/index.js"
@@ -39,6 +51,14 @@
       "types": "./dist/monitoring/v1/index.d.ts",
       "default": "./dist/monitoring/v1/index.js"
     },
+    "./notification/v1": {
+      "types": "./dist/notification/v1/index.d.ts",
+      "default": "./dist/notification/v1/index.js"
+    },
+    "./support/v1": {
+      "types": "./dist/support/v1/index.d.ts",
+      "default": "./dist/support/v1/index.js"
+    },
     "./tunnel/v1": {
       "types": "./dist/tunnel/v1/index.d.ts",
       "default": "./dist/tunnel/v1/index.js"
@@ -56,7 +76,6 @@
     "format:check": "prettier --check gen scripts"
   },
   "devDependencies": {
-    "openapi-fetch": "^0.17.0",
     "openapi-typescript": "7.13.0",
     "prettier": "^3.6.2",
     "typescript": "^5.9.3",
@@ -65,12 +84,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "peerDependencies": {
+  "dependencies": {
     "openapi-fetch": "^0.17.0"
-  },
-  "peerDependenciesMeta": {
-    "openapi-fetch": {
-      "optional": true
-    }
   }
 }