@polar-sh/sdk 0.32.8 → 0.32.9

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(),

package/src/models/components/benefitdownloadablescreate.ts

@@ -14,7 +14,29 @@ import {
   BenefitDownloadablesCreateProperties$outboundSchema,
 } from "./benefitdownloadablescreateproperties.js";
 
+export type BenefitDownloadablesCreateMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
 export type BenefitDownloadablesCreate = {
+  /**
+   * 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?: "downloadables" | undefined;
   /**
    * The description of the benefit. Will be displayed on products having this benefit.
@@ -27,12 +49,71 @@ export type BenefitDownloadablesCreate = {
   properties: BenefitDownloadablesCreateProperties;
 };
 
+/** @internal */
+export const BenefitDownloadablesCreateMetadata$inboundSchema: z.ZodType<
+  BenefitDownloadablesCreateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDownloadablesCreateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDownloadablesCreateMetadata$outboundSchema: z.ZodType<
+  BenefitDownloadablesCreateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDownloadablesCreateMetadata
+> = 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 BenefitDownloadablesCreateMetadata$ {
+  /** @deprecated use `BenefitDownloadablesCreateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDownloadablesCreateMetadata$inboundSchema;
+  /** @deprecated use `BenefitDownloadablesCreateMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    BenefitDownloadablesCreateMetadata$outboundSchema;
+  /** @deprecated use `BenefitDownloadablesCreateMetadata$Outbound` instead. */
+  export type Outbound = BenefitDownloadablesCreateMetadata$Outbound;
+}
+
+export function benefitDownloadablesCreateMetadataToJSON(
+  benefitDownloadablesCreateMetadata: BenefitDownloadablesCreateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDownloadablesCreateMetadata$outboundSchema.parse(
+      benefitDownloadablesCreateMetadata,
+    ),
+  );
+}
+
+export function benefitDownloadablesCreateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDownloadablesCreateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BenefitDownloadablesCreateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDownloadablesCreateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDownloadablesCreate$inboundSchema: z.ZodType<
   BenefitDownloadablesCreate,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("downloadables").optional(),
   description: z.string(),
   organization_id: z.nullable(z.string()).optional(),
@@ -45,6 +126,7 @@ export const BenefitDownloadablesCreate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDownloadablesCreate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   type: "downloadables";
   description: string;
   organization_id?: string | null | undefined;
