@polar-sh/sdk 0.40.1 → 0.40.3

package/src/models/components/customerstatesubscription.ts

@@ -32,13 +32,11 @@ export type CustomerStateSubscriptionMetadata =
   | number
   | boolean;
 
-export const CustomerStateSubscriptionStatus = {
+export const Status = {
   Active: "active",
   Trialing: "trialing",
 } as const;
-export type CustomerStateSubscriptionStatus = ClosedEnum<
-  typeof CustomerStateSubscriptionStatus
->;
+export type Status = ClosedEnum<typeof Status>;
 
 /**
  * An active customer subscription.
@@ -63,7 +61,7 @@ export type CustomerStateSubscription = {
     | { [k: string]: string | number | boolean | Date | null }
     | undefined;
   metadata: { [k: string]: string | number | number | boolean };
-  status: CustomerStateSubscriptionStatus;
+  status: Status;
   /**
    * The amount of the subscription.
    */
@@ -248,24 +246,22 @@ export function customerStateSubscriptionMetadataFromJSON(
 }
 
 /** @internal */
-export const CustomerStateSubscriptionStatus$inboundSchema: z.ZodNativeEnum<
-  typeof CustomerStateSubscriptionStatus
-> = z.nativeEnum(CustomerStateSubscriptionStatus);
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
 
 /** @internal */
-export const CustomerStateSubscriptionStatus$outboundSchema: z.ZodNativeEnum<
-  typeof CustomerStateSubscriptionStatus
-> = CustomerStateSubscriptionStatus$inboundSchema;
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace CustomerStateSubscriptionStatus$ {
-  /** @deprecated use `CustomerStateSubscriptionStatus$inboundSchema` instead. */
-  export const inboundSchema = CustomerStateSubscriptionStatus$inboundSchema;
-  /** @deprecated use `CustomerStateSubscriptionStatus$outboundSchema` instead. */
-  export const outboundSchema = CustomerStateSubscriptionStatus$outboundSchema;
+export namespace Status$ {
+  /** @deprecated use `Status$inboundSchema` instead. */
+  export const inboundSchema = Status$inboundSchema;
+  /** @deprecated use `Status$outboundSchema` instead. */
+  export const outboundSchema = Status$outboundSchema;
 }
 
 /** @internal */
@@ -292,7 +288,7 @@ export const CustomerStateSubscription$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  status: CustomerStateSubscriptionStatus$inboundSchema,
+  status: Status$inboundSchema,
   amount: z.number().int(),
   currency: z.string(),
   recurring_interval: SubscriptionRecurringInterval$inboundSchema,
@@ -388,7 +384,7 @@ export const CustomerStateSubscription$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  status: CustomerStateSubscriptionStatus$outboundSchema,
+  status: Status$outboundSchema,
   amount: z.number().int(),
   currency: z.string(),
   recurringInterval: SubscriptionRecurringInterval$outboundSchema,

package/src/models/components/customerupdatedevent.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  CustomerUpdatedMetadata,
+  CustomerUpdatedMetadata$inboundSchema,
+  CustomerUpdatedMetadata$Outbound,
+  CustomerUpdatedMetadata$outboundSchema,
+} from "./customerupdatedmetadata.js";
+
+/**
+ * An event created by Polar when a customer is updated.
+ */
+export type CustomerUpdatedEvent = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp: Date;
+  /**
+   * The ID of the organization owning the event.
+   */
+  organizationId: string;
+  /**
+   * ID of the customer in your Polar organization associated with the event.
+   */
+  customerId: string | null;
+  /**
+   * The customer associated with the event.
+   */
+  customer: Customer | null;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string | null;
+  /**
+   * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
+   */
+  source: "system";
+  /**
+   * The name of the event.
+   */
+  name: "customer.updated";
+  metadata: CustomerUpdatedMetadata;
+};
+
+/** @internal */
+export const CustomerUpdatedEvent$inboundSchema: z.ZodType<
+  CustomerUpdatedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  organization_id: z.string(),
+  customer_id: z.nullable(z.string()),
+  customer: z.nullable(Customer$inboundSchema),
+  external_customer_id: z.nullable(z.string()),
+  source: z.literal("system"),
+  name: z.literal("customer.updated"),
+  metadata: CustomerUpdatedMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+  });
+});
+
+/** @internal */
+export type CustomerUpdatedEvent$Outbound = {
+  id: string;
+  timestamp: string;
+  organization_id: string;
+  customer_id: string | null;
+  customer: Customer$Outbound | null;
+  external_customer_id: string | null;
+  source: "system";
+  name: "customer.updated";
+  metadata: CustomerUpdatedMetadata$Outbound;
+};
+
+/** @internal */
+export const CustomerUpdatedEvent$outboundSchema: z.ZodType<
+  CustomerUpdatedEvent$Outbound,
+  z.ZodTypeDef,
+  CustomerUpdatedEvent
+> = z.object({
+  id: z.string(),
+  timestamp: z.date().transform(v => v.toISOString()),
+  organizationId: z.string(),
+  customerId: z.nullable(z.string()),
+  customer: z.nullable(Customer$outboundSchema),
+  externalCustomerId: z.nullable(z.string()),
+  source: z.literal("system"),
+  name: z.literal("customer.updated"),
+  metadata: CustomerUpdatedMetadata$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    customerId: "customer_id",
+    externalCustomerId: "external_customer_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerUpdatedEvent$ {
+  /** @deprecated use `CustomerUpdatedEvent$inboundSchema` instead. */
+  export const inboundSchema = CustomerUpdatedEvent$inboundSchema;
+  /** @deprecated use `CustomerUpdatedEvent$outboundSchema` instead. */
+  export const outboundSchema = CustomerUpdatedEvent$outboundSchema;
+  /** @deprecated use `CustomerUpdatedEvent$Outbound` instead. */
+  export type Outbound = CustomerUpdatedEvent$Outbound;
+}
+
+export function customerUpdatedEventToJSON(
+  customerUpdatedEvent: CustomerUpdatedEvent,
+): string {
+  return JSON.stringify(
+    CustomerUpdatedEvent$outboundSchema.parse(customerUpdatedEvent),
+  );
+}
+
+export function customerUpdatedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerUpdatedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerUpdatedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerUpdatedEvent' from JSON`,
+  );
+}

