@polar-sh/sdk 0.22.2 → 0.23.0

package/src/models/components/event.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 {
+  EventSource,
+  EventSource$inboundSchema,
+  EventSource$outboundSchema,
+} from "./eventsource.js";
+
+export type EventMetadata = string | number | boolean;
+
+export type Event = {
+  metadata: { [k: string]: string | number | boolean };
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp: Date;
+  /**
+   * The name of the event.
+   */
+  name: string;
+  source: EventSource;
+  /**
+   * 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;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string | null;
+};
+
+/** @internal */
+export const EventMetadata$inboundSchema: z.ZodType<
+  EventMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type EventMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const EventMetadata$outboundSchema: z.ZodType<
+  EventMetadata$Outbound,
+  z.ZodTypeDef,
+  EventMetadata
+> = 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 EventMetadata$ {
+  /** @deprecated use `EventMetadata$inboundSchema` instead. */
+  export const inboundSchema = EventMetadata$inboundSchema;
+  /** @deprecated use `EventMetadata$outboundSchema` instead. */
+  export const outboundSchema = EventMetadata$outboundSchema;
+  /** @deprecated use `EventMetadata$Outbound` instead. */
+  export type Outbound = EventMetadata$Outbound;
+}
+
+export function eventMetadataToJSON(eventMetadata: EventMetadata): string {
+  return JSON.stringify(EventMetadata$outboundSchema.parse(eventMetadata));
+}
+
+export function eventMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
+  .object({
+    metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+    id: z.string(),
+    timestamp: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    name: z.string(),
+    source: EventSource$inboundSchema,
+    organization_id: z.string(),
+    customer_id: z.nullable(z.string()),
+    external_customer_id: z.nullable(z.string()),
+  }).transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+      "customer_id": "customerId",
+      "external_customer_id": "externalCustomerId",
+    });
+  });
+
+/** @internal */
+export type Event$Outbound = {
+  metadata: { [k: string]: string | number | boolean };
+  id: string;
+  timestamp: string;
+  name: string;
+  source: string;
+  organization_id: string;
+  customer_id: string | null;
+  external_customer_id: string | null;
+};
+
+/** @internal */
+export const Event$outboundSchema: z.ZodType<
+  Event$Outbound,
+  z.ZodTypeDef,
+  Event
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  id: z.string(),
+  timestamp: z.date().transform(v => v.toISOString()),
+  name: z.string(),
+  source: EventSource$outboundSchema,
+  organizationId: z.string(),
+  customerId: z.nullable(z.string()),
+  externalCustomerId: z.nullable(z.string()),
+}).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 Event$ {
+  /** @deprecated use `Event$inboundSchema` instead. */
+  export const inboundSchema = Event$inboundSchema;
+  /** @deprecated use `Event$outboundSchema` instead. */
+  export const outboundSchema = Event$outboundSchema;
+  /** @deprecated use `Event$Outbound` instead. */
+  export type Outbound = Event$Outbound;
+}
+
+export function eventToJSON(event: Event): string {
+  return JSON.stringify(Event$outboundSchema.parse(event));
+}
+
+export function eventFromJSON(
+  jsonString: string,
+): SafeParseResult<Event, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event' from JSON`,
+  );
+}

package/src/models/components/eventcreatecustomer.ts

