@polar-sh/sdk 0.32.7 → 0.32.9

package/src/models/components/benefitbase.ts

@@ -13,7 +13,13 @@ import {
   BenefitType$outboundSchema,
 } from "./benefittype.js";
 
+export type BenefitBaseMetadata = string | number | number | boolean;
+
 export type BenefitBase = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -22,10 +28,7 @@ export type BenefitBase = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: BenefitType;
   /**
    * The description of the benefit.
@@ -45,17 +48,68 @@ export type BenefitBase = {
   organizationId: string;
 };
 
+/** @internal */
+export const BenefitBaseMetadata$inboundSchema: z.ZodType<
+  BenefitBaseMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitBaseMetadata$Outbound = string | number | number | boolean;
+
+/** @internal */
+export const BenefitBaseMetadata$outboundSchema: z.ZodType<
+  BenefitBaseMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitBaseMetadata
+> = 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 BenefitBaseMetadata$ {
+  /** @deprecated use `BenefitBaseMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitBaseMetadata$inboundSchema;
+  /** @deprecated use `BenefitBaseMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitBaseMetadata$outboundSchema;
+  /** @deprecated use `BenefitBaseMetadata$Outbound` instead. */
+  export type Outbound = BenefitBaseMetadata$Outbound;
+}
+
+export function benefitBaseMetadataToJSON(
+  benefitBaseMetadata: BenefitBaseMetadata,
+): string {
+  return JSON.stringify(
+    BenefitBaseMetadata$outboundSchema.parse(benefitBaseMetadata),
+  );
+}
+
+export function benefitBaseMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitBaseMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitBaseMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitBaseMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitBase$inboundSchema: z.ZodType<
   BenefitBase,
   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: BenefitType$inboundSchema,
   description: z.string(),
   selectable: z.boolean(),
@@ -71,9 +125,10 @@ export const BenefitBase$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitBase$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: string;
   description: string;
   selectable: boolean;
@@ -87,9 +142,12 @@ export const BenefitBase$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitBase
 > = 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: BenefitType$outboundSchema,
   description: z.string(),
   selectable: z.boolean(),

package/src/models/components/benefitcustom.ts

@@ -14,6 +14,8 @@ import {
   BenefitCustomProperties$outboundSchema,
 } from "./benefitcustomproperties.js";
 
+export type BenefitCustomMetadata = string | number | number | boolean;
+
 /**
  * A benefit of type `custom`.
  *
@@ -22,6 +24,10 @@ import {
  * Use it to grant any kind of benefit that doesn't fit in the other types.
  */
 export type BenefitCustom = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -30,10 +36,7 @@ export type BenefitCustom = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type?: "custom" | undefined;
   /**
    * The description of the benefit.
@@ -61,17 +64,68 @@ export type BenefitCustom = {
   isTaxApplicable: boolean;
 };
 
+/** @internal */
+export const BenefitCustomMetadata$inboundSchema: z.ZodType<
+  BenefitCustomMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitCustomMetadata$Outbound = string | number | number | boolean;
+
+/** @internal */
+export const BenefitCustomMetadata$outboundSchema: z.ZodType<
+  BenefitCustomMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitCustomMetadata
+> = 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 BenefitCustomMetadata$ {
+  /** @deprecated use `BenefitCustomMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitCustomMetadata$inboundSchema;
+  /** @deprecated use `BenefitCustomMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitCustomMetadata$outboundSchema;
+  /** @deprecated use `BenefitCustomMetadata$Outbound` instead. */
+  export type Outbound = BenefitCustomMetadata$Outbound;
+}
+
+export function benefitCustomMetadataToJSON(
+  benefitCustomMetadata: BenefitCustomMetadata,
+): string {
+  return JSON.stringify(
+    BenefitCustomMetadata$outboundSchema.parse(benefitCustomMetadata),
+  );
+}
+
+export function benefitCustomMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitCustomMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitCustomMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitCustomMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitCustom$inboundSchema: z.ZodType<
   BenefitCustom,
   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("custom").optional(),
   description: z.string(),
   selectable: z.boolean(),
@@ -90,9 +144,10 @@ export const BenefitCustom$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitCustom$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: "custom";
   description: string;
   selectable: boolean;
@@ -108,9 +163,12 @@ export const BenefitCustom$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitCustom
 > = 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("custom").default("custom" as const),
   description: z.string(),
   selectable: z.boolean(),

package/src/models/components/benefitcustomcreate.ts

