@polar-sh/sdk 0.34.13 → 0.34.15

package/src/models/components/subscriptionrevokedevent.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  SubscriptionRevokedMetadata,
+  SubscriptionRevokedMetadata$inboundSchema,
+  SubscriptionRevokedMetadata$Outbound,
+  SubscriptionRevokedMetadata$outboundSchema,
+} from "./subscriptionrevokedmetadata.js";
+
+/**
+ * An event created by Polar when a subscription is revoked from a customer.
+ */
+export type SubscriptionRevokedEvent = {
+  /**
+   * 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: "subscription.revoked";
+  metadata: SubscriptionRevokedMetadata;
+};
+
+/** @internal */
+export const SubscriptionRevokedEvent$inboundSchema: z.ZodType<
+  SubscriptionRevokedEvent,
+  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("subscription.revoked"),
+  metadata: SubscriptionRevokedMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+  });
+});
+
+/** @internal */
+export type SubscriptionRevokedEvent$Outbound = {
+  id: string;
+  timestamp: string;
+  organization_id: string;
+  customer_id: string | null;
+  customer: Customer$Outbound | null;
+  external_customer_id: string | null;
+  source: "system";
+  name: "subscription.revoked";
+  metadata: SubscriptionRevokedMetadata$Outbound;
+};
+
+/** @internal */
+export const SubscriptionRevokedEvent$outboundSchema: z.ZodType<
+  SubscriptionRevokedEvent$Outbound,
+  z.ZodTypeDef,
+  SubscriptionRevokedEvent
+> = 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("subscription.revoked"),
+  metadata: SubscriptionRevokedMetadata$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 SubscriptionRevokedEvent$ {
+  /** @deprecated use `SubscriptionRevokedEvent$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionRevokedEvent$inboundSchema;
+  /** @deprecated use `SubscriptionRevokedEvent$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionRevokedEvent$outboundSchema;
+  /** @deprecated use `SubscriptionRevokedEvent$Outbound` instead. */
+  export type Outbound = SubscriptionRevokedEvent$Outbound;
+}
+
+export function subscriptionRevokedEventToJSON(
+  subscriptionRevokedEvent: SubscriptionRevokedEvent,
+): string {
+  return JSON.stringify(
+    SubscriptionRevokedEvent$outboundSchema.parse(subscriptionRevokedEvent),
+  );
+}
+
+export function subscriptionRevokedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionRevokedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionRevokedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionRevokedEvent' from JSON`,
+  );
+}

package/src/models/components/subscriptionrevokedmetadata.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 SubscriptionRevokedMetadata = {
+  subscriptionId: string;
+};
+
+/** @internal */
+export const SubscriptionRevokedMetadata$inboundSchema: z.ZodType<
+  SubscriptionRevokedMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscription_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "subscription_id": "subscriptionId",
+  });
+});
+
+/** @internal */
+export type SubscriptionRevokedMetadata$Outbound = {
+  subscription_id: string;
+};
+
+/** @internal */
+export const SubscriptionRevokedMetadata$outboundSchema: z.ZodType<
+  SubscriptionRevokedMetadata$Outbound,
+  z.ZodTypeDef,
+  SubscriptionRevokedMetadata
+> = z.object({
+  subscriptionId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    subscriptionId: "subscription_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriptionRevokedMetadata$ {
+  /** @deprecated use `SubscriptionRevokedMetadata$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionRevokedMetadata$inboundSchema;
+  /** @deprecated use `SubscriptionRevokedMetadata$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionRevokedMetadata$outboundSchema;
+  /** @deprecated use `SubscriptionRevokedMetadata$Outbound` instead. */
+  export type Outbound = SubscriptionRevokedMetadata$Outbound;
+}
+
+export function subscriptionRevokedMetadataToJSON(
+  subscriptionRevokedMetadata: SubscriptionRevokedMetadata,
+): string {
+  return JSON.stringify(
+    SubscriptionRevokedMetadata$outboundSchema.parse(
+      subscriptionRevokedMetadata,
+    ),
+  );
+}
+
+export function subscriptionRevokedMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionRevokedMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionRevokedMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionRevokedMetadata' from JSON`,
+  );
+}

package/src/models/components/systemevent.ts

@@ -42,6 +42,24 @@ import {
   MeterResetEvent$Outbound,
   MeterResetEvent$outboundSchema,
 } from "./meterresetevent.js";