@@ -0,0 +1,174 @@
+/*
+ * 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";
+
+export type EventCreateCustomerMetadata = string | number | boolean;
+
+export type EventCreateCustomer = {
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be either:
+   *
+   * * A string with a maximum length of **500 characters**
+   * * An integer
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp?: Date | undefined;
+  /**
+   * The name of the event.
+   */
+  name: string;
+  /**
+   * The ID of the organization owning the event. **Required unless you use an organization token.**
+   */
+  organizationId?: string | null | undefined;
+  /**
+   * ID of the customer in your Polar organization associated with the event.
+   */
+  customerId: string;
+};
+
+/** @internal */
+export const EventCreateCustomerMetadata$inboundSchema: z.ZodType<
+  EventCreateCustomerMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type EventCreateCustomerMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const EventCreateCustomerMetadata$outboundSchema: z.ZodType<
+  EventCreateCustomerMetadata$Outbound,
+  z.ZodTypeDef,
+  EventCreateCustomerMetadata
+> = 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 EventCreateCustomerMetadata$ {
+  /** @deprecated use `EventCreateCustomerMetadata$inboundSchema` instead. */
+  export const inboundSchema = EventCreateCustomerMetadata$inboundSchema;
+  /** @deprecated use `EventCreateCustomerMetadata$outboundSchema` instead. */
+  export const outboundSchema = EventCreateCustomerMetadata$outboundSchema;
+  /** @deprecated use `EventCreateCustomerMetadata$Outbound` instead. */
+  export type Outbound = EventCreateCustomerMetadata$Outbound;
+}
+
+export function eventCreateCustomerMetadataToJSON(
+  eventCreateCustomerMetadata: EventCreateCustomerMetadata,
+): string {
+  return JSON.stringify(
+    EventCreateCustomerMetadata$outboundSchema.parse(
+      eventCreateCustomerMetadata,
+    ),
+  );
+}
+
+export function eventCreateCustomerMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventCreateCustomerMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventCreateCustomerMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventCreateCustomerMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventCreateCustomer$inboundSchema: z.ZodType<
+  EventCreateCustomer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  name: z.string(),
+  organization_id: z.nullable(z.string()).optional(),
+  customer_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+  });
+});
+
+/** @internal */
+export type EventCreateCustomer$Outbound = {
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  timestamp?: string | undefined;
+  name: string;
+  organization_id?: string | null | undefined;
+  customer_id: string;
+};
+
+/** @internal */
+export const EventCreateCustomer$outboundSchema: z.ZodType<
+  EventCreateCustomer$Outbound,
+  z.ZodTypeDef,
+  EventCreateCustomer
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
+  timestamp: z.date().transform(v => v.toISOString()).optional(),
+  name: z.string(),
+  organizationId: z.nullable(z.string()).optional(),
+  customerId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    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 EventCreateCustomer$ {
+  /** @deprecated use `EventCreateCustomer$inboundSchema` instead. */
+  export const inboundSchema = EventCreateCustomer$inboundSchema;
+  /** @deprecated use `EventCreateCustomer$outboundSchema` instead. */
+  export const outboundSchema = EventCreateCustomer$outboundSchema;
+  /** @deprecated use `EventCreateCustomer$Outbound` instead. */
+  export type Outbound = EventCreateCustomer$Outbound;
+}
+
+export function eventCreateCustomerToJSON(
+  eventCreateCustomer: EventCreateCustomer,
+): string {
+  return JSON.stringify(
+    EventCreateCustomer$outboundSchema.parse(eventCreateCustomer),
+  );
+}
+
+export function eventCreateCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<EventCreateCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventCreateCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventCreateCustomer' from JSON`,
+  );
+}

package/src/models/components/eventcreateexternalcustomer.ts

@@ -0,0 +1,182 @@
+/*
+ * 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";
+
+export type EventCreateExternalCustomerMetadata = string | number | boolean;
+
+export type EventCreateExternalCustomer = {
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be either:
+   *
+   * * A string with a maximum length of **500 characters**
+   * * An integer
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp?: Date | undefined;
+  /**
+   * The name of the event.
+   */
+  name: string;
+  /**
+   * The ID of the organization owning the event. **Required unless you use an organization token.**
+   */
+  organizationId?: string | null | undefined;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string;
+};
+
+/** @internal */
+export const EventCreateExternalCustomerMetadata$inboundSchema: z.ZodType<
+  EventCreateExternalCustomerMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type EventCreateExternalCustomerMetadata$Outbound =
+  | string
+  | number
+  | boolean;
+
+/** @internal */
+export const EventCreateExternalCustomerMetadata$outboundSchema: z.ZodType<
+  EventCreateExternalCustomerMetadata$Outbound,
+  z.ZodTypeDef,
+  EventCreateExternalCustomerMetadata
+> = 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 EventCreateExternalCustomerMetadata$ {
+  /** @deprecated use `EventCreateExternalCustomerMetadata$inboundSchema` instead. */
+  export const inboundSchema =
+    EventCreateExternalCustomerMetadata$inboundSchema;
+  /** @deprecated use `EventCreateExternalCustomerMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    EventCreateExternalCustomerMetadata$outboundSchema;
+  /** @deprecated use `EventCreateExternalCustomerMetadata$Outbound` instead. */
+  export type Outbound = EventCreateExternalCustomerMetadata$Outbound;
+}
+
+export function eventCreateExternalCustomerMetadataToJSON(
+  eventCreateExternalCustomerMetadata: EventCreateExternalCustomerMetadata,
+): string {
+  return JSON.stringify(
+    EventCreateExternalCustomerMetadata$outboundSchema.parse(
+      eventCreateExternalCustomerMetadata,
+    ),
+  );
+}
+
+export function eventCreateExternalCustomerMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<EventCreateExternalCustomerMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EventCreateExternalCustomerMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventCreateExternalCustomerMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventCreateExternalCustomer$inboundSchema: z.ZodType<
+  EventCreateExternalCustomer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  name: z.string(),
+  organization_id: z.nullable(z.string()).optional(),
+  external_customer_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "external_customer_id": "externalCustomerId",
+  });
+});
+
+/** @internal */
+export type EventCreateExternalCustomer$Outbound = {
+  metadata?: { [k: string]: string | number | boolean } | undefined;
+  timestamp?: string | undefined;
+  name: string;
+  organization_id?: string | null | undefined;
+  external_customer_id: string;
+};
+
+/** @internal */
+export const EventCreateExternalCustomer$outboundSchema: z.ZodType<
+  EventCreateExternalCustomer$Outbound,
+  z.ZodTypeDef,
+  EventCreateExternalCustomer
+> = z.object({
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()]))
+    .optional(),
+  timestamp: z.date().transform(v => v.toISOString()).optional(),
+  name: z.string(),
+  organizationId: z.nullable(z.string()).optional(),
+  externalCustomerId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_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 EventCreateExternalCustomer$ {
+  /** @deprecated use `EventCreateExternalCustomer$inboundSchema` instead. */
+  export const inboundSchema = EventCreateExternalCustomer$inboundSchema;
+  /** @deprecated use `EventCreateExternalCustomer$outboundSchema` instead. */
+  export const outboundSchema = EventCreateExternalCustomer$outboundSchema;
+  /** @deprecated use `EventCreateExternalCustomer$Outbound` instead. */
+  export type Outbound = EventCreateExternalCustomer$Outbound;
+}
+
+export function eventCreateExternalCustomerToJSON(
+  eventCreateExternalCustomer: EventCreateExternalCustomer,
+): string {
+  return JSON.stringify(
+    EventCreateExternalCustomer$outboundSchema.parse(
+      eventCreateExternalCustomer,
+    ),
+  );
+}
+
+export function eventCreateExternalCustomerFromJSON(
+  jsonString: string,
+): SafeParseResult<EventCreateExternalCustomer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventCreateExternalCustomer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventCreateExternalCustomer' from JSON`,
+  );
+}

