@polar-sh/sdk 0.30.0 → 0.32.0

package/src/models/components/organization.ts

@@ -19,6 +19,12 @@ import {
   OrganizationProfileSettings$Outbound,
   OrganizationProfileSettings$outboundSchema,
 } from "./organizationprofilesettings.js";
+import {
+  OrganizationSocialLink,
+  OrganizationSocialLink$inboundSchema,
+  OrganizationSocialLink$Outbound,
+  OrganizationSocialLink$outboundSchema,
+} from "./organizationsociallink.js";
 import {
   OrganizationSubscriptionSettings,
   OrganizationSubscriptionSettings$inboundSchema,
@@ -39,27 +45,77 @@ export type Organization = {
    * The organization ID.
    */
   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;
+  /**
+   * Public support email.
+   */
+  email: string | null;
+  /**
+   * Official website of the organization.
+   */
+  website: string | null;
+  /**
+   * Links to social profiles.
+   */
+  socials: Array<OrganizationSocialLink>;
+  /**
+   * When the business details were submitted.
+   */
+  detailsSubmittedAt: Date | null;
+  /**
+   * Organization feature settings
+   */
+  featureSettings: OrganizationFeatureSettings | null;
+  subscriptionSettings: OrganizationSubscriptionSettings;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   bio: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   company: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   blog: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   location: string | null;
-  email: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   twitterUsername: string | null;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   pledgeMinimumAmount: number;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   pledgeBadgeShowAmount: boolean;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   defaultUpfrontSplitToContributors: number | null;
   /**
    * Settings for the organization profile
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   profileSettings: OrganizationProfileSettings | null;
-  /**
-   * Settings for the organization features
-   */
-  featureSettings: OrganizationFeatureSettings | null;
-  subscriptionSettings: OrganizationSubscriptionSettings;
 };
 
 /** @internal */
@@ -76,31 +132,37 @@ export const Organization$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.string(),
   avatar_url: z.nullable(z.string()),
+  email: z.nullable(z.string()),
+  website: z.nullable(z.string()),
+  socials: z.array(OrganizationSocialLink$inboundSchema),
+  details_submitted_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema),
+  subscription_settings: OrganizationSubscriptionSettings$inboundSchema,
   bio: z.nullable(z.string()),
   company: z.nullable(z.string()),
   blog: z.nullable(z.string()),
   location: z.nullable(z.string()),
-  email: z.nullable(z.string()),
   twitter_username: z.nullable(z.string()),
   pledge_minimum_amount: z.number().int(),
   pledge_badge_show_amount: z.boolean(),
   default_upfront_split_to_contributors: z.nullable(z.number().int()),
   profile_settings: z.nullable(OrganizationProfileSettings$inboundSchema),
-  feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema),
-  subscription_settings: OrganizationSubscriptionSettings$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
     "modified_at": "modifiedAt",
     "avatar_url": "avatarUrl",
+    "details_submitted_at": "detailsSubmittedAt",
+    "feature_settings": "featureSettings",
+    "subscription_settings": "subscriptionSettings",
     "twitter_username": "twitterUsername",
     "pledge_minimum_amount": "pledgeMinimumAmount",
     "pledge_badge_show_amount": "pledgeBadgeShowAmount",
     "default_upfront_split_to_contributors":
       "defaultUpfrontSplitToContributors",
     "profile_settings": "profileSettings",
-    "feature_settings": "featureSettings",
-    "subscription_settings": "subscriptionSettings",
   });
 });
 
@@ -112,18 +174,21 @@ export type Organization$Outbound = {
   name: string;
   slug: string;
   avatar_url: string | null;
+  email: string | null;
+  website: string | null;
+  socials: Array<OrganizationSocialLink$Outbound>;
+  details_submitted_at: string | null;
+  feature_settings: OrganizationFeatureSettings$Outbound | null;
+  subscription_settings: OrganizationSubscriptionSettings$Outbound;
   bio: string | null;
   company: string | null;
   blog: string | null;
   location: string | null;
-  email: string | null;
   twitter_username: string | null;
   pledge_minimum_amount: number;
   pledge_badge_show_amount: boolean;
   default_upfront_split_to_contributors: number | null;
   profile_settings: OrganizationProfileSettings$Outbound | null;
-  feature_settings: OrganizationFeatureSettings$Outbound | null;
-  subscription_settings: OrganizationSubscriptionSettings$Outbound;
 };
 
 /** @internal */
