@polar-sh/sdk 0.22.2 → 0.23.0

package/src/models/operations/metersquantities.ts

@@ -0,0 +1,255 @@
+/*
+ * 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 {
+  TimeInterval,
+  TimeInterval$inboundSchema,
+  TimeInterval$outboundSchema,
+} from "../components/timeinterval.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter by customer ID.
+ */
+export type MetersQuantitiesQueryParamCustomerIDFilter = string | Array<string>;
+
+/**
+ * Filter by external customer ID.
+ */
+export type QueryParamExternalCustomerIDFilter = string | Array<string>;
+
+export type MetersQuantitiesRequest = {
+  /**
+   * The meter ID.
+   */
+  id: string;
+  /**
+   * Start timestamp.
+   */
+  startTimestamp: Date;
+  /**
+   * End timestamp.
+   */
+  endTimestamp: Date;
+  /**
+   * Interval between two timestamps.
+   */
+  interval: TimeInterval;
+  /**
+   * Filter by customer ID.
+   */
+  customerId?: string | Array<string> | null | undefined;
+  /**
+   * Filter by external customer ID.
+   */
+  exernalCustomerId?: string | Array<string> | null | undefined;
+};
+
+/** @internal */
+export const MetersQuantitiesQueryParamCustomerIDFilter$inboundSchema:
+  z.ZodType<MetersQuantitiesQueryParamCustomerIDFilter, z.ZodTypeDef, unknown> =
+    z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type MetersQuantitiesQueryParamCustomerIDFilter$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const MetersQuantitiesQueryParamCustomerIDFilter$outboundSchema:
+  z.ZodType<
+    MetersQuantitiesQueryParamCustomerIDFilter$Outbound,
+    z.ZodTypeDef,
+    MetersQuantitiesQueryParamCustomerIDFilter
+  > = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MetersQuantitiesQueryParamCustomerIDFilter$ {
+  /** @deprecated use `MetersQuantitiesQueryParamCustomerIDFilter$inboundSchema` instead. */
+  export const inboundSchema =
+    MetersQuantitiesQueryParamCustomerIDFilter$inboundSchema;
+  /** @deprecated use `MetersQuantitiesQueryParamCustomerIDFilter$outboundSchema` instead. */
+  export const outboundSchema =
+    MetersQuantitiesQueryParamCustomerIDFilter$outboundSchema;
+  /** @deprecated use `MetersQuantitiesQueryParamCustomerIDFilter$Outbound` instead. */
+  export type Outbound = MetersQuantitiesQueryParamCustomerIDFilter$Outbound;
+}
+
+export function metersQuantitiesQueryParamCustomerIDFilterToJSON(
+  metersQuantitiesQueryParamCustomerIDFilter:
+    MetersQuantitiesQueryParamCustomerIDFilter,
+): string {
+  return JSON.stringify(
+    MetersQuantitiesQueryParamCustomerIDFilter$outboundSchema.parse(
+      metersQuantitiesQueryParamCustomerIDFilter,
+    ),
+  );
+}
+
+export function metersQuantitiesQueryParamCustomerIDFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  MetersQuantitiesQueryParamCustomerIDFilter,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      MetersQuantitiesQueryParamCustomerIDFilter$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'MetersQuantitiesQueryParamCustomerIDFilter' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryParamExternalCustomerIDFilter$inboundSchema: z.ZodType<
+  QueryParamExternalCustomerIDFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type QueryParamExternalCustomerIDFilter$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const QueryParamExternalCustomerIDFilter$outboundSchema: z.ZodType<
+  QueryParamExternalCustomerIDFilter$Outbound,
+  z.ZodTypeDef,
+  QueryParamExternalCustomerIDFilter
+> = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamExternalCustomerIDFilter$ {
+  /** @deprecated use `QueryParamExternalCustomerIDFilter$inboundSchema` instead. */
+  export const inboundSchema = QueryParamExternalCustomerIDFilter$inboundSchema;
+  /** @deprecated use `QueryParamExternalCustomerIDFilter$outboundSchema` instead. */
+  export const outboundSchema =
+    QueryParamExternalCustomerIDFilter$outboundSchema;
+  /** @deprecated use `QueryParamExternalCustomerIDFilter$Outbound` instead. */
+  export type Outbound = QueryParamExternalCustomerIDFilter$Outbound;
+}
+
+export function queryParamExternalCustomerIDFilterToJSON(
+  queryParamExternalCustomerIDFilter: QueryParamExternalCustomerIDFilter,
+): string {
+  return JSON.stringify(
+    QueryParamExternalCustomerIDFilter$outboundSchema.parse(
+      queryParamExternalCustomerIDFilter,
+    ),
+  );
+}
+
+export function queryParamExternalCustomerIDFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryParamExternalCustomerIDFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryParamExternalCustomerIDFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryParamExternalCustomerIDFilter' from JSON`,
+  );
+}
+
+/** @internal */
+export const MetersQuantitiesRequest$inboundSchema: z.ZodType<
+  MetersQuantitiesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  start_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  end_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  interval: TimeInterval$inboundSchema,
+  customer_id: z.nullable(z.union([z.string(), z.array(z.string())]))
+    .optional(),
+  exernal_customer_id: z.nullable(z.union([z.string(), z.array(z.string())]))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "start_timestamp": "startTimestamp",
+    "end_timestamp": "endTimestamp",
+    "customer_id": "customerId",
+    "exernal_customer_id": "exernalCustomerId",
+  });
+});
+
+/** @internal */
+export type MetersQuantitiesRequest$Outbound = {
+  id: string;
+  start_timestamp: string;
+  end_timestamp: string;
+  interval: string;
+  customer_id?: string | Array<string> | null | undefined;
+  exernal_customer_id?: string | Array<string> | null | undefined;
+};
+
+/** @internal */
+export const MetersQuantitiesRequest$outboundSchema: z.ZodType<
+  MetersQuantitiesRequest$Outbound,
+  z.ZodTypeDef,
+  MetersQuantitiesRequest
+> = z.object({
+  id: z.string(),
+  startTimestamp: z.date().transform(v => v.toISOString()),
+  endTimestamp: z.date().transform(v => v.toISOString()),
+  interval: TimeInterval$outboundSchema,
+  customerId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  exernalCustomerId: z.nullable(z.union([z.string(), z.array(z.string())]))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startTimestamp: "start_timestamp",
+    endTimestamp: "end_timestamp",
+    customerId: "customer_id",
+    exernalCustomerId: "exernal_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 MetersQuantitiesRequest$ {
+  /** @deprecated use `MetersQuantitiesRequest$inboundSchema` instead. */
+  export const inboundSchema = MetersQuantitiesRequest$inboundSchema;
+  /** @deprecated use `MetersQuantitiesRequest$outboundSchema` instead. */
+  export const outboundSchema = MetersQuantitiesRequest$outboundSchema;
+  /** @deprecated use `MetersQuantitiesRequest$Outbound` instead. */
+  export type Outbound = MetersQuantitiesRequest$Outbound;
+}
+
+export function metersQuantitiesRequestToJSON(
+  metersQuantitiesRequest: MetersQuantitiesRequest,
+): string {
+  return JSON.stringify(
+    MetersQuantitiesRequest$outboundSchema.parse(metersQuantitiesRequest),
+  );
+}
+
+export function metersQuantitiesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MetersQuantitiesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetersQuantitiesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetersQuantitiesRequest' from JSON`,
+  );
+}

