@leaflow/sdk 0.0.0-dev.352.g85966ed → 0.0.0-dev.353.g74313e0

package/dist/canopy/v1/generated/validators/price.zod.d.ts

@@ -69,15 +69,17 @@ export declare const Price: zod.ZodObject<{
     plan_id: zod.ZodUUID;
     currency: zod.ZodString;
     type: zod.ZodEnum<{
-        postpaid: "postpaid";
-        prepaid: "prepaid";
         one_time: "one_time";
+        recurring: "recurring";
     }>;
-    billing_scheme: zod.ZodEnum<{
+    usage_type: zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
+    }>;
+    billing_scheme: zod.ZodOptional<zod.ZodEnum<{
         per_unit: "per_unit";
         tiered: "tiered";
-        rated: "rated";
-    }>;
+    }>>;
     unit_amount: zod.ZodOptional<zod.ZodString>;
     tiers_mode: zod.ZodOptional<zod.ZodEnum<{
         none: "none";

package/dist/canopy/v1/generated/validators/price.zod.js

@@ -31,19 +31,25 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+import { BillingScheme } from "./billingScheme.zod.js";
 import { Money } from "./money.zod.js";
 import { ObjectIdentity } from "./objectIdentity.zod.js";
+import { PriceType } from "./priceType.zod.js";
 import { Product } from "./product.zod.js";
 import { ProductID } from "./productID.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
 import { TerminationPolicy } from "./terminationPolicy.zod.js";
 import { Tier } from "./tier.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const Price = zod.strictObject({
     rate_card: ObjectIdentity.optional(),
     lookup_key: zod.string().optional(),
     product: Product,
     plan: ObjectIdentity,
-    meter_id: zod.uuid().optional(),
+    meter_id: zod
+        .uuid()
+        .optional()
+        .describe("For a metered price with its own amounts, the meter it charges. For a licensed price, the meter its quantity is held on. Absent otherwise."),
     meter: ObjectIdentity.optional(),
     unit_quantity: zod.string(),
     active: zod
@@ -55,22 +61,19 @@ export const Price = zod.strictObject({
     id: zod.uuid(),
     plan_id: zod.uuid(),
     currency: zod.string(),
-    type: zod
-        .enum(["postpaid", "prepaid", "one_time"])
-        .describe("`postpaid` charges for what is used, `prepaid` buys a period in advance, `one_time`\ncharges once."),
-    billing_scheme: zod
-        .enum(["per_unit", "tiered", "rated"])
-        .describe("How the amount is arrived at. `rated` means the rate depends on attributes such as\nregion or machine type, and is looked up on a price list."),
+    type: PriceType,
+    usage_type: UsageType,
+    billing_scheme: BillingScheme.optional().describe("Absent when the price delegates to a rate card, where the rate depends on attributes such as region or machine type."),
     unit_amount: Money.optional().describe("Present for `per_unit`."),
     tiers_mode: zod
         .enum(["none", "graduated", "volume"])
         .optional()
-        .describe("`none` for a price that is not tiered, which is most of them.\n\nOtherwise `graduated` charges each band at its own rate, and `volume` charges\neverything at the rate of the band the total falls in."),
+        .describe("How a ladder is walked: `graduated` charges each band at its own rate, `volume` charges everything at the rate of the band the total falls in. `none` when not tiered."),
     tiers: zod.array(Tier).optional().describe("Present for `tiered`, in ascending order."),
     rate_card_id: zod
         .uuid()
         .optional()
-        .describe("For `rated` prices, the price list the rates are read from."),
+        .describe("Present when the price delegates to a rate card, the price list its rates are read from."),
     min_quantity: zod
         .string()
         .optional()
@@ -78,7 +81,7 @@ export const Price = zod.strictObject({
     max_quantity: zod
         .string()
         .optional()
-        .describe("The largest purchasable quantity. Omitted when no maximum applies. A quantity above this limit is\nrejected with BILLING_PRICE_INVALID and field=max_quantity."),
+        .describe("The largest quantity that may be bought; absent when there is no limit. A larger quantity is refused with `BILLING_PRICE_INVALID` and `field` `max_quantity`."),
     quantity_step: zod
         .string()
         .optional()
@@ -86,7 +89,7 @@ export const Price = zod.strictObject({
     interval_count: zod
         .int()
         .optional()
-        .describe("For prepaid prices, how many periods one purchase covers."),
+        .describe("For recurring licensed prices, how many interval units one period covers."),
     interval: zod.enum(["none", "day", "month", "year"]),
     setup_fee: Money.optional(),
 });

package/dist/canopy/v1/generated/validators/priceList.zod.d.ts

@@ -70,15 +70,17 @@ export declare const PriceList: zod.ZodObject<{
         plan_id: zod.ZodUUID;
         currency: zod.ZodString;
         type: zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
             one_time: "one_time";
+            recurring: "recurring";
         }>;
-        billing_scheme: zod.ZodEnum<{
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>;
+        billing_scheme: zod.ZodOptional<zod.ZodEnum<{
             per_unit: "per_unit";
             tiered: "tiered";
-            rated: "rated";
-        }>;
+        }>>;
         unit_amount: zod.ZodOptional<zod.ZodString>;
         tiers_mode: zod.ZodOptional<zod.ZodEnum<{
             none: "none";

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

@@ -42,18 +42,20 @@ export declare const PriceOption: zod.ZodObject<{
         id: zod.ZodUUID;
         name: zod.ZodString;
     }, zod.z.core.$strict>;
-    billing_scheme: zod.ZodEnum<{
+    billing_scheme: zod.ZodOptional<zod.ZodEnum<{
         per_unit: "per_unit";
         tiered: "tiered";
-        rated: "rated";
-    }>;
+    }>>;
     unit_quantity: zod.ZodString;
     id: zod.ZodUUID;
     currency: zod.ZodString;
     type: zod.ZodEnum<{
-        postpaid: "postpaid";
-        prepaid: "prepaid";
         one_time: "one_time";
+        recurring: "recurring";
+    }>;
+    usage_type: zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
     }>;
     interval: zod.ZodEnum<{
         none: "none";

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

@@ -31,18 +31,22 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+import { BillingScheme } from "./billingScheme.zod.js";
 import { Money } from "./money.zod.js";
 import { ObjectIdentity } from "./objectIdentity.zod.js";
+import { PriceType } from "./priceType.zod.js";
 import { Product } from "./product.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const PriceOption = zod
     .strictObject({
     product: Product,
     plan: ObjectIdentity,
-    billing_scheme: zod.enum(["per_unit", "tiered", "rated"]),
+    billing_scheme: BillingScheme.optional().describe("Absent when the price delegates to a rate card."),
     unit_quantity: zod.string(),
     id: zod.uuid(),
     currency: zod.string(),
-    type: zod.enum(["postpaid", "prepaid", "one_time"]),
+    type: PriceType,
+    usage_type: UsageType,
     interval: zod.enum(["none", "day", "month", "year"]),
     interval_count: zod.int().optional().describe("How many periods one purchase covers."),
     unit_amount: Money.optional(),
@@ -50,4 +54,4 @@ export const PriceOption = zod
         .boolean()
         .describe("False once the price is archived. It still applies to purchases already made at this price."),
 })
-    .describe("A price's display terms, including archived prices referenced by an applicability list.");
+    .describe("A price's display terms, including archived prices referenced by an applicability.");

package/dist/canopy/v1/generated/validators/priceType.zod.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Canopy model inference, API keys, model catalogue, service enablement and recorded usage.
+ *
+ * OpenAI-compatible project inference is served on this host at `/v1/chat/completions`,
+ * `/v1/embeddings`, `/v1/models` and `/v1/models/{model}`. Use `https://canopy.leaflow.cloud/v1`
+ * as the OpenAI SDK base URL. Chat completions support `stream=true` SSE.
+ *
+ * Management operations use `/api/v1`. The management model catalogue includes pricing;
+ * `/v1/models` returns the OpenAI model format with Canopy capabilities and parameter limits.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * Management and project inference accept the same verified IAM scoped token. The token is the
+ * sole billing project authority; `OpenAI-Project` and historical identity headers cannot
+ * override it. These endpoints do not accept a Canopy API key. The separate API-key gateway
+ * accepts Canopy API keys and supports OpenAI, Anthropic and Gemini request formats.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const PriceType: zod.ZodEnum<{
+    one_time: "one_time";
+    recurring: "recurring";
+}>;
+export type PriceType = zod.input<typeof PriceType>;
+export type PriceTypeOutput = zod.output<typeof PriceType>;

package/dist/canopy/v1/generated/validators/priceType.zod.js

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Canopy model inference, API keys, model catalogue, service enablement and recorded usage.
+ *
+ * OpenAI-compatible project inference is served on this host at `/v1/chat/completions`,
+ * `/v1/embeddings`, `/v1/models` and `/v1/models/{model}`. Use `https://canopy.leaflow.cloud/v1`
+ * as the OpenAI SDK base URL. Chat completions support `stream=true` SSE.
+ *
+ * Management operations use `/api/v1`. The management model catalogue includes pricing;
+ * `/v1/models` returns the OpenAI model format with Canopy capabilities and parameter limits.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * Management and project inference accept the same verified IAM scoped token. The token is the
+ * sole billing project authority; `OpenAI-Project` and historical identity headers cannot
+ * override it. These endpoints do not accept a Canopy API key. The separate API-key gateway
+ * accepts Canopy API keys and supports OpenAI, Anthropic and Gemini request formats.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const PriceType = zod
+    .enum(["one_time", "recurring"])
+    .describe("`one_time` charges once when bought. `recurring` charges again for every period, or for usage as it is settled.");

package/dist/canopy/v1/generated/validators/productID.zod.js

@@ -38,4 +38,4 @@ export const ProductID = zod
     .min(1)
     .max(ProductIDMax)
     .regex(ProductIDRegExp)
-    .describe("Immutable platform service identifier, such as compute, canopy or assistant.");
+    .describe("The platform service's fixed identifier, such as compute, canopy or assistant.");

package/dist/canopy/v1/generated/validators/projectAssignment.zod.js

@@ -38,11 +38,11 @@ export const ProjectAssignment = zod
     project: zod
         .union([NamedIdentity, zod.null()])
         .optional()
-        .describe("The project and its current name, for display. Absent when the project no longer exists or its\ndetails cannot be read at the moment; `project_id` still identifies it."),
+        .describe("The project and its current name. Absent when the project cannot be read; `project_id` still identifies it."),
     billing_account_id: zod.int(),
     account_name: zod.string().optional(),
     currency: zod.string(),
     effective_from: zod.iso.datetime({ offset: true }),
     effective_to: zod.iso.datetime({ offset: true }).nullish(),
 })
-    .describe("A project's assignment to a billing account for the interval from effective_from to effective_to. An open-ended assignment has no end time.");
+    .describe("A project's assignment to a billing account from effective_from until effective_to; an open assignment has no end.");

package/dist/canopy/v1/generated/validators/purchaseOperation.zod.js

@@ -33,4 +33,4 @@
 import * as zod from "zod";
 export const PurchaseOperation = zod
     .enum(["new", "renew", "modify"])
-    .describe("Which purchase operation this applies to. `new` covers every new purchase, including\nzero-charge purchases. It does not mean the account's first purchase; use\n`first_purchase_only` for that restriction. `renew` covers renewals. `modify` covers\nconfiguration or billing-term changes, including changes that increase or decrease\nthe amount due and changes with no additional charge or refund.");
+    .describe("The purchase operation covered. `new`: every new purchase, including zero-charge ones; it does not mean the account's first purchase, which `first_purchase_only` restricts. `renew`: renewals. `modify`: configuration or billing-term changes, whether they charge, refund or neither.");

package/dist/canopy/v1/generated/validators/quote5f60d00.zod.d.ts

@@ -104,10 +104,13 @@ export declare const Quote5f60d00: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>, zod.ZodNull]>>;
-            charge_type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
+            type: zod.ZodEnum<{
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             auto_renew: zod.ZodBoolean;
             unused_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/quote5f60d00.zod.js

@@ -40,18 +40,18 @@ import { QuoteItem } from "./quoteItem.zod.js";
 import { QuoteRenewalResult } from "./quoteRenewalResult.zod.js";
 export const Quote5f60d00 = zod
     .strictObject({
-    funds: Funds.optional().describe("Account funding for an existing-order checkout quote. Absent for usage estimates, refunds and cancellation previews."),
+    funds: Funds.optional().describe("Account funds for an existing-order checkout quote. Absent for usage estimates, refunds and cancellations."),
     subtotal: Money,
     discount_amount: Money,
     tax_amount: Money,
     discount: zod
         .union([QuotedDiscount, zod.null()])
-        .describe("The discount evaluated for a purchase or order, without applying it. Null when none is selected or\nwhen quoting renewals or a cancellation. A confirmed order reports its recorded discount."),
+        .describe("The discount a purchase or order would get, not yet applied. Null when there is none, and for renewals and cancellations. A confirmed order reports its recorded discount."),
     items: zod.array(QuoteItem),
     renewals: zod.array(QuoteRenewalResult),
     cancellation: CancellationRefundPreview.optional().describe("What the cancellation requested would return. Present only when one was requested."),
     total: Money,
     currency: zod.string(),
-    refund: OrderRefundQuote.optional().describe("Present only when an order refund was requested. Nothing is collectible for this target."),
+    refund: OrderRefundQuote.optional().describe("Present when an order refund was requested."),
 })
-    .describe("A complete calculation in one billing-account currency, without saving a quote or reserving funds or\nredemptions. The request fails if any item cannot be priced. Requested future usage estimates are\nincluded in totals for reporting and are not collectible at checkout. Only an existing-order quote\nprovides that order's checkout amount.");
+    .describe("A complete calculation in the billing account's currency; nothing is saved or reserved. The request fails if any item cannot be priced. Usage estimates are included in totals but are not collected at checkout; only an existing-order quote gives that order's checkout amount.");

package/dist/canopy/v1/generated/validators/quoteA200529.zod.d.ts

@@ -104,10 +104,13 @@ export declare const QuoteA200529: zod.ZodObject<{
                 id: zod.ZodUUID;
                 name: zod.ZodString;
             }, zod.z.core.$strict>, zod.ZodNull]>>;
-            charge_type: zod.ZodEnum<{
-                postpaid: "postpaid";
-                prepaid: "prepaid";
+            type: zod.ZodEnum<{
                 one_time: "one_time";
+                recurring: "recurring";
+            }>;
+            usage_type: zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
             }>;
             auto_renew: zod.ZodBoolean;
             unused_amount: zod.ZodString;

package/dist/canopy/v1/generated/validators/quoteCancellation.zod.js

@@ -39,7 +39,7 @@ export const QuoteCancellation = zod
         .array(zod.uuid())
         .min(1)
         .max(quoteCancellationSubscriptionIdsMax)
-        .describe("The subscriptions to end together, all of one service. Every subscription released with a resource must be included."),
+        .describe("The subscriptions to end together, all of one service, including every subscription released with a resource."),
     mode: TerminationPolicy,
 })
-    .describe("A cancellation to quote: what ending these subscriptions together would return. One mode per\nrequest; to compare, quote `immediate` and `period_end` separately.\n\nRefused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being\ncanceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a\npaid change still waiting to switch (`meta.order_id`).");
+    .describe("A cancellation to quote: what ending these subscriptions together would return, for one mode; quote `immediate` and `period_end` separately to compare. Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when a subscription is already being canceled (`meta.cancellation_id`), is being reclaimed (`meta.reason` `reclaim_requested`) or has a paid change waiting to switch (`meta.order_id`).");

package/dist/canopy/v1/generated/validators/quoteItem.zod.js

@@ -40,24 +40,24 @@ export const QuoteItem = zod
     index: zod
         .int()
         .min(quoteItemIndexMin)
-        .describe("Zero-based request line index, or the recorded order item's position for an order quote."),
+        .describe("The zero-based request line index, or the recorded order item's position for an order quote."),
     order_item_id: zod
         .uuid()
         .optional()
         .describe("Present for an existing order quote; identifies the recorded item being priced."),
     price_id: zod
         .uuid()
-        .describe("The selected price, including when the request identified it indirectly."),
+        .describe("The selected price, also when the request identified it indirectly."),
     plan_name: zod.string(),
     unit_amount: zod
         .union([Money, zod.null()])
         .describe("Unit price before discounts. Null when no single unit price applies, such as tiered or multiple-rate pricing."),
     quantity: zod
         .string()
-        .describe("The quantity priced. When duration_seconds is supplied for metered usage, this is quantity multiplied by that duration."),
+        .describe("The quantity priced; with duration_seconds, quantity times the duration."),
     amount: Money.describe("Amount before discounts and including any setup charge. For requested future usage this is an estimate, not a collectible checkout amount."),
     discount_amount: Money,
     total: Money,
     currency: zod.string(),
 })
