@polar-sh/sdk 0.34.13 → 0.34.15

package/src/models/components/customerorderproduct.ts

@@ -69,7 +69,7 @@ export type CustomerOrderProduct = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/customerproduct.ts

@@ -64,7 +64,7 @@ export type CustomerProduct = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/customersubscriptionproduct.ts

@@ -69,7 +69,7 @@ export type CustomerSubscriptionProduct = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/discountproduct.ts

@@ -41,7 +41,7 @@ export type DiscountProduct = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/meter.ts

@@ -78,6 +78,10 @@ export type Meter = {
    * The ID of the organization owning the meter.
    */
   organizationId: string;
+  /**
+   * Whether the meter is archived and the time it was archived.
+   */
+  archivedAt?: Date | null | undefined;
 };
 
 /** @internal */
@@ -268,11 +272,15 @@ export const Meter$inboundSchema: z.ZodType<Meter, z.ZodTypeDef, unknown> = z
       ),
     ]),
     organization_id: z.string(),
+    archived_at: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
   }).transform((v) => {
     return remap$(v, {
       "created_at": "createdAt",
       "modified_at": "modifiedAt",
       "organization_id": "organizationId",
+      "archived_at": "archivedAt",
     });
   });
 
@@ -292,6 +300,7 @@ export type Meter$Outbound = {
     | (UniqueAggregation$Outbound & { func: "unique" })
     | (CountAggregation$Outbound & { func: "count" });
   organization_id: string;
+  archived_at?: string | null | undefined;
 };
 
 /** @internal */
@@ -333,11 +342,13 @@ export const Meter$outboundSchema: z.ZodType<
     ),
   ]),
   organizationId: z.string(),
+  archivedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
     modifiedAt: "modified_at",
     organizationId: "organization_id",
+    archivedAt: "archived_at",
   });
 });
 

package/src/models/components/meterupdate.ts

@@ -3,6 +3,7 @@
  */
 
 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";
@@ -78,6 +79,10 @@ export type MeterUpdate = {
     | (CountAggregation & { func: "count" })
     | null
     | undefined;
+  /**
+   * Whether the meter is archived. Archived meters are no longer used for billing.
+   */
+  isArchived?: boolean | null | undefined;
 };
 
 /** @internal */
@@ -265,6 +270,11 @@ export const MeterUpdate$inboundSchema: z.ZodType<
       ),
     ]),
   ).optional(),
+  is_archived: z.nullable(z.boolean()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "is_archived": "isArchived",
+  });
 });
 
 /** @internal */
@@ -281,6 +291,7 @@ export type MeterUpdate$Outbound = {
     | (CountAggregation$Outbound & { func: "count" })
     | null
     | undefined;
+  is_archived?: boolean | null | undefined;
 };
 
 /** @internal */
@@ -328,6 +339,11 @@ export const MeterUpdate$outboundSchema: z.ZodType<
       ),
     ]),
   ).optional(),
+  isArchived: z.nullable(z.boolean()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    isArchived: "is_archived",
+  });
 });
 
 /**

package/src/models/components/orderproduct.ts

@@ -38,7 +38,7 @@ export type OrderProduct = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/product.ts

@@ -72,7 +72,7 @@ export type Product = {
    */
   description: string | null;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/productcreate.ts

@@ -80,7 +80,7 @@ export type ProductCreate = {
    */
   description?: string | null | undefined;
   /**
-   * The recurring interval of the product. If `None`, the product is a one-time purchase.
+   * The recurring interval of the product. If `None`, the product is a one-time purchase.Note that the `day` and `week` values are for internal Polar staff use only.
    */
   recurringInterval: SubscriptionRecurringInterval | null;
   /**

package/src/models/components/scope.ts

@@ -10,7 +10,8 @@ export const Scope = {
   Profile: "profile",
   Email: "email",
   UserRead: "user:read",
-  WebDefault: "web_default",
+  WebRead: "web:read",
+  WebWrite: "web:write",
   OrganizationsRead: "organizations:read",
   OrganizationsWrite: "organizations:write",
   CustomFieldsRead: "custom_fields:read",

package/src/models/components/subscriptioncycledevent.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 {
+  SubscriptionCycledMetadata,
+  SubscriptionCycledMetadata$inboundSchema,
+  SubscriptionCycledMetadata$Outbound,
+  SubscriptionCycledMetadata$outboundSchema,
+} from "./subscriptioncycledmetadata.js";
+
+/**
+ * An event created by Polar when a subscription is cycled.
+ */
+export type SubscriptionCycledEvent = {
+  /**
+   * 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.cycled";
+  metadata: SubscriptionCycledMetadata;
+};
+
+/** @internal */
+export const SubscriptionCycledEvent$inboundSchema: z.ZodType<
+  SubscriptionCycledEvent,
+  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.cycled"),
+  metadata: SubscriptionCycledMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+  });
+});
+
+/** @internal */
+export type SubscriptionCycledEvent$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.cycled";
+  metadata: SubscriptionCycledMetadata$Outbound;
+};
+
+/** @internal */
+export const SubscriptionCycledEvent$outboundSchema: z.ZodType<
+  SubscriptionCycledEvent$Outbound,
+  z.ZodTypeDef,
+  SubscriptionCycledEvent
+> = 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.cycled"),
+  metadata: SubscriptionCycledMetadata$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 SubscriptionCycledEvent$ {
+  /** @deprecated use `SubscriptionCycledEvent$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionCycledEvent$inboundSchema;
+  /** @deprecated use `SubscriptionCycledEvent$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionCycledEvent$outboundSchema;
+  /** @deprecated use `SubscriptionCycledEvent$Outbound` instead. */
+  export type Outbound = SubscriptionCycledEvent$Outbound;
+}
+
+export function subscriptionCycledEventToJSON(
+  subscriptionCycledEvent: SubscriptionCycledEvent,
+): string {
+  return JSON.stringify(
+    SubscriptionCycledEvent$outboundSchema.parse(subscriptionCycledEvent),
+  );
+}
+
+export function subscriptionCycledEventFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionCycledEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionCycledEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionCycledEvent' from JSON`,
+  );
+}