package/src/models/operations/metersupdate.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  MeterUpdate,
+  MeterUpdate$inboundSchema,
+  MeterUpdate$Outbound,
+  MeterUpdate$outboundSchema,
+} from "../components/meterupdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MetersUpdateRequest = {
+  /**
+   * The meter ID.
+   */
+  id: string;
+  meterUpdate: MeterUpdate;
+};
+
+/** @internal */
+export const MetersUpdateRequest$inboundSchema: z.ZodType<
+  MetersUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  MeterUpdate: MeterUpdate$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "MeterUpdate": "meterUpdate",
+  });
+});
+
+/** @internal */
+export type MetersUpdateRequest$Outbound = {
+  id: string;
+  MeterUpdate: MeterUpdate$Outbound;
+};
+
+/** @internal */
+export const MetersUpdateRequest$outboundSchema: z.ZodType<
+  MetersUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  MetersUpdateRequest
+> = z.object({
+  id: z.string(),
+  meterUpdate: MeterUpdate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    meterUpdate: "MeterUpdate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MetersUpdateRequest$ {
+  /** @deprecated use `MetersUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = MetersUpdateRequest$inboundSchema;
+  /** @deprecated use `MetersUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = MetersUpdateRequest$outboundSchema;
+  /** @deprecated use `MetersUpdateRequest$Outbound` instead. */
+  export type Outbound = MetersUpdateRequest$Outbound;
+}
+
+export function metersUpdateRequestToJSON(
+  metersUpdateRequest: MetersUpdateRequest,
+): string {
+  return JSON.stringify(
+    MetersUpdateRequest$outboundSchema.parse(metersUpdateRequest),
+  );
+}
+
+export function metersUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MetersUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetersUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetersUpdateRequest' from JSON`,
+  );
+}

