@leaflow/sdk 0.174.0 → 0.175.0

package/dist/swas/v1/generated/functions.d.ts

@@ -43,7 +43,7 @@ export type listPlansResponseError = (listPlansResponse400 | listPlansResponse40
 export type listPlansResponse = listPlansResponseSuccess | listPlansResponseError;
 export declare const getListPlansUrl: (params: ListPlansParams) => string;
 /**
- * Lists available plans and prices for the requested region. A plan without a price is not available to buy.
+ * Lists one plan per provider plan ID in the requested region. The default response preserves the single price and buyable fields. With include_prices=true, plans also contain verified price options for explicit billing-period selection. Archived snapshot prices are never offered for purchase.
  * @summary List plans
  */
 export declare const listPlans: (params: ListPlansParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listPlansResponse>;

package/dist/swas/v1/generated/functions.js

@@ -11,7 +11,7 @@ export const getListPlansUrl = (params) => {
         : `https://swas.leaflow.cloud/api/v1/catalog/plans`;
 };
 /**
- * Lists available plans and prices for the requested region. A plan without a price is not available to buy.
+ * Lists one plan per provider plan ID in the requested region. The default response preserves the single price and buyable fields. With include_prices=true, plans also contain verified price options for explicit billing-period selection. Archived snapshot prices are never offered for purchase.
  * @summary List plans
  */
 export const listPlans = async (params, options, fetchFn) => {

package/dist/swas/v1/generated/models.d.ts

@@ -36,7 +36,10 @@ export interface PurchaseCreate {
      * @maxLength 256
      */
     provider_plan_id: string;
-    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    /**
+     * Selects a price from the requested plan and current catalog revision. The server resolves its immutable Billing terms, billing period and ownership; the client does not set the billing period.
+     * @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
+     */
     billing_price_id: string;
     /**
      * @minLength 1
@@ -44,6 +47,7 @@ export interface PurchaseCreate {
      */
     image_id: string;
     quantity: 1;
+    /** An assertion about the displayed quote, not an authoritative amount. The server obtains a new Billing quote and rejects a mismatch before accepting a purchase. */
     expected_quote: ExpectedQuote;
     /**
      * @minLength 1
@@ -98,6 +102,27 @@ export interface Price {
     amount: DecimalAmount;
     period_months: PricePeriodMonths;
 }
+export type PriceOptionPeriodMonths = (typeof PriceOptionPeriodMonths)[keyof typeof PriceOptionPeriodMonths];
+export declare const PriceOptionPeriodMonths: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_3: 3;
+    readonly NUMBER_6: 6;
+    readonly NUMBER_12: 12;
+    readonly NUMBER_24: 24;
+    readonly NUMBER_36: 36;
+};
+/**
+ * A verified price option for one billing period. Its Billing price must currently be available, use period-end cancellation without an automatic refund, and match this provider plan and region. Archived snapshots, unknown periods and unverified prices are excluded. Selection does not bypass current permissions, quote checks or disabled purchase controls. IDs and amounts are authoritative only after server revalidation.
+ */
+export interface PriceOption {
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    billing_plan_id: string;
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    billing_price_id: string;
+    currency: "USD";
+    amount: DecimalAmount;
+    period_months: PriceOptionPeriodMonths;
+}
 export interface Plan {
     provider_plan_id: string;
     region_id: string;
@@ -105,7 +130,14 @@ export interface Plan {
     /** @minimum 1 */
     catalog_revision: number;
     buyable: boolean;
+    /** The existing default price representation. Its availability and the buyable field are unchanged by include_prices; clients using price retain the same default billing period. */
     price: Price | null;
+    /**
+     * Present only when include_prices=true. Contains all currently verified billing-period options, ordered by period_months. Billing price IDs and billing periods are each unique within a plan. An empty array means no verified option is available. It does not make the default price buyable.
+     * @minItems 0
+     * @maxItems 6
+     */
+    prices?: PriceOption[];
     /**
      * @minItems 1
      * @maxItems 256
@@ -119,7 +151,7 @@ export interface Plan {
     disk_gb: number;
 }
 /**
- * Bounded catalog snapshot for one requested region. Incomplete or unavailable price information is not a purchasable offer.
+ * Bounded catalog snapshot for one requested region. Incomplete or unavailable price information is not a purchasable offer. Provider plan IDs are unique regardless of the number of billing periods.
  */
 export interface Catalog {
     items: Plan[];
@@ -376,6 +408,10 @@ export type ListPlansParams = {
      * @maxLength 128
      */
     region_id: string;
+    /**
+     * Set to true to include all verified billing-period price options. When false or omitted, the response omits prices and preserves the default price representation.
+     */
+    include_prices?: boolean;
 };
 export type CreatePurchaseHeaders = {
     /**

package/dist/swas/v1/generated/models.js

@@ -22,6 +22,14 @@ export const PricePeriodMonths = {
     NUMBER_24: 24,
     NUMBER_36: 36,
 };
+export const PriceOptionPeriodMonths = {
+    NUMBER_1: 1,
+    NUMBER_3: 3,
+    NUMBER_6: 6,
+    NUMBER_12: 12,
+    NUMBER_24: 24,
+    NUMBER_36: 36,
+};
 export const InstancePricePeriodMonths = {
     NUMBER_1: 1,
     NUMBER_3: 3,

package/dist/swas/v1/generated/schemas.zod.d.ts

@@ -7,12 +7,14 @@
  */
 import * as zod from "zod";
 /**
- * Lists available plans and prices for the requested region. A plan without a price is not available to buy.
+ * Lists one plan per provider plan ID in the requested region. The default response preserves the single price and buyable fields. With include_prices=true, plans also contain verified price options for explicit billing-period selection. Archived snapshot prices are never offered for purchase.
  * @summary List plans
  */
 export declare const listPlansQueryRegionIdMax = 128;
+export declare const listPlansQueryIncludePricesDefault = false;
 export declare const ListPlansQueryParams: zod.ZodObject<{
     region_id: zod.ZodString;
+    include_prices: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strict>;
 /**
  * Creates a purchase using the current catalog revision and expected price. Reuse the same Idempotency-Key after a timeout. Acceptance is not confirmation of payment or instance delivery.

package/dist/swas/v1/generated/schemas.zod.js

@@ -11,12 +11,17 @@ import { RebootInstance } from "./validators/rebootInstance.zod.js";
 import { StartInstance } from "./validators/startInstance.zod.js";
 import { StopInstance } from "./validators/stopInstance.zod.js";
 /**
- * Lists available plans and prices for the requested region. A plan without a price is not available to buy.
+ * Lists one plan per provider plan ID in the requested region. The default response preserves the single price and buyable fields. With include_prices=true, plans also contain verified price options for explicit billing-period selection. Archived snapshot prices are never offered for purchase.
  * @summary List plans
  */
 export const listPlansQueryRegionIdMax = 128;
+export const listPlansQueryIncludePricesDefault = false;
 export const ListPlansQueryParams = zod.strictObject({
     region_id: zod.string().min(1).max(listPlansQueryRegionIdMax),
+    include_prices: zod
+        .boolean()
+        .default(listPlansQueryIncludePricesDefault)
+        .describe("Set to true to include all verified billing-period price options. When false or omitted, the response omits prices and preserves the default price representation."),
 });
 /**
  * Creates a purchase using the current catalog revision and expected price. Reuse the same Idempotency-Key after a timeout. Acceptance is not confirmation of payment or instance delivery.

package/dist/swas/v1/generated/validators/catalog.zod.d.ts

@@ -20,6 +20,13 @@ export declare const Catalog: zod.ZodObject<{
             amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
             period_months: zod.ZodUnion<readonly [zod.ZodUnion<readonly [zod.ZodLiteral<1>, zod.ZodLiteral<3>, zod.ZodLiteral<6>, zod.ZodLiteral<12>, zod.ZodLiteral<24>, zod.ZodLiteral<36>]>, zod.ZodNull]>;
         }, zod.z.core.$strict>, zod.ZodNull]>;
+        prices: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            billing_plan_id: zod.ZodUUID;
+            billing_price_id: zod.ZodUUID;
+            currency: zod.ZodLiteral<"USD">;
+            amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
+            period_months: zod.ZodUnion<readonly [zod.ZodLiteral<1>, zod.ZodLiteral<3>, zod.ZodLiteral<6>, zod.ZodLiteral<12>, zod.ZodLiteral<24>, zod.ZodLiteral<36>]>;
+        }, zod.z.core.$strict>>>;
         image_ids: zod.ZodArray<zod.ZodString>;
         cpu: zod.ZodInt;
         memory_mb: zod.ZodInt;

package/dist/swas/v1/generated/validators/catalog.zod.js

@@ -13,4 +13,4 @@ export const Catalog = zod
     source_observed_at: zod.iso.datetime({ offset: true }).describe("UTC RFC 3339 timestamp."),
     complete: zod.boolean(),
 })
-    .describe("Bounded catalog snapshot for one requested region. Incomplete or unavailable price information is not a purchasable offer.");
+    .describe("Bounded catalog snapshot for one requested region. Incomplete or unavailable price information is not a purchasable offer. Provider plan IDs are unique regardless of the number of billing periods.");

package/dist/swas/v1/generated/validators/listPlansParams.zod.d.ts

@@ -7,8 +7,10 @@
  */
 import * as zod from "zod";
 export declare const listPlansParamsRegionIdMax = 128;
+export declare const listPlansParamsIncludePricesDefault = false;
 export declare const ListPlansParams: zod.ZodObject<{
     region_id: zod.ZodString;
+    include_prices: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strict>;
 export type ListPlansParams = zod.input<typeof ListPlansParams>;
 export type ListPlansParamsOutput = zod.output<typeof ListPlansParams>;

package/dist/swas/v1/generated/validators/listPlansParams.zod.js

@@ -7,6 +7,8 @@
  */
 import * as zod from "zod";
 export const listPlansParamsRegionIdMax = 128;
+export const listPlansParamsIncludePricesDefault = false;
 export const ListPlansParams = zod.strictObject({
     region_id: zod.string().min(1).max(listPlansParamsRegionIdMax),
+    include_prices: zod.boolean().default(listPlansParamsIncludePricesDefault),
 });

package/dist/swas/v1/generated/validators/plan.zod.d.ts

@@ -6,6 +6,8 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+export declare const planPricesMin = 0;
+export declare const planPricesMax = 6;
 export declare const planImageIdsMax = 256;
 export declare const Plan: zod.ZodObject<{
     provider_plan_id: zod.ZodString;
@@ -20,6 +22,13 @@ export declare const Plan: zod.ZodObject<{
         amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
         period_months: zod.ZodUnion<readonly [zod.ZodUnion<readonly [zod.ZodLiteral<1>, zod.ZodLiteral<3>, zod.ZodLiteral<6>, zod.ZodLiteral<12>, zod.ZodLiteral<24>, zod.ZodLiteral<36>]>, zod.ZodNull]>;
     }, zod.z.core.$strict>, zod.ZodNull]>;
+    prices: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        billing_plan_id: zod.ZodUUID;
+        billing_price_id: zod.ZodUUID;
+        currency: zod.ZodLiteral<"USD">;
+        amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
+        period_months: zod.ZodUnion<readonly [zod.ZodLiteral<1>, zod.ZodLiteral<3>, zod.ZodLiteral<6>, zod.ZodLiteral<12>, zod.ZodLiteral<24>, zod.ZodLiteral<36>]>;
+    }, zod.z.core.$strict>>>;
     image_ids: zod.ZodArray<zod.ZodString>;
     cpu: zod.ZodInt;
     memory_mb: zod.ZodInt;

package/dist/swas/v1/generated/validators/plan.zod.js

@@ -7,6 +7,9 @@
  */
 import * as zod from "zod";
 import { Price } from "./price.zod.js";
+import { PriceOption } from "./priceOption.zod.js";
+export const planPricesMin = 0;
+export const planPricesMax = 6;
 export const planImageIdsMax = 256;
 export const Plan = zod.strictObject({
     provider_plan_id: zod.string(),
@@ -14,7 +17,15 @@ export const Plan = zod.strictObject({
     name: zod.string(),
     catalog_revision: zod.int().min(1),
     buyable: zod.boolean(),
-    price: zod.union([Price, zod.null()]),
+    price: zod
+        .union([Price, zod.null()])
+        .describe("The existing default price representation. Its availability and the buyable field are unchanged by include_prices; clients using price retain the same default billing period."),
+    prices: zod
+        .array(PriceOption)
+        .min(planPricesMin)
+        .max(planPricesMax)
+        .optional()
+        .describe("Present only when include_prices=true. Contains all currently verified billing-period options, ordered by period_months. Billing price IDs and billing periods are each unique within a plan. An empty array means no verified option is available. It does not make the default price buyable."),
     image_ids: zod.array(zod.string()).min(1).max(planImageIdsMax),
     cpu: zod.int().min(1),
     memory_mb: zod.int().min(1),

package/dist/swas/v1/generated/validators/priceOption.zod.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow SWAS API
+ * Manage SWAS purchases and instances in the current project. Use an IAM scoped token for every request. Amounts are decimal strings in the stated currency; timestamps are UTC RFC 3339. Accepted requests may still be in progress. Read purchase, operation and refund progress separately.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const priceOptionBillingPlanIdRegExp: RegExp;
+export declare const priceOptionBillingPriceIdRegExp: RegExp;
+export declare const PriceOption: zod.ZodObject<{
+    billing_plan_id: zod.ZodUUID;
+    billing_price_id: zod.ZodUUID;
+    currency: zod.ZodLiteral<"USD">;
+    amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
+    period_months: zod.ZodUnion<readonly [zod.ZodLiteral<1>, zod.ZodLiteral<3>, zod.ZodLiteral<6>, zod.ZodLiteral<12>, zod.ZodLiteral<24>, zod.ZodLiteral<36>]>;
+}, zod.z.core.$strict>;
+export type PriceOption = zod.input<typeof PriceOption>;
+export type PriceOptionOutput = zod.output<typeof PriceOption>;

package/dist/swas/v1/generated/validators/priceOption.zod.js

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow SWAS API
+ * Manage SWAS purchases and instances in the current project. Use an IAM scoped token for every request. Amounts are decimal strings in the stated currency; timestamps are UTC RFC 3339. Accepted requests may still be in progress. Read purchase, operation and refund progress separately.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { DecimalAmount } from "./decimalAmount.zod.js";
+export const priceOptionBillingPlanIdRegExp = new RegExp("^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$");
+export const priceOptionBillingPriceIdRegExp = new RegExp("^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$");
+export const PriceOption = zod
+    .strictObject({
+    billing_plan_id: zod.uuid().regex(priceOptionBillingPlanIdRegExp),
+    billing_price_id: zod.uuid().regex(priceOptionBillingPriceIdRegExp),
+    currency: zod.literal("USD"),
+    amount: DecimalAmount,
+    period_months: zod.union([
+        zod.literal(1),
+        zod.literal(3),
+        zod.literal(6),
+        zod.literal(12),
+        zod.literal(24),
+        zod.literal(36),
+    ]),
+})
+    .describe("A verified price option for one billing period. Its Billing price must currently be available, use period-end cancellation without an automatic refund, and match this provider plan and region. Archived snapshots, unknown periods and unverified prices are excluded. Selection does not bypass current permissions, quote checks or disabled purchase controls. IDs and amounts are authoritative only after server revalidation.");

package/dist/swas/v1/generated/validators/purchaseCreate.zod.js

@@ -15,9 +15,12 @@ export const purchaseCreateRegionIdMax = 128;
 export const PurchaseCreate = zod.strictObject({
     catalog_revision: zod.int().min(1).max(purchaseCreateCatalogRevisionMax),
     provider_plan_id: zod.string().min(1).max(purchaseCreateProviderPlanIdMax),
-    billing_price_id: zod.uuid().regex(purchaseCreateBillingPriceIdRegExp),
+    billing_price_id: zod
+        .uuid()
+        .regex(purchaseCreateBillingPriceIdRegExp)
+        .describe("Selects a price from the requested plan and current catalog revision. The server resolves its immutable Billing terms, billing period and ownership; the client does not set the billing period."),
     image_id: zod.string().min(1).max(purchaseCreateImageIdMax),
     quantity: zod.literal(1),
-    expected_quote: ExpectedQuote,
+    expected_quote: ExpectedQuote.describe("An assertion about the displayed quote, not an authoritative amount. The server obtains a new Billing quote and rejects a mismatch before accepting a purchase."),
     region_id: zod.string().min(1).max(purchaseCreateRegionIdMax),
 });

package/dist/swas/v1/response-schemas.d.ts

@@ -16,3 +16,4 @@ export { CustomerRefundProgress } from "./generated/validators/customerRefundPro
 export { SupplierRefundProgress } from "./generated/validators/supplierRefundProgress.zod.js";
 export { DecimalAmount } from "./generated/validators/decimalAmount.zod.js";
 export { Money } from "./generated/validators/money.zod.js";
+export { PriceOption } from "./generated/validators/priceOption.zod.js";

package/dist/swas/v1/response-schemas.js

@@ -17,3 +17,4 @@ export { CustomerRefundProgress } from "./generated/validators/customerRefundPro
 export { SupplierRefundProgress } from "./generated/validators/supplierRefundProgress.zod.js";
 export { DecimalAmount } from "./generated/validators/decimalAmount.zod.js";
 export { Money } from "./generated/validators/money.zod.js";
+export { PriceOption } from "./generated/validators/priceOption.zod.js";

package/package.json

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