+import {
+  SubscriptionCycledEvent,
+  SubscriptionCycledEvent$inboundSchema,
+  SubscriptionCycledEvent$Outbound,
+  SubscriptionCycledEvent$outboundSchema,
+} from "./subscriptioncycledevent.js";
+import {
+  SubscriptionProductUpdatedEvent,
+  SubscriptionProductUpdatedEvent$inboundSchema,
+  SubscriptionProductUpdatedEvent$Outbound,
+  SubscriptionProductUpdatedEvent$outboundSchema,
+} from "./subscriptionproductupdatedevent.js";
+import {
+  SubscriptionRevokedEvent,
+  SubscriptionRevokedEvent$inboundSchema,
+  SubscriptionRevokedEvent$Outbound,
+  SubscriptionRevokedEvent$outboundSchema,
+} from "./subscriptionrevokedevent.js";
 
 export type SystemEvent =
   | (BenefitCycledEvent & { name: "benefit.cycled" })
@@ -49,7 +67,10 @@ export type SystemEvent =
   | (BenefitRevokedEvent & { name: "benefit.revoked" })
   | (BenefitUpdatedEvent & { name: "benefit.updated" })
   | (MeterCreditEvent & { name: "meter.credited" })
-  | (MeterResetEvent & { name: "meter.reset" });
+  | (MeterResetEvent & { name: "meter.reset" })
+  | (SubscriptionCycledEvent & { name: "subscription.cycled" })
+  | (SubscriptionProductUpdatedEvent & { name: "subscription.product_updated" })
+  | (SubscriptionRevokedEvent & { name: "subscription.revoked" });
 
 /** @internal */
 export const SystemEvent$inboundSchema: z.ZodType<
@@ -87,6 +108,21 @@ export const SystemEvent$inboundSchema: z.ZodType<
       name: v.name,
     })),
   ),
+  SubscriptionCycledEvent$inboundSchema.and(
+    z.object({ name: z.literal("subscription.cycled") }).transform((v) => ({
+      name: v.name,
+    })),
+  ),
+  SubscriptionProductUpdatedEvent$inboundSchema.and(
+    z.object({ name: z.literal("subscription.product_updated") }).transform((
+      v,
+    ) => ({ name: v.name })),
+  ),
+  SubscriptionRevokedEvent$inboundSchema.and(
+    z.object({ name: z.literal("subscription.revoked") }).transform((v) => ({
+      name: v.name,
+    })),
+  ),
 ]);
 
 /** @internal */
@@ -96,7 +132,12 @@ export type SystemEvent$Outbound =
   | (BenefitRevokedEvent$Outbound & { name: "benefit.revoked" })
   | (BenefitUpdatedEvent$Outbound & { name: "benefit.updated" })
   | (MeterCreditEvent$Outbound & { name: "meter.credited" })
-  | (MeterResetEvent$Outbound & { name: "meter.reset" });
+  | (MeterResetEvent$Outbound & { name: "meter.reset" })
+  | (SubscriptionCycledEvent$Outbound & { name: "subscription.cycled" })
+  | (SubscriptionProductUpdatedEvent$Outbound & {
+    name: "subscription.product_updated";
+  })
+  | (SubscriptionRevokedEvent$Outbound & { name: "subscription.revoked" });
 
 /** @internal */
 export const SystemEvent$outboundSchema: z.ZodType<
@@ -134,6 +175,21 @@ export const SystemEvent$outboundSchema: z.ZodType<
       name: v.name,
     })),
   ),