-    .describe("One fully calculated purchase, estimated postpaid usage or recorded order item. Amounts use the\nbilling-account currency. An item with no immediate charge has zero checkout amounts.");
+    .describe("One fully calculated purchase, estimated metered usage or recorded order item. Amounts use the\nbilling-account currency. An item with no immediate charge has zero checkout amounts.");

package/dist/canopy/v1/generated/validators/quoteItemInput.zod.d.ts

@@ -42,9 +42,12 @@ export declare const QuoteItemInput: zod.ZodObject<{
     product_id: zod.ZodOptional<zod.ZodString>;
     plan_id: zod.ZodOptional<zod.ZodUUID>;
     price_type: zod.ZodOptional<zod.ZodEnum<{
-        postpaid: "postpaid";
-        prepaid: "prepaid";
         one_time: "one_time";
+        recurring: "recurring";
+    }>>;
+    usage_type: zod.ZodOptional<zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
     }>>;
     interval: zod.ZodOptional<zod.ZodEnum<{
         none: "none";

package/dist/canopy/v1/generated/validators/quoteItemInput.zod.js

@@ -31,8 +31,10 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+import { PriceType } from "./priceType.zod.js";
 import { ProductID } from "./productID.zod.js";
 import { TerminationPolicy } from "./terminationPolicy.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const quoteItemInputPriceLookupKeyMax = 128;
 export const quoteItemInputPlanLookupKeyMax = 128;
 export const quoteItemInputQuantityRegExp = new RegExp("^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$");
@@ -44,23 +46,21 @@ export const QuoteItemInput = zod
     price_id: zod.uuid().optional(),
     product_id: ProductID.optional(),
     plan_id: zod.uuid().optional(),
-    price_type: zod
-        .enum(["postpaid", "prepaid", "one_time"])
-        .optional()
-        .describe("Narrows the selection when a plan offers more than one charge type."),
+    price_type: PriceType.optional().describe("Narrows the selection when a plan offers more than one price type."),
+    usage_type: UsageType.optional().describe("Narrows the selection when a plan offers more than one usage type."),
     interval: zod.enum(["none", "day", "month", "year"]).optional(),
     interval_count: zod.int().min(1).optional(),
-    termination_policy: TerminationPolicy.optional().describe("Selects among prepaid prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily."),
+    termination_policy: TerminationPolicy.optional().describe("Selects among licensed prices with otherwise identical billing terms. Ambiguous terms are refused instead of choosing a price arbitrarily."),
     quantity: zod.string().regex(quoteItemInputQuantityRegExp),
     meter_id: zod.uuid().optional(),
     meter_lookup_key: zod.string().min(1).max(quoteItemInputMeterLookupKeyMax).optional(),
     dimensions: zod
         .record(zod.string(), zod.string())
         .optional()
-        .describe("The attributes the price depends on — region, instance type, token class.\n\nRequired when the price draws its rates from a price list, which is how anything\nsold by region or by machine type is priced. A price that carries a single unit\namount, or a ladder, has no attributes to give and takes none.\n\nEvery attribute the meter declares must be present. A combination with no rate\ncovering it is refused rather than priced at zero."),
+        .describe("The dimension values the rate depends on, such as region, instance type or token kind: those of the usage for a metered estimate, and those of what is bought for a licensed price on a rate card. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused rather than priced at zero."),
     duration_seconds: zod
         .int()
         .optional()
-        .describe('For metered items, how long to price for. This allows an estimate such as "about\nthis much per month" to be shown before anything exists. The priced quantity is\n`quantity` multiplied by this duration.'),
+        .describe("For a metered estimate, how long to price for, in seconds; the priced quantity is `quantity` times this duration."),
 })
