@polar-sh/sdk 0.48.0 → 0.49.0

package/src/models/components/benefitlicensekeyssubscriber.ts

@@ -15,10 +15,6 @@ import {
   BenefitSubscriberOrganization,
   BenefitSubscriberOrganization$inboundSchema,
 } from "./benefitsubscriberorganization.js";
-import {
-  MetadataOutputType,
-  MetadataOutputType$inboundSchema,
-} from "./metadataoutputtype.js";
 
 export type BenefitLicenseKeysSubscriber = {
   /**
@@ -54,7 +50,6 @@ export type BenefitLicenseKeysSubscriber = {
    * The ID of the organization owning the benefit.
    */
   organizationId: string;
-  metadata: { [k: string]: MetadataOutputType };
   organization: BenefitSubscriberOrganization;
   properties: BenefitLicenseKeysSubscriberProperties;
 };
@@ -79,7 +74,6 @@ export const BenefitLicenseKeysSubscriber$inboundSchema: z.ZodMiniType<
     deletable: z.boolean(),
     is_deleted: z.boolean(),
     organization_id: z.string(),
-    metadata: z.record(z.string(), MetadataOutputType$inboundSchema),
     organization: BenefitSubscriberOrganization$inboundSchema,
     properties: BenefitLicenseKeysSubscriberProperties$inboundSchema,
   }),

package/src/models/components/benefitlicensekeysupdate.ts

@@ -9,6 +9,10 @@ import {
   BenefitLicenseKeysCreateProperties$Outbound,
   BenefitLicenseKeysCreateProperties$outboundSchema,
 } from "./benefitlicensekeyscreateproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
 
 export type BenefitLicenseKeysUpdateMetadata =
   | string
@@ -37,6 +41,10 @@ export type BenefitLicenseKeysUpdate = {
    * The description of the benefit. Will be displayed on products having this benefit.
    */
   description?: string | null | undefined;
+  /**
+   * The visibility of the benefit in the customer portal.
+   */
+  visibility?: BenefitVisibility | null | undefined;
   type: "license_keys";
   properties?: BenefitLicenseKeysCreateProperties | null | undefined;
 };
@@ -68,6 +76,7 @@ export function benefitLicenseKeysUpdateMetadataToJSON(
 export type BenefitLicenseKeysUpdate$Outbound = {
   metadata?: { [k: string]: string | number | number | boolean } | undefined;
   description?: string | null | undefined;
+  visibility?: string | null | undefined;
   type: "license_keys";
   properties?: BenefitLicenseKeysCreateProperties$Outbound | null | undefined;
 };
@@ -84,6 +93,7 @@ export const BenefitLicenseKeysUpdate$outboundSchema: z.ZodMiniType<
     ),
   ),
   description: z.optional(z.nullable(z.string())),
+  visibility: z.optional(z.nullable(BenefitVisibility$outboundSchema)),
   type: z.literal("license_keys"),
   properties: z.optional(
     z.nullable(BenefitLicenseKeysCreateProperties$outboundSchema),

package/src/models/components/benefitmetercredit.ts

@@ -13,6 +13,11 @@ import {
   BenefitMeterCreditProperties$Outbound,
   BenefitMeterCreditProperties$outboundSchema,
 } from "./benefitmetercreditproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$inboundSchema,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
 import {
   MetadataOutputType,
   MetadataOutputType$inboundSchema,
@@ -62,10 +67,12 @@ export type BenefitMeterCredit = {
    */
   organizationId: string;
   metadata: { [k: string]: MetadataOutputType };
+  visibility: BenefitVisibility;
   /**
    * Properties for a benefit of type `meter_unit`.
    */
   properties: BenefitMeterCreditProperties;
+  visibilityConfigurable: boolean;
 };
 
 /** @internal */
@@ -89,7 +96,9 @@ export const BenefitMeterCredit$inboundSchema: z.ZodMiniType<
     is_deleted: z.boolean(),
     organization_id: z.string(),
     metadata: z.record(z.string(), MetadataOutputType$inboundSchema),
+    visibility: BenefitVisibility$inboundSchema,
     properties: BenefitMeterCreditProperties$inboundSchema,
+    visibility_configurable: z.boolean(),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -97,6 +106,7 @@ export const BenefitMeterCredit$inboundSchema: z.ZodMiniType<
       "modified_at": "modifiedAt",
       "is_deleted": "isDeleted",
       "organization_id": "organizationId",
+      "visibility_configurable": "visibilityConfigurable",
     });
   }),
 );
