@leaflow/sdk 0.120.0 → 0.122.0

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

@@ -7,25 +7,24 @@
  */
 import * as zod from "zod";
 import { AccountIdentity } from "./accountIdentity.zod.js";
-import { CancellationRequest } from "./cancellationRequest.zod.js";
 import { NamedIdentity } from "./namedIdentity.zod.js";
 import { ObjectIdentity } from "./objectIdentity.zod.js";
-import { PaidWith } from "./paidWith.zod.js";
 import { Product } from "./product.zod.js";
 import { ProductID } from "./productID.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
+import { SubscriptionCancellation } from "./subscriptionCancellation.zod.js";
 import { TerminationPolicy } from "./terminationPolicy.zod.js";
 export const subscriptionDiscountedRenewalsRemainingMin = 0;
 export const Subscription = zod
     .strictObject({
     currency: zod.string(),
-    billing_type: zod.enum(["postpaid", "prepaid", "one_time"]),
+    charge_type: zod.enum(["postpaid", "prepaid", "one_time"]),
     interval: zod.enum(["none", "day", "month", "year"]),
     interval_count: zod.int().min(1).optional(),
     recurring_amount: zod
         .string()
         .optional()
-        .describe("Whole-subscription prepaid renewal amount, after continuing discounts and before tax.\nPending subscriptions show base terms until checkout confirms any new continuing discount.\nAbsent for other billing types."),
+        .describe("Whole-subscription prepaid renewal amount, after continuing discounts and before tax.\nPending subscriptions show base terms until paying the order fixes any new continuing discount.\nAbsent for other charge types."),
     termination_policy: TerminationPolicy.optional(),
     refund_policy: RefundPolicy.optional(),
     order_item_id: zod.uuid().optional(),
@@ -41,8 +40,11 @@ export const Subscription = zod
         .optional(),
     suspend_reason: zod.string().optional(),
     billing_cycle_anchor: zod.iso.datetime({ offset: true }).optional(),
-    cancellation_request: CancellationRequest.optional(),
-    paid_with: PaidWith.optional().describe("How the purchase, or the latest renewal paid with a saved card, was paid. Automatic renewal\ntries this card after the account's balance and credits, and the account's default card after\nthat."),
+    cancellation: SubscriptionCancellation.optional(),
+    default_payment_method_id: zod
+        .uuid()
+        .nullish()
+        .describe("The saved payment method automatic renewal charges after the account's balance and credits,\nbefore the account's default payment method. Set when the purchase, or a renewal, is paid with a saved\npayment method. It is used only while it belongs to the account that pays the renewal."),
     created_at: zod.iso.datetime({ offset: true }).optional(),
     id: zod.uuid(),
     billing_account_id: zod
@@ -63,11 +65,21 @@ export const Subscription = zod
     plan_name: zod.string(),
     price_id: zod.uuid(),
     quantity: zod.string(),
-    paid_until: zod.iso
+    current_term_end: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("When a prepaid subscription renews or expires, the end of the last service period bought.\nRenewing several periods in advance moves it. Null until a new subscription becomes active, even when\nits purchase has been paid, and for postpaid subscriptions."),
+    current_period_start: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("Start of the service period in effect now. Null when none is, including for postpaid subscriptions."),
+    current_period_end: zod.iso
         .datetime({ offset: true })
         .nullish()
-        .describe("End of the prepaid service already activated. Null until a new subscription becomes active,\neven when its purchase has been paid, and for postpaid subscriptions with no prepaid end date."),
-    auto_renew: zod.boolean(),
+        .describe("End of the service period in effect now. Renewing in advance moves `current_term_end`, not\nthis. Null when no period is in effect, including for postpaid subscriptions."),
+    auto_renew: zod
+        .boolean()
+        .describe("A prepaid subscription renews automatically while this is on. A postpaid subscription always continues until it is canceled; this is true until a cancellation is requested and cannot be set."),
     status: zod
         .enum(["pending", "provisioning", "active", "suspended", "canceled", "terminated"])
         .describe("pending means the purchase relationship exists but its order has not been accepted.\nprovisioning means the service accepted the order and is delivering. For a service-owned\npurchase, only confirmed delivery moves it to active; paying alone does not.\ncanceled means cancellation completed, or an unfulfilled purchase was canceled or failed without delivery.\nterminated means an administrator or the owning service immediately ended the commercial relationship."),

package/dist/billing/v1/generated/validators/{cancellationRequest.zod.d.ts → subscriptionCancellation.zod.d.ts}

@@ -6,7 +6,7 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export declare const CancellationRequest: zod.ZodObject<{
+export declare const SubscriptionCancellation: zod.ZodObject<{
     reason: zod.ZodOptional<zod.ZodString>;
     cancellation_id: zod.ZodOptional<zod.ZodUUID>;
     id: zod.ZodUUID;
@@ -33,5 +33,5 @@ export declare const CancellationRequest: zod.ZodObject<{
     failure_code: zod.ZodOptional<zod.ZodString>;
     failure_reason: zod.ZodOptional<zod.ZodString>;
 }, zod.z.core.$strict>;
-export type CancellationRequest = zod.input<typeof CancellationRequest>;
-export type CancellationRequestOutput = zod.output<typeof CancellationRequest>;
+export type SubscriptionCancellation = zod.input<typeof SubscriptionCancellation>;
+export type SubscriptionCancellationOutput = zod.output<typeof SubscriptionCancellation>;

package/dist/billing/v1/generated/validators/{cancellationRequest.zod.js → subscriptionCancellation.zod.js}

@@ -6,7 +6,7 @@
  * OpenAPI spec version: v1
  */
 import * as zod from "zod";
-export const CancellationRequest = zod
+export const SubscriptionCancellation = zod
     .strictObject({
     reason: zod.string().optional(),
     cancellation_id: zod
@@ -27,4 +27,4 @@ export const CancellationRequest = zod
     failure_code: zod.string().optional(),
     failure_reason: zod.string().optional(),
 })
-    .describe("A cancellation request for the original purchase. scheduled_at is the intended time; effective_at is\nthe confirmed end of service. The request alone does not stop metering or issue a refund.");
+    .describe("The latest cancellation that includes the subscription, with this subscription's item. `id` is the\nitem; `cancellation_id` is the cancellation. scheduled_at is the intended time; effective_at is the\nconfirmed end of service. A cancellation alone does not stop metering or issue a refund.");

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

@@ -9,7 +9,7 @@ import * as zod from "zod";
 export declare const SubscriptionList: zod.ZodObject<{
     items: zod.ZodArray<zod.ZodObject<{
         currency: zod.ZodString;
-        billing_type: zod.ZodEnum<{
+        charge_type: zod.ZodEnum<{
             postpaid: "postpaid";
             prepaid: "prepaid";
             one_time: "one_time";
@@ -41,7 +41,7 @@ export declare const SubscriptionList: zod.ZodObject<{
         discounted_renewals_remaining: zod.ZodOptional<zod.ZodInt>;
         suspend_reason: zod.ZodOptional<zod.ZodString>;
         billing_cycle_anchor: zod.ZodOptional<zod.z.ZodISODateTime>;
-        cancellation_request: zod.ZodOptional<zod.ZodObject<{
+        cancellation: zod.ZodOptional<zod.ZodObject<{
             reason: zod.ZodOptional<zod.ZodString>;
             cancellation_id: zod.ZodOptional<zod.ZodUUID>;
             id: zod.ZodUUID;
@@ -68,13 +68,7 @@ export declare const SubscriptionList: zod.ZodObject<{
             failure_code: zod.ZodOptional<zod.ZodString>;
             failure_reason: zod.ZodOptional<zod.ZodString>;
         }, zod.z.core.$strict>>;
-        paid_with: zod.ZodOptional<zod.ZodObject<{
-            method_type: zod.ZodString;
-            payment_gateway: zod.ZodOptional<zod.ZodString>;
-            payment_method_id: zod.ZodOptional<zod.ZodUUID>;
-            brand: zod.ZodOptional<zod.ZodString>;
-            last4: zod.ZodOptional<zod.ZodString>;
-        }, zod.z.core.$strict>>;
+        default_payment_method_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
         created_at: zod.ZodOptional<zod.z.ZodISODateTime>;
         id: zod.ZodUUID;
         billing_account_id: zod.ZodInt;
@@ -98,7 +92,9 @@ export declare const SubscriptionList: zod.ZodObject<{
         plan_name: zod.ZodString;
         price_id: zod.ZodUUID;
         quantity: zod.ZodString;
-        paid_until: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+        current_term_end: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+        current_period_start: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+        current_period_end: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
         auto_renew: zod.ZodBoolean;
         status: zod.ZodEnum<{
             pending: "pending";

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

@@ -17,7 +17,7 @@ export const TopUp = zod
     account: AccountIdentity,
     amount: Money.describe("What is credited to the account, in the account's own currency."),
     currency: zod.string(),
-    remaining_amount: Money.optional().describe("The part of this top-up still held in the balance. Pending refunds and payouts can temporarily\nreserve part of it; it is not a promise that the whole amount is immediately withdrawable."),
+    remaining_amount: Money.optional().describe("The part of this top-up still held in the balance. Pending refunds can temporarily\nreserve part of it; it is not a promise that the whole amount is immediately withdrawable."),
     status: zod
         .enum(["pending", "succeeded", "failed", "canceled"])
         .describe("`pending` until the payment gateway reaches a result. The balance increases on `succeeded`.\n\n`failed` means the gateway declined the payment. A declined attempt ends the top-up at once\nand the payment is withdrawn at the gateway; to pay another way, create a new top-up.\n`canceled` means the attempt was withdrawn without collecting money; `cancellation_reason`\nsays why. Unknown gateway outcomes remain `pending`, and a browser redirect is not proof of\npayment.\n\n`failed` and `canceled` are final. If the gateway nevertheless collects payment for such an\nattempt, the amount is credited as a separate `succeeded` top-up."),

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

@@ -41,7 +41,6 @@ export declare const Transaction: zod.ZodObject<{
         topup: "topup";
         payment: "payment";
         refund: "refund";
-        payout: "payout";
         adjustment: "adjustment";
     }>;
     amount: zod.ZodString;

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

@@ -39,7 +39,7 @@ export const Transaction = zod
     id: zod.uuid(),
     billing_account_id: zod.int().optional(),
     type: TransactionType,
-    amount: Money.describe("Signed by type: positive for `topup` and `payment`, negative for `refund` and `payout`.\nAn `adjustment` is positive when it adds to the balance and negative when it takes from\nit. For the other types the sign does not tell the effect on the balance: a payment from\nthe balance lowers it, while a payment by gateway or by credit leaves it unchanged."),
+    amount: Money.describe("Signed by type: positive for `topup` and `payment`, negative for `refund`.\nAn `adjustment` is positive when it adds to the balance and negative when it takes from\nit. For the other types the sign does not tell the effect on the balance: a payment from\nthe balance lowers it, while a payment by gateway or by credit leaves it unchanged."),
     remaining_amount: Money.describe("How much of this transaction is still available in the balance. Only top-ups, positive\nadjustments and gateway payments later returned to the balance can be non-zero."),
     currency: zod.string(),
     reason: zod.string().optional(),

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

@@ -42,7 +42,6 @@ export declare const TransactionList: zod.ZodObject<{
             topup: "topup";
             payment: "payment";
             refund: "refund";
-            payout: "payout";
             adjustment: "adjustment";
         }>;
         amount: zod.ZodString;

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

@@ -10,7 +10,6 @@ export declare const TransactionType: zod.ZodEnum<{
     topup: "topup";
     payment: "payment";
     refund: "refund";
-    payout: "payout";
     adjustment: "adjustment";
 }>;
 export type TransactionType = zod.input<typeof TransactionType>;

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

@@ -7,5 +7,5 @@
  */
 import * as zod from "zod";
 export const TransactionType = zod
-    .enum(["topup", "payment", "refund", "payout", "adjustment"])
-    .describe("topup adds to the balance; payment settles an invoice; refund returns original funds; payout withdraws from the balance; adjustment changes the balance with an audit reason.");
+    .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.");