package/src/models/components/customerupdatedfields.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  AddressDict,
+  AddressDict$inboundSchema,
+  AddressDict$Outbound,
+  AddressDict$outboundSchema,
+} from "./addressdict.js";
+
+export type CustomerUpdatedFieldsMetadata = string | number | boolean;
+
+export type CustomerUpdatedFields = {
+  name?: string | null | undefined;
+  email?: string | null | undefined;
+  billingAddress?: AddressDict | null | undefined;
+  taxId?: string | null | undefined;
+  metadata?: { [k: string]: string | number | boolean } | null | undefined;
+};
+
+/** @internal */
+export const CustomerUpdatedFieldsMetadata$inboundSchema: z.ZodType<
+  CustomerUpdatedFieldsMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type CustomerUpdatedFieldsMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const CustomerUpdatedFieldsMetadata$outboundSchema: z.ZodType<
+  CustomerUpdatedFieldsMetadata$Outbound,
+  z.ZodTypeDef,
+  CustomerUpdatedFieldsMetadata
+> = 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 CustomerUpdatedFieldsMetadata$ {
+  /** @deprecated use `CustomerUpdatedFieldsMetadata$inboundSchema` instead. */
+  export const inboundSchema = CustomerUpdatedFieldsMetadata$inboundSchema;
+  /** @deprecated use `CustomerUpdatedFieldsMetadata$outboundSchema` instead. */
+  export const outboundSchema = CustomerUpdatedFieldsMetadata$outboundSchema;
+  /** @deprecated use `CustomerUpdatedFieldsMetadata$Outbound` instead. */
+  export type Outbound = CustomerUpdatedFieldsMetadata$Outbound;
+}
+
+export function customerUpdatedFieldsMetadataToJSON(
+  customerUpdatedFieldsMetadata: CustomerUpdatedFieldsMetadata,
+): string {
+  return JSON.stringify(
+    CustomerUpdatedFieldsMetadata$outboundSchema.parse(
+      customerUpdatedFieldsMetadata,
+    ),
+  );
+}
+
+export function customerUpdatedFieldsMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerUpdatedFieldsMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerUpdatedFieldsMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerUpdatedFieldsMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerUpdatedFields$inboundSchema: z.ZodType<
+  CustomerUpdatedFields,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  billing_address: z.nullable(AddressDict$inboundSchema).optional(),
+  tax_id: z.nullable(z.string()).optional(),
+  metadata: z.nullable(
+    z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "billing_address": "billingAddress",
+    "tax_id": "taxId",
+  });
+});
+
+/** @internal */
+export type CustomerUpdatedFields$Outbound = {
+  name?: string | null | undefined;
+  email?: string | null | undefined;
+  billing_address?: AddressDict$Outbound | null | undefined;
+  tax_id?: string | null | undefined;
+  metadata?: { [k: string]: string | number | boolean } | null | undefined;
+};
+
+/** @internal */
+export const CustomerUpdatedFields$outboundSchema: z.ZodType<
+  CustomerUpdatedFields$Outbound,
+  z.ZodTypeDef,
+  CustomerUpdatedFields
+> = z.object({
+  name: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  billingAddress: z.nullable(AddressDict$outboundSchema).optional(),
+  taxId: z.nullable(z.string()).optional(),
+  metadata: z.nullable(
+    z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    billingAddress: "billing_address",
+    taxId: "tax_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerUpdatedFields$ {
+  /** @deprecated use `CustomerUpdatedFields$inboundSchema` instead. */
+  export const inboundSchema = CustomerUpdatedFields$inboundSchema;
+  /** @deprecated use `CustomerUpdatedFields$outboundSchema` instead. */
+  export const outboundSchema = CustomerUpdatedFields$outboundSchema;
+  /** @deprecated use `CustomerUpdatedFields$Outbound` instead. */
+  export type Outbound = CustomerUpdatedFields$Outbound;
+}
+
+export function customerUpdatedFieldsToJSON(
+  customerUpdatedFields: CustomerUpdatedFields,
+): string {
+  return JSON.stringify(
+    CustomerUpdatedFields$outboundSchema.parse(customerUpdatedFields),
+  );
+}
+
+export function customerUpdatedFieldsFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerUpdatedFields, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerUpdatedFields$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerUpdatedFields' from JSON`,
+  );
+}

