@polar-sh/sdk 0.40.3 → 0.41.1

package/src/models/components/benefitdiscordsubscriber.ts

@@ -14,11 +14,11 @@ import {
   BenefitDiscordSubscriberProperties$outboundSchema,
 } from "./benefitdiscordsubscriberproperties.js";
 import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+  BenefitSubscriberOrganization$Outbound,
+  BenefitSubscriberOrganization$outboundSchema,
+} from "./benefitsubscriberorganization.js";
 
 export type BenefitDiscordSubscriberMetadata =
   | string
@@ -57,7 +57,7 @@ export type BenefitDiscordSubscriber = {
    */
   organizationId: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization;
+  organization: BenefitSubscriberOrganization;
   /**
    * Properties available to subscribers for a benefit of type `discord`.
    */
@@ -137,7 +137,7 @@ export const BenefitDiscordSubscriber$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$inboundSchema,
+  organization: BenefitSubscriberOrganization$inboundSchema,
   properties: BenefitDiscordSubscriberProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -158,7 +158,7 @@ export type BenefitDiscordSubscriber$Outbound = {
   deletable: boolean;
   organization_id: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization$Outbound;
+  organization: BenefitSubscriberOrganization$Outbound;
   properties: BenefitDiscordSubscriberProperties$Outbound;
 };
 
@@ -179,7 +179,7 @@ export const BenefitDiscordSubscriber$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$outboundSchema,
+  organization: BenefitSubscriberOrganization$outboundSchema,
   properties: BenefitDiscordSubscriberProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitdownloadablessubscriber.ts

@@ -14,11 +14,11 @@ import {
   BenefitDownloadablesSubscriberProperties$outboundSchema,
 } from "./benefitdownloadablessubscriberproperties.js";
 import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+  BenefitSubscriberOrganization$Outbound,
+  BenefitSubscriberOrganization$outboundSchema,
+} from "./benefitsubscriberorganization.js";
 
 export type BenefitDownloadablesSubscriberMetadata =
   | string
@@ -57,7 +57,7 @@ export type BenefitDownloadablesSubscriber = {
    */
   organizationId: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization;
+  organization: BenefitSubscriberOrganization;
   properties: BenefitDownloadablesSubscriberProperties;
 };
 
@@ -138,7 +138,7 @@ export const BenefitDownloadablesSubscriber$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$inboundSchema,
+  organization: BenefitSubscriberOrganization$inboundSchema,
   properties: BenefitDownloadablesSubscriberProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -159,7 +159,7 @@ export type BenefitDownloadablesSubscriber$Outbound = {
   deletable: boolean;
   organization_id: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization$Outbound;
+  organization: BenefitSubscriberOrganization$Outbound;
   properties: BenefitDownloadablesSubscriberProperties$Outbound;
 };
 
@@ -180,7 +180,7 @@ export const BenefitDownloadablesSubscriber$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$outboundSchema,
+  organization: BenefitSubscriberOrganization$outboundSchema,
   properties: BenefitDownloadablesSubscriberProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitgithubrepositorysubscriber.ts

@@ -14,11 +14,11 @@ import {
   BenefitGitHubRepositorySubscriberProperties$outboundSchema,
 } from "./benefitgithubrepositorysubscriberproperties.js";
 import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+  BenefitSubscriberOrganization$Outbound,
+  BenefitSubscriberOrganization$outboundSchema,
+} from "./benefitsubscriberorganization.js";
 
 export type BenefitGitHubRepositorySubscriberMetadata =
   | string