-    .describe("Identify a price directly, or select a price for a plan. For each resource give its ID or lookup\nkey, never both. Lookup keys require product_id. Meter, dimensions or duration_seconds request a\npostpaid usage estimate. Such an estimate cannot be combined with a promotion code or treated as a\ncheckout amount. Without a usage estimate, a postpaid item includes only any setup charge.");
+    .describe("Identify a price, or select one for a plan; give each resource's ID or lookup key, never both, and product_id with lookup keys. For a metered price, a meter or duration_seconds requests a usage estimate, which cannot be combined with a promotion code and is not a checkout amount. Without one, a metered item includes only any setup charge.");

package/dist/canopy/v1/generated/validators/quoteRenewal.zod.js

@@ -48,4 +48,4 @@ export const QuoteRenewal = zod
         .default(quoteRenewalPeriodsDefault)
         .describe("How many consecutive periods to renew for."),
 })
-    .describe("Price renewing a prepaid subscription. Give `price_id`, or `interval` with\n`interval_count`, to renew for another term at the price currently sold for it. Naming\nthe current term, or giving neither, renews at the agreed amount. A term sold at several\nprices that differ in termination policy is refused with 409\n`BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` or `price_id` is given.");
+    .describe("Price renewing a licensed subscription. Give `price_id`, or `interval` with\n`interval_count`, to renew for another term at the price currently sold for it. Naming\nthe current term, or giving neither, renews at the agreed amount. A term sold at several\nprices that differ in termination policy is refused with 409\n`BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `termination_policy` or `price_id` is given.");