@@ -112,7 +122,9 @@ export type BenefitMeterCredit$Outbound = {
   is_deleted: boolean;
   organization_id: string;
   metadata: { [k: string]: MetadataOutputType$Outbound };
+  visibility: string;
   properties: BenefitMeterCreditProperties$Outbound;
+  visibility_configurable: boolean;
 };
 
 /** @internal */
@@ -131,7 +143,9 @@ export const BenefitMeterCredit$outboundSchema: z.ZodMiniType<
     isDeleted: z.boolean(),
     organizationId: z.string(),
     metadata: z.record(z.string(), MetadataOutputType$outboundSchema),
+    visibility: BenefitVisibility$outboundSchema,
     properties: BenefitMeterCreditProperties$outboundSchema,
+    visibilityConfigurable: z.boolean(),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -139,6 +153,7 @@ export const BenefitMeterCredit$outboundSchema: z.ZodMiniType<
       modifiedAt: "modified_at",
       isDeleted: "is_deleted",
       organizationId: "organization_id",
+      visibilityConfigurable: "visibility_configurable",
     });
   }),
 );

package/src/models/components/benefitmetercreditcreate.ts

@@ -10,6 +10,10 @@ import {
   BenefitMeterCreditCreateProperties$Outbound,
   BenefitMeterCreditCreateProperties$outboundSchema,
 } from "./benefitmetercreditcreateproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
 
 export type BenefitMeterCreditCreateMetadata =
   | string