package/src/models/components/subscriptioncycledmetadata.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 SubscriptionCycledMetadata = {
+  subscriptionId: string;
+};
+
+/** @internal */
+export const SubscriptionCycledMetadata$inboundSchema: z.ZodType<
+  SubscriptionCycledMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscription_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "subscription_id": "subscriptionId",
+  });
+});
+
+/** @internal */
+export type SubscriptionCycledMetadata$Outbound = {
+  subscription_id: string;
+};
+
+/** @internal */
+export const SubscriptionCycledMetadata$outboundSchema: z.ZodType<
+  SubscriptionCycledMetadata$Outbound,
+  z.ZodTypeDef,
+  SubscriptionCycledMetadata
+> = 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 SubscriptionCycledMetadata$ {
+  /** @deprecated use `SubscriptionCycledMetadata$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionCycledMetadata$inboundSchema;
+  /** @deprecated use `SubscriptionCycledMetadata$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionCycledMetadata$outboundSchema;
+  /** @deprecated use `SubscriptionCycledMetadata$Outbound` instead. */
+  export type Outbound = SubscriptionCycledMetadata$Outbound;
+}
+
+export function subscriptionCycledMetadataToJSON(
+  subscriptionCycledMetadata: SubscriptionCycledMetadata,
+): string {
+  return JSON.stringify(
+    SubscriptionCycledMetadata$outboundSchema.parse(subscriptionCycledMetadata),
+  );
+}
+
+export function subscriptionCycledMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionCycledMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionCycledMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionCycledMetadata' from JSON`,
+  );
+}

package/src/models/components/subscriptionproductupdatedevent.ts

@@ -0,0 +1,152 @@
+/*
+ * 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 {
+  SubscriptionProductUpdatedMetadata,
+  SubscriptionProductUpdatedMetadata$inboundSchema,
+  SubscriptionProductUpdatedMetadata$Outbound,
+  SubscriptionProductUpdatedMetadata$outboundSchema,
+} from "./subscriptionproductupdatedmetadata.js";
+
+/**
+ * An event created by Polar when a subscription changes the product.
+ */
+export type SubscriptionProductUpdatedEvent = {
+  /**
+   * 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.product_updated";
+  metadata: SubscriptionProductUpdatedMetadata;
+};
+
+/** @internal */
+export const SubscriptionProductUpdatedEvent$inboundSchema: z.ZodType<
+  SubscriptionProductUpdatedEvent,
+  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.product_updated"),
+  metadata: SubscriptionProductUpdatedMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+  });
+});
+
+/** @internal */
+export type SubscriptionProductUpdatedEvent$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.product_updated";
+  metadata: SubscriptionProductUpdatedMetadata$Outbound;
+};
+
+/** @internal */
+export const SubscriptionProductUpdatedEvent$outboundSchema: z.ZodType<
+  SubscriptionProductUpdatedEvent$Outbound,
+  z.ZodTypeDef,
+  SubscriptionProductUpdatedEvent
+> = 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.product_updated"),
+  metadata: SubscriptionProductUpdatedMetadata$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 SubscriptionProductUpdatedEvent$ {
+  /** @deprecated use `SubscriptionProductUpdatedEvent$inboundSchema` instead. */
+  export const inboundSchema = SubscriptionProductUpdatedEvent$inboundSchema;
+  /** @deprecated use `SubscriptionProductUpdatedEvent$outboundSchema` instead. */
+  export const outboundSchema = SubscriptionProductUpdatedEvent$outboundSchema;
+  /** @deprecated use `SubscriptionProductUpdatedEvent$Outbound` instead. */
+  export type Outbound = SubscriptionProductUpdatedEvent$Outbound;
+}
+
+export function subscriptionProductUpdatedEventToJSON(
+  subscriptionProductUpdatedEvent: SubscriptionProductUpdatedEvent,
+): string {
+  return JSON.stringify(
+    SubscriptionProductUpdatedEvent$outboundSchema.parse(
+      subscriptionProductUpdatedEvent,
+    ),
+  );
+}
+
+export function subscriptionProductUpdatedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionProductUpdatedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionProductUpdatedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionProductUpdatedEvent' from JSON`,
+  );
+}

package/src/models/components/subscriptionproductupdatedmetadata.ts

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

package/src/models/components/subscriptionrecurringinterval.ts

@@ -6,6 +6,8 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const SubscriptionRecurringInterval = {
+  Day: "day",
+  Week: "week",
   Month: "month",
   Year: "year",
 } as const;