package/dist/canopy/v1/generated/validators/quoteRenewalResult.zod.js

@@ -40,10 +40,10 @@ export const QuoteRenewalResult = zod
     interval: zod.enum(["day", "month", "year"]),
     interval_count: zod.int(),
     periods: zod.int(),
-    amount: Money.describe("The price of the periods before the discounts the account holds. A discount the\nsubscription already carries is reflected here. Contains tax only where the price\nitself includes it."),
+    amount: Money.describe("The price of the periods before the account's discounts, with any discount the subscription carries already reflected; includes tax only where the price does."),
     discount_amount: Money.describe("The reduction from a discount the account holds."),
     tax_amount: Money.describe("Tax on the discounted amount."),
     tax_included_amount: Money.describe("The part of `tax_amount` already contained in `amount`."),
     total: Money.describe("What renewing would charge: `amount` less `discount_amount`, plus `tax_amount`, less\n`tax_included_amount`."),
 })
-    .describe("What renewing would charge. Renewing the same subscription for the same term and number\nof periods charges exactly `total`, unless prices or the discounts the account holds\nchange in between.");
+    .describe("What renewing would charge. Renewing the same subscription for the same term and periods charges exactly `total` unless prices or the account's discounts change first.");

package/dist/canopy/v1/generated/validators/quoteRequest.zod.d.ts