+  SubscriptionCycledEvent$outboundSchema.and(
+    z.object({ name: z.literal("subscription.cycled") }).transform((v) => ({
+      name: v.name,
+    })),
+  ),
+  SubscriptionProductUpdatedEvent$outboundSchema.and(
+    z.object({ name: z.literal("subscription.product_updated") }).transform((
+      v,
+    ) => ({ name: v.name })),
+  ),
+  SubscriptionRevokedEvent$outboundSchema.and(
+    z.object({ name: z.literal("subscription.revoked") }).transform((v) => ({
+      name: v.name,
+    })),
+  ),
 ]);
 
 /**

package/src/models/errors/paymentmethodinusebyactivesubscription.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { PolarError } from "./polarerror.js";
+
+export type PaymentMethodInUseByActiveSubscriptionData = {
+  error: "PaymentMethodInUseByActiveSubscription";
+  detail: string;
+};
+
+export class PaymentMethodInUseByActiveSubscription extends PolarError {
+  error: "PaymentMethodInUseByActiveSubscription";
+  detail: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: PaymentMethodInUseByActiveSubscriptionData;
+
+  constructor(
+    err: PaymentMethodInUseByActiveSubscriptionData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    this.detail = err.detail;
+
+    this.name = "PaymentMethodInUseByActiveSubscription";
+  }
+}
+
+/** @internal */
+export const PaymentMethodInUseByActiveSubscription$inboundSchema: z.ZodType<
+  PaymentMethodInUseByActiveSubscription,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.literal("PaymentMethodInUseByActiveSubscription"),
+  detail: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PaymentMethodInUseByActiveSubscription(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type PaymentMethodInUseByActiveSubscription$Outbound = {
+  error: "PaymentMethodInUseByActiveSubscription";
+  detail: string;
+};
+
+/** @internal */
+export const PaymentMethodInUseByActiveSubscription$outboundSchema: z.ZodType<
+  PaymentMethodInUseByActiveSubscription$Outbound,
+  z.ZodTypeDef,
+  PaymentMethodInUseByActiveSubscription
+> = z.instanceof(PaymentMethodInUseByActiveSubscription)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.literal("PaymentMethodInUseByActiveSubscription"),
+    detail: 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 PaymentMethodInUseByActiveSubscription$ {
+  /** @deprecated use `PaymentMethodInUseByActiveSubscription$inboundSchema` instead. */
+  export const inboundSchema =
+    PaymentMethodInUseByActiveSubscription$inboundSchema;
+  /** @deprecated use `PaymentMethodInUseByActiveSubscription$outboundSchema` instead. */
+  export const outboundSchema =
+    PaymentMethodInUseByActiveSubscription$outboundSchema;
+  /** @deprecated use `PaymentMethodInUseByActiveSubscription$Outbound` instead. */
+  export type Outbound = PaymentMethodInUseByActiveSubscription$Outbound;
+}

package/src/models/errors/subscriptionlocked.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { PolarError } from "./polarerror.js";
+
+export type SubscriptionLockedData = {
+  error: "SubscriptionLocked";
+  detail: string;
+};
+
+export class SubscriptionLocked extends PolarError {
+  error: "SubscriptionLocked";
+  detail: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: SubscriptionLockedData;
+
+  constructor(
+    err: SubscriptionLockedData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    this.detail = err.detail;
+
+    this.name = "SubscriptionLocked";
+  }
+}
+
+/** @internal */
+export const SubscriptionLocked$inboundSchema: z.ZodType<
+  SubscriptionLocked,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.literal("SubscriptionLocked"),
+  detail: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new SubscriptionLocked(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type SubscriptionLocked$Outbound = {
+  error: "SubscriptionLocked";
+  detail: string;
+};
+
+/** @internal */
+export const SubscriptionLocked$outboundSchema: z.ZodType<
+  SubscriptionLocked$Outbound,
+  z.ZodTypeDef,
+  SubscriptionLocked
+> = z.instanceof(SubscriptionLocked)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.literal("SubscriptionLocked"),
+    detail: 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 SubscriptionLocked$ {
+  /** @deprecated use `SubscriptionLocked$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionLocked$inboundSchema;
+  /** @deprecated use `SubscriptionLocked$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionLocked$outboundSchema;
+  /** @deprecated use `SubscriptionLocked$Outbound` instead. */
+  export type Outbound = SubscriptionLocked$Outbound;
+}

package/src/models/operations/meterslist.ts

@@ -39,6 +39,10 @@ export type MetersListRequest = {
    * Filter by name.
    */
   query?: string | null | undefined;
+  /**
+   * Filter on archived meters.
+   */
+  isArchived?: boolean | null | undefined;
   /**
    * Page number, defaults to 1.
    */
@@ -131,6 +135,7 @@ export const MetersListRequest$inboundSchema: z.ZodType<
   organization_id: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   query: z.nullable(z.string()).optional(),
+  is_archived: z.nullable(z.boolean()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
   sorting: z.nullable(z.array(MeterSortProperty$inboundSchema)).optional(),
@@ -138,6 +143,7 @@ export const MetersListRequest$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "organization_id": "organizationId",
+    "is_archived": "isArchived",
   });
 });
 
@@ -145,6 +151,7 @@ export const MetersListRequest$inboundSchema: z.ZodType<
 export type MetersListRequest$Outbound = {
   organization_id?: string | Array<string> | null | undefined;
   query?: string | null | undefined;
+  is_archived?: boolean | null | undefined;
   page: number;
   limit: number;
   sorting?: Array<string> | null | undefined;
@@ -160,6 +167,7 @@ export const MetersListRequest$outboundSchema: z.ZodType<
   organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   query: z.nullable(z.string()).optional(),
+  isArchived: z.nullable(z.boolean()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
   sorting: z.nullable(z.array(MeterSortProperty$outboundSchema)).optional(),
@@ -167,6 +175,7 @@ export const MetersListRequest$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     organizationId: "organization_id",
+    isArchived: "is_archived",
   });
 });