@@ -57,7 +57,7 @@ export type BenefitGitHubRepositorySubscriber = {
    */
   organizationId: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization;
+  organization: BenefitSubscriberOrganization;
   /**
    * Properties available to subscribers for a benefit of type `github_repository`.
    */
@@ -147,7 +147,7 @@ export const BenefitGitHubRepositorySubscriber$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$inboundSchema,
+  organization: BenefitSubscriberOrganization$inboundSchema,
   properties: BenefitGitHubRepositorySubscriberProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -168,7 +168,7 @@ export type BenefitGitHubRepositorySubscriber$Outbound = {
   deletable: boolean;
   organization_id: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization$Outbound;
+  organization: BenefitSubscriberOrganization$Outbound;
   properties: BenefitGitHubRepositorySubscriberProperties$Outbound;
 };
 
@@ -189,7 +189,7 @@ export const BenefitGitHubRepositorySubscriber$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$outboundSchema,
+  organization: BenefitSubscriberOrganization$outboundSchema,
   properties: BenefitGitHubRepositorySubscriberProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitgrantedevent.ts

@@ -48,6 +48,14 @@ export type BenefitGrantedEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
+  /**
+   * The ID of the parent event.
+   */
+  parentId?: string | null | undefined;
   /**
    * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
@@ -71,6 +79,8 @@ export const BenefitGrantedEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
+  parent_id: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.granted"),
   metadata: BenefitGrantMetadata$inboundSchema,
@@ -79,6 +89,8 @@ export const BenefitGrantedEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
+    "parent_id": "parentId",
   });
 });
 
@@ -90,6 +102,8 @@ export type BenefitGrantedEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
+  parent_id?: string | null | undefined;
   source: "system";
   name: "benefit.granted";
   metadata: BenefitGrantMetadata$Outbound;
@@ -107,6 +121,8 @@ export const BenefitGrantedEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
+  parentId: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.granted"),
   metadata: BenefitGrantMetadata$outboundSchema,
@@ -115,6 +131,8 @@ export const BenefitGrantedEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
+    parentId: "parent_id",
   });
 });
 

package/src/models/components/benefitlicensekeyssubscriber.ts

@@ -14,11 +14,11 @@ import {
   BenefitLicenseKeysSubscriberProperties$outboundSchema,
 } from "./benefitlicensekeyssubscriberproperties.js";
 import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+  BenefitSubscriberOrganization$Outbound,
+  BenefitSubscriberOrganization$outboundSchema,
+} from "./benefitsubscriberorganization.js";
 
 export type BenefitLicenseKeysSubscriberMetadata =
   | string
@@ -57,7 +57,7 @@ export type BenefitLicenseKeysSubscriber = {
    */
   organizationId: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization;
+  organization: BenefitSubscriberOrganization;
   properties: BenefitLicenseKeysSubscriberProperties;
 };
 
@@ -137,7 +137,7 @@ export const BenefitLicenseKeysSubscriber$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$inboundSchema,
+  organization: BenefitSubscriberOrganization$inboundSchema,
   properties: BenefitLicenseKeysSubscriberProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -158,7 +158,7 @@ export type BenefitLicenseKeysSubscriber$Outbound = {
   deletable: boolean;
   organization_id: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization$Outbound;
+  organization: BenefitSubscriberOrganization$Outbound;
   properties: BenefitLicenseKeysSubscriberProperties$Outbound;
 };
 
@@ -179,7 +179,7 @@ export const BenefitLicenseKeysSubscriber$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$outboundSchema,
+  organization: BenefitSubscriberOrganization$outboundSchema,
   properties: BenefitLicenseKeysSubscriberProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitmetercreditsubscriber.ts

@@ -14,11 +14,11 @@ import {
   BenefitMeterCreditSubscriberProperties$outboundSchema,
 } from "./benefitmetercreditsubscriberproperties.js";
 import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
+  BenefitSubscriberOrganization,
+  BenefitSubscriberOrganization$inboundSchema,
+  BenefitSubscriberOrganization$Outbound,
+  BenefitSubscriberOrganization$outboundSchema,
+} from "./benefitsubscriberorganization.js";
 
 export type BenefitMeterCreditSubscriberMetadata =
   | string