package/src/models/components/eventsingest.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EventCreateCustomer,
+  EventCreateCustomer$inboundSchema,
+  EventCreateCustomer$Outbound,
+  EventCreateCustomer$outboundSchema,
+} from "./eventcreatecustomer.js";
+import {
+  EventCreateExternalCustomer,
+  EventCreateExternalCustomer$inboundSchema,
+  EventCreateExternalCustomer$Outbound,
+  EventCreateExternalCustomer$outboundSchema,
+} from "./eventcreateexternalcustomer.js";
+
+export type Events = EventCreateCustomer | EventCreateExternalCustomer;
+
+export type EventsIngest = {
+  /**
+   * List of events to ingest.
+   */
+  events: Array<EventCreateCustomer | EventCreateExternalCustomer>;
+};
+
+/** @internal */
+export const Events$inboundSchema: z.ZodType<Events, z.ZodTypeDef, unknown> = z
+  .union([
+    EventCreateCustomer$inboundSchema,
+    EventCreateExternalCustomer$inboundSchema,
+  ]);
+
+/** @internal */
+export type Events$Outbound =
+  | EventCreateCustomer$Outbound
+  | EventCreateExternalCustomer$Outbound;
+
+/** @internal */
+export const Events$outboundSchema: z.ZodType<
+  Events$Outbound,
+  z.ZodTypeDef,
+  Events
+> = z.union([
+  EventCreateCustomer$outboundSchema,
+  EventCreateExternalCustomer$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Events$ {
+  /** @deprecated use `Events$inboundSchema` instead. */
+  export const inboundSchema = Events$inboundSchema;
+  /** @deprecated use `Events$outboundSchema` instead. */
+  export const outboundSchema = Events$outboundSchema;
+  /** @deprecated use `Events$Outbound` instead. */
+  export type Outbound = Events$Outbound;
+}
+
+export function eventsToJSON(events: Events): string {
+  return JSON.stringify(Events$outboundSchema.parse(events));
+}
+
+export function eventsFromJSON(
+  jsonString: string,
+): SafeParseResult<Events, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Events$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Events' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventsIngest$inboundSchema: z.ZodType<
+  EventsIngest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  events: z.array(
+    z.union([
+      EventCreateCustomer$inboundSchema,
+      EventCreateExternalCustomer$inboundSchema,
+    ]),
+  ),
+});
+
+/** @internal */
+export type EventsIngest$Outbound = {
+  events: Array<
+    EventCreateCustomer$Outbound | EventCreateExternalCustomer$Outbound
+  >;
+};
+
+/** @internal */
+export const EventsIngest$outboundSchema: z.ZodType<
+  EventsIngest$Outbound,
+  z.ZodTypeDef,
+  EventsIngest
+> = z.object({
+  events: z.array(
+    z.union([
+      EventCreateCustomer$outboundSchema,
+      EventCreateExternalCustomer$outboundSchema,
+    ]),
+  ),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EventsIngest$ {
+  /** @deprecated use `EventsIngest$inboundSchema` instead. */
+  export const inboundSchema = EventsIngest$inboundSchema;
+  /** @deprecated use `EventsIngest$outboundSchema` instead. */
+  export const outboundSchema = EventsIngest$outboundSchema;
+  /** @deprecated use `EventsIngest$Outbound` instead. */
+  export type Outbound = EventsIngest$Outbound;
+}
+
+export function eventsIngestToJSON(eventsIngest: EventsIngest): string {
+  return JSON.stringify(EventsIngest$outboundSchema.parse(eventsIngest));
+}
+
+export function eventsIngestFromJSON(
+  jsonString: string,
+): SafeParseResult<EventsIngest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventsIngest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventsIngest' from JSON`,
+  );
+}