@@ -46,6 +50,10 @@ export type BenefitMeterCreditCreate = {
    * The ID of the organization owning the benefit. **Required unless you use an organization token.**
    */
   organizationId?: string | null | undefined;
+  /**
+   * The visibility of the benefit in the customer portal.
+   */
+  visibility?: BenefitVisibility | null | undefined;
   /**
    * Properties for creating a benefit of type `meter_unit`.
    */
@@ -81,6 +89,7 @@ export type BenefitMeterCreditCreate$Outbound = {
   type: "meter_credit";
   description: string;
   organization_id?: string | null | undefined;
+  visibility?: string | null | undefined;
   properties: BenefitMeterCreditCreateProperties$Outbound;
 };
 
@@ -99,6 +108,7 @@ export const BenefitMeterCreditCreate$outboundSchema: z.ZodMiniType<
     type: z.literal("meter_credit"),
     description: z.string(),
     organizationId: z.optional(z.nullable(z.string())),
+    visibility: z.optional(z.nullable(BenefitVisibility$outboundSchema)),
     properties: BenefitMeterCreditCreateProperties$outboundSchema,
   }),
   z.transform((v) => {

package/src/models/components/benefitmetercreditsubscriber.ts

@@ -15,10 +15,6 @@ import {
   BenefitSubscriberOrganization,
   BenefitSubscriberOrganization$inboundSchema,
 } from "./benefitsubscriberorganization.js";
-import {
-  MetadataOutputType,
-  MetadataOutputType$inboundSchema,
-} from "./metadataoutputtype.js";
 
 export type BenefitMeterCreditSubscriber = {
   /**
@@ -54,7 +50,6 @@ export type BenefitMeterCreditSubscriber = {
    * The ID of the organization owning the benefit.
    */
   organizationId: string;
-  metadata: { [k: string]: MetadataOutputType };
   organization: BenefitSubscriberOrganization;
   /**
    * Properties available to subscribers for a benefit of type `meter_unit`.
@@ -82,7 +77,6 @@ export const BenefitMeterCreditSubscriber$inboundSchema: z.ZodMiniType<
     deletable: z.boolean(),
     is_deleted: z.boolean(),
     organization_id: z.string(),
-    metadata: z.record(z.string(), MetadataOutputType$inboundSchema),
     organization: BenefitSubscriberOrganization$inboundSchema,
     properties: BenefitMeterCreditSubscriberProperties$inboundSchema,
   }),

package/src/models/components/benefitmetercreditupdate.ts

@@ -9,6 +9,10 @@ import {
   BenefitMeterCreditCreateProperties$Outbound,
   BenefitMeterCreditCreateProperties$outboundSchema,
 } from "./benefitmetercreditcreateproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
 
 export type BenefitMeterCreditUpdateMetadata =
   | string
@@ -37,6 +41,10 @@ export type BenefitMeterCreditUpdate = {
    * The description of the benefit. Will be displayed on products having this benefit.
    */
   description?: string | null | undefined;
+  /**
+   * The visibility of the benefit in the customer portal.
+   */
+  visibility?: BenefitVisibility | null | undefined;
   type: "meter_credit";
   properties?: BenefitMeterCreditCreateProperties | null | undefined;
 };
@@ -68,6 +76,7 @@ export function benefitMeterCreditUpdateMetadataToJSON(
 export type BenefitMeterCreditUpdate$Outbound = {
   metadata?: { [k: string]: string | number | number | boolean } | undefined;
   description?: string | null | undefined;
+  visibility?: string | null | undefined;
   type: "meter_credit";
   properties?: BenefitMeterCreditCreateProperties$Outbound | null | undefined;
 };
@@ -84,6 +93,7 @@ export const BenefitMeterCreditUpdate$outboundSchema: z.ZodMiniType<
     ),
   ),
   description: z.optional(z.nullable(z.string())),
+  visibility: z.optional(z.nullable(BenefitVisibility$outboundSchema)),
   type: z.literal("meter_credit"),
   properties: z.optional(
     z.nullable(BenefitMeterCreditCreateProperties$outboundSchema),

package/src/models/components/benefitslacksharedchannel.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 {
+  BenefitSlackSharedChannelProperties,
+  BenefitSlackSharedChannelProperties$inboundSchema,
+  BenefitSlackSharedChannelProperties$Outbound,
+  BenefitSlackSharedChannelProperties$outboundSchema,
+} from "./benefitslacksharedchannelproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$inboundSchema,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
+import {
+  MetadataOutputType,
+  MetadataOutputType$inboundSchema,
+  MetadataOutputType$Outbound,
+  MetadataOutputType$outboundSchema,
+} from "./metadataoutputtype.js";
+
+export type BenefitSlackSharedChannel = {
+  /**
+   * The ID of the benefit.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  type: "slack_shared_channel";
+  /**
+   * The description of the benefit.
+   */
+  description: string;
+  /**
+   * Whether the benefit is selectable when creating a product.
+   */
+  selectable: boolean;
+  /**
+   * Whether the benefit is deletable.
+   */
+  deletable: boolean;
+  /**
+   * Whether the benefit is deleted.
+   */
+  isDeleted: boolean;
+  /**
+   * The ID of the organization owning the benefit.
+   */
+  organizationId: string;
+  metadata: { [k: string]: MetadataOutputType };
+  visibility: BenefitVisibility;
+  properties: BenefitSlackSharedChannelProperties;
+  visibilityConfigurable: boolean;
+};
+
+/** @internal */
+export const BenefitSlackSharedChannel$inboundSchema: z.ZodMiniType<
+  BenefitSlackSharedChannel,
+  unknown
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    type: z.literal("slack_shared_channel"),
+    description: z.string(),
+    selectable: z.boolean(),
+    deletable: z.boolean(),
+    is_deleted: z.boolean(),
+    organization_id: z.string(),
+    metadata: z.record(z.string(), MetadataOutputType$inboundSchema),
+    visibility: BenefitVisibility$inboundSchema,
+    properties: BenefitSlackSharedChannelProperties$inboundSchema,
+    visibility_configurable: z.boolean(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "is_deleted": "isDeleted",
+      "organization_id": "organizationId",
+      "visibility_configurable": "visibilityConfigurable",
+    });
+  }),
+);
+/** @internal */
+export type BenefitSlackSharedChannel$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  type: "slack_shared_channel";
+  description: string;
+  selectable: boolean;
+  deletable: boolean;
+  is_deleted: boolean;
+  organization_id: string;
+  metadata: { [k: string]: MetadataOutputType$Outbound };
+  visibility: string;
+  properties: BenefitSlackSharedChannelProperties$Outbound;
+  visibility_configurable: boolean;
+};
+
+/** @internal */
+export const BenefitSlackSharedChannel$outboundSchema: z.ZodMiniType<
+  BenefitSlackSharedChannel$Outbound,
+  BenefitSlackSharedChannel
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    createdAt: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    modifiedAt: z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    type: z.literal("slack_shared_channel"),
+    description: z.string(),
+    selectable: z.boolean(),
+    deletable: z.boolean(),
+    isDeleted: z.boolean(),
+    organizationId: z.string(),
+    metadata: z.record(z.string(), MetadataOutputType$outboundSchema),
+    visibility: BenefitVisibility$outboundSchema,
+    properties: BenefitSlackSharedChannelProperties$outboundSchema,
+    visibilityConfigurable: z.boolean(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      createdAt: "created_at",
+      modifiedAt: "modified_at",
+      isDeleted: "is_deleted",
+      organizationId: "organization_id",
+      visibilityConfigurable: "visibility_configurable",
+    });
+  }),
+);
+
+export function benefitSlackSharedChannelToJSON(
+  benefitSlackSharedChannel: BenefitSlackSharedChannel,
+): string {
+  return JSON.stringify(
+    BenefitSlackSharedChannel$outboundSchema.parse(benefitSlackSharedChannel),
+  );
+}
+export function benefitSlackSharedChannelFromJSON(
+  jsonString: string,
+): SafeParseResult<BenefitSlackSharedChannel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BenefitSlackSharedChannel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BenefitSlackSharedChannel' from JSON`,
+  );
+}

