@leaflow/sdk 0.154.0 → 0.155.0

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

@@ -35,374 +35,7 @@ export const MembershipEndedReason = {
     revoked: "revoked",
     abandoned: "abandoned",
 };
-export const InvoiceStatus = {
-    draft: "draft",
-    open: "open",
-    paid: "paid",
-    void: "void",
-};
 export const CheckoutMode = {
     automatic: "automatic",
     deferred: "deferred",
 };
-export const WithdrawalItemStatus = {
-    pending: "pending",
-    succeeded: "succeeded",
-    failed: "failed",
-    reversed: "reversed",
-};
-export const WithdrawalStatus = {
-    pending: "pending",
-    processing: "processing",
-    succeeded: "succeeded",
-    partially_completed: "partially_completed",
-    failed: "failed",
-    reversed: "reversed",
-};
-export const CancellationPolicy = {
-    immediate: "immediate",
-    period_end: "period_end",
-};
-export const RefundPolicy = {
-    none: "none",
-    prorated: "prorated",
-    short_rate: "short_rate",
-};
-export const QuoteRenewalInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const QuoteRenewalResultInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const QuotedDiscountType = {
-    promotion_code: "promotion_code",
-    account_discount: "account_discount",
-};
-export const PriceType = {
-    one_time: "one_time",
-    recurring: "recurring",
-};
-export const UsageType = {
-    licensed: "licensed",
-    metered: "metered",
-};
-export const CancellationStatus = {
-    requested: "requested",
-    scheduled: "scheduled",
-    releasing: "releasing",
-    completed: "completed",
-    canceled: "canceled",
-    failed: "failed",
-};
-export const CancellationOrigin = {
-    customer: "customer",
-    operator: "operator",
-    project_deletion: "project_deletion",
-};
-export const CancellationItemStatus = {
-    requested: "requested",
-    scheduled: "scheduled",
-    releasing: "releasing",
-    completed: "completed",
-    canceled: "canceled",
-    failed: "failed",
-};
-export const SubscriptionCancellationStatus = {
-    requested: "requested",
-    scheduled: "scheduled",
-    releasing: "releasing",
-    failed: "failed",
-    completed: "completed",
-    canceled: "canceled",
-};
-export const SubscriptionCancellationMode = {
-    immediate: "immediate",
-    period_end: "period_end",
-};
-export const BillingAccountStatus = {
-    active: "active",
-    suspended: "suspended",
-    closed: "closed",
-};
-export const BillingAccountSuspendedBy = {
-    none: "none",
-    owner: "owner",
-    operator: "operator",
-};
-export const BillingScheme = {
-    per_unit: "per_unit",
-    tiered: "tiered",
-};
-export const PriceOptionInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const PurchaseOperation = {
-    new: "new",
-    renew: "renew",
-    modify: "modify",
-};
-export const AccountDeletionObjection = {
-    ARREARS: "ARREARS",
-    PROJECTS_ASSIGNED: "PROJECTS_ASSIGNED",
-    ACTIVE_SUBSCRIPTION: "ACTIVE_SUBSCRIPTION",
-    OPEN_ORDER: "OPEN_ORDER",
-    UNPAID_INVOICE: "UNPAID_INVOICE",
-    UNBILLED_USAGE: "UNBILLED_USAGE",
-    PENDING_TRANSACTION: "PENDING_TRANSACTION",
-};
-export const TopUpStatus = {
-    pending: "pending",
-    succeeded: "succeeded",
-    failed: "failed",
-    canceled: "canceled",
-};
-export const PaymentCancellationReason = {
-    abandoned: "abandoned",
-    requested_by_customer: "requested_by_customer",
-};
-export const PaymentActionType = {
-    redirect: "redirect",
-    qr_code: "qr_code",
-    sdk: "sdk",
-};
-export const PaymentMethodStatus = {
-    active: "active",
-    expired: "expired",
-    removed: "removed",
-};
-export const PaymentStatus = {
-    succeeded: "succeeded",
-    processing: "processing",
-    requires_action: "requires_action",
-    failed: "failed",
-};
-export const TransactionRefundDestination = {
-    balance: "balance",
-    credit: "credit",
-    gateway: "gateway",
-};
-export const TransactionStatus = {
-    pending: "pending",
-    succeeded: "succeeded",
-    failed: "failed",
-    canceled: "canceled",
-};
-export const TransactionType = {
-    topup: "topup",
-    payment: "payment",
-    refund: "refund",
-    adjustment: "adjustment",
-    fee: "fee",
-};
-export const InvoiceCustomerTaxExempt = {
-    none: "none",
-    exempt: "exempt",
-    reverse: "reverse",
-};
-export const CreditGrantStatus = {
-    active: "active",
-    depleted: "depleted",
-    expired: "expired",
-    voided: "voided",
-};
-export const CreditNoteStatus = {
-    issued: "issued",
-    void: "void",
-};
-export const CreditNoteReason = {
-    provisioning_failed: "provisioning_failed",
-    order_expired: "order_expired",
-    order_canceled: "order_canceled",
-    change_canceled: "change_canceled",
-    change_expired: "change_expired",
-    subscription_canceled: "subscription_canceled",
-    usage_true_up: "usage_true_up",
-    operator: "operator",
-};
-export const RefundDestination = {
-    balance: "balance",
-    gateway: "gateway",
-};
-export const RefundStatus = {
-    pending: "pending",
-    processing: "processing",
-    succeeded: "succeeded",
-    failed: "failed",
-};
-export const RefundReason = {
-    provisioning_failed: "provisioning_failed",
-    order_expired: "order_expired",
-    order_canceled: "order_canceled",
-    change_canceled: "change_canceled",
-    change_expired: "change_expired",
-    subscription_canceled: "subscription_canceled",
-    future_period_canceled: "future_period_canceled",
-    downgrade_difference: "downgrade_difference",
-    usage_true_up: "usage_true_up",
-    payment_not_applied: "payment_not_applied",
-    operator: "operator",
-};
-export const SubscriptionInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const SubscriptionRestriction = {
-    billingsubscriptionsuse: "billing.subscriptions.use",
-    billingsubscriptionsrenew: "billing.subscriptions.renew",
-    billingsubscriptionsmodify: "billing.subscriptions.modify",
-    billingsubscriptionscancel: "billing.subscriptions.cancel",
-    billingsubscriptionsterminate: "billing.subscriptions.terminate",
-};
-export const OrderStatus = {
-    pending: "pending",
-    accepted: "accepted",
-    completed: "completed",
-    partially_completed: "partially_completed",
-    failed: "failed",
-    canceled: "canceled",
-};
-export const ScheduledChangeInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const SubscriptionStatus = {
-    pending: "pending",
-    provisioning: "provisioning",
-    active: "active",
-    suspended: "suspended",
-    canceled: "canceled",
-    terminated: "terminated",
-};
-export const RenewalPriceInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const RenewRequestInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const RenewalOrderRequestInterval = {
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const OrderItemStatus = {
-    pending: "pending",
-    completed: "completed",
-    failed: "failed",
-    canceled: "canceled",
-};
-export const OrderType = {
-    new: "new",
-    renew: "renew",
-    modify: "modify",
-};
-export const OrderChangeEffective = {
-    none: "none",
-    immediate: "immediate",
-    period_end: "period_end",
-};
-export const OrderItemInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const DiscountStatus = {
-    scheduled: "scheduled",
-    active: "active",
-    expired: "expired",
-    voided: "voided",
-};
-export const DiscountType = {
-    percentage: "percentage",
-    fixed_amount: "fixed_amount",
-    price_override: "price_override",
-    free_setup: "free_setup",
-};
-export const DiscountFrequency = {
-    once: "once",
-    recurring: "recurring",
-    forever: "forever",
-};
-export const AllowanceCategory = {
-    paid: "paid",
-    promotional: "promotional",
-};
-export const AllowanceStatus = {
-    active: "active",
-    depleted: "depleted",
-    expired: "expired",
-    voided: "voided",
-};
-export const FeatureGrantStatus = {
-    scheduled: "scheduled",
-    active: "active",
-    expired: "expired",
-    voided: "voided",
-};
-export const PriceTiersMode = {
-    none: "none",
-    graduated: "graduated",
-    volume: "volume",
-};
-export const PriceInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const RateInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const RateTiersMode = {
-    none: "none",
-    graduated: "graduated",
-    volume: "volume",
-};
-export const QuoteItemInputInterval = {
-    none: "none",
-    day: "day",
-    month: "month",
-    year: "year",
-};
-export const ActiveResourceStatus = {
-    active: "active",
-    suspended: "suspended",
-    closing: "closing",
-    closed: "closed",
-};
-export const ContactTaxExempt = {
-    none: "none",
-    exempt: "exempt",
-    reverse: "reverse",
-};
-export const StatementStatus = {
-    open: "open",
-    closed: "closed",
-};
-export const StatementType = {
-    interim: "interim",
-    final: "final",
-    supplement: "supplement",
-};
-export const StatementSummaryGroupBy = {
-    project: "project",
-    product: "product",
-    meter: "meter",
-};

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

@@ -45,7 +45,7 @@ export declare const ListMembershipsQueryParams: zod.ZodObject<{
     billing_account_id: zod.ZodInt;
 }, zod.z.core.$strict>;
 /**
- * Places a purchase order and returns the membership and invoice. Activation follows successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
+ * Creates a Billing Checkout Session for the purchase and returns the membership with it. With deferred checkout, the customer completes checkout in Billing. Activation follows payment, successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
  * @summary Buy a membership
  */
 export declare const CreateMembershipBody: zod.ZodObject<{
@@ -58,6 +58,7 @@ export declare const CreateMembershipBody: zod.ZodObject<{
             deferred: "deferred";
         }>>;
         expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+        return_url: zod.ZodOptional<zod.ZodURL>;
     }, zod.z.core.$strict>>;
 }, zod.z.core.$strict>;
 /**
@@ -82,7 +83,7 @@ export declare const ListMembershipPeriodsQueryParams: zod.ZodObject<{
     page_size: zod.ZodDefault<zod.ZodInt>;
 }, zod.z.core.$strict>;
 /**
- * Places an order for the full-period price difference. The upgrade takes effect after benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
+ * Creates a Billing Checkout Session for the full-period price difference. The upgrade takes effect after payment, benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
  * @summary Upgrade a membership
  */
 export declare const UpgradeMembershipParams: zod.ZodObject<{
@@ -96,6 +97,7 @@ export declare const UpgradeMembershipBody: zod.ZodObject<{
             deferred: "deferred";
         }>>;
         expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+        return_url: zod.ZodOptional<zod.ZodURL>;
     }, zod.z.core.$strict>>;
 }, zod.z.core.$strict>;
 /**

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

@@ -76,7 +76,7 @@ export const ListMembershipsQueryParams = zod.strictObject({
     billing_account_id: zod.int().min(1).describe("The account to query."),
 });
 /**
- * Places a purchase order and returns the membership and invoice. Activation follows successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
+ * Creates a Billing Checkout Session for the purchase and returns the membership with it. With deferred checkout, the customer completes checkout in Billing. Activation follows payment, successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
  * @summary Buy a membership
  */
 export const CreateMembershipBody = MembershipCreate;