@@ -138,30 +203,34 @@ export const Organization$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.string(),
   avatarUrl: z.nullable(z.string()),
+  email: z.nullable(z.string()),
+  website: z.nullable(z.string()),
+  socials: z.array(OrganizationSocialLink$outboundSchema),
+  detailsSubmittedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema),
+  subscriptionSettings: OrganizationSubscriptionSettings$outboundSchema,
   bio: z.nullable(z.string()),
   company: z.nullable(z.string()),
   blog: z.nullable(z.string()),
   location: z.nullable(z.string()),
-  email: z.nullable(z.string()),
   twitterUsername: z.nullable(z.string()),
   pledgeMinimumAmount: z.number().int(),
   pledgeBadgeShowAmount: z.boolean(),
   defaultUpfrontSplitToContributors: z.nullable(z.number().int()),
   profileSettings: z.nullable(OrganizationProfileSettings$outboundSchema),
-  featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema),
-  subscriptionSettings: OrganizationSubscriptionSettings$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
     modifiedAt: "modified_at",
     avatarUrl: "avatar_url",
+    detailsSubmittedAt: "details_submitted_at",
+    featureSettings: "feature_settings",
+    subscriptionSettings: "subscription_settings",
     twitterUsername: "twitter_username",
     pledgeMinimumAmount: "pledge_minimum_amount",
     pledgeBadgeShowAmount: "pledge_badge_show_amount",
     defaultUpfrontSplitToContributors: "default_upfront_split_to_contributors",
     profileSettings: "profile_settings",
-    featureSettings: "feature_settings",
-    subscriptionSettings: "subscription_settings",
   });
 });
 

package/src/models/components/organizationcreate.ts

@@ -7,12 +7,24 @@ 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 {
+  OrganizationDetails,
+  OrganizationDetails$inboundSchema,
+  OrganizationDetails$Outbound,
+  OrganizationDetails$outboundSchema,
+} from "./organizationdetails.js";
 import {
   OrganizationFeatureSettings,
   OrganizationFeatureSettings$inboundSchema,
   OrganizationFeatureSettings$Outbound,
   OrganizationFeatureSettings$outboundSchema,
 } from "./organizationfeaturesettings.js";
