@leaflow/sdk 0.154.0 → 0.155.0

package/dist/billing/type/checkout/v1/generated/models.d.ts

@@ -6,13 +6,13 @@
  * OpenAPI spec version: v1
  */
 /**
- * automatic applies the best applicable account discount, issues the invoice and pays it from eligible
- * credit grants and available balance at placement. Insufficient funds fail the purchase with HTTP 422
- * BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or discount redemption is committed.
- * deferred places the order with a draft invoice at base prices and collects nothing. Paying that
- * invoice through Billing applies a promotion code or the best applicable account discount, issues the
- * invoice and collects it; an order still unpaid at its deadline expires. A zero-total invoice is issued
- * and paid at placement in either mode.
+ * automatic completes checkout with the purchase: the best applicable account discount is applied, and the
+ * order is created with its invoice issued and paid from eligible credit grants and available balance.
+ * Insufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or
+ * discount redemption is committed.
+ * deferred creates an open Billing Checkout Session and charges nothing, even for a zero total. The customer
+ * completes it through Billing, where a promotion code can be applied, and then pays the issued invoice; a
+ * session not completed by its deadline expires.
  */
 export type CheckoutMode = (typeof CheckoutMode)[keyof typeof CheckoutMode];
 export declare const CheckoutMode: {
@@ -32,10 +32,11 @@ export declare const CheckoutMode: {
  */
 export type Money = string;
 /**
- * Shared checkout choices for a product purchase. Omitting this object or mode selects
- * automatic checkout. Each purchase creates its own order. Promotion codes are supplied only to
- * Billing quote and payment operations. A service may retain a failed creation record when Billing
- * refuses a purchase; no infrastructure is created for that refusal.
+ * Shared checkout choices for a product purchase. The service may set them or forward its client's
+ * choices unchanged; it does not need to read them, and Billing validates them. Omitting this object or
+ * mode selects automatic checkout. Each purchase creates its own Checkout Session. Promotion codes are supplied
+ * only to Billing. A service may retain a failed creation record when Billing refuses a purchase; no
+ * infrastructure is created for that refusal.
  */
 export interface CheckoutOptions {
     mode?: CheckoutMode;
@@ -43,7 +44,14 @@ export interface CheckoutOptions {
      * Expected invoice total after discounts and tax, before applying credit grants or balance.
      * A different total fails with BILLING_AMOUNT_CHANGED without charging or reserving a discount.
      * Accepted only in automatic mode; with deferred it is refused with HTTP 400. For deferred
-     * checkout, give the expected amount when paying the invoice through Billing.
+     * checkout, give the expected amount when completing it through Billing.
      */
     expected_amount?: Money & string;
+    /**
+     * Where the client goes after the customer finishes a deferred checkout. Any absolute URI with a
+     * scheme, including mobile and desktop application schemes. Billing stores it without checking the
+     * target; each client validates its own.
+     * @maxLength 2048
+     */
+    return_url?: string;
 }

package/dist/billing/type/checkout/v1/generated/validators/checkoutMode.zod.js

@@ -8,4 +8,4 @@
 import * as zod from "zod";
 export const CheckoutMode = zod
     .enum(["automatic", "deferred"])
-    .describe("automatic applies the best applicable account discount, issues the invoice and pays it from eligible\ncredit grants and available balance at placement. Insufficient funds fail the purchase with HTTP 422\nBILLING_INSUFFICIENT_FUNDS; no Billing order, charge or discount redemption is committed.\ndeferred places the order with a draft invoice at base prices and collects nothing. Paying that\ninvoice through Billing applies a promotion code or the best applicable account discount, issues the\ninvoice and collects it; an order still unpaid at its deadline expires. A zero-total invoice is issued\nand paid at placement in either mode.");
+    .describe("automatic completes checkout with the purchase: the best applicable account discount is applied, and the\norder is created with its invoice issued and paid from eligible credit grants and available balance.\nInsufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or\ndiscount redemption is committed.\ndeferred creates an open Billing Checkout Session and charges nothing, even for a zero total. The customer\ncompletes it through Billing, where a promotion code can be applied, and then pays the issued invoice; a\nsession not completed by its deadline expires.");

package/dist/billing/type/checkout/v1/generated/validators/checkoutOptions.zod.d.ts

@@ -8,12 +8,14 @@
 import * as zod from "zod";
 export declare const checkoutOptionsModeDefault = "automatic";
 export declare const checkoutOptionsExpectedAmountTwoRegExp: RegExp;
+export declare const checkoutOptionsReturnUrlMax = 2048;
 export declare const CheckoutOptions: zod.ZodObject<{
     mode: zod.ZodDefault<zod.ZodEnum<{
         automatic: "automatic";
         deferred: "deferred";
     }>>;
     expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+    return_url: zod.ZodOptional<zod.ZodURL>;
 }, zod.z.core.$strict>;
 export type CheckoutOptions = zod.input<typeof CheckoutOptions>;
 export type CheckoutOptionsOutput = zod.output<typeof CheckoutOptions>;

package/dist/billing/type/checkout/v1/generated/validators/checkoutOptions.zod.js

@@ -10,11 +10,17 @@ import { CheckoutMode } from "./checkoutMode.zod.js";
 import { Money } from "./money.zod.js";
 export const checkoutOptionsModeDefault = `automatic`;
 export const checkoutOptionsExpectedAmountTwoRegExp = new RegExp("^[0-9]{1,15}([.][0-9]{1,10})?$");
+export const checkoutOptionsReturnUrlMax = 2048;
 export const CheckoutOptions = zod
     .strictObject({
     mode: CheckoutMode.default(checkoutOptionsModeDefault),
     expected_amount: Money.and(zod.string().regex(checkoutOptionsExpectedAmountTwoRegExp))
         .optional()
-        .describe("Expected invoice total after discounts and tax, before applying credit grants or balance.\nA different total fails with BILLING_AMOUNT_CHANGED without charging or reserving a discount.\nAccepted only in automatic mode; with deferred it is refused with HTTP 400. For deferred\ncheckout, give the expected amount when paying the invoice through Billing."),
+        .describe("Expected invoice total after discounts and tax, before applying credit grants or balance.\nA different total fails with BILLING_AMOUNT_CHANGED without charging or reserving a discount.\nAccepted only in automatic mode; with deferred it is refused with HTTP 400. For deferred\ncheckout, give the expected amount when completing it through Billing."),
+    return_url: zod
+        .url()
+        .max(checkoutOptionsReturnUrlMax)
+        .optional()
+        .describe("Where the client goes after the customer finishes a deferred checkout. Any absolute URI with a\nscheme, including mobile and desktop application schemes. Billing stores it without checking the\ntarget; each client validates its own."),
 })
-    .describe("Shared checkout choices for a product purchase. Omitting this object or mode selects\nautomatic checkout. Each purchase creates its own order. Promotion codes are supplied only to\nBilling quote and payment operations. A service may retain a failed creation record when Billing\nrefuses a purchase; no infrastructure is created for that refusal.");
+    .describe("Shared checkout choices for a product purchase. The service may set them or forward its client's\nchoices unchanged; it does not need to read them, and Billing validates them. Omitting this object or\nmode selects automatic checkout. Each purchase creates its own Checkout Session. Promotion codes are supplied\nonly to Billing. A service may retain a failed creation record when Billing refuses a purchase; no\ninfrastructure is created for that refusal.");

package/dist/billing/type/order/v1/generated/validators/invoice.zod.d.ts

@@ -28,8 +28,8 @@ export declare const Invoice: zod.ZodObject<{
     status: zod.ZodEnum<{
         void: "void";
         open: "open";
-        draft: "draft";
         paid: "paid";
+        draft: "draft";
     }>;
     subtotal: zod.ZodOptional<zod.ZodString>;
     discount_amount: zod.ZodOptional<zod.ZodString>;

package/dist/billing/type/order/v1/generated/validators/invoiceList.zod.d.ts

@@ -29,8 +29,8 @@ export declare const InvoiceList: zod.ZodObject<{
         status: zod.ZodEnum<{
             void: "void";
             open: "open";
-            draft: "draft";
             paid: "paid";
+            draft: "draft";
         }>;
         subtotal: zod.ZodOptional<zod.ZodString>;
         discount_amount: zod.ZodOptional<zod.ZodString>;

package/dist/billing/type/order/v1/generated/validators/invoiceStatus.zod.d.ts

@@ -9,8 +9,8 @@ import * as zod from "zod";
 export declare const InvoiceStatus: zod.ZodEnum<{
     void: "void";
     open: "open";
-    draft: "draft";
     paid: "paid";
+    draft: "draft";
 }>;
 export type InvoiceStatus = zod.input<typeof InvoiceStatus>;
 export type InvoiceStatusOutput = zod.output<typeof InvoiceStatus>;

package/dist/billing/type/order/v1/generated/validators/invoiceSummary.zod.d.ts

@@ -14,8 +14,8 @@ export declare const InvoiceSummary: zod.ZodObject<{
     status: zod.ZodEnum<{
         void: "void";
         open: "open";
-        draft: "draft";
         paid: "paid";
+        draft: "draft";
     }>;
     subtotal: zod.ZodString;
     discount_amount: zod.ZodString;

package/dist/billing/type/order/v1/generated/validators/order.zod.d.ts

@@ -23,8 +23,8 @@ export declare const Order: zod.ZodObject<{
         status: zod.ZodEnum<{
             void: "void";
             open: "open";
-            draft: "draft";
             paid: "paid";
+            draft: "draft";
         }>;
         subtotal: zod.ZodString;
         discount_amount: zod.ZodString;

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

@@ -24,8 +24,8 @@ export declare const OrderList: zod.ZodObject<{
             status: zod.ZodEnum<{
                 void: "void";
                 open: "open";
-                draft: "draft";
                 paid: "paid";
+                draft: "draft";
             }>;
             subtotal: zod.ZodString;
             discount_amount: zod.ZodString;

package/dist/billing/type/order/v1/generated/validators/placedOrder.zod.d.ts

@@ -16,8 +16,8 @@ export declare const PlacedOrder: zod.ZodObject<{
         status: zod.ZodEnum<{
             void: "void";
             open: "open";
-            draft: "draft";
             paid: "paid";
+            draft: "draft";
         }>;
         subtotal: zod.ZodString;
         discount_amount: zod.ZodString;

package/dist/billing/type/quote/v1/generated/models.d.ts

@@ -5,6 +5,14 @@
  * Price previews returned before purchase confirmation. Types only; this document declares no operations.
  * OpenAPI spec version: v1
  */
+/**
+ * `complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without a billing account, which leaves out tax that would be added; tax already contained in a price is included.
+ */
+export type QuoteTaxStatus = (typeof QuoteTaxStatus)[keyof typeof QuoteTaxStatus];
+export declare const QuoteTaxStatus: {
+    readonly complete: "complete";
+    readonly requires_location_inputs: "requires_location_inputs";
+};
 /**
  * A decimal string, in the currency stated alongside it.
  *
@@ -36,13 +44,73 @@ export interface Funds {
     /** Minimum recharge that covers the shortfall, respecting the currency minimum recharge and currency precision. Zero when no additional balance is needed. */
     required_top_up_amount: Money;
 }
+/**
+ * one_time or recurring.
+ */
+export type QuoteItemType = (typeof QuoteItemType)[keyof typeof QuoteItemType];
+export declare const QuoteItemType: {
+    readonly one_time: "one_time";
+    readonly recurring: "recurring";
+};
+/**
+ * licensed or metered.
+ */
+export type QuoteItemUsageType = (typeof QuoteItemUsageType)[keyof typeof QuoteItemUsageType];
+export declare const QuoteItemUsageType: {
+    readonly licensed: "licensed";
+    readonly metered: "metered";
+};
+/**
+ * The billing period of a recurring licensed line; `none` otherwise.
+ */
+export type QuoteItemInterval = (typeof QuoteItemInterval)[keyof typeof QuoteItemInterval];
+export declare const QuoteItemInterval: {
+    readonly none: "none";
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The dimension values the line is priced at, such as region and instance type.
+ */
+export type QuoteItemDimensions = {
+    [key: string]: string;
+};
 /**
  * One calculated purchase line. Fixed purchase amounts are rounded as checkout rounds them.
  * A line without an immediate charge has zero checkout amounts. unit_amount remains null when
  * no single unit price applies; an unrequested usage estimate remains null.
  */
 export interface QuoteItem {
+    product_id: string;
+    plan_id: string;
     plan_name: string;
+    /**
+     * The price the line is priced at, including one Billing selected. With quantity and dimensions it
+     * prices the same line in Billing's own quote, for example with a promotion code.
+     */
+    price_id: string;
+    /** The dimension values the line is priced at, such as region and instance type. */
+    dimensions: QuoteItemDimensions;
+    /** one_time or recurring. */
+    type: QuoteItemType;
+    /** licensed or metered. */
+    usage_type: QuoteItemUsageType;
+    /** The billing period of a recurring licensed line; `none` otherwise. */
+    interval: QuoteItemInterval;
+    /**
+     * Periods per billing cycle of a recurring licensed line; null otherwise.
+     * @minimum 1
+     * @nullable
+     */
+    interval_count: number | null;
+    /** The setup charge already included in amount; null when none applies. */
+    setup_amount: Money | null;
+    /**
+     * Recurring licensed lines only; null otherwise. What each later period renews at, before discounts
+     * and tax, which differs from amount when the first period is priced differently.
+     */
+    recurring_amount: Money | null;
     /**
      * Unit price before discounts, with tax included only where the price includes it. Null when
      * no single unit price applies, such as tiered or multiple-rate pricing or an immediate change.
@@ -74,14 +142,18 @@ export interface QuoteItem {
 /**
  * A price preview for the purchase described by a service, calculated by Billing. Nothing is saved,
  * charged or reserved, and no discount redemption is consumed. Account discounts and tax are
- * evaluated as for automatic checkout. Promotion codes are evaluated through Billing quote operations.
+ * evaluated as for automatic checkout. Promotion codes are evaluated by Billing at checkout, not here.
  * All amounts use currency. This preview does not lock prices or guarantee discount availability.
  * Success includes complete checkout amounts and every requested usage estimate. If any item or
  * requested usage estimate cannot be calculated, the operation returns its existing structured
- * error response; it never returns a partial quote with HTTP 200.
+ * error response; it never returns a partial quote with HTTP 200. A quote without a billing account
+ * has no funds and no account discount, and leaves out tax that would be added.
  */
 export interface Quote {
-    funds: Funds;
+    /** Null for a quote without a billing account. */
+    funds: Funds | null;
+    /** `complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without a billing account, which leaves out tax that would be added; tax already contained in a price is included. */
+    tax_status: QuoteTaxStatus;
     /** One line for each item the purchase would order, in the order it would order them. */
     items: QuoteItem[];
     /**

package/dist/billing/type/quote/v1/generated/models.js

@@ -1 +1,18 @@
-export {};
+export const QuoteTaxStatus = {
+    complete: "complete",
+    requires_location_inputs: "requires_location_inputs",
+};
+export const QuoteItemType = {
+    one_time: "one_time",
+    recurring: "recurring",
+};
+export const QuoteItemUsageType = {
+    licensed: "licensed",
+    metered: "metered",
+};
+export const QuoteItemInterval = {
+    none: "none",
+    day: "day",
+    month: "month",
+    year: "year",
+};

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

@@ -7,16 +7,41 @@
  */
 import * as zod from "zod";
 export declare const Quote: zod.ZodObject<{
-    funds: zod.ZodObject<{
+    funds: zod.ZodUnion<readonly [zod.ZodObject<{
         available_balance_amount: zod.ZodString;
         usable_credit_amount: zod.ZodString;
         restricted_credit_amount: zod.ZodString;
         required_balance_amount: zod.ZodString;
         balance_shortfall_amount: zod.ZodString;
         required_top_up_amount: zod.ZodString;
-    }, zod.z.core.$strict>;
+    }, zod.z.core.$strict>, zod.ZodNull]>;
+    tax_status: zod.ZodEnum<{
+        complete: "complete";
+        requires_location_inputs: "requires_location_inputs";
+    }>;
     items: zod.ZodArray<zod.ZodObject<{
+        product_id: zod.ZodString;
+        plan_id: zod.ZodUUID;
         plan_name: zod.ZodString;
+        price_id: zod.ZodUUID;
+        dimensions: zod.ZodRecord<zod.ZodString, zod.ZodString>;
+        type: zod.ZodEnum<{
+            one_time: "one_time";
+            recurring: "recurring";
+        }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
+        }>;
+        interval: zod.ZodEnum<{
+            none: "none";
+            day: "day";
+            month: "month";
+            year: "year";
+        }>;
+        interval_count: zod.ZodNullable<zod.ZodInt>;
+        setup_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+        recurring_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
         unit_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
         quantity: zod.ZodString;
         amount: zod.ZodString;

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

@@ -11,7 +11,10 @@ import { Money } from "./money.zod.js";
 import { QuoteItem } from "./quoteItem.zod.js";
 export const Quote = zod
     .strictObject({
-    funds: Funds,
+    funds: zod.union([Funds, zod.null()]).describe("Null for a quote without a billing account."),
+    tax_status: zod
+        .enum(["complete", "requires_location_inputs"])
+        .describe("`complete`: tax is calculated for the billing account's invoice contact. `requires_location_inputs`: a quote without a billing account, which leaves out tax that would be added; tax already contained in a price is included."),
     items: zod
         .array(QuoteItem)
         .describe("One line for each item the purchase would order, in the order it would order them."),
@@ -31,4 +34,4 @@ export const Quote = zod
         .union([Money, zod.null()])
         .describe("Changes that lower the price only; null otherwise. What the change would return to the original\npayment sources, including the tax paid on it. total is zero for such a change."),
 })
-    .describe("A price preview for the purchase described by a service, calculated by Billing. Nothing is saved,\ncharged or reserved, and no discount redemption is consumed. Account discounts and tax are\nevaluated as for automatic checkout. Promotion codes are evaluated through Billing quote operations.\nAll amounts use currency. This preview does not lock prices or guarantee discount availability.\nSuccess includes complete checkout amounts and every requested usage estimate. If any item or\nrequested usage estimate cannot be calculated, the operation returns its existing structured\nerror response; it never returns a partial quote with HTTP 200.");
+    .describe("A price preview for the purchase described by a service, calculated by Billing. Nothing is saved,\ncharged or reserved, and no discount redemption is consumed. Account discounts and tax are\nevaluated as for automatic checkout. Promotion codes are evaluated by Billing at checkout, not here.\nAll amounts use currency. This preview does not lock prices or guarantee discount availability.\nSuccess includes complete checkout amounts and every requested usage estimate. If any item or\nrequested usage estimate cannot be calculated, the operation returns its existing structured\nerror response; it never returns a partial quote with HTTP 200. A quote without a billing account\nhas no funds and no account discount, and leaves out tax that would be added.");

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

@@ -7,7 +7,28 @@
  */
 import * as zod from "zod";
 export declare const QuoteItem: zod.ZodObject<{
+    product_id: zod.ZodString;
+    plan_id: zod.ZodUUID;
     plan_name: zod.ZodString;
+    price_id: zod.ZodUUID;
+    dimensions: zod.ZodRecord<zod.ZodString, zod.ZodString>;
+    type: zod.ZodEnum<{
+        one_time: "one_time";
+        recurring: "recurring";
+    }>;
+    usage_type: zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
+    }>;
+    interval: zod.ZodEnum<{
+        none: "none";
+        day: "day";
+        month: "month";
+        year: "year";
+    }>;
+    interval_count: zod.ZodNullable<zod.ZodInt>;
+    setup_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+    recurring_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
     unit_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
     quantity: zod.ZodString;
     amount: zod.ZodString;

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

@@ -9,7 +9,31 @@ import * as zod from "zod";
 import { Money } from "./money.zod.js";
 export const QuoteItem = zod
     .strictObject({
+    product_id: zod.string(),
+    plan_id: zod.uuid(),
     plan_name: zod.string(),
+    price_id: zod
+        .uuid()
+        .describe("The price the line is priced at, including one Billing selected. With quantity and dimensions it\nprices the same line in Billing's own quote, for example with a promotion code."),
+    dimensions: zod
+        .record(zod.string(), zod.string())
+        .describe("The dimension values the line is priced at, such as region and instance type."),
+    type: zod.enum(["one_time", "recurring"]).describe("one_time or recurring."),
+    usage_type: zod.enum(["licensed", "metered"]).describe("licensed or metered."),
+    interval: zod
+        .enum(["none", "day", "month", "year"])
+        .describe("The billing period of a recurring licensed line; `none` otherwise."),
+    interval_count: zod
+        .int()
+        .min(1)
+        .nullable()
+        .describe("Periods per billing cycle of a recurring licensed line; null otherwise."),
+    setup_amount: zod
+        .union([Money, zod.null()])
+        .describe("The setup charge already included in amount; null when none applies."),
+    recurring_amount: zod
+        .union([Money, zod.null()])
+        .describe("Recurring licensed lines only; null otherwise. What each later period renews at, before discounts\nand tax, which differs from amount when the first period is priced differently."),
     unit_amount: zod
         .union([Money, zod.null()])
         .describe("Unit price before discounts, with tax included only where the price includes it. Null when\nno single unit price applies, such as tiered or multiple-rate pricing or an immediate change."),