@@ -43,9 +43,12 @@ export declare const QuoteRequest: zod.ZodObject<{
         product_id: zod.ZodOptional<zod.ZodString>;
         plan_id: zod.ZodOptional<zod.ZodUUID>;
         price_type: zod.ZodOptional<zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
             one_time: "one_time";
+            recurring: "recurring";
+        }>>;
+        usage_type: zod.ZodOptional<zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
         }>>;
         interval: zod.ZodOptional<zod.ZodEnum<{
             none: "none";

package/dist/canopy/v1/generated/validators/quoteRequest.zod.js

@@ -43,25 +43,25 @@ export const QuoteRequest = zod
     billing_account_id: zod
         .int()
         .min(1)
-        .describe("The billing account to price for. It must belong to you. Existing orders must have been purchased\nwith this account; renewals and cancellations must currently be paid for by it."),
+        .describe("The billing account to price for; it must be yours. Existing orders must have been placed with it, and renewals and cancellations must currently be paid by it."),
     items: zod
         .array(QuoteItemInput)
         .min(1)
         .max(quoteRequestItemsMax)
         .optional()
-        .describe("A proposed purchase priced in the account currency. Metered items may estimate specified usage\nquantities; those estimates are not amounts collectible at checkout."),
+        .describe("A proposed purchase priced in the account's currency. Metered items may include usage estimates, which are not checkout amounts."),
     order_id: zod
         .uuid()
         .optional()
-        .describe("Preview paying this existing order. Its recorded purchase terms supply every line, and an order\nwhose terms are fixed returns its recorded amounts. A preview does not change the order."),
+        .describe("Preview paying this order. Its recorded terms supply every line, and an order whose terms are fixed returns its recorded amounts. The order does not change."),
     renewals: zod
         .array(QuoteRenewal)
         .min(1)
         .max(quoteRequestRenewalsMax)
         .optional()
-        .describe("Preview renewing these subscriptions, each at most once. Each entry represents a separate\nrenewal order. To preview a new promotion code, create a renewal order and quote it by order_id."),
+        .describe("Preview renewing these subscriptions, each at most once; each entry is a separate renewal order. To preview a promotion code, create a renewal order and quote it by order_id."),
     cancellation: QuoteCancellation.optional(),
     promotion_code: zod.string().min(1).max(quoteRequestPromotionCodeMax).optional(),
     refund: OrderRefundQuoteInput.optional(),
 })
