@leaflow/sdk 0.211.0 → 0.213.1

package/dist/billing/v1/generated/validators/order.zod.js

@@ -43,12 +43,12 @@ export const Order = zod
     currency: zod.string(),
     type: zod
         .enum(["new", "renew", "modify"])
-        .describe("`new` buys, `renew` extends a licensed subscription, `modify` changes a subscription's configuration or billing terms."),
+        .describe("`new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms."),
     status: OrderStatus,
     change_effective: zod
         .enum(["none", "immediate", "period_end"])
         .optional()
-        .describe("When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the subscription renews or ends as usual."),
+        .describe("When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the item renews or ends with its subscription as usual."),
     expires_at: zod.iso
         .datetime({ offset: true })
         .nullish()

package/dist/billing/v1/generated/validators/orderItem.zod.d.ts

@@ -13,6 +13,7 @@ export declare const OrderItem: zod.ZodObject<{
     position: zod.ZodOptional<zod.ZodInt>;
     configuration: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
     subscription_id: zod.ZodOptional<zod.ZodUUID>;
+    subscription_item_id: zod.ZodOptional<zod.ZodUUID>;
     interval: zod.ZodEnum<{
         none: "none";
         day: "day";

package/dist/billing/v1/generated/validators/orderItem.zod.js

@@ -11,7 +11,7 @@ import { Money } from "./money.zod.js";
 import { OrderItemStatus } from "./orderItemStatus.zod.js";
 import { PriceType } from "./priceType.zod.js";
 import { Product } from "./product.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
 import { UsageType } from "./usageType.zod.js";
 export const orderItemPositionMin = 0;
@@ -30,7 +30,11 @@ export const OrderItem = zod
     subscription_id: zod
         .uuid()
         .optional()
-        .describe("The Billing subscription: the new pending subscription of a recurring purchase, or the existing one renewed or changed, which keeps its ID. Absent for a purchase without a subscription."),
+        .describe("The Billing subscription the line belongs to: a new pending one, the existing one an added item joins, or the one renewed or changed, which keeps its ID. Absent for a purchase without a subscription."),
+    subscription_item_id: zod
+        .uuid()
+        .optional()
+        .describe("The subscription item the line created, renewed or changed, which keeps its ID. Absent for a purchase without a subscription."),
     interval: zod.enum(["none", "day", "month", "year"]),
     interval_count: zod.int().min(1).optional(),
     cancellation_policy: CancellationPolicy.optional(),
@@ -65,7 +69,7 @@ export const OrderItem = zod
     id: zod.uuid(),
     order_id: zod.uuid().optional(),
     price_id: zod.uuid(),
-    product_id: ProductID.optional(),
+    product_id: ProductId.optional(),
     product: Product.optional(),
     plan_id: zod.uuid().describe("Which plan was bought."),
     plan_name: zod.string().describe("The name when bought."),
@@ -85,4 +89,4 @@ export const OrderItem = zod
         .describe("The end of that service period, exclusive."),
     status: OrderItemStatus,
 })
-    .describe("The purchase terms frozen at placement. Monetary fields come from the order's invoice lines and are zero without an immediate charge, such as for a metered purchase. Later catalog changes do not reprice the line. A new service purchase has its pending subscription from placement.");
+    .describe("The purchase terms frozen at placement. Monetary fields come from the order's invoice lines and are zero without an immediate charge, such as for a metered purchase. Later catalog changes do not reprice the line. A new service purchase has its pending subscription and subscription item from placement.");

package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts

@@ -13,6 +13,7 @@ export declare const OrderItemList: zod.ZodObject<{
         position: zod.ZodOptional<zod.ZodInt>;
         configuration: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
         subscription_id: zod.ZodOptional<zod.ZodUUID>;
+        subscription_item_id: zod.ZodOptional<zod.ZodUUID>;
         interval: zod.ZodEnum<{
             none: "none";
             day: "day";

package/dist/billing/v1/generated/validators/orderItemStatus.zod.js

@@ -8,4 +8,4 @@
 import * as zod from "zod";
 export const OrderItemStatus = zod
     .enum(["pending", "completed", "failed", "canceled"])
-    .describe("`pending`: waiting to be set up. `completed`: set up, as confirmed by the service. `failed`: not set up; its amount was refunded to the original payment sources. `canceled`: withdrawn without delivery; any collected amount is returned. A completed item ends when its subscription is canceled.");
+    .describe("`pending`: waiting to be set up. `completed`: set up, as confirmed by the service. `failed`: not set up; its amount was refunded to the original payment sources. `canceled`: withdrawn without delivery; any collected amount is returned. A completed item ends when its subscription item is canceled.");

package/dist/billing/v1/generated/validators/orderList.zod.d.ts

@@ -85,6 +85,7 @@ export declare const OrderList: zod.ZodObject<{
             position: zod.ZodOptional<zod.ZodInt>;
             configuration: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
             subscription_id: zod.ZodOptional<zod.ZodUUID>;
+            subscription_item_id: zod.ZodOptional<zod.ZodUUID>;
             interval: zod.ZodEnum<{
                 none: "none";
                 day: "day";

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

@@ -8,7 +8,7 @@
 import * as zod from "zod";
 import { PlanFeature } from "./planFeature.zod.js";
 import { Product } from "./product.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 export const Plan = zod.strictObject({
     active: zod
         .boolean()
@@ -17,7 +17,7 @@ export const Plan = zod.strictObject({
     product: Product,
     features: zod.array(PlanFeature),
     id: zod.uuid(),
-    product_id: ProductID,
+    product_id: ProductId,
     name: zod.string(),
     description: zod.string().optional(),
 });

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

@@ -12,7 +12,7 @@ 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 { ProductId } from "./productId.zod.js";
 import { Rate } from "./rate.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
 import { Tier } from "./tier.zod.js";
@@ -44,7 +44,7 @@ export const Price = zod.strictObject({
         .int()
         .optional()
         .describe("Refund policy `short_rate` only, how long after the period start `short_rate_multiplier` applies."),
-    product_id: ProductID.optional(),
+    product_id: ProductId.optional(),
     id: zod.uuid(),
     plan_id: zod.uuid(),
     currency: zod.string(),

package/dist/billing/v1/generated/validators/priceSearch.zod.js

@@ -7,7 +7,7 @@
  */
 import * as zod from "zod";
 import { PriceType } from "./priceType.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 import { UsageType } from "./usageType.zod.js";
 export const priceSearchCurrencyMin = 3;
 export const priceSearchCurrencyMax = 3;
@@ -35,7 +35,7 @@ export const PriceSearch = zod
         .max(priceSearchPlanIdsMax)
         .optional()
         .describe("Only prices of these plans."),
-    product_id: ProductID.optional(),
+    product_id: ProductId.optional(),
     type: PriceType.optional().describe("Narrows to one price type."),
     usage_type: UsageType.optional().describe("Narrows to one usage type."),
     dimensions: zod

package/dist/billing/v1/generated/validators/product.zod.js

@@ -6,9 +6,9 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 export const Product = zod.strictObject({
-    id: ProductID,
+    id: ProductId,
     name: zod.string(),
     description: zod.string().optional(),
 });

package/dist/billing/v1/generated/validators/{productID.zod.d.ts → productId.zod.d.ts}

@@ -6,8 +6,8 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const ProductIDMax = 64;
-export declare const ProductIDRegExp: RegExp;
-export declare const ProductID: zod.ZodString;
-export type ProductID = zod.input<typeof ProductID>;
-export type ProductIDOutput = zod.output<typeof ProductID>;
+export declare const ProductIdMax = 64;
+export declare const ProductIdRegExp: RegExp;
+export declare const ProductId: zod.ZodString;
+export type ProductId = zod.input<typeof ProductId>;
+export type ProductIdOutput = zod.output<typeof ProductId>;

package/dist/billing/v1/generated/validators/{productID.zod.js → productId.zod.js}

@@ -6,11 +6,11 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export const ProductIDMax = 64;
-export const ProductIDRegExp = new RegExp("^[a-z][a-z0-9]*(-[a-z0-9]+)*$");
-export const ProductID = zod
+export const ProductIdMax = 64;
+export const ProductIdRegExp = new RegExp("^[a-z][a-z0-9]*(-[a-z0-9]+)*$");
+export const ProductId = zod
     .string()
     .min(1)
-    .max(ProductIDMax)
-    .regex(ProductIDRegExp)
+    .max(ProductIdMax)
+    .regex(ProductIdRegExp)
     .describe("The platform service's fixed identifier, such as compute, canopy or assistant.");

package/dist/billing/v1/generated/validators/quote.zod.d.ts

@@ -41,6 +41,7 @@ export declare const Quote: zod.ZodObject<{
         tax_included_amount: zod.ZodString;
         index: zod.ZodInt;
         subscription_id: zod.ZodNullable<zod.ZodUUID>;
+        subscription_item_id: zod.ZodNullable<zod.ZodUUID>;
         product_id: zod.ZodString;
         plan_id: zod.ZodUUID;
         price_id: zod.ZodUUID;
@@ -79,7 +80,13 @@ export declare const Quote: zod.ZodObject<{
     renewals: zod.ZodArray<zod.ZodObject<{
         index: zod.ZodInt;
         subscription_id: zod.ZodUUID;
-        price_id: zod.ZodUUID;
+        items: zod.ZodArray<zod.ZodObject<{
+            subscription_item_id: zod.ZodUUID;
+            plan_id: zod.ZodUUID;
+            plan_name: zod.ZodString;
+            price_id: zod.ZodUUID;
+            amount: zod.ZodString;
+        }, zod.z.core.$strict>>;
         interval: zod.ZodEnum<{
             day: "day";
             month: "month";

package/dist/billing/v1/generated/validators/quote.zod.js

@@ -29,7 +29,7 @@ export const Quote = zod
     proration_date: zod.iso
         .datetime({ offset: true })
         .nullable()
-        .describe("Immediate changes only; null otherwise. The instant the change is priced from; pass it when confirming the Checkout Session so it is priced from the same instant."),
+        .describe("Immediate changes and items added to an existing subscription only; null otherwise. The instant they are priced from; pass it when confirming the Checkout Session so it is priced from the same instant."),
     tax_status: zod
         .enum(["complete", "requires_location_inputs"])
         .describe("`complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included."),

package/dist/billing/v1/generated/validators/quoteChangeInput.zod.d.ts

@@ -10,7 +10,7 @@ export declare const quoteChangeInputPriceLookupKeyMax = 128;
 export declare const quoteChangeInputPlanLookupKeyMax = 128;
 export declare const quoteChangeInputQuantityRegExp: RegExp;
 export declare const QuoteChangeInput: zod.ZodObject<{
-    subscription_id: zod.ZodUUID;
+    subscription_item_id: zod.ZodUUID;
     price_lookup_key: zod.ZodOptional<zod.ZodString>;
     plan_lookup_key: zod.ZodOptional<zod.ZodString>;
     price_id: zod.ZodOptional<zod.ZodUUID>;

package/dist/billing/v1/generated/validators/quoteChangeInput.zod.js

@@ -8,21 +8,21 @@
 import * as zod from "zod";
 import { CancellationPolicy } from "./cancellationPolicy.zod.js";
 import { PriceType } from "./priceType.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 import { UsageType } from "./usageType.zod.js";
 export const quoteChangeInputPriceLookupKeyMax = 128;
 export const quoteChangeInputPlanLookupKeyMax = 128;
 export const quoteChangeInputQuantityRegExp = 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]))))))))))$");
 export const QuoteChangeInput = zod
     .strictObject({
-    subscription_id: zod.uuid(),
+    subscription_item_id: zod.uuid(),
     price_lookup_key: zod.string().min(1).max(quoteChangeInputPriceLookupKeyMax).optional(),
     plan_lookup_key: zod.string().min(1).max(quoteChangeInputPlanLookupKeyMax).optional(),
     price_id: zod.uuid().optional(),
-    product_id: ProductID.optional(),
+    product_id: ProductId.optional(),
     plan_id: zod.uuid().optional(),
-    price_type: PriceType.optional().describe("Selects the price type instead of keeping the subscription's."),
-    usage_type: UsageType.optional().describe("Selects the usage type instead of keeping the subscription's."),
+    price_type: PriceType.optional().describe("Selects the price type instead of keeping the item's."),
+    usage_type: UsageType.optional().describe("Selects the usage type instead of keeping the item's."),
     interval: zod.enum(["none", "day", "month", "year"]).optional(),
     interval_count: zod.int().min(1).optional(),
     cancellation_policy: CancellationPolicy.optional().describe("Selects among licensed prices with otherwise identical billing terms."),
@@ -33,6 +33,6 @@ export const QuoteChangeInput = zod
     dimensions: zod
         .record(zod.string(), zod.string())
         .optional()
-        .describe("The dimension values after the change, given in full; omit to keep the subscription's."),
+        .describe("The dimension values after the change, given in full; omit to keep the item's."),
 })