@@ -112,7 +112,7 @@ export const ListMembershipPeriodsQueryParams = zod.strictObject({
         .describe("Items per page. Defaults to 50; at most 200."),
 });
 /**
- * Places an order for the full-period price difference. The upgrade takes effect after benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
+ * Creates a Billing Checkout Session for the full-period price difference. The upgrade takes effect after payment, benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE. Returns 403 MEMBERSHIP_ACCOUNT_DELETING while the caller's account deletion is pending, or 403 MEMBERSHIP_ACCOUNT_UNUSABLE when the account is deleted, suspended or banned.
  * @summary Upgrade a membership
  */
 export const UpgradeMembershipParams = zod.strictObject({

package/dist/membership/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/membership/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/membership/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/membership/v1/generated/validators/membershipCreate.zod.d.ts

@@ -16,6 +16,7 @@ export declare const MembershipCreate: zod.ZodObject<{
             deferred: "deferred";
         }>>;
         expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+        return_url: zod.ZodOptional<zod.ZodURL>;
     }, zod.z.core.$strict>>;
 }, zod.z.core.$strict>;
 export type MembershipCreate = zod.input<typeof MembershipCreate>;

package/dist/membership/v1/generated/validators/membershipPurchase.zod.d.ts

@@ -107,31 +107,8 @@ export declare const MembershipPurchase: zod.ZodObject<{
         created_at: zod.z.ZodISODateTime;
         ended_at: zod.ZodNullable<zod.z.ZodISODateTime>;
     }, zod.z.core.$strict>;
