@polar-sh/sdk 0.32.7 → 0.32.9

package/src/models/components/benefitdiscord.ts

@@ -14,6 +14,8 @@ import {
   BenefitDiscordProperties$outboundSchema,
 } from "./benefitdiscordproperties.js";
 
+export type BenefitDiscordMetadata = string | number | number | boolean;
+
 /**
  * A benefit of type `discord`.
  *
@@ -22,6 +24,10 @@ import {
  * Use it to automatically invite your backers to a Discord server.
  */
 export type BenefitDiscord = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -30,10 +36,7 @@ export type BenefitDiscord = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type?: "discord" | undefined;
   /**
    * The description of the benefit.
@@ -57,17 +60,72 @@ export type BenefitDiscord = {
   properties: BenefitDiscordProperties;
 };
 
+/** @internal */
+export const BenefitDiscordMetadata$inboundSchema: z.ZodType<
+  BenefitDiscordMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDiscordMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDiscordMetadata$outboundSchema: z.ZodType<
+  BenefitDiscordMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDiscordMetadata
+> = z.union([z.string(), z.number().int(), z.number(), 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 BenefitDiscordMetadata$ {
+  /** @deprecated use `BenefitDiscordMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDiscordMetadata$inboundSchema;
+  /** @deprecated use `BenefitDiscordMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitDiscordMetadata$outboundSchema;
+  /** @deprecated use `BenefitDiscordMetadata$Outbound` instead. */
+  export type Outbound = BenefitDiscordMetadata$Outbound;
+}
+
+export function benefitDiscordMetadataToJSON(
+  benefitDiscordMetadata: BenefitDiscordMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDiscordMetadata$outboundSchema.parse(benefitDiscordMetadata),
+  );
+}
+
+export function benefitDiscordMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDiscordMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitDiscordMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDiscordMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDiscord$inboundSchema: z.ZodType<
   BenefitDiscord,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   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(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("discord").optional(),
   description: z.string(),
   selectable: z.boolean(),
@@ -84,9 +142,10 @@ export const BenefitDiscord$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDiscord$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: "discord";
   description: string;
   selectable: boolean;
@@ -101,9 +160,12 @@ export const BenefitDiscord$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDiscord
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("discord").default("discord" as const),
   description: z.string(),
   selectable: z.boolean(),

package/src/models/components/benefitdiscordcreate.ts

@@ -14,7 +14,25 @@ import {
   BenefitDiscordCreateProperties$outboundSchema,
 } from "./benefitdiscordcreateproperties.js";
 
+export type BenefitDiscordCreateMetadata = string | number | number | boolean;
+
 export type BenefitDiscordCreate = {
+  /**
+   * 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 floating-point number
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   type?: "discord" | undefined;
   /**
    * The description of the benefit. Will be displayed on products having this benefit.
@@ -30,12 +48,69 @@ export type BenefitDiscordCreate = {
   properties: BenefitDiscordCreateProperties;
 };
 
+/** @internal */
+export const BenefitDiscordCreateMetadata$inboundSchema: z.ZodType<
+  BenefitDiscordCreateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDiscordCreateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDiscordCreateMetadata$outboundSchema: z.ZodType<
+  BenefitDiscordCreateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDiscordCreateMetadata
+> = z.union([z.string(), z.number().int(), z.number(), 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 BenefitDiscordCreateMetadata$ {
+  /** @deprecated use `BenefitDiscordCreateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDiscordCreateMetadata$inboundSchema;
+  /** @deprecated use `BenefitDiscordCreateMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitDiscordCreateMetadata$outboundSchema;
+  /** @deprecated use `BenefitDiscordCreateMetadata$Outbound` instead. */
+  export type Outbound = BenefitDiscordCreateMetadata$Outbound;
+}
+
+export function benefitDiscordCreateMetadataToJSON(
+  benefitDiscordCreateMetadata: BenefitDiscordCreateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDiscordCreateMetadata$outboundSchema.parse(
+      benefitDiscordCreateMetadata,
+    ),
+  );
+}
+
+export function benefitDiscordCreateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDiscordCreateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitDiscordCreateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDiscordCreateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDiscordCreate$inboundSchema: z.ZodType<
   BenefitDiscordCreate,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("discord").optional(),
   description: z.string(),
   organization_id: z.nullable(z.string()).optional(),
@@ -48,6 +123,7 @@ export const BenefitDiscordCreate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDiscordCreate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   type: "discord";
   description: string;
   organization_id?: string | null | undefined;
@@ -60,6 +136,9 @@ export const BenefitDiscordCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDiscordCreate
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("discord").default("discord" as const),
   description: z.string(),
   organizationId: z.nullable(z.string()).optional(),

package/src/models/components/benefitdiscordsubscriber.ts

@@ -20,7 +20,17 @@ import {
   Organization$outboundSchema,
 } from "./organization.js";
 
+export type BenefitDiscordSubscriberMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
 export type BenefitDiscordSubscriber = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -29,10 +39,7 @@ export type BenefitDiscordSubscriber = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type?: "discord" | undefined;
   /**
    * The description of the benefit.
@@ -57,17 +64,74 @@ export type BenefitDiscordSubscriber = {
   properties: BenefitDiscordSubscriberProperties;
 };
 
+/** @internal */
+export const BenefitDiscordSubscriberMetadata$inboundSchema: z.ZodType<
+  BenefitDiscordSubscriberMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDiscordSubscriberMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDiscordSubscriberMetadata$outboundSchema: z.ZodType<
+  BenefitDiscordSubscriberMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDiscordSubscriberMetadata
+> = z.union([z.string(), z.number().int(), z.number(), 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 BenefitDiscordSubscriberMetadata$ {
+  /** @deprecated use `BenefitDiscordSubscriberMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDiscordSubscriberMetadata$inboundSchema;
+  /** @deprecated use `BenefitDiscordSubscriberMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitDiscordSubscriberMetadata$outboundSchema;
+  /** @deprecated use `BenefitDiscordSubscriberMetadata$Outbound` instead. */
+  export type Outbound = BenefitDiscordSubscriberMetadata$Outbound;
+}
+
+export function benefitDiscordSubscriberMetadataToJSON(
+  benefitDiscordSubscriberMetadata: BenefitDiscordSubscriberMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDiscordSubscriberMetadata$outboundSchema.parse(
+      benefitDiscordSubscriberMetadata,
+    ),
+  );
+}
+
+export function benefitDiscordSubscriberMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDiscordSubscriberMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitDiscordSubscriberMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDiscordSubscriberMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDiscordSubscriber$inboundSchema: z.ZodType<
   BenefitDiscordSubscriber,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   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(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("discord").optional(),
   description: z.string(),
   selectable: z.boolean(),
@@ -85,9 +149,10 @@ export const BenefitDiscordSubscriber$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDiscordSubscriber$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: "discord";
   description: string;
   selectable: boolean;
@@ -103,9 +168,12 @@ export const BenefitDiscordSubscriber$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDiscordSubscriber
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("discord").default("discord" as const),
   description: z.string(),
   selectable: z.boolean(),

package/src/models/components/benefitdiscordupdate.ts

@@ -13,7 +13,25 @@ import {
   BenefitDiscordCreateProperties$outboundSchema,
 } from "./benefitdiscordcreateproperties.js";
 
+export type BenefitDiscordUpdateMetadata = string | number | number | boolean;
+
 export type BenefitDiscordUpdate = {
+  /**
+   * 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 floating-point number
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   /**
    * The description of the benefit. Will be displayed on products having this benefit.
    */
@@ -22,12 +40,69 @@ export type BenefitDiscordUpdate = {
   properties?: BenefitDiscordCreateProperties | null | undefined;
 };
 
+/** @internal */
+export const BenefitDiscordUpdateMetadata$inboundSchema: z.ZodType<
+  BenefitDiscordUpdateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDiscordUpdateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDiscordUpdateMetadata$outboundSchema: z.ZodType<
+  BenefitDiscordUpdateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDiscordUpdateMetadata
+> = z.union([z.string(), z.number().int(), z.number(), 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 BenefitDiscordUpdateMetadata$ {
+  /** @deprecated use `BenefitDiscordUpdateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDiscordUpdateMetadata$inboundSchema;
+  /** @deprecated use `BenefitDiscordUpdateMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitDiscordUpdateMetadata$outboundSchema;
+  /** @deprecated use `BenefitDiscordUpdateMetadata$Outbound` instead. */
+  export type Outbound = BenefitDiscordUpdateMetadata$Outbound;
+}
+
+export function benefitDiscordUpdateMetadataToJSON(
+  benefitDiscordUpdateMetadata: BenefitDiscordUpdateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDiscordUpdateMetadata$outboundSchema.parse(
+      benefitDiscordUpdateMetadata,
+    ),
+  );
+}
+
+export function benefitDiscordUpdateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDiscordUpdateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitDiscordUpdateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDiscordUpdateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDiscordUpdate$inboundSchema: z.ZodType<
   BenefitDiscordUpdate,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   description: z.nullable(z.string()).optional(),
   type: z.literal("discord").optional(),
   properties: z.nullable(BenefitDiscordCreateProperties$inboundSchema)
@@ -36,6 +111,7 @@ export const BenefitDiscordUpdate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDiscordUpdate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   description?: string | null | undefined;
   type: "discord";
   properties?: BenefitDiscordCreateProperties$Outbound | null | undefined;
@@ -47,6 +123,9 @@ export const BenefitDiscordUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDiscordUpdate
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   description: z.nullable(z.string()).optional(),
   type: z.literal("discord").default("discord" as const),
   properties: z.nullable(BenefitDiscordCreateProperties$outboundSchema)

package/src/models/components/benefitdownloadables.ts

@@ -14,7 +14,13 @@ import {
   BenefitDownloadablesProperties$outboundSchema,
 } from "./benefitdownloadablesproperties.js";
 
+export type BenefitDownloadablesMetadata = string | number | number | boolean;
+
 export type BenefitDownloadables = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -23,10 +29,7 @@ export type BenefitDownloadables = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type?: "downloadables" | undefined;
   /**
    * The description of the benefit.
@@ -47,17 +50,74 @@ export type BenefitDownloadables = {
   properties: BenefitDownloadablesProperties;
 };
 
+/** @internal */
+export const BenefitDownloadablesMetadata$inboundSchema: z.ZodType<
+  BenefitDownloadablesMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDownloadablesMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDownloadablesMetadata$outboundSchema: z.ZodType<
+  BenefitDownloadablesMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDownloadablesMetadata
+> = z.union([z.string(), z.number().int(), z.number(), 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 BenefitDownloadablesMetadata$ {
+  /** @deprecated use `BenefitDownloadablesMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDownloadablesMetadata$inboundSchema;
+  /** @deprecated use `BenefitDownloadablesMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitDownloadablesMetadata$outboundSchema;
+  /** @deprecated use `BenefitDownloadablesMetadata$Outbound` instead. */
+  export type Outbound = BenefitDownloadablesMetadata$Outbound;
+}
+
+export function benefitDownloadablesMetadataToJSON(
+  benefitDownloadablesMetadata: BenefitDownloadablesMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDownloadablesMetadata$outboundSchema.parse(
+      benefitDownloadablesMetadata,
+    ),
+  );
+}
+
+export function benefitDownloadablesMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDownloadablesMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitDownloadablesMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDownloadablesMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDownloadables$inboundSchema: z.ZodType<
   BenefitDownloadables,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   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(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("downloadables").optional(),
   description: z.string(),
   selectable: z.boolean(),
@@ -74,9 +134,10 @@ export const BenefitDownloadables$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDownloadables$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: "downloadables";
   description: string;
   selectable: boolean;
@@ -91,9 +152,12 @@ export const BenefitDownloadables$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDownloadables
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ),
   type: z.literal("downloadables").default("downloadables" as const),
   description: z.string(),
   selectable: z.boolean(),