package/src/models/operations/metricsget.ts

@@ -7,16 +7,16 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { RFCDate } from "../../types/rfcdate.js";
-import {
-  Interval,
-  Interval$inboundSchema,
-  Interval$outboundSchema,
-} from "../components/interval.js";
 import {
   ProductPriceType,
   ProductPriceType$inboundSchema,
   ProductPriceType$outboundSchema,
 } from "../components/productpricetype.js";
+import {
+  TimeInterval,
+  TimeInterval$inboundSchema,
+  TimeInterval$outboundSchema,
+} from "../components/timeinterval.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
@@ -53,7 +53,7 @@ export type MetricsGetRequest = {
   /**
    * Interval between two timestamps.
    */
-  interval: Interval;
+  interval: TimeInterval;
   /**
    * Filter by organization ID.
    */
@@ -311,7 +311,7 @@ export const MetricsGetRequest$inboundSchema: z.ZodType<
 > = z.object({
   start_date: z.string().transform(v => new RFCDate(v)),
   end_date: z.string().transform(v => new RFCDate(v)),
-  interval: Interval$inboundSchema,
+  interval: TimeInterval$inboundSchema,
   organization_id: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   product_id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
@@ -353,7 +353,7 @@ export const MetricsGetRequest$outboundSchema: z.ZodType<
 > = z.object({
   startDate: z.instanceof(RFCDate).transform(v => v.toString()),
   endDate: z.instanceof(RFCDate).transform(v => v.toString()),
-  interval: Interval$outboundSchema,
+  interval: TimeInterval$outboundSchema,
   organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   productId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),

package/src/sdk/events.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { eventsGet } from "../funcs/eventsGet.js";
+import { eventsIngest } from "../funcs/eventsIngest.js";
+import { eventsList } from "../funcs/eventsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { Event } from "../models/components/event.js";
+import { EventsIngest } from "../models/components/eventsingest.js";
+import { EventsIngestResponse } from "../models/components/eventsingestresponse.js";
+import { EventsGetRequest } from "../models/operations/eventsget.js";
+import {
+  EventsListRequest,
+  EventsListResponse,
+} from "../models/operations/eventslist.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Events extends ClientSDK {
+  /**
+   * List Events
+   *
+   * @remarks
+   * List events.
+   */
+  async list(
+    request: EventsListRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<EventsListResponse, { page: number }>> {
+    return unwrapResultIterator(eventsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Event
+   *
+   * @remarks
+   * Get an event by ID.
+   */
+  async get(
+    request: EventsGetRequest,
+    options?: RequestOptions,
+  ): Promise<Event> {
+    return unwrapAsync(eventsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Ingest Events
+   *
+   * @remarks
+   * Ingest batch of events.
+   */
+  async ingest(
+    request: EventsIngest,
+    options?: RequestOptions,
+  ): Promise<EventsIngestResponse> {
+    return unwrapAsync(eventsIngest(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/meters.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metersCreate } from "../funcs/metersCreate.js";
+import { metersEvents } from "../funcs/metersEvents.js";
+import { metersGet } from "../funcs/metersGet.js";
+import { metersList } from "../funcs/metersList.js";
+import { metersQuantities } from "../funcs/metersQuantities.js";
+import { metersUpdate } from "../funcs/metersUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { Meter } from "../models/components/meter.js";
+import { MeterCreate } from "../models/components/metercreate.js";
+import { MeterQuantities } from "../models/components/meterquantities.js";
+import {
+  MetersEventsRequest,
+  MetersEventsResponse,
+} from "../models/operations/metersevents.js";
+import { MetersGetRequest } from "../models/operations/metersget.js";
+import {
+  MetersListRequest,
+  MetersListResponse,
+} from "../models/operations/meterslist.js";
+import { MetersQuantitiesRequest } from "../models/operations/metersquantities.js";
+import { MetersUpdateRequest } from "../models/operations/metersupdate.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Meters extends ClientSDK {
+  /**
+   * List Meters
+   *
+   * @remarks
+   * List meters.
+   */
+  async list(
+    request: MetersListRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<MetersListResponse, { page: number }>> {
+    return unwrapResultIterator(metersList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Meter
+   *
+   * @remarks
+   * Create a meter.
+   */
+  async create(
+    request: MeterCreate,
+    options?: RequestOptions,
+  ): Promise<Meter> {
+    return unwrapAsync(metersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Meter
+   *
+   * @remarks
+   * Get a meter by ID.
+   */
+  async get(
+    request: MetersGetRequest,
+    options?: RequestOptions,
+  ): Promise<Meter> {
+    return unwrapAsync(metersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Meter
+   *
+   * @remarks
+   * Update a meter.
+   */
+  async update(
+    request: MetersUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<Meter> {
+    return unwrapAsync(metersUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Meter Events
+   *
+   * @remarks
+   * Get events matching the filter of a meter.
+   */
+  async events(
+    request: MetersEventsRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<MetersEventsResponse, { page: number }>> {
+    return unwrapResultIterator(metersEvents(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Meter Quantities
+   *
+   * @remarks
+   * Get quantities of a meter over a time period.
+   */
+  async quantities(
+    request: MetersQuantitiesRequest,
+    options?: RequestOptions,
+  ): Promise<MeterQuantities> {
+    return unwrapAsync(metersQuantities(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -12,9 +12,11 @@ import { Customers } from "./customers.js";
 import { CustomerSessions } from "./customersessions.js";
 import { CustomFields } from "./customfields.js";
 import { Discounts } from "./discounts.js";
+import { Events } from "./events.js";
 import { ExternalOrganizations } from "./externalorganizations.js";
 import { Files } from "./files.js";
 import { LicenseKeys } from "./licensekeys.js";
+import { Meters } from "./meters.js";
 import { Metrics } from "./metrics.js";
 import { Oauth2 } from "./oauth2.js";
 import { Orders } from "./orders.js";
@@ -126,4 +128,14 @@ export class Polar extends ClientSDK {
   get customerSessions(): CustomerSessions {
     return (this._customerSessions ??= new CustomerSessions(this._options));
   }
+
+  private _events?: Events;
+  get events(): Events {
+    return (this._events ??= new Events(this._options));
+  }
+
+  private _meters?: Meters;
+  get meters(): Meters {
+    return (this._meters ??= new Meters(this._options));
+  }
 }

package/src/{webhooks/index.test.ts → webhooks.test.ts}

@@ -1,9 +1,9 @@
 import { randomUUID } from "crypto";
 import { Webhook } from "standardwebhooks"
-import { validateEvent, WebhookVerificationError } from "./index.js";
-import { WebhookCheckoutCreatedPayload$inboundSchema } from "../models/components/webhookcheckoutcreatedpayload.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 
+import { WebhookCheckoutCreatedPayload$inboundSchema } from "./models/components/webhookcheckoutcreatedpayload.js";
+import { SDKValidationError } from "./models/errors/sdkvalidationerror.js";
+import { validateEvent, WebhookVerificationError } from "./webhooks.js";
 
 const ORGANIZATION_ID = randomUUID().toString();
 const PRODUCT_ID = randomUUID().toString();
@@ -76,6 +76,7 @@ const checkoutCreated = {
         attached_custom_fields: [],
         custom_field_data: {},
         payment_processor: 'stripe',
+        customer_metadata: {},
     }
 };