@polar-sh/sdk 0.29.0 → 0.29.2

package/src/models/components/customerstatesubscription.ts

@@ -0,0 +1,389 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SubscriptionRecurringInterval,
+  SubscriptionRecurringInterval$inboundSchema,
+  SubscriptionRecurringInterval$outboundSchema,
+} from "./subscriptionrecurringinterval.js";
+
+export type CustomerStateSubscriptionCustomFieldData =
+  | string
+  | number
+  | boolean
+  | Date;
+
+export type CustomerStateSubscriptionMetadata = string | number | boolean;
+
+/**
+ * An active customer subscription.
+ */
+export type CustomerStateSubscription = {
+  /**
+   * The ID of the subscription.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * Key-value object storing custom field values.
+   */
+  customFieldData?:
+    | { [k: string]: string | number | boolean | Date | null }
+    | undefined;
+  metadata: { [k: string]: string | number | boolean };
+  status?: "active" | undefined;
+  /**
+   * The amount of the subscription.
+   */
+  amount: number | null;
+  /**
+   * The currency of the subscription.
+   */
+  currency: string | null;
+  recurringInterval: SubscriptionRecurringInterval;
+  /**
+   * The start timestamp of the current billing period.
+   */
+  currentPeriodStart: Date;
+  /**
+   * The end timestamp of the current billing period.
+   */
+  currentPeriodEnd: Date | null;
+  /**
+   * Whether the subscription will be canceled at the end of the current period.
+   */
+  cancelAtPeriodEnd: boolean;
+  /**
+   * The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.
+   */
+  canceledAt: Date | null;
+  /**
+   * The timestamp when the subscription started.
+   */
+  startedAt: Date | null;
+  /**
+   * The timestamp when the subscription will end.
+   */
+  endsAt: Date | null;
+  /**
+   * The ID of the subscribed product.
+   */
+  productId: string;
+  /**
+   * The ID of the subscribed price.
+   */
+  priceId: string;
+  /**
+   * The ID of the applied discount, if any.
+   */
+  discountId: string | null;
+};
+
+/** @internal */
+export const CustomerStateSubscriptionCustomFieldData$inboundSchema: z.ZodType<
+  CustomerStateSubscriptionCustomFieldData,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.string(),
+  z.number().int(),
+  z.boolean(),
+  z.string().datetime({ offset: true }).transform(v => new Date(v)),
+]);
+
+/** @internal */
+export type CustomerStateSubscriptionCustomFieldData$Outbound =
+  | string
+  | number
+  | boolean
+  | string;
+
+/** @internal */
+export const CustomerStateSubscriptionCustomFieldData$outboundSchema: z.ZodType<
+  CustomerStateSubscriptionCustomFieldData$Outbound,
+  z.ZodTypeDef,
+  CustomerStateSubscriptionCustomFieldData
+> = z.union([
+  z.string(),
+  z.number().int(),
+  z.boolean(),
+  z.date().transform(v => v.toISOString()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateSubscriptionCustomFieldData$ {
+  /** @deprecated use `CustomerStateSubscriptionCustomFieldData$inboundSchema` instead. */
+  export const inboundSchema =
+    CustomerStateSubscriptionCustomFieldData$inboundSchema;
+  /** @deprecated use `CustomerStateSubscriptionCustomFieldData$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomerStateSubscriptionCustomFieldData$outboundSchema;
+  /** @deprecated use `CustomerStateSubscriptionCustomFieldData$Outbound` instead. */
+  export type Outbound = CustomerStateSubscriptionCustomFieldData$Outbound;
+}
+
+export function customerStateSubscriptionCustomFieldDataToJSON(
+  customerStateSubscriptionCustomFieldData:
+    CustomerStateSubscriptionCustomFieldData,
+): string {
+  return JSON.stringify(
+    CustomerStateSubscriptionCustomFieldData$outboundSchema.parse(
+      customerStateSubscriptionCustomFieldData,
+    ),
+  );
+}
+
+export function customerStateSubscriptionCustomFieldDataFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CustomerStateSubscriptionCustomFieldData,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CustomerStateSubscriptionCustomFieldData$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CustomerStateSubscriptionCustomFieldData' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerStateSubscriptionMetadata$inboundSchema: z.ZodType<
+  CustomerStateSubscriptionMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type CustomerStateSubscriptionMetadata$Outbound =
+  | string
+  | number
+  | boolean;
+
+/** @internal */
+export const CustomerStateSubscriptionMetadata$outboundSchema: z.ZodType<
+  CustomerStateSubscriptionMetadata$Outbound,
+  z.ZodTypeDef,
+  CustomerStateSubscriptionMetadata
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateSubscriptionMetadata$ {
+  /** @deprecated use `CustomerStateSubscriptionMetadata$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateSubscriptionMetadata$inboundSchema;
+  /** @deprecated use `CustomerStateSubscriptionMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomerStateSubscriptionMetadata$outboundSchema;
+  /** @deprecated use `CustomerStateSubscriptionMetadata$Outbound` instead. */
+  export type Outbound = CustomerStateSubscriptionMetadata$Outbound;
+}
+
+export function customerStateSubscriptionMetadataToJSON(
+  customerStateSubscriptionMetadata: CustomerStateSubscriptionMetadata,
+): string {
+  return JSON.stringify(
+    CustomerStateSubscriptionMetadata$outboundSchema.parse(
+      customerStateSubscriptionMetadata,
+    ),
+  );
+}
+
+export function customerStateSubscriptionMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateSubscriptionMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateSubscriptionMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateSubscriptionMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerStateSubscription$inboundSchema: z.ZodType<
+  CustomerStateSubscription,
+  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)),
+  ),
+  custom_field_data: z.record(
+    z.nullable(
+      z.union([
+        z.string(),
+        z.number().int(),
+        z.boolean(),
+        z.string().datetime({ offset: true }).transform(v => new Date(v)),
+      ]),
+    ),
+  ).optional(),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  status: z.literal("active").optional(),
+  amount: z.nullable(z.number().int()),
+  currency: z.nullable(z.string()),
+  recurring_interval: SubscriptionRecurringInterval$inboundSchema,
+  current_period_start: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  current_period_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)),
+  ),
+  started_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  ends_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  product_id: z.string(),
+  price_id: z.string(),
+  discount_id: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "custom_field_data": "customFieldData",
+    "recurring_interval": "recurringInterval",
+    "current_period_start": "currentPeriodStart",
+    "current_period_end": "currentPeriodEnd",
+    "cancel_at_period_end": "cancelAtPeriodEnd",
+    "canceled_at": "canceledAt",
+    "started_at": "startedAt",
+    "ends_at": "endsAt",
+    "product_id": "productId",
+    "price_id": "priceId",
+    "discount_id": "discountId",
+  });
+});
+
+/** @internal */
+export type CustomerStateSubscription$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  custom_field_data?:
+    | { [k: string]: string | number | boolean | string | null }
+    | undefined;
+  metadata: { [k: string]: string | number | boolean };
+  status: "active";
+  amount: number | null;
+  currency: string | null;
+  recurring_interval: string;
+  current_period_start: string;
+  current_period_end: string | null;
+  cancel_at_period_end: boolean;
+  canceled_at: string | null;
+  started_at: string | null;
+  ends_at: string | null;
+  product_id: string;
+  price_id: string;
+  discount_id: string | null;
+};
+
+/** @internal */
+export const CustomerStateSubscription$outboundSchema: z.ZodType<
+  CustomerStateSubscription$Outbound,
+  z.ZodTypeDef,
+  CustomerStateSubscription
+> = z.object({
+  id: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  customFieldData: z.record(
+    z.nullable(
+      z.union([
+        z.string(),
+        z.number().int(),
+        z.boolean(),
+        z.date().transform(v => v.toISOString()),
+      ]),
+    ),
+  ).optional(),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  status: z.literal("active").default("active" as const),
+  amount: z.nullable(z.number().int()),
+  currency: z.nullable(z.string()),
+  recurringInterval: SubscriptionRecurringInterval$outboundSchema,
+  currentPeriodStart: z.date().transform(v => v.toISOString()),
+  currentPeriodEnd: 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())),
+  endsAt: z.nullable(z.date().transform(v => v.toISOString())),
+  productId: z.string(),
+  priceId: z.string(),
+  discountId: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    customFieldData: "custom_field_data",
+    recurringInterval: "recurring_interval",
+    currentPeriodStart: "current_period_start",
+    currentPeriodEnd: "current_period_end",
+    cancelAtPeriodEnd: "cancel_at_period_end",
+    canceledAt: "canceled_at",
+    startedAt: "started_at",
+    endsAt: "ends_at",
+    productId: "product_id",
+    priceId: "price_id",
+    discountId: "discount_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateSubscription$ {
+  /** @deprecated use `CustomerStateSubscription$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateSubscription$inboundSchema;
+  /** @deprecated use `CustomerStateSubscription$outboundSchema` instead. */
+  export const outboundSchema = CustomerStateSubscription$outboundSchema;
+  /** @deprecated use `CustomerStateSubscription$Outbound` instead. */
+  export type Outbound = CustomerStateSubscription$Outbound;
+}
+
+export function customerStateSubscriptionToJSON(
+  customerStateSubscription: CustomerStateSubscription,
+): string {
+  return JSON.stringify(
+    CustomerStateSubscription$outboundSchema.parse(customerStateSubscription),
+  );
+}
+
+export function customerStateSubscriptionFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateSubscription, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateSubscription$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateSubscription' from JSON`,
+  );
+}