@@ -57,7 +57,7 @@ export type BenefitMeterCreditSubscriber = {
    */
   organizationId: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization;
+  organization: BenefitSubscriberOrganization;
   /**
    * Properties available to subscribers for a benefit of type `meter_unit`.
    */
@@ -140,7 +140,7 @@ export const BenefitMeterCreditSubscriber$inboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$inboundSchema,
+  organization: BenefitSubscriberOrganization$inboundSchema,
   properties: BenefitMeterCreditSubscriberProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -161,7 +161,7 @@ export type BenefitMeterCreditSubscriber$Outbound = {
   deletable: boolean;
   organization_id: string;
   metadata: { [k: string]: string | number | number | boolean };
-  organization: Organization$Outbound;
+  organization: BenefitSubscriberOrganization$Outbound;
   properties: BenefitMeterCreditSubscriberProperties$Outbound;
 };
 
@@ -182,7 +182,7 @@ export const BenefitMeterCreditSubscriber$outboundSchema: z.ZodType<
   metadata: z.record(
     z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
   ),
-  organization: Organization$outboundSchema,
+  organization: BenefitSubscriberOrganization$outboundSchema,
   properties: BenefitMeterCreditSubscriberProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/benefitrevokedevent.ts

@@ -48,6 +48,14 @@ export type BenefitRevokedEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
+  /**
+   * The ID of the parent event.
+   */
+  parentId?: string | null | undefined;
   /**
    * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
@@ -71,6 +79,8 @@ export const BenefitRevokedEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
+  parent_id: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.revoked"),
   metadata: BenefitGrantMetadata$inboundSchema,
@@ -79,6 +89,8 @@ export const BenefitRevokedEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
+    "parent_id": "parentId",
   });
 });
 
@@ -90,6 +102,8 @@ export type BenefitRevokedEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
+  parent_id?: string | null | undefined;
   source: "system";
   name: "benefit.revoked";
   metadata: BenefitGrantMetadata$Outbound;
@@ -107,6 +121,8 @@ export const BenefitRevokedEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
+  parentId: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.revoked"),
   metadata: BenefitGrantMetadata$outboundSchema,
@@ -115,6 +131,8 @@ export const BenefitRevokedEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
+    parentId: "parent_id",
   });
 });
 

package/src/models/components/benefitsubscriberorganization.ts

@@ -0,0 +1,141 @@
+/*
+ * 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 {
+  SubscriptionProrationBehavior,
+  SubscriptionProrationBehavior$inboundSchema,
+  SubscriptionProrationBehavior$outboundSchema,
+} from "./subscriptionprorationbehavior.js";
+
+export type BenefitSubscriberOrganization = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Organization name shown in checkout, customer portal, emails etc.
+   */
+  name: string;
+  /**
+   * Unique organization slug in checkout, customer portal and credit card statements.
+   */
+  slug: string;
+  /**
+   * Avatar URL shown in checkout, customer portal, emails etc.
+   */
+  avatarUrl: string | null;
+  prorationBehavior: SubscriptionProrationBehavior;
+  /**
+   * Whether customers can update their subscriptions from the customer portal.
+   */
+  allowCustomerUpdates: boolean;
+};
+
+/** @internal */
+export const BenefitSubscriberOrganization$inboundSchema: z.ZodType<
+  BenefitSubscriberOrganization,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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)),
+  ),
+  id: z.string(),
+  name: z.string(),
+  slug: z.string(),
+  avatar_url: z.nullable(z.string()),
+  proration_behavior: SubscriptionProrationBehavior$inboundSchema,
+  allow_customer_updates: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "avatar_url": "avatarUrl",
+    "proration_behavior": "prorationBehavior",
+    "allow_customer_updates": "allowCustomerUpdates",
+  });
+});
+
+/** @internal */
+export type BenefitSubscriberOrganization$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  name: string;
+  slug: string;
+  avatar_url: string | null;
+  proration_behavior: string;
+  allow_customer_updates: boolean;
+};
+
+/** @internal */
+export const BenefitSubscriberOrganization$outboundSchema: z.ZodType<
+  BenefitSubscriberOrganization$Outbound,
+  z.ZodTypeDef,
+  BenefitSubscriberOrganization
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  id: z.string(),
+  name: z.string(),
+  slug: z.string(),
+  avatarUrl: z.nullable(z.string()),
+  prorationBehavior: SubscriptionProrationBehavior$outboundSchema,
+  allowCustomerUpdates: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    avatarUrl: "avatar_url",
+    prorationBehavior: "proration_behavior",
+    allowCustomerUpdates: "allow_customer_updates",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BenefitSubscriberOrganization$ {
+  /** @deprecated use `BenefitSubscriberOrganization$inboundSchema` instead. */
+  export const inboundSchema = BenefitSubscriberOrganization$inboundSchema;
+  /** @deprecated use `BenefitSubscriberOrganization$outboundSchema` instead. */
+  export const outboundSchema = BenefitSubscriberOrganization$outboundSchema;
+  /** @deprecated use `BenefitSubscriberOrganization$Outbound` instead. */
+  export type Outbound = BenefitSubscriberOrganization$Outbound;
+}
+
+export function benefitSubscriberOrganizationToJSON(
+  benefitSubscriberOrganization: BenefitSubscriberOrganization,
+): string {
+  return JSON.stringify(
+    BenefitSubscriberOrganization$outboundSchema.parse(
+      benefitSubscriberOrganization,
+    ),
+  );
+}
+
+export function benefitSubscriberOrganizationFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitSubscriberOrganization, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitSubscriberOrganization$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitSubscriberOrganization' from JSON`,
+  );
+}

package/src/models/components/benefitupdatedevent.ts

@@ -48,6 +48,14 @@ export type BenefitUpdatedEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
+  /**
+   * The ID of the parent event.
+   */
+  parentId?: string | null | undefined;
   /**
    * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
@@ -71,6 +79,8 @@ export const BenefitUpdatedEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
+  parent_id: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.updated"),
   metadata: BenefitGrantMetadata$inboundSchema,
@@ -79,6 +89,8 @@ export const BenefitUpdatedEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
+    "parent_id": "parentId",
   });
 });
 
@@ -90,6 +102,8 @@ export type BenefitUpdatedEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
+  parent_id?: string | null | undefined;
   source: "system";
   name: "benefit.updated";
   metadata: BenefitGrantMetadata$Outbound;
@@ -107,6 +121,8 @@ export const BenefitUpdatedEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
+  parentId: z.nullable(z.string()).optional(),
   source: z.literal("system"),
   name: z.literal("benefit.updated"),
   metadata: BenefitGrantMetadata$outboundSchema,
@@ -115,6 +131,8 @@ export const BenefitUpdatedEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
+    parentId: "parent_id",
   });
 });