package/src/models/components/customerupdatedmetadata.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  CustomerUpdatedFields,
+  CustomerUpdatedFields$inboundSchema,
+  CustomerUpdatedFields$Outbound,
+  CustomerUpdatedFields$outboundSchema,
+} from "./customerupdatedfields.js";
+
+export type CustomerUpdatedMetadata = {
+  customerId: string;
+  customerEmail: string;
+  customerName: string | null;
+  customerExternalId: string | null;
+  updatedFields: CustomerUpdatedFields;
+};
+
+/** @internal */
+export const CustomerUpdatedMetadata$inboundSchema: z.ZodType<
+  CustomerUpdatedMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customer_id: z.string(),
+  customer_email: z.string(),
+  customer_name: z.nullable(z.string()),
+  customer_external_id: z.nullable(z.string()),
+  updated_fields: CustomerUpdatedFields$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "customer_id": "customerId",
+    "customer_email": "customerEmail",
+    "customer_name": "customerName",
+    "customer_external_id": "customerExternalId",
+    "updated_fields": "updatedFields",
+  });
+});
+
+/** @internal */
+export type CustomerUpdatedMetadata$Outbound = {
+  customer_id: string;
+  customer_email: string;
+  customer_name: string | null;
+  customer_external_id: string | null;
+  updated_fields: CustomerUpdatedFields$Outbound;
+};
+
+/** @internal */
+export const CustomerUpdatedMetadata$outboundSchema: z.ZodType<
+  CustomerUpdatedMetadata$Outbound,
+  z.ZodTypeDef,
+  CustomerUpdatedMetadata
+> = z.object({
+  customerId: z.string(),
+  customerEmail: z.string(),
+  customerName: z.nullable(z.string()),
+  customerExternalId: z.nullable(z.string()),
+  updatedFields: CustomerUpdatedFields$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    customerId: "customer_id",
+    customerEmail: "customer_email",
+    customerName: "customer_name",
+    customerExternalId: "customer_external_id",
+    updatedFields: "updated_fields",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerUpdatedMetadata$ {
+  /** @deprecated use `CustomerUpdatedMetadata$inboundSchema` instead. */
+  export const inboundSchema = CustomerUpdatedMetadata$inboundSchema;
+  /** @deprecated use `CustomerUpdatedMetadata$outboundSchema` instead. */
+  export const outboundSchema = CustomerUpdatedMetadata$outboundSchema;
+  /** @deprecated use `CustomerUpdatedMetadata$Outbound` instead. */
+  export type Outbound = CustomerUpdatedMetadata$Outbound;
+}
+
+export function customerUpdatedMetadataToJSON(
+  customerUpdatedMetadata: CustomerUpdatedMetadata,
+): string {
+  return JSON.stringify(
+    CustomerUpdatedMetadata$outboundSchema.parse(customerUpdatedMetadata),
+  );
+}
+
+export function customerUpdatedMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerUpdatedMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerUpdatedMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerUpdatedMetadata' from JSON`,
+  );
+}