-    order: zod.ZodObject<{
-        order_id: zod.ZodUUID;
-        invoice_id: zod.ZodUUID;
-        invoice: zod.ZodObject<{
-            id: zod.ZodUUID;
-            number: zod.ZodOptional<zod.ZodString>;
-            currency: zod.ZodString;
-            status: zod.ZodEnum<{
-                void: "void";
-                open: "open";
-                draft: "draft";
-                paid: "paid";
-            }>;
-            subtotal: zod.ZodString;
-            discount_amount: zod.ZodString;
-            tax_amount: zod.ZodString;
-            total: zod.ZodString;
-            amount_paid: zod.ZodString;
-            pre_payment_credit_notes_amount: zod.ZodString;
-            post_payment_credit_notes_amount: zod.ZodString;
-            amount_due: zod.ZodString;
-            amount_refunded: zod.ZodString;
-            due_at: zod.ZodOptional<zod.z.ZodISODateTime>;
-        }, zod.z.core.$strict>;
-    }, zod.z.core.$strict>;
+    checkout_session_id: zod.ZodUUID;
+    order_id: zod.ZodNullable<zod.ZodUUID>;
 }, zod.z.core.$strict>;
 export type MembershipPurchase = zod.input<typeof MembershipPurchase>;
 export type MembershipPurchaseOutput = zod.output<typeof MembershipPurchase>;

package/dist/membership/v1/generated/validators/membershipPurchase.zod.js

@@ -7,10 +7,15 @@
  */
 import * as zod from "zod";
 import { Membership } from "./membership.zod.js";
-import { PlacedOrder } from "./placedOrder.zod.js";
 export const MembershipPurchase = zod
     .strictObject({
     membership: Membership,
-    order: PlacedOrder,
+    checkout_session_id: zod
+        .uuid()
+        .describe("The Billing Checkout Session of this purchase. With deferred checkout, the customer completes it in Billing."),
+    order_id: zod
+        .uuid()
+        .nullable()
+        .describe("The order created when checkout completes, at once for automatic checkout; null until then."),
 })
-    .describe("The membership and its Billing purchase order.");
+    .describe("The membership and its Billing Checkout Session.");

package/dist/membership/v1/generated/validators/membershipUpgrade.zod.d.ts

@@ -14,6 +14,7 @@ export declare const MembershipUpgrade: zod.ZodObject<{
             deferred: "deferred";
         }>>;
         expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+        return_url: zod.ZodOptional<zod.ZodURL>;
     }, zod.z.core.$strict>>;
 }, zod.z.core.$strict>;
 export type MembershipUpgrade = zod.input<typeof MembershipUpgrade>;