-    .describe("The new terms of one subscription. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the subscription's price type, usage type, interval, interval count and cancellation policy is selected. Omitted dimensions keep the subscription's.");
+    .describe("The new terms of one subscription item. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the item's price type, usage type, interval, interval count and cancellation policy is selected. Omitted dimensions keep the item's.");

package/dist/billing/v1/generated/validators/quoteDowngradeRefund.zod.js

@@ -10,6 +10,6 @@ import { Money } from "./money.zod.js";
 export const QuoteDowngradeRefund = zod
     .strictObject({
     refundable_amount: Money.describe("Returned to the original payment sources, tax paid on it included."),
-    forfeited_amount: Money.describe("Before tax, the part of the excess that the subscription's refund terms do not return."),
+    forfeited_amount: Money.describe("Before tax, the part of the excess that the item's refund terms do not return."),
 })
     .describe("What an immediate downgrade would refund, estimated as of `proration_date`. The refund itself is determined when the change takes effect.");

package/dist/billing/v1/generated/validators/quoteItem.zod.d.ts

@@ -12,6 +12,7 @@ export declare const QuoteItem: zod.ZodObject<{
     tax_included_amount: zod.ZodString;
     index: zod.ZodInt;
     subscription_id: zod.ZodNullable<zod.ZodUUID>;
+    subscription_item_id: zod.ZodNullable<zod.ZodUUID>;
     product_id: zod.ZodString;
     plan_id: zod.ZodUUID;
     price_id: zod.ZodUUID;

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

@@ -8,7 +8,7 @@
 import * as zod from "zod";
 import { Money } from "./money.zod.js";
 import { PriceType } from "./priceType.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 import { QuoteDowngradeRefund } from "./quoteDowngradeRefund.zod.js";
 import { UsageType } from "./usageType.zod.js";
 export const quoteItemIndexMin = 0;
@@ -23,8 +23,12 @@ export const QuoteItem = zod
     subscription_id: zod
         .uuid()
         .nullable()
-        .describe("The subscription changed; null for a new purchase."),
-    product_id: ProductID,
+        .describe("The subscription the line belongs to when it changes an item or is added to an existing subscription; null when it opens a new one."),
+    subscription_item_id: zod
+        .uuid()
+        .nullable()
+        .describe("The subscription item changed; null for a new line."),
+    product_id: ProductId,
     plan_id: zod.uuid(),
     price_id: zod
         .uuid()

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

@@ -36,6 +36,7 @@ export declare const QuoteItemInput: zod.ZodObject<{
     }>>;
     quantity: zod.ZodString;
     dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+    subscription_id: zod.ZodOptional<zod.ZodUUID>;
 }, zod.z.core.$strict>;
 export type QuoteItemInput = zod.input<typeof QuoteItemInput>;
 export type QuoteItemInputOutput = zod.output<typeof QuoteItemInput>;

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

