@leaflow/sdk 0.0.0-dev.375.gbce4ffc → 0.0.0-dev.379.g796e6e7

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

@@ -17,9 +17,11 @@ export const QuoteRenewalResultInterval = {
     month: "month",
     year: "year",
 };
-export const QuotedDiscountType = {
-    promotion_code: "promotion_code",
-    account_discount: "account_discount",
+export const QuoteItemInterval = {
+    none: "none",
+    day: "day",
+    month: "month",
+    year: "year",
 };
 export const PriceType = {
     one_time: "one_time",
@@ -29,6 +31,23 @@ export const UsageType = {
     licensed: "licensed",
     metered: "metered",
 };
+export const QuoteTaxStatus = {
+    complete: "complete",
+    requires_location_inputs: "requires_location_inputs",
+};
+export const QuotedDiscountType = {
+    promotion_code: "promotion_code",
+    account_discount: "account_discount",
+};
+export const QuotedDiscountFrequency = {
+    once: "once",
+    recurring: "recurring",
+    forever: "forever",
+};
+export const QuotedDiscountEligibility = {
+    confirmed: "confirmed",
+    unverified: "unverified",
+};
 export const CancellationStatus = {
     requested: "requested",
     scheduled: "scheduled",
@@ -141,7 +160,6 @@ export const TransactionType = {
     fee: "fee",
 };
 export const InvoiceStatus = {
-    draft: "draft",
     open: "open",
     paid: "paid",
     void: "void",
@@ -151,13 +169,6 @@ export const InvoiceCustomerTaxExempt = {
     exempt: "exempt",
     reverse: "reverse",
 };
-export const InvoiceItemType = {
-    usage: "usage",
-    subscription: "subscription",
-    one_time: "one_time",
-    setup: "setup",
-    adjustment: "adjustment",
-};
 export const CreditGrantStatus = {
     active: "active",
     depleted: "depleted",
@@ -245,17 +256,30 @@ export const RenewRequestInterval = {
     month: "month",
     year: "year",
 };
-export const RenewalOrderRequestInterval = {
+export const CheckoutSessionStatus = {
+    open: "open",
+    complete: "complete",
+    expired: "expired",
+};
+export const CheckoutSessionType = {
+    new: "new",
+    renew: "renew",
+    modify: "modify",
+};
+export const CheckoutSessionChangeEffective = {
+    none: "none",
+    immediate: "immediate",
+    period_end: "period_end",
+};
+export const CheckoutMode = {
+    automatic: "automatic",
+    deferred: "deferred",
+};
+export const CheckoutSessionCreateInterval = {
     day: "day",
     month: "month",
     year: "year",
 };
-export const OrderItemStatus = {
-    pending: "pending",
-    completed: "completed",
-    failed: "failed",
-    canceled: "canceled",
-};
 export const OrderType = {
     new: "new",
     renew: "renew",
@@ -272,6 +296,12 @@ export const OrderItemInterval = {
     month: "month",
     year: "year",
 };
+export const OrderItemStatus = {
+    pending: "pending",
+    completed: "completed",
+    failed: "failed",
+    canceled: "canceled",
+};
 export const DiscountStatus = {
     scheduled: "scheduled",
     active: "active",

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

@@ -348,15 +348,9 @@ export declare const DeletePaymentMethodParams: zod.ZodObject<{
 }, zod.z.core.$strict>;
 /**
  * Pays the invoice from eligible credit grants and balance as requested, and collects the remainder through the
- * selected gateway and method. Without a gateway, insufficient funds fail and no online payment starts.
- *
- * The draft invoice of a deferred order is priced on its first payment: promotion_code, or otherwise the best
- * applicable account discount, is applied, the total is compared with expected_amount, and the invoice is issued
- * before collection. An invalid or inapplicable code fails, and a total other than expected_amount fails with
- * `BILLING_AMOUNT_CHANGED`; neither changes anything. Once fixed, the terms stay fixed even if collection does
- * not complete, and a different promotion_code is refused with `BILLING_ORDER_CHECKOUT_CONFLICT`. A deferred
- * period-end change can be paid only once its first period is due to be invoiced; earlier attempts fail with
- * `BILLING_CHANGE_NOT_INVOICED`.
+ * selected gateway and method. Without a gateway, insufficient funds fail and no online payment starts. The
+ * invoice's amounts and discount were fixed when it was issued and are not changed by paying; promotion codes
+ * are applied when completing a Checkout Session.
  *
  * Returns a payment action when the customer must act; requires_action and processing are not paid. An
  * unresolved online payment with the same gateway, method and saved payment method is reused, and retries never
@@ -369,8 +363,9 @@ export declare const DeletePaymentMethodParams: zod.ZodObject<{
  * order; `BILLING_ORDER_EXPIRED` after the order's payment deadline; `BILLING_INVOICE_NOT_PAYABLE` with
  * `meta.reason` `subscription_canceling`, `subscription_reclaiming` or `subscription_ended` for a renewal
  * invoice whose subscription is being canceled, is being reclaimed or has ended; and
- * `BILLING_INVOICE_NOT_PAYABLE` with `meta.reason` `usage_invoice` for a usage invoice, which is collected from
- * credit grants and balance automatically, including right after a top-up.
+ * `BILLING_INVOICE_NOT_PAYABLE` with `meta.reason` `fractional_amount` when the amount left for the gateway is
+ * not a whole number of the currency's minor unit; such an invoice is collected from credit grants and balance
+ * automatically, including right after a top-up.
  * @summary Pay an invoice
  */
 export declare const PayInvoiceParams: zod.ZodObject<{
@@ -383,8 +378,6 @@ export declare const PayInvoiceBody: zod.ZodObject<{
     use_balance: zod.ZodDefault<zod.ZodBoolean>;
     use_credits: zod.ZodDefault<zod.ZodBoolean>;
     return_url: zod.ZodOptional<zod.ZodString>;
-    promotion_code: zod.ZodOptional<zod.ZodString>;
-    expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
 }, zod.z.core.$strict>;
 /**
  * What paying this invoice now would take from credit grants, from the balance and, for the rest,
@@ -392,8 +385,6 @@ export declare const PayInvoiceBody: zod.ZodObject<{
  * straight afterwards takes exactly these amounts unless the account's funds change in between.
  * Nothing is charged, reserved or created.
  *
- * A draft order invoice is priced as paying it with the same promotion_code would price it.
- *
  * Refused with the same errors as paying, except that insufficient funds are not an error here:
  * they show as a `gateway_amount` above zero.
  * @summary Preview invoice payment
@@ -401,25 +392,21 @@ export declare const PayInvoiceBody: zod.ZodObject<{
 export declare const PreviewInvoicePaymentParams: zod.ZodObject<{
     invoiceId: zod.ZodUUID;
 }, zod.z.core.$strict>;
-export declare const previewInvoicePaymentQueryPromotionCodeMax = 64;
 export declare const previewInvoicePaymentQueryUseBalanceDefault = true;
 export declare const previewInvoicePaymentQueryUseCreditsDefault = true;
 export declare const PreviewInvoicePaymentQueryParams: zod.ZodObject<{
-    promotion_code: zod.ZodOptional<zod.ZodString>;
     use_balance: zod.ZodDefault<zod.ZodBoolean>;
     use_credits: zod.ZodDefault<zod.ZodBoolean>;
 }, zod.z.core.$strict>;
 /**
  * Pays outstanding invoices, including those of the listed orders, from eligible credit grants and then balance,
- * without a payment gateway. The draft invoice of a deferred order takes the best applicable account discount
- * and is issued first, staying issued if payment fails; pay it alone to use a promotion code.
+ * without a payment gateway.
  *
  * All invoices are paid or none: insufficient funds fail with `BILLING_INSUFFICIENT_FUNDS`, and a total other
  * than expected_amount fails with `BILLING_AMOUNT_CHANGED`, charging nothing. Paid invoices are not charged
  * again. An earlier online payment for one of the invoices is canceled first; one the gateway is still
  * processing is refused with `BILLING_PAYMENT_PENDING` and `meta.transaction_id`. Also refused with
- * `BILLING_INVOICE_NOT_PAYABLE` for a void invoice; `BILLING_CHANGE_NOT_INVOICED` for a period-end change not
- * yet due; `BILLING_ORDER_FAILED`, `BILLING_ORDER_CANCELED` or `BILLING_ORDER_EXPIRED` for an order in that
+ * `BILLING_INVOICE_NOT_PAYABLE` for a void invoice; `BILLING_ORDER_FAILED`, `BILLING_ORDER_CANCELED` or `BILLING_ORDER_EXPIRED` for an order in that
  * state; and `BILLING_INVOICE_NOT_PAYABLE` with `meta.reason` `subscription_canceling`,
  * `subscription_reclaiming` or `subscription_ended` for a renewal invoice of a subscription being canceled,
  * being reclaimed or ended.
@@ -431,7 +418,7 @@ export declare const PayTogetherBody: zod.ZodObject<{
     expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
 }, zod.z.core.$strict>;
 /**
- * Issued invoices of your billing accounts. Drafts are not listed; an order's draft invoice is reached through its order. Top-ups have no invoices.
+ * Issued invoices of your billing accounts. Top-ups have no invoices.
  * @summary List invoices
  */
 export declare const listInvoicesQueryPageDefault = 1;
@@ -445,7 +432,6 @@ export declare const ListInvoicesQueryParams: zod.ZodObject<{
     status: zod.ZodOptional<zod.ZodEnum<{
         void: "void";
         open: "open";
-        draft: "draft";
         paid: "paid";
     }>>;
     subscription_id: zod.ZodOptional<zod.ZodUUID>;
@@ -453,14 +439,14 @@ export declare const ListInvoicesQueryParams: zod.ZodObject<{
     to: zod.ZodOptional<zod.z.ZodISODateTime>;
 }, zod.z.core.$strict>;
 /**
- * An invoice of your billing account, issued or an order's draft, with its amounts, tax lines and payment state. A missing invoice or another draft returns 404; an invoice of another user's account returns 403.
+ * An issued invoice of your billing account, with its amounts, tax lines and payment state. A missing or unissued invoice returns 404; an invoice of another user's account returns 403.
  * @summary Get invoice
  */
 export declare const GetInvoiceParams: zod.ZodObject<{
     invoiceId: zod.ZodUUID;
 }, zod.z.core.$strict>;
 /**
- * Lines of an invoice of your billing account, issued or an order's draft, with their service periods and projects. A missing invoice or another draft returns 404; an invoice of another user's account returns 403.
+ * Lines of an issued invoice of your billing account, with their service periods and projects. A missing or unissued invoice returns 404; an invoice of another user's account returns 403.
  * @summary List invoice items
  */
 export declare const ListInvoiceItemsParams: zod.ZodObject<{
@@ -754,7 +740,7 @@ export declare const ListRenewalPricesQueryParams: zod.ZodObject<{
  *
  * Without `payment_method_id`, the renewal is paid from credit grants and balance as `use_credits` and
  * `use_balance` allow; when they cannot cover it, the request fails with `BILLING_INSUFFICIENT_FUNDS` and no
- * order is left. To pay another way, create a renewal order and pay its invoice.
+ * order is left. To apply a promotion code or pay later, create a renewal Checkout Session.
  *
  * Keep order_id and read the order after an unknown outcome; creating it again conflicts.
  * @summary Renew subscription
@@ -780,34 +766,6 @@ export declare const RenewSubscriptionBody: zod.ZodObject<{
     use_credits: zod.ZodDefault<zod.ZodBoolean>;
     return_url: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
-/**
- * Places a renewal order with a draft invoice, without applying a new discount or charging anything. Pay its
- * invoice to renew; a promotion code can be applied when paying. Existing subscription discounts are kept.
- * Periods and price are chosen as for renewing. The order can be paid until the current paid period ends, and
- * never after the end of the first period it renews; unpaid by then, it is canceled. While auto-renew is on, the
- * renewal due at the end of the period pays this order instead of placing another, applying an applicable
- * account discount first if its terms are not fixed yet.
- *
- * Keep `order_id` and read the order after an unknown outcome; creating it again conflicts.
- * @summary Create renewal order
- */
-export declare const CreateRenewalOrderParams: zod.ZodObject<{
-    subscriptionId: zod.ZodUUID;
-}, zod.z.core.$strict>;
-export declare const CreateRenewalOrderBody: zod.ZodObject<{
-    order_id: zod.ZodUUID;
-    periods: zod.ZodDefault<zod.ZodInt>;
-    interval_count: zod.ZodOptional<zod.ZodInt>;
-    interval: zod.ZodOptional<zod.ZodEnum<{
-        day: "day";
-        month: "month";
-        year: "year";
-    }>>;
-    cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
-        immediate: "immediate";
-        period_end: "period_end";
-    }>>;
-}, zod.z.core.$strict>;
 /**
  * Turns automatic renewal of an active or suspended licensed subscription on or off. Turning it off does not shorten current_term_end and still allows manual renewal. Refused with 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_INACTIVE` for a pending or provisioning subscription, 409 `BILLING_SUBSCRIPTION_AUTO_RENEW_FIXED` for a metered subscription, which continues until it is canceled, and 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` with `meta.cancellation_id` while a cancellation is open: creating it turned renewal off, and withdrawing it does not turn renewal back on.
  * @summary Set auto renew
@@ -843,6 +801,118 @@ export declare const ListAllowancesQueryParams: zod.ZodObject<{
     product_id: zod.ZodOptional<zod.ZodString>;
     project_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
 }, zod.z.core.$strict>;
+/**
+ * Checkout Sessions of your billing accounts, newest first. An open session is a purchase waiting for you to complete checkout.
+ * @summary List Checkout Sessions
+ */
+export declare const listCheckoutSessionsQueryPageDefault = 1;
+export declare const listCheckoutSessionsQueryPageMax = 2147483647;
+export declare const listCheckoutSessionsQueryPageSizeDefault = 50;
+export declare const listCheckoutSessionsQueryPageSizeMax = 200;
+export declare const listCheckoutSessionsQueryProjectIdsMax = 100;
+export declare const ListCheckoutSessionsQueryParams: zod.ZodObject<{
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+    billing_account_id: zod.ZodOptional<zod.ZodInt>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        expired: "expired";
+        open: "open";
+        complete: "complete";
+    }>>;
+    project_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+}, zod.z.core.$strict>;
+/**
+ * Opens a Checkout Session renewing one of your licensed subscriptions, with periods and price chosen as in
+ * renewing. Nothing is charged until you complete it, when a promotion code can be applied; it then renews from
+ * the subscription's current_term_end at that time. To renew at once from credit grants, balance or a payment
+ * method, renew the subscription instead. Purchases and changes of a service's resources are created through
+ * that service.
+ *
+ * Keep `checkout_session_id` and read the session after an unknown outcome; creating it again conflicts.
+ * @summary Create a renewal Checkout Session
+ */
+export declare const CreateCheckoutSessionBody: zod.ZodObject<{
+    checkout_session_id: zod.ZodUUID;
+    subscription_id: zod.ZodUUID;
+    periods: zod.ZodDefault<zod.ZodInt>;
+    interval_count: zod.ZodOptional<zod.ZodInt>;
+    interval: zod.ZodOptional<zod.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>>;
+    cancellation_policy: zod.ZodOptional<zod.ZodEnum<{
+        immediate: "immediate";
+        period_end: "period_end";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * A Checkout Session of your billing account. Poll it to follow checkout; once it is complete, read its order for payment and delivery. An unknown session returns 404; another account's session returns 403.
+ * @summary Get a Checkout Session
+ */
+export declare const GetCheckoutSessionParams: zod.ZodObject<{
+    checkoutSessionId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * What the session buys, by position. Prices and amounts are in its quote.
+ * @summary List Checkout Session items
+ */
+export declare const ListCheckoutSessionItemsParams: zod.ZodObject<{
+    checkoutSessionId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const listCheckoutSessionItemsQueryPageDefault = 1;
+export declare const listCheckoutSessionItemsQueryPageMax = 2147483647;
+export declare const listCheckoutSessionItemsQueryPageSizeDefault = 50;
+export declare const listCheckoutSessionItemsQueryPageSizeMax = 200;
+export declare const ListCheckoutSessionItemsQueryParams: zod.ZodObject<{
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * What completing this open session now would invoice, with `promotion_code` or otherwise the best applicable
+ * account discount, and the account funds available for it. Nothing is applied, reserved or redeemed. An invalid
+ * or inapplicable code fails the request without changing the session.
+ *
+ * Complete the session with the returned `total` as `expected_amount`, the same `promotion_code` and, for an
+ * immediate change, the returned `proration_date`. An expired session is refused with
+ * `BILLING_CHECKOUT_SESSION_EXPIRED`, and a complete one with `BILLING_CHECKOUT_SESSION_COMPLETE`; read its order
+ * instead.
+ * @summary Quote a Checkout Session
+ */
+export declare const GetCheckoutSessionQuoteParams: zod.ZodObject<{
+    checkoutSessionId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const getCheckoutSessionQuoteQueryPromotionCodeMax = 64;
+export declare const GetCheckoutSessionQuoteQueryParams: zod.ZodObject<{
+    promotion_code: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Completes an open session: applies `promotion_code`, or otherwise the best applicable account discount, checks
+ * the total against `expected_amount` and creates the order with its invoice issued. A zero-total invoice is paid
+ * at once; otherwise pay the invoice next. A failed payment leaves the order and its terms as they are, and the
+ * invoice can be paid again until the order expires. Nothing is created when the code is invalid or
+ * inapplicable or the total differs, which fails with `BILLING_AMOUNT_CHANGED`.
+ *
+ * Confirming a complete session again with the same terms returns it with its order; different terms are refused
+ * with `BILLING_CHECKOUT_SESSION_COMPLETE`. An expired session is refused with `BILLING_CHECKOUT_SESSION_EXPIRED`.
+ * The order is delivered by the service that owns it once paid; confirmation alone does not mean delivery.
+ * @summary Confirm a Checkout Session
+ */
+export declare const ConfirmCheckoutSessionParams: zod.ZodObject<{
+    checkoutSessionId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const ConfirmCheckoutSessionBody: zod.ZodObject<{
+    promotion_code: zod.ZodOptional<zod.ZodString>;
+    expected_amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
+    proration_date: zod.ZodOptional<zod.z.ZodISODateTime>;
+}, zod.z.core.$strict>;
+/**
+ * Ends an open session without an order; the service that created it releases what it was holding for the purchase. An expired session is returned unchanged.
+ * @summary Expire a Checkout Session
+ */
+export declare const ExpireCheckoutSessionParams: zod.ZodObject<{
+    checkoutSessionId: zod.ZodUUID;
+}, zod.z.core.$strict>;
 /**
  * Orders with their status and invoice amounts. A pending order is not yet accepted and can expire at expires_at; its invoice shows whether payment is needed. Accepted does not mean delivered.
  * @summary List orders
@@ -875,20 +945,30 @@ export declare const ListOrdersQueryParams: zod.ZodObject<{
 export declare const GetOrderParams: zod.ZodObject<{
     orderId: zod.ZodUUID;
 }, zod.z.core.$strict>;
+/**
+ * What canceling the listed items, or the whole order, would refund to the original payment sources. Nothing is canceled or refunded.
+ * @summary Preview an order refund
+ */
+export declare const PreviewOrderRefundParams: zod.ZodObject<{
+    orderId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const previewOrderRefundQueryOrderItemIdsMax = 100;
+export declare const PreviewOrderRefundQueryParams: zod.ZodObject<{
+    order_item_ids: zod.ZodOptional<zod.ZodArray<zod.ZodUUID>>;
+}, zod.z.core.$strict>;
 /**
  * Cancels the selected undelivered items of an order that has not been accepted, without recording a delivery
  * failure. Omit order_item_ids to select every pending item. Delivered items stay delivered and are not
  * refunded; failed items keep their outcome. The order stays pending while any item is pending, and its final
  * status follows its items.
  *
- * Once the order's terms are fixed, the canceled items keep their agreed amounts and discounts: credit notes
- * reduce the issued invoice, and collected amounts return to their original payment sources, possibly
- * asynchronously. While a deferred order's terms are not fixed, the remaining items are priced again. An online
+ * The canceled items keep their agreed amounts and discounts: credit notes reduce the issued invoice, and
+ * collected amounts return to their original payment sources, possibly asynchronously. An online
  * payment waiting for the payer is canceled with the order; one the gateway is processing is refused with
  * `BILLING_PAYMENT_PENDING` and `meta.transaction_id`. Repeating the cancellation does not refund twice.
  *
  * An accepted order is canceled by its owning service, and delivered items through subscription cancellation.
- * Refunds are quoted with the quote operation's `refund` target.
+ * Refunds are previewed with `preview-order-refund`.
  * @summary Cancel order
  */
 export declare const CancelOrderParams: zod.ZodObject<{