+import {
+  OrganizationSocialLink,
+  OrganizationSocialLink$inboundSchema,
+  OrganizationSocialLink$Outbound,
+  OrganizationSocialLink$outboundSchema,
+} from "./organizationsociallink.js";
 import {
   OrganizationSubscriptionSettings,
   OrganizationSubscriptionSettings$inboundSchema,
@@ -24,6 +36,22 @@ export type OrganizationCreate = {
   name: string;
   slug: string;
   avatarUrl?: string | null | undefined;
+  /**
+   * Public support email.
+   */
+  email?: string | null | undefined;
+  /**
+   * Official website of the organization.
+   */
+  website?: string | null | undefined;
+  /**
+   * Link to social profiles.
+   */
+  socials?: Array<OrganizationSocialLink> | null | undefined;
+  /**
+   * Additional, private, business details Polar needs about active organizations for compliance (KYC).
+   */
+  details?: OrganizationDetails | null | undefined;
   featureSettings?: OrganizationFeatureSettings | null | undefined;
   subscriptionSettings?: OrganizationSubscriptionSettings | null | undefined;
 };
@@ -37,6 +65,10 @@ export const OrganizationCreate$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.string(),
   avatar_url: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  website: z.nullable(z.string()).optional(),
+  socials: z.nullable(z.array(OrganizationSocialLink$inboundSchema)).optional(),
+  details: z.nullable(OrganizationDetails$inboundSchema).optional(),
   feature_settings: z.nullable(OrganizationFeatureSettings$inboundSchema)
     .optional(),
   subscription_settings: z.nullable(
@@ -55,6 +87,10 @@ export type OrganizationCreate$Outbound = {
   name: string;
   slug: string;
   avatar_url?: string | null | undefined;
+  email?: string | null | undefined;
+  website?: string | null | undefined;
+  socials?: Array<OrganizationSocialLink$Outbound> | null | undefined;
+  details?: OrganizationDetails$Outbound | null | undefined;
   feature_settings?: OrganizationFeatureSettings$Outbound | null | undefined;
   subscription_settings?:
     | OrganizationSubscriptionSettings$Outbound
@@ -71,6 +107,11 @@ export const OrganizationCreate$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.string(),
   avatarUrl: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  website: z.nullable(z.string()).optional(),
+  socials: z.nullable(z.array(OrganizationSocialLink$outboundSchema))
+    .optional(),
+  details: z.nullable(OrganizationDetails$outboundSchema).optional(),
   featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema)
     .optional(),
   subscriptionSettings: z.nullable(

package/src/models/components/organizationdetails.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const SwitchingFrom = {
+  Paddle: "paddle",
+  LemonSqueezy: "lemon_squeezy",
+  Gumroad: "gumroad",
+  Stripe: "stripe",
+  Other: "other",
+} as const;
+export type SwitchingFrom = ClosedEnum<typeof SwitchingFrom>;
+
+export type OrganizationDetails = {
+  /**
+   * Brief information about you and your business.
+   */
+  about: string;
+  /**
+   * Description of digital products being sold.
+   */
+  productDescription: string;
+  /**
+   * How the organization will integrate and use Polar.
+   */
+  intendedUse: string;
+  /**
+   * Main customer acquisition channels.
+   */
+  customerAcquisition: Array<string>;
+  /**
+   * Estimated revenue in the next 12 months
+   */
+  futureAnnualRevenue: number;
+  /**
+   * Switching from another platform?
+   */
+  switching?: boolean | undefined;
+  /**
+   * Which platform the organization is migrating from.
+   */
+  switchingFrom?: SwitchingFrom | null | undefined;
+  /**
+   * Revenue from last year if applicable.
+   */
+  previousAnnualRevenue?: number | undefined;
+};
+
+/** @internal */
+export const SwitchingFrom$inboundSchema: z.ZodNativeEnum<
+  typeof SwitchingFrom
+> = z.nativeEnum(SwitchingFrom);
+
+/** @internal */
+export const SwitchingFrom$outboundSchema: z.ZodNativeEnum<
+  typeof SwitchingFrom
+> = SwitchingFrom$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SwitchingFrom$ {
+  /** @deprecated use `SwitchingFrom$inboundSchema` instead. */
+  export const inboundSchema = SwitchingFrom$inboundSchema;
+  /** @deprecated use `SwitchingFrom$outboundSchema` instead. */
+  export const outboundSchema = SwitchingFrom$outboundSchema;
+}
+
+/** @internal */
+export const OrganizationDetails$inboundSchema: z.ZodType<
+  OrganizationDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  about: z.string(),
+  product_description: z.string(),
+  intended_use: z.string(),
+  customer_acquisition: z.array(z.string()),
+  future_annual_revenue: z.number().int(),
+  switching: z.boolean().default(true),
+  switching_from: z.nullable(SwitchingFrom$inboundSchema).optional(),
+  previous_annual_revenue: z.number().int().default(0),
+}).transform((v) => {
+  return remap$(v, {
+    "product_description": "productDescription",
+    "intended_use": "intendedUse",
+    "customer_acquisition": "customerAcquisition",
+    "future_annual_revenue": "futureAnnualRevenue",
+    "switching_from": "switchingFrom",
+    "previous_annual_revenue": "previousAnnualRevenue",
+  });
+});
+
+/** @internal */
+export type OrganizationDetails$Outbound = {
+  about: string;
+  product_description: string;
+  intended_use: string;
+  customer_acquisition: Array<string>;
+  future_annual_revenue: number;
+  switching: boolean;
+  switching_from?: string | null | undefined;
+  previous_annual_revenue: number;
+};
+
+/** @internal */
+export const OrganizationDetails$outboundSchema: z.ZodType<
+  OrganizationDetails$Outbound,
+  z.ZodTypeDef,
+  OrganizationDetails
+> = z.object({
+  about: z.string(),
+  productDescription: z.string(),
+  intendedUse: z.string(),
+  customerAcquisition: z.array(z.string()),
+  futureAnnualRevenue: z.number().int(),
+  switching: z.boolean().default(true),
+  switchingFrom: z.nullable(SwitchingFrom$outboundSchema).optional(),
+  previousAnnualRevenue: z.number().int().default(0),
+}).transform((v) => {
+  return remap$(v, {
+    productDescription: "product_description",
+    intendedUse: "intended_use",
+    customerAcquisition: "customer_acquisition",
+    futureAnnualRevenue: "future_annual_revenue",
+    switchingFrom: "switching_from",
+    previousAnnualRevenue: "previous_annual_revenue",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrganizationDetails$ {
+  /** @deprecated use `OrganizationDetails$inboundSchema` instead. */
+  export const inboundSchema = OrganizationDetails$inboundSchema;
+  /** @deprecated use `OrganizationDetails$outboundSchema` instead. */
+  export const outboundSchema = OrganizationDetails$outboundSchema;
+  /** @deprecated use `OrganizationDetails$Outbound` instead. */
+  export type Outbound = OrganizationDetails$Outbound;
+}
+
+export function organizationDetailsToJSON(
+  organizationDetails: OrganizationDetails,
+): string {
+  return JSON.stringify(
+    OrganizationDetails$outboundSchema.parse(organizationDetails),
+  );
+}
+
+export function organizationDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<OrganizationDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrganizationDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrganizationDetails' from JSON`,
+  );
+}

package/src/models/components/organizationsociallink.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  OrganizationSocialPlatforms,
+  OrganizationSocialPlatforms$inboundSchema,
+  OrganizationSocialPlatforms$outboundSchema,
+} from "./organizationsocialplatforms.js";
+
+export type OrganizationSocialLink = {
+  platform: OrganizationSocialPlatforms;
+  /**
+   * The URL to the organization profile
+   */
+  url: string;
+};
+
+/** @internal */
+export const OrganizationSocialLink$inboundSchema: z.ZodType<
+  OrganizationSocialLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  platform: OrganizationSocialPlatforms$inboundSchema,
+  url: z.string(),
+});
+
+/** @internal */
+export type OrganizationSocialLink$Outbound = {
+  platform: string;
+  url: string;
+};
+
+/** @internal */
+export const OrganizationSocialLink$outboundSchema: z.ZodType<
+  OrganizationSocialLink$Outbound,
+  z.ZodTypeDef,
+  OrganizationSocialLink
+> = z.object({
+  platform: OrganizationSocialPlatforms$outboundSchema,
+  url: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrganizationSocialLink$ {
+  /** @deprecated use `OrganizationSocialLink$inboundSchema` instead. */
+  export const inboundSchema = OrganizationSocialLink$inboundSchema;
+  /** @deprecated use `OrganizationSocialLink$outboundSchema` instead. */
+  export const outboundSchema = OrganizationSocialLink$outboundSchema;
+  /** @deprecated use `OrganizationSocialLink$Outbound` instead. */
+  export type Outbound = OrganizationSocialLink$Outbound;
+}
+
+export function organizationSocialLinkToJSON(
+  organizationSocialLink: OrganizationSocialLink,
+): string {
+  return JSON.stringify(
+    OrganizationSocialLink$outboundSchema.parse(organizationSocialLink),
+  );
+}
+
+export function organizationSocialLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<OrganizationSocialLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrganizationSocialLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrganizationSocialLink' from JSON`,
+  );
+}