@@ -8,7 +8,7 @@
 import * as zod from "zod";
 import { CancellationPolicy } from "./cancellationPolicy.zod.js";
 import { PriceType } from "./priceType.zod.js";
-import { ProductID } from "./productID.zod.js";
+import { ProductId } from "./productId.zod.js";
 import { UsageType } from "./usageType.zod.js";
 export const quoteItemInputPriceLookupKeyMax = 128;
 export const quoteItemInputPlanLookupKeyMax = 128;
@@ -18,7 +18,7 @@ export const QuoteItemInput = zod
     price_lookup_key: zod.string().min(1).max(quoteItemInputPriceLookupKeyMax).optional(),
     plan_lookup_key: zod.string().min(1).max(quoteItemInputPlanLookupKeyMax).optional(),
     price_id: zod.uuid().optional(),
-    product_id: ProductID.optional(),
+    product_id: ProductId.optional(),
     plan_id: zod.uuid().optional(),
     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."),
@@ -30,5 +30,9 @@ export const QuoteItemInput = zod
         .record(zod.string(), zod.string())
         .optional()
         .describe("The dimension values of what is bought, such as region and instance type. 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 with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to."),
+    subscription_id: zod
+        .uuid()
+        .optional()
+        .describe("Price the line as a new item added to this existing subscription, as the owning service adds it when buying for a resource the subscription pays for. Needs `billing_account_id`, which must currently pay for the subscription. A licensed line is priced up to the subscription's `current_term_end`, the rest of the current period in proportion to the time left from `proration_date`, and must have the subscription's interval and interval count; a metered line has no immediate charge; added to a trialing subscription, the line is free until the trial ends."),
 })
     .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. A metered item includes only any setup charge; its usage is estimated with `estimate-usage`.");