package/src/models/components/customerwallet.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * A wallet represents your balance with an organization.
+ *
+ * @remarks
+ *
+ * You can top-up your wallet and use the balance to pay for usage.
+ */
+export type CustomerWallet = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the customer that owns the wallet.
+   */
+  customerId: string;
+  /**
+   * The current balance of the wallet, in cents.
+   */
+  balance: number;
+  /**
+   * The currency of the wallet.
+   */
+  currency: string;
+};
+
+/** @internal */
+export const CustomerWallet$inboundSchema: z.ZodType<
+  CustomerWallet,
+  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)),
+  ),
+  customer_id: z.string(),
+  balance: z.number().int(),
+  currency: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "customer_id": "customerId",
+  });
+});
+
+/** @internal */
+export type CustomerWallet$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  customer_id: string;
+  balance: number;
+  currency: string;
+};
+
+/** @internal */
+export const CustomerWallet$outboundSchema: z.ZodType<
+  CustomerWallet$Outbound,
+  z.ZodTypeDef,
+  CustomerWallet
+> = z.object({
+  id: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  customerId: z.string(),
+  balance: z.number().int(),
+  currency: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    customerId: "customer_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerWallet$ {
+  /** @deprecated use `CustomerWallet$inboundSchema` instead. */
+  export const inboundSchema = CustomerWallet$inboundSchema;
+  /** @deprecated use `CustomerWallet$outboundSchema` instead. */
+  export const outboundSchema = CustomerWallet$outboundSchema;
+  /** @deprecated use `CustomerWallet$Outbound` instead. */
+  export type Outbound = CustomerWallet$Outbound;
+}
+
+export function customerWalletToJSON(customerWallet: CustomerWallet): string {
+  return JSON.stringify(CustomerWallet$outboundSchema.parse(customerWallet));
+}
+
+export function customerWalletFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerWallet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerWallet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerWallet' from JSON`,
+  );
+}

package/src/models/components/customerwalletsortproperty.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CustomerWalletSortProperty = {
+  CreatedAt: "created_at",
+  MinusCreatedAt: "-created_at",
+  Balance: "balance",
+  MinusBalance: "-balance",
+} as const;
+export type CustomerWalletSortProperty = ClosedEnum<
+  typeof CustomerWalletSortProperty
+>;
+
+/** @internal */
+export const CustomerWalletSortProperty$inboundSchema: z.ZodNativeEnum<
+  typeof CustomerWalletSortProperty
+> = z.nativeEnum(CustomerWalletSortProperty);
+
+/** @internal */
+export const CustomerWalletSortProperty$outboundSchema: z.ZodNativeEnum<
+  typeof CustomerWalletSortProperty
+> = CustomerWalletSortProperty$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerWalletSortProperty$ {
+  /** @deprecated use `CustomerWalletSortProperty$inboundSchema` instead. */
+  export const inboundSchema = CustomerWalletSortProperty$inboundSchema;
+  /** @deprecated use `CustomerWalletSortProperty$outboundSchema` instead. */
+  export const outboundSchema = CustomerWalletSortProperty$outboundSchema;
+}