package/src/models/components/organizationsocialplatforms.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const OrganizationSocialPlatforms = {
+  X: "x",
+  Github: "github",
+  Facebook: "facebook",
+  Instagram: "instagram",
+  Youtube: "youtube",
+  Tiktok: "tiktok",
+  Linkedin: "linkedin",
+  Other: "other",
+} as const;
+export type OrganizationSocialPlatforms = ClosedEnum<
+  typeof OrganizationSocialPlatforms
+>;
+
+/** @internal */
+export const OrganizationSocialPlatforms$inboundSchema: z.ZodNativeEnum<
+  typeof OrganizationSocialPlatforms
+> = z.nativeEnum(OrganizationSocialPlatforms);
+
+/** @internal */
+export const OrganizationSocialPlatforms$outboundSchema: z.ZodNativeEnum<
+  typeof OrganizationSocialPlatforms
+> = OrganizationSocialPlatforms$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrganizationSocialPlatforms$ {
+  /** @deprecated use `OrganizationSocialPlatforms$inboundSchema` instead. */
+  export const inboundSchema = OrganizationSocialPlatforms$inboundSchema;
+  /** @deprecated use `OrganizationSocialPlatforms$outboundSchema` instead. */
+  export const outboundSchema = OrganizationSocialPlatforms$outboundSchema;
+}