@polar-sh/sdk 0.35.0 → 0.35.2

package/src/models/components/checkoutpublic.ts

@@ -83,6 +83,11 @@ import {
   ProductPrice$Outbound,
   ProductPrice$outboundSchema,
 } from "./productprice.js";
+import {
+  TrialInterval,
+  TrialInterval$inboundSchema,
+  TrialInterval$outboundSchema,
+} from "./trialinterval.js";
 
 export type CheckoutPublicCustomFieldData = string | number | boolean | Date;
 
@@ -103,6 +108,10 @@ export type CheckoutPublicDiscount =
  * Checkout session data retrieved using the client secret.
  */
 export type CheckoutPublic = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -111,10 +120,6 @@ export type CheckoutPublic = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the object.
-   */
-  id: string;
   /**
    * Key-value object storing custom field values.
    */
@@ -167,6 +172,18 @@ export type CheckoutPublic = {
    * Currency code of the checkout session.
    */
   currency: string;
+  /**
+   * Interval unit of the trial period, if any. This value is either set from the checkout, if `trial_interval` is set, or from the selected product.
+   */
+  activeTrialInterval: TrialInterval | null;
+  /**
+   * Number of interval units of the trial period, if any. This value is either set from the checkout, if `trial_interval_count` is set, or from the selected product.
+   */
+  activeTrialIntervalCount: number | null;
+  /**
+   * End date and time of the trial period, if any.
+   */
+  trialEnd: Date | null;
   /**
    * ID of the product to checkout.
    */
@@ -436,11 +453,11 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   modified_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
-  id: z.string(),
   custom_field_data: z.record(
     z.nullable(
       z.union([
@@ -464,6 +481,11 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
   tax_amount: z.nullable(z.number().int()),
   total_amount: z.number().int(),
   currency: z.string(),
+  active_trial_interval: z.nullable(TrialInterval$inboundSchema),
+  active_trial_interval_count: z.nullable(z.number().int()),
+  trial_end: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   product_id: z.string(),
   product_price_id: z.string(),
   discount_id: z.nullable(z.string()),
@@ -514,6 +536,9 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
     "net_amount": "netAmount",
     "tax_amount": "taxAmount",
     "total_amount": "totalAmount",
+    "active_trial_interval": "activeTrialInterval",
+    "active_trial_interval_count": "activeTrialIntervalCount",
+    "trial_end": "trialEnd",
     "product_id": "productId",
     "product_price_id": "productPriceId",
     "discount_id": "discountId",
@@ -541,9 +566,9 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CheckoutPublic$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   custom_field_data?:
     | { [k: string]: string | number | boolean | string | null }
     | undefined;
@@ -560,6 +585,9 @@ export type CheckoutPublic$Outbound = {
   tax_amount: number | null;
   total_amount: number;
   currency: string;
+  active_trial_interval: string | null;
+  active_trial_interval_count: number | null;
+  trial_end: string | null;
   product_id: string;
   product_price_id: string;
   discount_id: string | null;
@@ -599,9 +627,9 @@ export const CheckoutPublic$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CheckoutPublic
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
   customFieldData: z.record(
     z.nullable(
       z.union([
@@ -625,6 +653,9 @@ export const CheckoutPublic$outboundSchema: z.ZodType<
   taxAmount: z.nullable(z.number().int()),
   totalAmount: z.number().int(),
   currency: z.string(),
+  activeTrialInterval: z.nullable(TrialInterval$outboundSchema),
+  activeTrialIntervalCount: z.nullable(z.number().int()),
+  trialEnd: z.nullable(z.date().transform(v => v.toISOString())),
   productId: z.string(),
   productPriceId: z.string(),
   discountId: z.nullable(z.string()),
@@ -675,6 +706,9 @@ export const CheckoutPublic$outboundSchema: z.ZodType<
     netAmount: "net_amount",
     taxAmount: "tax_amount",
     totalAmount: "total_amount",
+    activeTrialInterval: "active_trial_interval",
+    activeTrialIntervalCount: "active_trial_interval_count",
+    trialEnd: "trial_end",
     productId: "product_id",
     productPriceId: "product_price_id",
     discountId: "discount_id",

package/src/models/components/checkoutpublicconfirmed.ts

@@ -78,6 +78,11 @@ import {
   ProductPrice$Outbound,
   ProductPrice$outboundSchema,
 } from "./productprice.js";
+import {
+  TrialInterval,
+  TrialInterval$inboundSchema,
+  TrialInterval$outboundSchema,
+} from "./trialinterval.js";
 
 export type CheckoutPublicConfirmedCustomFieldData =
   | string
@@ -107,6 +112,10 @@ export type CheckoutPublicConfirmedDiscount =
  * right after the checkout.
  */
 export type CheckoutPublicConfirmed = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -115,10 +124,6 @@ export type CheckoutPublicConfirmed = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the object.
-   */
-  id: string;
   /**
    * Key-value object storing custom field values.
    */
@@ -171,6 +176,18 @@ export type CheckoutPublicConfirmed = {
    * Currency code of the checkout session.
    */
   currency: string;
+  /**
+   * Interval unit of the trial period, if any. This value is either set from the checkout, if `trial_interval` is set, or from the selected product.
+   */
+  activeTrialInterval: TrialInterval | null;
+  /**
+   * Number of interval units of the trial period, if any. This value is either set from the checkout, if `trial_interval_count` is set, or from the selected product.
+   */
+  activeTrialIntervalCount: number | null;
+  /**
+   * End date and time of the trial period, if any.
+   */
+  trialEnd: Date | null;
   /**
    * ID of the product to checkout.
    */
@@ -452,11 +469,11 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   modified_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
-  id: z.string(),
   custom_field_data: z.record(
     z.nullable(
       z.union([
@@ -480,6 +497,11 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
   tax_amount: z.nullable(z.number().int()),
   total_amount: z.number().int(),
   currency: z.string(),
+  active_trial_interval: z.nullable(TrialInterval$inboundSchema),
+  active_trial_interval_count: z.nullable(z.number().int()),
+  trial_end: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   product_id: z.string(),
   product_price_id: z.string(),
   discount_id: z.nullable(z.string()),
@@ -531,6 +553,9 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
     "net_amount": "netAmount",
     "tax_amount": "taxAmount",
     "total_amount": "totalAmount",
+    "active_trial_interval": "activeTrialInterval",
+    "active_trial_interval_count": "activeTrialIntervalCount",
+    "trial_end": "trialEnd",
     "product_id": "productId",
     "product_price_id": "productPriceId",
     "discount_id": "discountId",
@@ -559,9 +584,9 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CheckoutPublicConfirmed$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   custom_field_data?:
     | { [k: string]: string | number | boolean | string | null }
     | undefined;
@@ -578,6 +603,9 @@ export type CheckoutPublicConfirmed$Outbound = {
   tax_amount: number | null;
   total_amount: number;
   currency: string;
+  active_trial_interval: string | null;
+  active_trial_interval_count: number | null;
+  trial_end: string | null;
   product_id: string;
   product_price_id: string;
   discount_id: string | null;
@@ -618,9 +646,9 @@ export const CheckoutPublicConfirmed$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CheckoutPublicConfirmed
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
   customFieldData: z.record(
     z.nullable(
       z.union([
@@ -644,6 +672,9 @@ export const CheckoutPublicConfirmed$outboundSchema: z.ZodType<
   taxAmount: z.nullable(z.number().int()),
   totalAmount: z.number().int(),
   currency: z.string(),
+  activeTrialInterval: z.nullable(TrialInterval$outboundSchema),
+  activeTrialIntervalCount: z.nullable(z.number().int()),
+  trialEnd: z.nullable(z.date().transform(v => v.toISOString())),
   productId: z.string(),
   productPriceId: z.string(),
   discountId: z.nullable(z.string()),
@@ -695,6 +726,9 @@ export const CheckoutPublicConfirmed$outboundSchema: z.ZodType<
     netAmount: "net_amount",
     taxAmount: "tax_amount",
     totalAmount: "total_amount",
+    activeTrialInterval: "active_trial_interval",
+    activeTrialIntervalCount: "active_trial_interval_count",
+    trialEnd: "trial_end",
     productId: "product_id",
     productPriceId: "product_price_id",
     discountId: "discount_id",

package/src/models/components/checkoutupdate.ts

@@ -13,6 +13,11 @@ import {
   AddressInput$Outbound,
   AddressInput$outboundSchema,
 } from "./addressinput.js";
+import {
+  TrialInterval,
+  TrialInterval$inboundSchema,
+  TrialInterval$outboundSchema,
+} from "./trialinterval.js";
 
 export type CheckoutUpdateCustomFieldData = string | number | boolean | Date;
 
@@ -47,6 +52,14 @@ export type CheckoutUpdate = {
   customerBillingName?: string | null | undefined;
   customerBillingAddress?: AddressInput | null | undefined;
   customerTaxId?: string | null | undefined;
+  /**
+   * The interval unit for the trial period.
+   */
+  trialInterval?: TrialInterval | null | undefined;
+  /**
+   * The number of interval units for the trial period.
+   */
+  trialIntervalCount?: number | null | undefined;
   /**
    * Key-value object allowing you to store additional information.
    *
@@ -300,6 +313,8 @@ export const CheckoutUpdate$inboundSchema: z.ZodType<
   customer_billing_name: z.nullable(z.string()).optional(),
   customer_billing_address: z.nullable(AddressInput$inboundSchema).optional(),
   customer_tax_id: z.nullable(z.string()).optional(),
+  trial_interval: z.nullable(TrialInterval$inboundSchema).optional(),
+  trial_interval_count: z.nullable(z.number().int()).optional(),
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ).optional(),
@@ -323,6 +338,8 @@ export const CheckoutUpdate$inboundSchema: z.ZodType<
     "customer_billing_name": "customerBillingName",
     "customer_billing_address": "customerBillingAddress",
     "customer_tax_id": "customerTaxId",
+    "trial_interval": "trialInterval",
+    "trial_interval_count": "trialIntervalCount",
     "discount_id": "discountId",
     "allow_discount_codes": "allowDiscountCodes",
     "require_billing_address": "requireBillingAddress",
@@ -347,6 +364,8 @@ export type CheckoutUpdate$Outbound = {
   customer_billing_name?: string | null | undefined;
   customer_billing_address?: AddressInput$Outbound | null | undefined;
   customer_tax_id?: string | null | undefined;
+  trial_interval?: string | null | undefined;
+  trial_interval_count?: number | null | undefined;
   metadata?: { [k: string]: string | number | number | boolean } | undefined;
   discount_id?: string | null | undefined;
   allow_discount_codes?: boolean | null | undefined;
@@ -385,6 +404,8 @@ export const CheckoutUpdate$outboundSchema: z.ZodType<
   customerBillingName: z.nullable(z.string()).optional(),
   customerBillingAddress: z.nullable(AddressInput$outboundSchema).optional(),
   customerTaxId: z.nullable(z.string()).optional(),
+  trialInterval: z.nullable(TrialInterval$outboundSchema).optional(),
+  trialIntervalCount: z.nullable(z.number().int()).optional(),
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ).optional(),
@@ -408,6 +429,8 @@ export const CheckoutUpdate$outboundSchema: z.ZodType<
     customerBillingName: "customer_billing_name",
     customerBillingAddress: "customer_billing_address",
     customerTaxId: "customer_tax_id",
+    trialInterval: "trial_interval",
+    trialIntervalCount: "trial_interval_count",
     discountId: "discount_id",
     allowDiscountCodes: "allow_discount_codes",
     requireBillingAddress: "require_billing_address",

package/src/models/components/customerorderproduct.ts

@@ -42,12 +42,21 @@ import {
   SubscriptionRecurringInterval$inboundSchema,
   SubscriptionRecurringInterval$outboundSchema,
 } from "./subscriptionrecurringinterval.js";
+import {
+  TrialInterval,
+  TrialInterval$inboundSchema,
+  TrialInterval$outboundSchema,
+} from "./trialinterval.js";
 
 export type CustomerOrderProductPrices =
   | LegacyRecurringProductPrice
   | ProductPrice;
 
 export type CustomerOrderProduct = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -57,9 +66,13 @@ export type CustomerOrderProduct = {
    */
   modifiedAt: Date | null;
   /**
-   * The ID of the product.
+   * The interval unit for the trial period.
    */
-  id: string;
+  trialInterval: TrialInterval | null;
+  /**
+   * The number of interval units for the trial period.
+   */
+  trialIntervalCount: number | null;
   /**
    * The name of the product.
    */
@@ -161,11 +174,13 @@ export const CustomerOrderProduct$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   modified_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
-  id: z.string(),
+  trial_interval: z.nullable(TrialInterval$inboundSchema),
+  trial_interval_count: z.nullable(z.number().int()),
   name: z.string(),
   description: z.nullable(z.string()),
   recurring_interval: z.nullable(SubscriptionRecurringInterval$inboundSchema),
@@ -185,6 +200,8 @@ export const CustomerOrderProduct$inboundSchema: z.ZodType<
   return remap$(v, {
     "created_at": "createdAt",
     "modified_at": "modifiedAt",
+    "trial_interval": "trialInterval",
+    "trial_interval_count": "trialIntervalCount",
     "recurring_interval": "recurringInterval",
     "is_recurring": "isRecurring",
     "is_archived": "isArchived",
@@ -194,9 +211,11 @@ export const CustomerOrderProduct$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CustomerOrderProduct$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  trial_interval: string | null;
+  trial_interval_count: number | null;
   name: string;
   description: string | null;
   recurring_interval: string | null;
@@ -215,9 +234,11 @@ export const CustomerOrderProduct$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerOrderProduct
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
+  trialInterval: z.nullable(TrialInterval$outboundSchema),
+  trialIntervalCount: z.nullable(z.number().int()),
   name: z.string(),
   description: z.nullable(z.string()),
   recurringInterval: z.nullable(SubscriptionRecurringInterval$outboundSchema),
@@ -237,6 +258,8 @@ export const CustomerOrderProduct$outboundSchema: z.ZodType<
   return remap$(v, {
     createdAt: "created_at",
     modifiedAt: "modified_at",
+    trialInterval: "trial_interval",
+    trialIntervalCount: "trial_interval_count",
     recurringInterval: "recurring_interval",
     isRecurring: "is_recurring",
     isArchived: "is_archived",

package/src/models/components/customerordersubscription.ts

@@ -54,6 +54,14 @@ export type CustomerOrderSubscription = {
    * The end timestamp of the current billing period.
    */
   currentPeriodEnd: Date | null;
+  /**
+   * The start timestamp of the trial period, if any.
+   */
+  trialStart: Date | null;
+  /**
+   * The end timestamp of the trial period, if any.
+   */
+  trialEnd: Date | null;
   /**
    * Whether the subscription will be canceled at the end of the current period.
    */
@@ -112,6 +120,12 @@ export const CustomerOrderSubscription$inboundSchema: z.ZodType<
   current_period_end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  trial_start: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  trial_end: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   cancel_at_period_end: z.boolean(),
   canceled_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -140,6 +154,8 @@ export const CustomerOrderSubscription$inboundSchema: z.ZodType<
     "recurring_interval": "recurringInterval",
     "current_period_start": "currentPeriodStart",
     "current_period_end": "currentPeriodEnd",
+    "trial_start": "trialStart",
+    "trial_end": "trialEnd",
     "cancel_at_period_end": "cancelAtPeriodEnd",
     "canceled_at": "canceledAt",
     "started_at": "startedAt",
@@ -165,6 +181,8 @@ export type CustomerOrderSubscription$Outbound = {
   status: string;
   current_period_start: string;
   current_period_end: string | null;
+  trial_start: string | null;
+  trial_end: string | null;
   cancel_at_period_end: boolean;
   canceled_at: string | null;
   started_at: string | null;
@@ -193,6 +211,8 @@ export const CustomerOrderSubscription$outboundSchema: z.ZodType<
   status: SubscriptionStatus$outboundSchema,
   currentPeriodStart: z.date().transform(v => v.toISOString()),
   currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())),
+  trialStart: z.nullable(z.date().transform(v => v.toISOString())),
+  trialEnd: z.nullable(z.date().transform(v => v.toISOString())),
   cancelAtPeriodEnd: z.boolean(),
   canceledAt: z.nullable(z.date().transform(v => v.toISOString())),
   startedAt: z.nullable(z.date().transform(v => v.toISOString())),
@@ -213,6 +233,8 @@ export const CustomerOrderSubscription$outboundSchema: z.ZodType<
     recurringInterval: "recurring_interval",
     currentPeriodStart: "current_period_start",
     currentPeriodEnd: "current_period_end",
+    trialStart: "trial_start",
+    trialEnd: "trial_end",
     cancelAtPeriodEnd: "cancel_at_period_end",
     canceledAt: "canceled_at",
     startedAt: "started_at",

package/src/models/components/customerproduct.ts

@@ -36,6 +36,11 @@ import {
   SubscriptionRecurringInterval$inboundSchema,
   SubscriptionRecurringInterval$outboundSchema,
 } from "./subscriptionrecurringinterval.js";
+import {
+  TrialInterval,
+  TrialInterval$inboundSchema,
+  TrialInterval$outboundSchema,
+} from "./trialinterval.js";
 
 export type CustomerProductPrices = LegacyRecurringProductPrice | ProductPrice;
 
@@ -43,6 +48,10 @@ export type CustomerProductPrices = LegacyRecurringProductPrice | ProductPrice;
  * Schema of a product for customer portal.
  */
 export type CustomerProduct = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -52,9 +61,13 @@ export type CustomerProduct = {
    */
   modifiedAt: Date | null;
   /**
-   * The ID of the product.
+   * The interval unit for the trial period.
    */
-  id: string;
+  trialInterval: TrialInterval | null;
+  /**
+   * The number of interval units for the trial period.
+   */
+  trialIntervalCount: number | null;
   /**
    * The name of the product.
    */
@@ -155,11 +168,13 @@ export const CustomerProduct$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   modified_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
-  id: z.string(),
+  trial_interval: z.nullable(TrialInterval$inboundSchema),
+  trial_interval_count: z.nullable(z.number().int()),
   name: z.string(),
   description: z.nullable(z.string()),
   recurring_interval: z.nullable(SubscriptionRecurringInterval$inboundSchema),
@@ -178,6 +193,8 @@ export const CustomerProduct$inboundSchema: z.ZodType<
   return remap$(v, {
     "created_at": "createdAt",
     "modified_at": "modifiedAt",
+    "trial_interval": "trialInterval",
+    "trial_interval_count": "trialIntervalCount",
     "recurring_interval": "recurringInterval",
     "is_recurring": "isRecurring",
     "is_archived": "isArchived",
@@ -187,9 +204,11 @@ export const CustomerProduct$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CustomerProduct$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  trial_interval: string | null;
+  trial_interval_count: number | null;
   name: string;
   description: string | null;
   recurring_interval: string | null;
@@ -207,9 +226,11 @@ export const CustomerProduct$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerProduct
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
+  trialInterval: z.nullable(TrialInterval$outboundSchema),
+  trialIntervalCount: z.nullable(z.number().int()),
   name: z.string(),
   description: z.nullable(z.string()),
   recurringInterval: z.nullable(SubscriptionRecurringInterval$outboundSchema),
@@ -228,6 +249,8 @@ export const CustomerProduct$outboundSchema: z.ZodType<
   return remap$(v, {
     createdAt: "created_at",
     modifiedAt: "modified_at",
+    trialInterval: "trial_interval",
+    trialIntervalCount: "trial_interval_count",
     recurringInterval: "recurring_interval",
     isRecurring: "is_recurring",
     isArchived: "is_archived",