package/src/models/components/customersubscription.ts

@@ -56,7 +56,13 @@ export type CustomerSubscription = {
    * The ID of the object.
    */
   id: string;
+  /**
+   * The amount of the subscription.
+   */
   amount: number | null;
+  /**
+   * The currency of the subscription.
+   */
   currency: string | null;
   recurringInterval: SubscriptionRecurringInterval;
   status: SubscriptionStatus;
@@ -70,6 +76,9 @@ export type CustomerSubscription = {
   customerId: string;
   productId: string;
   priceId: string;
+  /**
+   * The ID of the applied discount, if any.
+   */
   discountId: string | null;
   checkoutId: string | null;
   customerCancellationReason: CustomerCancellationReason | null;

package/src/models/components/customerupdate.ts

@@ -33,6 +33,9 @@ export type CustomerUpdate = {
    * The email address of the customer. This must be unique within the organization.
    */
   email?: string | null | undefined;
+  /**
+   * The name of the customer.
+   */
   name?: string | null | undefined;
   billingAddress?: Address | null | undefined;
   taxId?: Array<string | TaxIDFormat | null> | null | undefined;

package/src/models/components/licensekeycustomer.ts

@@ -24,6 +24,10 @@ export type LicenseKeyCustomerMetadata = string | number | boolean;
 export type TaxId = string | TaxIDFormat;
 
 export type LicenseKeyCustomer = {
+  /**
+   * The ID of the customer.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -32,10 +36,6 @@ export type LicenseKeyCustomer = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the object.
-   */
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   /**
    * The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.
@@ -49,9 +49,15 @@ export type LicenseKeyCustomer = {
    * Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
    */
   emailVerified: boolean;
+  /**
+   * The name of the customer.
+   */
   name: string | null;
   billingAddress: Address | null;
   taxId: Array<string | TaxIDFormat | null> | null;
+  /**
+   * The ID of the organization owning the customer.
+   */
   organizationId: string;
   avatarUrl: string;
 };
@@ -151,11 +157,11 @@ export const LicenseKeyCustomer$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(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   external_id: z.nullable(z.string()),
   email: z.string(),
@@ -182,9 +188,9 @@ export const LicenseKeyCustomer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type LicenseKeyCustomer$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   external_id: string | null;
   email: string;
@@ -202,9 +208,9 @@ export const LicenseKeyCustomer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   LicenseKeyCustomer
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   externalId: z.nullable(z.string()),
   email: z.string(),

package/src/models/components/ordercustomer.ts

@@ -24,6 +24,10 @@ export type OrderCustomerMetadata = string | number | boolean;
 export type OrderCustomerTaxId = string | TaxIDFormat;
 
 export type OrderCustomer = {
+  /**
+   * The ID of the customer.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -32,10 +36,6 @@ export type OrderCustomer = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the object.
-   */
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   /**
    * The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.
@@ -49,9 +49,15 @@ export type OrderCustomer = {
    * Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
    */
   emailVerified: boolean;
+  /**
+   * The name of the customer.
+   */
   name: string | null;
   billingAddress: Address | null;
   taxId: Array<string | TaxIDFormat | null> | null;
+  /**
+   * The ID of the organization owning the customer.
+   */
   organizationId: string;
   avatarUrl: string;
 };
@@ -158,11 +164,11 @@ export const OrderCustomer$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(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   external_id: z.nullable(z.string()),
   email: z.string(),
@@ -189,9 +195,9 @@ export const OrderCustomer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type OrderCustomer$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   external_id: string | null;
   email: string;
@@ -209,9 +215,9 @@ export const OrderCustomer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   OrderCustomer
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   externalId: z.nullable(z.string()),
   email: z.string(),

package/src/models/components/ordersubscription.ts

@@ -39,20 +39,59 @@ export type OrderSubscription = {
    * The ID of the object.
    */
   id: string;
+  /**
+   * The amount of the subscription.
+   */
   amount: number | null;
+  /**
+   * The currency of the subscription.
+   */
   currency: string | null;
   recurringInterval: SubscriptionRecurringInterval;
   status: SubscriptionStatus;
+  /**
+   * The start timestamp of the current billing period.
+   */
   currentPeriodStart: Date;
+  /**
+   * The end timestamp of the current billing period.
+   */
   currentPeriodEnd: Date | null;
+  /**
+   * Whether the subscription will be canceled at the end of the current period.
+   */
   cancelAtPeriodEnd: boolean;
+  /**
+   * The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.
+   */
   canceledAt: Date | null;
+  /**
+   * The timestamp when the subscription started.
+   */
   startedAt: Date | null;
+  /**
+   * The timestamp when the subscription will end.
+   */
   endsAt: Date | null;
+  /**
+   * The timestamp when the subscription ended.
+   */
   endedAt: Date | null;
+  /**
+   * The ID of the subscribed customer.
+   */
   customerId: string;
+  /**
+   * The ID of the subscribed product.
+   */
   productId: string;
+  /**
+   * The ID of the subscribed price.
+   */
   priceId: string;
+  /**
+   * The ID of the applied discount, if any.
+   */
   discountId: string | null;
   checkoutId: string | null;
   customerCancellationReason: CustomerCancellationReason | null;

package/src/models/components/subscription.ts

@@ -102,20 +102,59 @@ export type Subscription = {
    * The ID of the object.
    */
   id: string;
+  /**
+   * The amount of the subscription.
+   */
   amount: number | null;
+  /**
+   * The currency of the subscription.
+   */
   currency: string | null;
   recurringInterval: SubscriptionRecurringInterval;
   status: SubscriptionStatus;
+  /**
+   * The start timestamp of the current billing period.
+   */
   currentPeriodStart: Date;
+  /**
+   * The end timestamp of the current billing period.
+   */
   currentPeriodEnd: Date | null;
+  /**
+   * Whether the subscription will be canceled at the end of the current period.
+   */
   cancelAtPeriodEnd: boolean;
+  /**
+   * The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.
+   */
   canceledAt: Date | null;
+  /**
+   * The timestamp when the subscription started.
+   */
   startedAt: Date | null;
+  /**
+   * The timestamp when the subscription will end.
+   */
   endsAt: Date | null;
+  /**
+   * The timestamp when the subscription ended.
+   */
   endedAt: Date | null;
+  /**
+   * The ID of the subscribed customer.
+   */
   customerId: string;
+  /**
+   * The ID of the subscribed product.
+   */
   productId: string;
+  /**
+   * The ID of the subscribed price.
+   */
   priceId: string;
+  /**
+   * The ID of the applied discount, if any.
+   */
   discountId: string | null;
   checkoutId: string | null;
   customerCancellationReason: CustomerCancellationReason | null;