-    .describe('"Quote exactly one target: proposed items, an existing order, renewals, a cancellation or an order\nrefund. All targets use the specified billing account. Nothing is saved, charged, reserved or\ncanceled. Promotion codes apply only to a purchase basket or an existing order. An invalid\ncombination returns BILLING_PURCHASE_INVALID with the offending field."');
+    .describe("Quote exactly one target for the billing account: proposed items, an existing order, renewals, a cancellation or an order refund. Promotion codes apply only to proposed items or an existing order. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.");

package/dist/canopy/v1/generated/validators/quotedDiscount.zod.js

@@ -43,4 +43,4 @@ export const QuotedDiscount = zod
         .nullable()
         .describe("Code text for a promotion_code discount; null for an account_discount."),
 })
-    .describe("The discount selected for this calculation. Its presence in a quote does not apply it or\nreserve a redemption. Discount amounts are reported on the quote and its lines.");
+    .describe("The discount selected for this calculation, not applied and not reserved. Amounts are on the quote and its lines.");

package/dist/canopy/v1/generated/validators/rate.zod.d.ts

@@ -43,6 +43,17 @@ export declare const Rate: zod.ZodObject<{
         per_unit: "per_unit";
         tiered: "tiered";
     }>;
+    usage_type: zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
+    }>;
+    interval: zod.ZodEnum<{
+        none: "none";
+        day: "day";
+        month: "month";
+        year: "year";
+    }>;
+    interval_count: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
     tiers_mode: zod.ZodEnum<{
         none: "none";
         graduated: "graduated";

package/dist/canopy/v1/generated/validators/rate.zod.js

@@ -31,18 +31,26 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+import { BillingScheme } from "./billingScheme.zod.js";
 import { Money } from "./money.zod.js";
 import { ObjectIdentity } from "./objectIdentity.zod.js";
 import { Tier } from "./tier.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const Rate = zod.strictObject({
     meter: ObjectIdentity,
-    unit: zod.string().optional().describe("The unit readings arrive in, such as `core-second`."),
+    unit: zod
+        .string()
+        .optional()
+        .describe("The unit readings are reported in, such as `core-second`."),
     dimensions: zod
         .record(zod.string(), zod.string())
-        .describe("The attributes this rate applies to, such as region and machine type."),
-    billing_scheme: zod
-        .enum(["per_unit", "tiered"])
-        .describe("`per_unit` multiplies `unit_amount`; `tiered` walks the tiers as `tiers_mode` says."),
+        .describe("The dimension values this rate applies to, such as region and machine type."),
+    billing_scheme: BillingScheme,
+    usage_type: UsageType.describe("`metered` prices usage; `licensed` prices holding a quantity for one period."),
+    interval: zod
+        .enum(["none", "day", "month", "year"])
+        .describe("Licensed rates only, the period the amount buys; `none` for metered rates."),
+    interval_count: zod.int().nullish(),
     tiers_mode: zod
         .enum(["none", "graduated", "volume"])
         .describe("`graduated` charges each band at its own rate; `volume` charges everything at the rate of the band the total lands in. `none` for a `per_unit` rate."),
@@ -51,7 +59,7 @@ export const Rate = zod.strictObject({
     unit_quantity: zod
         .string()
         .optional()
-        .describe('How many measured units one amount covers. An hourly rate on a per-second meter is\n`"3600"`.'),
+        .describe('How many measured units one amount covers; an hourly rate on a per-second meter is `"3600"`.'),
     currency: zod.string(),
     effective_from: zod.iso.datetime({ offset: true }),
     effective_to: zod.iso.datetime({ offset: true }).nullish(),

package/dist/canopy/v1/generated/validators/rateList.zod.d.ts

@@ -44,6 +44,17 @@ export declare const RateList: zod.ZodObject<{
             per_unit: "per_unit";
             tiered: "tiered";
         }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>;
+        interval: zod.ZodEnum<{
+            none: "none";
+            day: "day";
+            month: "month";
+            year: "year";
+        }>;
+        interval_count: zod.ZodOptional<zod.ZodNullable<zod.ZodInt>>;
         tiers_mode: zod.ZodEnum<{
             none: "none";
             graduated: "graduated";