package/src/models/components/benefitslacksharedchannelcreate.ts

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import {
+  BenefitSlackSharedChannelCreateProperties,
+  BenefitSlackSharedChannelCreateProperties$Outbound,
+  BenefitSlackSharedChannelCreateProperties$outboundSchema,
+} from "./benefitslacksharedchannelcreateproperties.js";
+import {
+  BenefitVisibility,
+  BenefitVisibility$outboundSchema,
+} from "./benefitvisibility.js";
+
+export type BenefitSlackSharedChannelCreateMetadata =
+  | string
+  | number
+  | number
+  | boolean;
+
+export type BenefitSlackSharedChannelCreate = {
+  /**
+   * 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: "slack_shared_channel";
+  /**
+   * The description of the benefit. Will be displayed on products having this benefit.
+   */
+  description: string;
+  /**
+   * The ID of the organization owning the benefit. **Required unless you use an organization token.**
+   */
+  organizationId?: string | null | undefined;
+  /**
+   * The visibility of the benefit in the customer portal.
+   */
+  visibility?: BenefitVisibility | null | undefined;
+  properties: BenefitSlackSharedChannelCreateProperties;
+};
+
+/** @internal */
+export type BenefitSlackSharedChannelCreateMetadata$Outbound =
+  | string
+  | number
+  | number
+  | boolean;
+
+/** @internal */
+export const BenefitSlackSharedChannelCreateMetadata$outboundSchema:
+  z.ZodMiniType<
+    BenefitSlackSharedChannelCreateMetadata$Outbound,
+    BenefitSlackSharedChannelCreateMetadata
+  > = smartUnion([z.string(), z.int(), z.number(), z.boolean()]);
+
+export function benefitSlackSharedChannelCreateMetadataToJSON(
+  benefitSlackSharedChannelCreateMetadata:
+    BenefitSlackSharedChannelCreateMetadata,
+): string {
+  return JSON.stringify(
+    BenefitSlackSharedChannelCreateMetadata$outboundSchema.parse(
+      benefitSlackSharedChannelCreateMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type BenefitSlackSharedChannelCreate$Outbound = {
+  metadata?: { [k: string]: string | number | number | boolean } | undefined;
+  type: "slack_shared_channel";
+  description: string;
+  organization_id?: string | null | undefined;
+  visibility?: string | null | undefined;
+  properties: BenefitSlackSharedChannelCreateProperties$Outbound;
+};
+
+/** @internal */
+export const BenefitSlackSharedChannelCreate$outboundSchema: z.ZodMiniType<
+  BenefitSlackSharedChannelCreate$Outbound,
+  BenefitSlackSharedChannelCreate
+> = z.pipe(
+  z.object({
+    metadata: z.optional(
+      z.record(
+        z.string(),
+        smartUnion([z.string(), z.int(), z.number(), z.boolean()]),
+      ),
+    ),
+    type: z.literal("slack_shared_channel"),
+    description: z.string(),
+    organizationId: z.optional(z.nullable(z.string())),
+    visibility: z.optional(z.nullable(BenefitVisibility$outboundSchema)),
+    properties: BenefitSlackSharedChannelCreateProperties$outboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      organizationId: "organization_id",
+    });
+  }),
+);
+
+export function benefitSlackSharedChannelCreateToJSON(
+  benefitSlackSharedChannelCreate: BenefitSlackSharedChannelCreate,
+): string {
+  return JSON.stringify(
+    BenefitSlackSharedChannelCreate$outboundSchema.parse(
+      benefitSlackSharedChannelCreate,
+    ),
+  );
+}

package/src/models/components/benefitslacksharedchannelcreateproperties.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type BenefitSlackSharedChannelCreateProperties = {
+  /**
+   * Polar Slack integration to use for this benefit.
+   */
+  slackIntegrationId: string;
+  channelNameTemplate: string;
+  private?: boolean | undefined;
+  welcomeMessage?: string | null | undefined;
+  archiveOnRevoke?: boolean | undefined;
+  teamInvitees?: Array<string> | undefined;
+};
+
+/** @internal */
+export type BenefitSlackSharedChannelCreateProperties$Outbound = {
+  slack_integration_id: string;
+  channel_name_template: string;
+  private: boolean;
+  welcome_message?: string | null | undefined;
+  archive_on_revoke: boolean;
+  team_invitees?: Array<string> | undefined;
+};
+
+/** @internal */
+export const BenefitSlackSharedChannelCreateProperties$outboundSchema:
+  z.ZodMiniType<
+    BenefitSlackSharedChannelCreateProperties$Outbound,
+    BenefitSlackSharedChannelCreateProperties
+  > = z.pipe(
+    z.object({
+      slackIntegrationId: z.string(),
+      channelNameTemplate: z.string(),
+      private: z._default(z.boolean(), true),
+      welcomeMessage: z.optional(z.nullable(z.string())),
+      archiveOnRevoke: z._default(z.boolean(), true),
+      teamInvitees: z.optional(z.array(z.string())),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        slackIntegrationId: "slack_integration_id",
+        channelNameTemplate: "channel_name_template",
+        welcomeMessage: "welcome_message",
+        archiveOnRevoke: "archive_on_revoke",
+        teamInvitees: "team_invitees",
+      });
+    }),
+  );
+
+export function benefitSlackSharedChannelCreatePropertiesToJSON(
+  benefitSlackSharedChannelCreateProperties:
+    BenefitSlackSharedChannelCreateProperties,
+): string {
+  return JSON.stringify(
+    BenefitSlackSharedChannelCreateProperties$outboundSchema.parse(
+      benefitSlackSharedChannelCreateProperties,
+    ),
+  );
+}