package/dist/billing/v1/generated/validators/quoteRenewal.zod.d.ts

@@ -10,7 +10,6 @@ export declare const quoteRenewalPeriodsDefault = 1;
 export declare const quoteRenewalPeriodsMax = 100;
 export declare const QuoteRenewal: zod.ZodObject<{
     subscription_id: zod.ZodUUID;
-    price_id: zod.ZodOptional<zod.ZodUUID>;
     interval: zod.ZodOptional<zod.ZodEnum<{
         day: "day";
         month: "month";

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

@@ -12,10 +12,9 @@ export const quoteRenewalPeriodsMax = 100;
 export const QuoteRenewal = zod
     .strictObject({
     subscription_id: zod.uuid(),
-    price_id: zod.uuid().optional(),
     interval: zod.enum(["day", "month", "year"]).optional(),
     interval_count: zod.int().min(1).optional(),
-    cancellation_policy: CancellationPolicy.optional().describe("With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy."),
+    cancellation_policy: CancellationPolicy.optional().describe("With `interval` and `interval_count`, renews every item at its price of that term with this cancellation policy."),
     periods: zod
         .int()
         .min(1)
@@ -23,4 +22,4 @@ export const QuoteRenewal = zod
         .default(quoteRenewalPeriodsDefault)
         .describe("How many consecutive periods to renew for."),
 })
-    .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 cancellation policy is refused with 409\n`BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` or `price_id` is given.");
+    .describe("Price renewing a whole subscription: every continuing licensed item. Give `interval` with\n`interval_count` to renew for another term at the price each item currently sells it for, with\nits own cancellation policy or the only price of that term. Naming the current term, or giving\nneither, renews every item at its agreed amount. A term an item does not sell is refused with\n409 `BILLING_RENEWAL_PRICE_UNAVAILABLE` and `meta.subscription_item_id`; prices the rule cannot\nchoose between, with 409 `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.");

package/dist/billing/v1/generated/validators/quoteRenewalItem.zod.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, quote purchases, changes and renewals, preview cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const QuoteRenewalItem: zod.ZodObject<{
+    subscription_item_id: zod.ZodUUID;
+    plan_id: zod.ZodUUID;
+    plan_name: zod.ZodString;
+    price_id: zod.ZodUUID;
+    amount: zod.ZodString;
+}, zod.z.core.$strict>;
+export type QuoteRenewalItem = zod.input<typeof QuoteRenewalItem>;
+export type QuoteRenewalItemOutput = zod.output<typeof QuoteRenewalItem>;

package/dist/billing/v1/generated/validators/quoteRenewalItem.zod.js

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Operations on a billing account require an account access token. The account, its balance, payment options and quotes are also readable by members of the projects it currently pays for; changing the account and moving its funds need the owner. Members of a project, as each operation states, can also read the project's billing account, subscriptions and orders, complete and pay for its purchases, quote purchases, changes and renewals, preview cancellations, and, with the project permission `billing:finance.manage` granted in IAM, renew, cancel and turn automatic renewal of its subscriptions on or off, change its billing account and read its costs. A member without the permission an operation needs is refused with 403 `PERMISSION_DENIED` and `meta.permission`; a caller who is not a member, with 403 `IAM_NOT_PROJECT_MEMBER`. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+export const QuoteRenewalItem = zod
+    .strictObject({
+    subscription_item_id: zod.uuid(),
+    plan_id: zod.uuid(),
+    plan_name: zod.string(),
+    price_id: zod.uuid().describe("The price the item is charged under."),
+    amount: Money.describe("The price of the periods for this item before the account's discounts."),
+})
+    .describe("One item of a quoted renewal.");

package/dist/billing/v1/generated/validators/quoteRenewalResult.zod.d.ts

@@ -9,7 +9,13 @@ import * as zod from "zod";
 export declare const QuoteRenewalResult: zod.ZodObject<{
     index: zod.ZodInt;
     subscription_id: zod.ZodUUID;
-    price_id: zod.ZodUUID;
+    items: zod.ZodArray<zod.ZodObject<{
+        subscription_item_id: zod.ZodUUID;
+        plan_id: zod.ZodUUID;
+        plan_name: zod.ZodString;
+        price_id: zod.ZodUUID;
+        amount: zod.ZodString;
+    }, zod.z.core.$strict>>;
     interval: zod.ZodEnum<{
         day: "day";
         month: "month";

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

@@ -7,18 +7,21 @@
  */
 import * as zod from "zod";
 import { Money } from "./money.zod.js";
+import { QuoteRenewalItem } from "./quoteRenewalItem.zod.js";
 export const QuoteRenewalResult = zod
     .strictObject({
     index: zod.int().describe("Which renewal of the request this answers."),
     subscription_id: zod.uuid(),
-    price_id: zod.uuid().describe("The price the renewal is charged under."),
+    items: zod
+        .array(QuoteRenewalItem)
+        .describe("Each item the renewal covers, with the price it is charged under."),
     interval: zod.enum(["day", "month", "year"]),
     interval_count: zod.int(),
     periods: zod.int(),
-    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."),
+    amount: Money.describe("The price of the periods for every item before the account's discounts, with any discount the items carry 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 periods charges exactly `total` unless prices or the account's discounts change first.");
+    .describe("What renewing one subscription would charge as part of the quoted renewal order.");

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

@@ -42,10 +42,10 @@ export declare const QuoteRequest: zod.ZodObject<{
         }>>;
         quantity: zod.ZodString;
         dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        subscription_id: zod.ZodOptional<zod.ZodUUID>;
     }, zod.z.core.$strict>>>;
     renewals: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         subscription_id: zod.ZodUUID;
-        price_id: zod.ZodOptional<zod.ZodUUID>;
         interval: zod.ZodOptional<zod.ZodEnum<{
             day: "day";
             month: "month";
@@ -59,7 +59,7 @@ export declare const QuoteRequest: zod.ZodObject<{
         periods: zod.ZodDefault<zod.ZodInt>;
     }, zod.z.core.$strict>>>;
     changes: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
-        subscription_id: zod.ZodUUID;
+        subscription_item_id: zod.ZodUUID;
         price_lookup_key: zod.ZodOptional<zod.ZodString>;
         plan_lookup_key: zod.ZodOptional<zod.ZodString>;
         price_id: zod.ZodOptional<zod.ZodUUID>;

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

@@ -40,13 +40,13 @@ export const QuoteRequest = zod
         .min(1)
         .max(quoteRequestRenewalsMax)
         .optional()
-        .describe("Preview renewing these subscriptions, each at most once; each entry is a separate renewal order. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project. To apply a promotion code, create a renewal Checkout Session and quote it."),
+        .describe("Preview renewing these subscriptions together in one renewal order, as a renewal Checkout Session does, each at most once; `total` is that order's. Each must currently be paid by `billing_account_id`, be yours to read as the owner of that account or a member of the subscription's project, and all must belong to the same project and service. To apply a promotion code, create a renewal Checkout Session and quote it."),
     changes: zod
         .array(QuoteChangeInput)
         .min(1)
         .max(quoteRequestChangesMax)
         .optional()
-        .describe("Preview changing these subscriptions in one order, each at most once. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project; all must belong to the same project, or all to no project."),
+        .describe("Preview changing these subscription items in one order, each at most once. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project; all must belong to the same project, or all to no project."),
     change_effective: zod
         .enum(["immediate", "period_end"])
         .optional()
@@ -54,4 +54,4 @@ export const QuoteRequest = zod
     address: QuoteAddress.optional().describe("Only with `currency`. Where the customer is, to include the tax that would be added there for a customer who is not tax exempt; `tax_status` is then `complete`. Refused with `billing_account_id`, whose invoice contact decides tax."),
     promotion_code: zod.string().min(1).max(quoteRequestPromotionCodeMax).optional(),
 })
-    .describe("Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes and renewals need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.");
+    .describe("Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes, renewals and items added to an existing subscription need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.");

package/dist/billing/v1/generated/validators/refundReason.zod.js

@@ -20,4 +20,4 @@ export const RefundReason = zod
     "payment_not_applied",
     "operator",
 ])
-    .describe("Why the refund was made. New codes may be added; treat an unknown code as unspecified.\n\n- `provisioning_failed`: the purchase could not be delivered.\n- `order_expired`: the order expired after part of it was paid.\n- `order_canceled`: the order was canceled after part of it was paid.\n- `change_canceled`: a scheduled change was withdrawn after part of it was paid.\n- `change_expired`: a scheduled change could not take effect in time.\n- `subscription_canceled`: the unused value of a canceled subscription, under its refund terms.\n- `future_period_canceled`: a renewal that had not started was withdrawn.\n- `downgrade_difference`: after a downgrade, the remaining paid value, valued under each paid period's refund\n  policy and as `prorated` where that policy is `none`, minus the new configuration's value for the remaining\n  time: each whole month at the change item's `monthly_list_amount` and the remainder in proportion to the\n  length of the month it falls in, or without `monthly_list_amount`, the new period price in proportion to the\n  remaining time.\n- `usage_true_up`: usage priced over the whole month cost less than was charged.\n- `payment_not_applied`: a payment arrived after its invoice could no longer be paid.\n- `operator`: made by the platform operator.");
+    .describe("Why the refund was made. New codes may be added; treat an unknown code as unspecified.\n\n- `provisioning_failed`: the purchase could not be delivered.\n- `order_expired`: the order expired after part of it was paid.\n- `order_canceled`: the order was canceled after part of it was paid.\n- `change_canceled`: a scheduled change was withdrawn after part of it was paid.\n- `change_expired`: a scheduled change could not take effect in time.\n- `subscription_canceled`: the unused value of a canceled subscription item, under its refund terms.\n- `future_period_canceled`: a renewal that had not started was withdrawn.\n- `downgrade_difference`: after a downgrade, the remaining paid value, valued under each paid period's refund\n  policy and as `prorated` where that policy is `none`, minus the new configuration's value for the remaining\n  time: each whole month at the change item's `monthly_list_amount` and the remainder in proportion to the\n  length of the month it falls in, or without `monthly_list_amount`, the new period price in proportion to the\n  remaining time.\n- `usage_true_up`: usage priced over the whole month cost less than was charged.\n- `payment_not_applied`: a payment arrived after its invoice could no longer be paid.\n- `operator`: made by the platform operator.");

package/dist/billing/v1/generated/validators/renewRequest.zod.js

@@ -18,17 +18,17 @@ export const RenewRequest = zod.strictObject({
         .int()
         .min(1)
         .default(renewRequestPeriodsDefault)
-        .describe("How many further periods to buy, each at the price the subscription already renews at. To buy a longer term at its own price, give `interval` and `interval_count` instead."),
+        .describe("How many further periods to buy for every renewed item, each at the price it already renews at. To buy a longer term at its own price, give `interval` and `interval_count` instead."),
     interval_count: zod
         .int()
         .min(1)
         .optional()
-        .describe("Renew for a term of this length instead, at the price currently sold for it. Give\n`interval` with it.\n\nLeaving both out renews at the price this item already bills at, which a later price\nchange does not affect. Naming a term that differs from the current one is a fresh\nchoice, so it is bought at today's price. Naming the current term changes nothing. A\nterm sold at several prices that differ in cancellation policy is refused with 409\n`BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.\n\nList the terms on offer with the renewal prices operation."),
+        .describe("Renew for a term of this length instead, at the price currently sold for it. Give\n`interval` with it.\n\nLeaving both out renews every item at the price it already bills at, which a later price\nchange does not affect. Naming a term that differs from the current one is a fresh\nchoice, so every item is bought at today's price for that term, with its own cancellation\npolicy or, without one, the only price of that term. Naming the current term changes\nnothing. A term an item does not sell is refused with 409 `BILLING_RENEWAL_PRICE_UNAVAILABLE`\nand `meta.subscription_item_id`; prices the rule cannot choose between, with 409\n`BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.\n\nList the terms on offer with the renewal options operation."),
     interval: zod
         .enum(["day", "month", "year"])
         .optional()
         .describe("The unit interval_count counts in."),
-    cancellation_policy: CancellationPolicy.optional().describe("With `interval` and `interval_count`, chooses among prices of that term that differ in cancellation policy."),
+    cancellation_policy: CancellationPolicy.optional().describe("With `interval` and `interval_count`, renews every item at its price of that term with this cancellation policy."),
     payment_method_id: zod.uuid().optional(),
     use_balance: zod
         .boolean()

package/dist/billing/v1/generated/validators/{renewalPriceList.zod.d.ts → renewalOption.zod.d.ts}

@@ -6,8 +6,20 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const RenewalPriceList: zod.ZodObject<{
+export declare const RenewalOption: zod.ZodObject<{
+    interval: zod.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>;
+    interval_count: zod.ZodInt;
+    current: zod.ZodBoolean;
+    amount: zod.ZodString;
+    currency: zod.ZodString;
     items: zod.ZodArray<zod.ZodObject<{
+        subscription_item_id: zod.ZodUUID;
+        price_id: zod.ZodNullable<zod.ZodUUID>;
+        amount: zod.ZodString;
         cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
             immediate: "immediate";
             period_end: "period_end";
@@ -19,22 +31,7 @@ export declare const RenewalPriceList: zod.ZodObject<{
         }>>;
         short_rate_multiplier: zod.ZodOptional<zod.ZodString>;
         short_rate_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
-        price_id: zod.ZodUUID;
-        interval_count: zod.ZodInt;
-        interval: zod.ZodEnum<{
-            day: "day";
-            month: "month";
-            year: "year";
-        }>;
-        amount: zod.ZodOptional<zod.ZodString>;
-        currency: zod.ZodOptional<zod.ZodString>;
-        current: zod.ZodBoolean;
     }, zod.z.core.$strict>>;
-    pagination: zod.ZodObject<{
-        page: zod.ZodInt;
-        page_size: zod.ZodInt;
-        total_count: zod.ZodOptional<zod.ZodInt>;
-    }, zod.z.core.$strict>;
 }, zod.z.core.$strict>;
-export type RenewalPriceList = zod.input<typeof RenewalPriceList>;
-export type RenewalPriceListOutput = zod.output<typeof RenewalPriceList>;
+export type RenewalOption = zod.input<typeof RenewalOption>;
+export type RenewalOptionOutput = zod.output<typeof RenewalOption>;