@@ -14,10 +14,28 @@ import {
   BenefitCustomCreateProperties$outboundSchema,
 } from "./benefitcustomcreateproperties.js";
 
+export type BenefitCustomCreateMetadata = string | number | number | boolean;
+
 /**
  * Schema to create a benefit of type `custom`.
  */
 export type BenefitCustomCreate = {
+  /**
+   * 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?: "custom" | undefined;
   /**
    * The description of the benefit. Will be displayed on products having this benefit.
@@ -33,12 +51,69 @@ export type BenefitCustomCreate = {
   properties: BenefitCustomCreateProperties;
 };
 
+/** @internal */
+export const BenefitCustomCreateMetadata$inboundSchema: z.ZodType<
+  BenefitCustomCreateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitCustomCreateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitCustomCreateMetadata$outboundSchema: z.ZodType<
+  BenefitCustomCreateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitCustomCreateMetadata
+> = 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 BenefitCustomCreateMetadata$ {
+  /** @deprecated use `BenefitCustomCreateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitCustomCreateMetadata$inboundSchema;
+  /** @deprecated use `BenefitCustomCreateMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitCustomCreateMetadata$outboundSchema;
+  /** @deprecated use `BenefitCustomCreateMetadata$Outbound` instead. */
+  export type Outbound = BenefitCustomCreateMetadata$Outbound;
+}
+
+export function benefitCustomCreateMetadataToJSON(
+  benefitCustomCreateMetadata: BenefitCustomCreateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitCustomCreateMetadata$outboundSchema.parse(
+      benefitCustomCreateMetadata,
+    ),
+  );
+}
+
+export function benefitCustomCreateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitCustomCreateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitCustomCreateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitCustomCreateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitCustomCreate$inboundSchema: z.ZodType<
   BenefitCustomCreate,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("custom").optional(),
   description: z.string(),
   organization_id: z.nullable(z.string()).optional(),
@@ -51,6 +126,7 @@ export const BenefitCustomCreate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitCustomCreate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   type: "custom";
   description: string;
   organization_id?: string | null | undefined;
@@ -63,6 +139,9 @@ export const BenefitCustomCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitCustomCreate
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("custom").default("custom" as const),
   description: z.string(),
   organizationId: z.nullable(z.string()).optional(),

package/src/models/components/benefitcustomsubscriber.ts

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

package/src/models/components/benefitcustomupdate.ts

@@ -13,7 +13,25 @@ import {
   BenefitCustomProperties$outboundSchema,
 } from "./benefitcustomproperties.js";
 
+export type BenefitCustomUpdateMetadata = string | number | number | boolean;
+
 export type BenefitCustomUpdate = {
+  /**
+   * 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 BenefitCustomUpdate = {
   properties?: BenefitCustomProperties | null | undefined;
 };
 
+/** @internal */
+export const BenefitCustomUpdateMetadata$inboundSchema: z.ZodType<
+  BenefitCustomUpdateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitCustomUpdateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitCustomUpdateMetadata$outboundSchema: z.ZodType<
+  BenefitCustomUpdateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitCustomUpdateMetadata
+> = 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 BenefitCustomUpdateMetadata$ {
+  /** @deprecated use `BenefitCustomUpdateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitCustomUpdateMetadata$inboundSchema;
+  /** @deprecated use `BenefitCustomUpdateMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitCustomUpdateMetadata$outboundSchema;
+  /** @deprecated use `BenefitCustomUpdateMetadata$Outbound` instead. */
+  export type Outbound = BenefitCustomUpdateMetadata$Outbound;
+}
+
+export function benefitCustomUpdateMetadataToJSON(
+  benefitCustomUpdateMetadata: BenefitCustomUpdateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitCustomUpdateMetadata$outboundSchema.parse(
+      benefitCustomUpdateMetadata,
+    ),
+  );
+}
+
+export function benefitCustomUpdateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitCustomUpdateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitCustomUpdateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitCustomUpdateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitCustomUpdate$inboundSchema: z.ZodType<
   BenefitCustomUpdate,
   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("custom").optional(),
   properties: z.nullable(BenefitCustomProperties$inboundSchema).optional(),
@@ -35,6 +110,7 @@ export const BenefitCustomUpdate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitCustomUpdate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   description?: string | null | undefined;
   type: "custom";
   properties?: BenefitCustomProperties$Outbound | null | undefined;
@@ -46,6 +122,9 @@ export const BenefitCustomUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitCustomUpdate
 > = 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("custom").default("custom" as const),
   properties: z.nullable(BenefitCustomProperties$outboundSchema).optional(),