@@ -57,6 +139,9 @@ export const BenefitDownloadablesCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDownloadablesCreate
 > = z.object({
+  metadata: z.record(
+    z.union([z.string(), z.number().int(), z.number(), z.boolean()]),
+  ).optional(),
   type: z.literal("downloadables").default("downloadables" as const),
   description: z.string(),
   organizationId: z.nullable(z.string()).optional(),

package/src/models/components/benefitdownloadablessubscriber.ts

@@ -20,7 +20,17 @@ import {
   Organization$outboundSchema,
 } from "./organization.js";
 
+export type BenefitDownloadablesSubscriberMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
 export type BenefitDownloadablesSubscriber = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -29,10 +39,7 @@ export type BenefitDownloadablesSubscriber = {
    * 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.
@@ -54,17 +61,78 @@ export type BenefitDownloadablesSubscriber = {
   properties: BenefitDownloadablesSubscriberProperties;
 };
 
+/** @internal */
+export const BenefitDownloadablesSubscriberMetadata$inboundSchema: z.ZodType<
+  BenefitDownloadablesSubscriberMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDownloadablesSubscriberMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDownloadablesSubscriberMetadata$outboundSchema: z.ZodType<
+  BenefitDownloadablesSubscriberMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDownloadablesSubscriberMetadata
+> = 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 BenefitDownloadablesSubscriberMetadata$ {
+  /** @deprecated use `BenefitDownloadablesSubscriberMetadata$inboundSchema` instead. */
+  export const inboundSchema =
+    BenefitDownloadablesSubscriberMetadata$inboundSchema;
+  /** @deprecated use `BenefitDownloadablesSubscriberMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    BenefitDownloadablesSubscriberMetadata$outboundSchema;
+  /** @deprecated use `BenefitDownloadablesSubscriberMetadata$Outbound` instead. */
+  export type Outbound = BenefitDownloadablesSubscriberMetadata$Outbound;
+}
+
+export function benefitDownloadablesSubscriberMetadataToJSON(
+  benefitDownloadablesSubscriberMetadata:
+    BenefitDownloadablesSubscriberMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDownloadablesSubscriberMetadata$outboundSchema.parse(
+      benefitDownloadablesSubscriberMetadata,
+    ),
+  );
+}
+
+export function benefitDownloadablesSubscriberMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDownloadablesSubscriberMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BenefitDownloadablesSubscriberMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDownloadablesSubscriberMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDownloadablesSubscriber$inboundSchema: z.ZodType<
   BenefitDownloadablesSubscriber,
   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(),
@@ -82,9 +150,10 @@ export const BenefitDownloadablesSubscriber$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDownloadablesSubscriber$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;
@@ -100,9 +169,12 @@ export const BenefitDownloadablesSubscriber$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDownloadablesSubscriber
 > = 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(),

package/src/models/components/benefitdownloadablesupdate.ts

@@ -13,7 +13,29 @@ import {
   BenefitDownloadablesCreateProperties$outboundSchema,
 } from "./benefitdownloadablescreateproperties.js";
 
+export type BenefitDownloadablesUpdateMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
 export type BenefitDownloadablesUpdate = {
+  /**
+   * 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 +44,71 @@ export type BenefitDownloadablesUpdate = {
   properties?: BenefitDownloadablesCreateProperties | null | undefined;
 };
 
+/** @internal */
+export const BenefitDownloadablesUpdateMetadata$inboundSchema: z.ZodType<
+  BenefitDownloadablesUpdateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitDownloadablesUpdateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitDownloadablesUpdateMetadata$outboundSchema: z.ZodType<
+  BenefitDownloadablesUpdateMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitDownloadablesUpdateMetadata
+> = 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 BenefitDownloadablesUpdateMetadata$ {
+  /** @deprecated use `BenefitDownloadablesUpdateMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitDownloadablesUpdateMetadata$inboundSchema;
+  /** @deprecated use `BenefitDownloadablesUpdateMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    BenefitDownloadablesUpdateMetadata$outboundSchema;
+  /** @deprecated use `BenefitDownloadablesUpdateMetadata$Outbound` instead. */
+  export type Outbound = BenefitDownloadablesUpdateMetadata$Outbound;
+}
+
+export function benefitDownloadablesUpdateMetadataToJSON(
+  benefitDownloadablesUpdateMetadata: BenefitDownloadablesUpdateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitDownloadablesUpdateMetadata$outboundSchema.parse(
+      benefitDownloadablesUpdateMetadata,
+    ),
+  );
+}
+
+export function benefitDownloadablesUpdateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitDownloadablesUpdateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BenefitDownloadablesUpdateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitDownloadablesUpdateMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitDownloadablesUpdate$inboundSchema: z.ZodType<
   BenefitDownloadablesUpdate,
   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("downloadables").optional(),
   properties: z.nullable(BenefitDownloadablesCreateProperties$inboundSchema)
@@ -36,6 +117,7 @@ export const BenefitDownloadablesUpdate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitDownloadablesUpdate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
   description?: string | null | undefined;
   type: "downloadables";
   properties?: BenefitDownloadablesCreateProperties$Outbound | null | undefined;
@@ -47,6 +129,9 @@ export const BenefitDownloadablesUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitDownloadablesUpdate
 > = 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("downloadables").default("downloadables" as const),
   properties: z.nullable(BenefitDownloadablesCreateProperties$outboundSchema)

package/src/models/components/benefitgithubrepository.ts

@@ -14,6 +14,12 @@ import {
   BenefitGitHubRepositoryProperties$outboundSchema,
 } from "./benefitgithubrepositoryproperties.js";
 
+export type BenefitGitHubRepositoryMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
 /**
  * A benefit of type `github_repository`.
  *
@@ -22,6 +28,10 @@ import {
  * Use it to automatically invite your backers to a private GitHub repository.
  */
 export type BenefitGitHubRepository = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -30,10 +40,7 @@ export type BenefitGitHubRepository = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the benefit.
-   */
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type?: "github_repository" | undefined;
   /**
    * The description of the benefit.
@@ -57,17 +64,74 @@ export type BenefitGitHubRepository = {
   properties: BenefitGitHubRepositoryProperties;
 };
 
+/** @internal */
+export const BenefitGitHubRepositoryMetadata$inboundSchema: z.ZodType<
+  BenefitGitHubRepositoryMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.number(), z.boolean()]);
+
+/** @internal */
+export type BenefitGitHubRepositoryMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitGitHubRepositoryMetadata$outboundSchema: z.ZodType<
+  BenefitGitHubRepositoryMetadata$Outbound,
+  z.ZodTypeDef,
+  BenefitGitHubRepositoryMetadata
+> = 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 BenefitGitHubRepositoryMetadata$ {
+  /** @deprecated use `BenefitGitHubRepositoryMetadata$inboundSchema` instead. */
+  export const inboundSchema = BenefitGitHubRepositoryMetadata$inboundSchema;
+  /** @deprecated use `BenefitGitHubRepositoryMetadata$outboundSchema` instead. */
+  export const outboundSchema = BenefitGitHubRepositoryMetadata$outboundSchema;
+  /** @deprecated use `BenefitGitHubRepositoryMetadata$Outbound` instead. */
+  export type Outbound = BenefitGitHubRepositoryMetadata$Outbound;
+}
+
+export function benefitGitHubRepositoryMetadataToJSON(
+  benefitGitHubRepositoryMetadata: BenefitGitHubRepositoryMetadata,
+): string {
+  return JSON.stringify(
+    BenefitGitHubRepositoryMetadata$outboundSchema.parse(
+      benefitGitHubRepositoryMetadata,
+    ),
+  );
+}
+
+export function benefitGitHubRepositoryMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitGitHubRepositoryMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitGitHubRepositoryMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitGitHubRepositoryMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const BenefitGitHubRepository$inboundSchema: z.ZodType<
   BenefitGitHubRepository,
   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("github_repository").optional(),
   description: z.string(),
   selectable: z.boolean(),
@@ -84,9 +148,10 @@ export const BenefitGitHubRepository$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BenefitGitHubRepository$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
+  metadata: { [k: string]: string | number | number | boolean };
   type: "github_repository";
   description: string;
   selectable: boolean;
@@ -101,9 +166,12 @@ export const BenefitGitHubRepository$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BenefitGitHubRepository
 > = 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("github_repository").default("github_repository" as const),
   description: z.string(),
   selectable: z.boolean(),