@leaflow/sdk 0.121.0 → 0.122.0

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

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const TransactionType: zod.ZodEnum<{
+    topup: "topup";
+    payment: "payment";
+    refund: "refund";
+    adjustment: "adjustment";
+}>;
+export type TransactionType = zod.input<typeof TransactionType>;
+export type TransactionTypeOutput = zod.output<typeof TransactionType>;

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

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const TransactionType = zod
+    .enum(["topup", "payment", "refund", "adjustment"])
+    .describe("topup adds to the balance; payment settles an invoice; refund returns original funds; adjustment changes the balance with an audit reason.");

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

@@ -0,0 +1,43 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const UsageCharge: zod.ZodObject<{
+    subscription_id: zod.ZodUUID;
+    id: zod.ZodUUID;
+    project_id: zod.ZodOptional<zod.ZodUUID>;
+    project: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+        id: zod.ZodUUID;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>, zod.ZodNull]>>;
+    product: zod.ZodObject<{
+        id: zod.ZodString;
+        name: zod.ZodString;
+        description: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>;
+    resource_id: zod.ZodOptional<zod.ZodString>;
+    meter: zod.ZodObject<{
+        lookup_key: zod.ZodOptional<zod.ZodString>;
+        id: zod.ZodUUID;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>;
+    unit: zod.ZodOptional<zod.ZodString>;
+    dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+    window_start: zod.z.ZodISODateTime;
+    window_end: zod.z.ZodISODateTime;
+    gross_quantity: zod.ZodOptional<zod.ZodString>;
+    deducted_quantity: zod.ZodOptional<zod.ZodString>;
+    quantity: zod.ZodString;
+    unit_amount: zod.ZodOptional<zod.ZodString>;
+    amount: zod.ZodString;
+    currency: zod.ZodString;
+    invoice_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    invoice_item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    statement_id: zod.ZodOptional<zod.ZodUUID>;
+}, zod.z.core.$strict>;
+export type UsageCharge = zod.input<typeof UsageCharge>;
+export type UsageChargeOutput = zod.output<typeof UsageCharge>;

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

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+import { NamedIdentity } from "./namedIdentity.zod.js";
+import { ObjectIdentity } from "./objectIdentity.zod.js";
+import { Product } from "./product.zod.js";
+export const UsageCharge = zod.strictObject({
+    subscription_id: zod.uuid(),
+    id: zod.uuid(),
+    project_id: zod.uuid().optional(),
+    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."),
+    product: Product,
+    resource_id: zod
+        .string()
+        .optional()
+        .describe("Which resource this was charged for. Empty for charges not tied to one."),
+    meter: ObjectIdentity,
+    unit: zod.string().optional(),
+    dimensions: zod
+        .record(zod.string(), zod.string())
+        .optional()
+        .describe("The attributes the rate was chosen by, such as region and machine type."),
+    window_start: zod.iso.datetime({ offset: true }),
+    window_end: zod.iso.datetime({ offset: true }).describe("Exclusive."),
+    gross_quantity: zod
+        .string()
+        .optional()
+        .describe("How much was used, before any included allowance."),
+    deducted_quantity: zod
+        .string()
+        .optional()
+        .describe("How much of that was covered by an allowance."),
+    quantity: zod
+        .string()
+        .describe("What was charged for — the gross quantity less the part covered."),
+    unit_amount: Money.optional(),
+    amount: Money,
+    currency: zod.string(),
+    invoice_id: zod
+        .uuid()
+        .nullish()
+        .describe("Present after the statement is closed and its invoice is issued."),
+    invoice_item_id: zod
+        .uuid()
+        .nullish()
+        .describe("Present after the statement is closed and its invoice is issued."),
+    statement_id: zod.uuid().optional().describe("The statement this charge was collected into."),
+});

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

@@ -0,0 +1,50 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const UsageChargeList: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        subscription_id: zod.ZodUUID;
+        id: zod.ZodUUID;
+        project_id: zod.ZodOptional<zod.ZodUUID>;
+        project: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>, zod.ZodNull]>>;
+        product: zod.ZodObject<{
+            id: zod.ZodString;
+            name: zod.ZodString;
+            description: zod.ZodOptional<zod.ZodString>;
+        }, zod.z.core.$strict>;
+        resource_id: zod.ZodOptional<zod.ZodString>;
+        meter: zod.ZodObject<{
+            lookup_key: zod.ZodOptional<zod.ZodString>;
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>;
+        unit: zod.ZodOptional<zod.ZodString>;
+        dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        window_start: zod.z.ZodISODateTime;
+        window_end: zod.z.ZodISODateTime;
+        gross_quantity: zod.ZodOptional<zod.ZodString>;
+        deducted_quantity: zod.ZodOptional<zod.ZodString>;
+        quantity: zod.ZodString;
+        unit_amount: zod.ZodOptional<zod.ZodString>;
+        amount: zod.ZodString;
+        currency: zod.ZodString;
+        invoice_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+        invoice_item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+        statement_id: zod.ZodOptional<zod.ZodUUID>;
+    }, 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 UsageChargeList = zod.input<typeof UsageChargeList>;
+export type UsageChargeListOutput = zod.output<typeof UsageChargeList>;

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

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Billing Order Types
+ * The Billing order a product purchase placed. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { OffsetPagination } from "./offsetPagination.zod.js";
+import { UsageCharge } from "./usageCharge.zod.js";
+export const UsageChargeList = zod.strictObject({
+    items: zod.array(UsageCharge),
+    pagination: OffsetPagination,
+});

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,98 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+/**
+ * A decimal string, in the currency stated alongside it.
+ *
+ * **The currency is not part of this type.** It is carried by a `currency` field next to the
+ * amount, or by the account the amount belongs to. Reading an amount without that field is
+ * reading a number with no unit.
+ *
+ * It is a string rather than a JSON number because a JSON number is a float in most parsers,
+ * and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+ * through a float.
+ */
+export type Money = 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 {
+    plan_name: string;
+    /**
+     * 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.
+     */
+    unit_amount: Money | null;
+    /** The quantity priced. */
+    quantity: string;
+    /**
+     * Before discounts, including any setup charges. Contains tax only where the price includes it.
+     * Zero for an item with no immediate charge.
+     */
+    amount: Money;
+    /** Total reduction on this line, including any committed recurring discount. */
+    discount_amount: Money;
+    /** Tax on the discounted amount, including any tax already contained in that amount. */
+    tax_amount: Money;
+    /** The part of tax_amount already contained in amount minus discount_amount. */
+    tax_included_amount: Money;
+    /** amount minus discount_amount plus tax_amount minus tax_included_amount. */
+    total: Money;
+    /**
+     * Projected charge for this line's future usage over the period stated by the quoting operation,
+     * at current rates, before discounts and tax and not rounded. Not part of amount or total and
+     * not collected at checkout. Null when no usage estimate is requested for this line.
+     */
+    estimated_usage_amount: Money | null;
+    currency: string;
+}
+/**
+ * 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.
+ * 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.
+ */
+export interface Quote {
+    /** One line for each item the purchase would order, in the order it would order them. */
+    items: QuoteItem[];
+    /**
+     * Sum of line amounts before discounts, less tax already included in the discounted line
+     * amounts, as on an invoice.
+     */
+    subtotal: Money;
+    /** Sum of line discounts. */
+    discount_amount: Money;
+    /** Sum of tax on the discounted line amounts. */
+    tax_amount: Money;
+    /**
+     * subtotal minus discount_amount plus tax_amount: what checkout collects, before applying
+     * credit grants or balance. Equals the sum of line totals and excludes estimated_usage_amount.
+     */
+    total: Money;
+    /**
+     * Sum of the lines' estimated_usage_amount. A projection, not part of total and not collected at
+     * checkout. Null when no usage estimate is requested.
+     */
+    estimated_usage_amount: Money | null;
+    currency: string;
+    /**
+     * Changes only; null otherwise. The instant the change is priced from. Pass it with the change so the
+     * order is priced from the same instant.
+     * @nullable
+     */
+    proration_date: string | null;
+    /**
+     * Changes that lower the price only; null otherwise. What the change would return to the original
+     * payment sources, including the tax paid on it. total is zero for such a change.
+     */
+    refundable_amount: Money | null;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,8 @@
+export {};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */

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

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const Money: zod.ZodString;
+export type Money = zod.input<typeof Money>;
+export type MoneyOutput = zod.output<typeof Money>;

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

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const Money = zod
+    .string()
+    .describe("A decimal string, in the currency stated alongside it.\n\n**The currency is not part of this type.** It is carried by a `currency` field next to the\namount, or by the account the amount belongs to. Reading an amount without that field is\nreading a number with no unit.\n\nIt is a string rather than a JSON number because a JSON number is a float in most parsers,\nand a float loses precision on the first arithmetic. Nothing on this platform puts an amount\nthrough a float.");

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

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const Quote: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        plan_name: zod.ZodString;
+        unit_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+        quantity: zod.ZodString;
+        amount: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        tax_included_amount: zod.ZodString;
+        total: zod.ZodString;
+        estimated_usage_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+        currency: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    subtotal: zod.ZodString;
+    discount_amount: zod.ZodString;
+    tax_amount: zod.ZodString;
+    total: zod.ZodString;
+    estimated_usage_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+    currency: zod.ZodString;
+    proration_date: zod.ZodNullable<zod.z.ZodISODateTime>;
+    refundable_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+}, zod.z.core.$strict>;
+export type Quote = zod.input<typeof Quote>;
+export type QuoteOutput = zod.output<typeof Quote>;

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

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+import { QuoteItem } from "./quoteItem.zod.js";
+export const Quote = zod
+    .strictObject({
+    items: zod
+        .array(QuoteItem)
+        .describe("One line for each item the purchase would order, in the order it would order them."),
+    subtotal: Money.describe("Sum of line amounts before discounts, less tax already included in the discounted line\namounts, as on an invoice."),
+    discount_amount: Money.describe("Sum of line discounts."),
+    tax_amount: Money.describe("Sum of tax on the discounted line amounts."),
+    total: Money.describe("subtotal minus discount_amount plus tax_amount: what checkout collects, before applying\ncredit grants or balance. Equals the sum of line totals and excludes estimated_usage_amount."),
+    estimated_usage_amount: zod
+        .union([Money, zod.null()])
+        .describe("Sum of the lines' estimated_usage_amount. A projection, not part of total and not collected at\ncheckout. Null when no usage estimate is requested."),
+    currency: zod.string(),
+    proration_date: zod.iso
+        .datetime({ offset: true })
+        .nullable()
+        .describe("Changes only; null otherwise. The instant the change is priced from. Pass it with the change so the\norder is priced from the same instant."),
+    refundable_amount: 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.");

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

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const QuoteItem: zod.ZodObject<{
+    plan_name: zod.ZodString;
+    unit_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+    quantity: zod.ZodString;
+    amount: zod.ZodString;
+    discount_amount: zod.ZodString;
+    tax_amount: zod.ZodString;
+    tax_included_amount: zod.ZodString;
+    total: zod.ZodString;
+    estimated_usage_amount: zod.ZodUnion<readonly [zod.ZodString, zod.ZodNull]>;
+    currency: zod.ZodString;
+}, zod.z.core.$strict>;
+export type QuoteItem = zod.input<typeof QuoteItem>;
+export type QuoteItemOutput = zod.output<typeof QuoteItem>;

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

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Quote Types
+ * Price previews returned before purchase confirmation. Types only; this document declares no operations.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+export const QuoteItem = zod
+    .strictObject({
+    plan_name: zod.string(),
+    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."),
+    quantity: zod.string().describe("The quantity priced."),
+    amount: Money.describe("Before discounts, including any setup charges. Contains tax only where the price includes it.\nZero for an item with no immediate charge."),
+    discount_amount: Money.describe("Total reduction on this line, including any committed recurring discount."),
+    tax_amount: Money.describe("Tax on the discounted amount, including any tax already contained in that amount."),
+    tax_included_amount: Money.describe("The part of tax_amount already contained in amount minus discount_amount."),
+    total: Money.describe("amount minus discount_amount plus tax_amount minus tax_included_amount."),
+    estimated_usage_amount: zod
+        .union([Money, zod.null()])
+        .describe("Projected charge for this line's future usage over the period stated by the quoting operation,\nat current rates, before discounts and tax and not rounded. Not part of amount or total and\nnot collected at checkout. Null when no usage estimate is requested for this line."),
+    currency: zod.string(),
+})
+    .describe("One calculated purchase line. Fixed purchase amounts are rounded as checkout rounds them.\nA line without an immediate charge has zero checkout amounts. unit_amount remains null when\nno single unit price applies; an unrequested usage estimate remains null.");