@polar-sh/sdk 0.40.2 → 0.41.0

package/src/models/components/orderpaidevent.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  OrderPaidMetadata,
+  OrderPaidMetadata$inboundSchema,
+  OrderPaidMetadata$Outbound,
+  OrderPaidMetadata$outboundSchema,
+} from "./orderpaidmetadata.js";
+
+/**
+ * An event created by Polar when an order is paid.
+ */
+export type OrderPaidEvent = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp: Date;
+  /**
+   * The ID of the organization owning the event.
+   */
+  organizationId: string;
+  /**
+   * ID of the customer in your Polar organization associated with the event.
+   */
+  customerId: string | null;
+  /**
+   * The customer associated with the event.
+   */
+  customer: Customer | null;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
+  /**
+   * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
+   */
+  source: "system";
+  /**
+   * The name of the event.
+   */
+  name: "order.paid";
+  metadata: OrderPaidMetadata;
+};
+
+/** @internal */
+export const OrderPaidEvent$inboundSchema: z.ZodType<
+  OrderPaidEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  organization_id: z.string(),
+  customer_id: z.nullable(z.string()),
+  customer: z.nullable(Customer$inboundSchema),
+  external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
+  source: z.literal("system"),
+  name: z.literal("order.paid"),
+  metadata: OrderPaidMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
+  });
+});
+
+/** @internal */
+export type OrderPaidEvent$Outbound = {
+  id: string;
+  timestamp: string;
+  organization_id: string;
+  customer_id: string | null;
+  customer: Customer$Outbound | null;
+  external_customer_id: string | null;
+  child_count: number;
+  source: "system";
+  name: "order.paid";
+  metadata: OrderPaidMetadata$Outbound;
+};
+
+/** @internal */
+export const OrderPaidEvent$outboundSchema: z.ZodType<
+  OrderPaidEvent$Outbound,
+  z.ZodTypeDef,
+  OrderPaidEvent
+> = z.object({
+  id: z.string(),
+  timestamp: z.date().transform(v => v.toISOString()),
+  organizationId: z.string(),
+  customerId: z.nullable(z.string()),
+  customer: z.nullable(Customer$outboundSchema),
+  externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
+  source: z.literal("system"),
+  name: z.literal("order.paid"),
+  metadata: OrderPaidMetadata$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    customerId: "customer_id",
+    externalCustomerId: "external_customer_id",
+    childCount: "child_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderPaidEvent$ {
+  /** @deprecated use `OrderPaidEvent$inboundSchema` instead. */
+  export const inboundSchema = OrderPaidEvent$inboundSchema;
+  /** @deprecated use `OrderPaidEvent$outboundSchema` instead. */
+  export const outboundSchema = OrderPaidEvent$outboundSchema;
+  /** @deprecated use `OrderPaidEvent$Outbound` instead. */
+  export type Outbound = OrderPaidEvent$Outbound;
+}
+
+export function orderPaidEventToJSON(orderPaidEvent: OrderPaidEvent): string {
+  return JSON.stringify(OrderPaidEvent$outboundSchema.parse(orderPaidEvent));
+}
+
+export function orderPaidEventFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderPaidEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderPaidEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderPaidEvent' from JSON`,
+  );
+}

package/src/models/components/orderpaidmetadata.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export type OrderPaidMetadata = {
+  orderId: string;
+  amount: number;
+  currency: string;
+  backfilled?: boolean | undefined;
+};
+
+/** @internal */
+export const OrderPaidMetadata$inboundSchema: z.ZodType<
+  OrderPaidMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  order_id: z.string(),
+  amount: z.number().int(),
+  currency: z.string(),
+  backfilled: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "order_id": "orderId",
+  });
+});
+
+/** @internal */
+export type OrderPaidMetadata$Outbound = {
+  order_id: string;
+  amount: number;
+  currency: string;
+  backfilled?: boolean | undefined;
+};
+
+/** @internal */
+export const OrderPaidMetadata$outboundSchema: z.ZodType<
+  OrderPaidMetadata$Outbound,
+  z.ZodTypeDef,
+  OrderPaidMetadata
+> = z.object({
+  orderId: z.string(),
+  amount: z.number().int(),
+  currency: z.string(),
+  backfilled: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    orderId: "order_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderPaidMetadata$ {
+  /** @deprecated use `OrderPaidMetadata$inboundSchema` instead. */
+  export const inboundSchema = OrderPaidMetadata$inboundSchema;
+  /** @deprecated use `OrderPaidMetadata$outboundSchema` instead. */
+  export const outboundSchema = OrderPaidMetadata$outboundSchema;
+  /** @deprecated use `OrderPaidMetadata$Outbound` instead. */
+  export type Outbound = OrderPaidMetadata$Outbound;
+}
+
+export function orderPaidMetadataToJSON(
+  orderPaidMetadata: OrderPaidMetadata,
+): string {
+  return JSON.stringify(
+    OrderPaidMetadata$outboundSchema.parse(orderPaidMetadata),
+  );
+}
+
+export function orderPaidMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderPaidMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderPaidMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderPaidMetadata' from JSON`,
+  );
+}

package/src/models/components/orderrefundedevent.ts

@@ -0,0 +1,159 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+import {
+  OrderRefundedMetadata,
+  OrderRefundedMetadata$inboundSchema,
+  OrderRefundedMetadata$Outbound,
+  OrderRefundedMetadata$outboundSchema,
+} from "./orderrefundedmetadata.js";
+
+/**
+ * An event created by Polar when an order is refunded.
+ */
+export type OrderRefundedEvent = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * The timestamp of the event.
+   */
+  timestamp: Date;
+  /**
+   * The ID of the organization owning the event.
+   */
+  organizationId: string;
+  /**
+   * ID of the customer in your Polar organization associated with the event.
+   */
+  customerId: string | null;
+  /**
+   * The customer associated with the event.
+   */
+  customer: Customer | null;
+  /**
+   * ID of the customer in your system associated with the event.
+   */
+  externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
+  /**
+   * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
+   */
+  source: "system";
+  /**
+   * The name of the event.
+   */
+  name: "order.refunded";
+  metadata: OrderRefundedMetadata;
+};
+
+/** @internal */
+export const OrderRefundedEvent$inboundSchema: z.ZodType<
+  OrderRefundedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  organization_id: z.string(),
+  customer_id: z.nullable(z.string()),
+  customer: z.nullable(Customer$inboundSchema),
+  external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
+  source: z.literal("system"),
+  name: z.literal("order.refunded"),
+  metadata: OrderRefundedMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "customer_id": "customerId",
+    "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
+  });
+});
+
+/** @internal */
+export type OrderRefundedEvent$Outbound = {
+  id: string;
+  timestamp: string;
+  organization_id: string;
+  customer_id: string | null;
+  customer: Customer$Outbound | null;
+  external_customer_id: string | null;
+  child_count: number;
+  source: "system";
+  name: "order.refunded";
+  metadata: OrderRefundedMetadata$Outbound;
+};
+
+/** @internal */
+export const OrderRefundedEvent$outboundSchema: z.ZodType<
+  OrderRefundedEvent$Outbound,
+  z.ZodTypeDef,
+  OrderRefundedEvent
+> = z.object({
+  id: z.string(),
+  timestamp: z.date().transform(v => v.toISOString()),
+  organizationId: z.string(),
+  customerId: z.nullable(z.string()),
+  customer: z.nullable(Customer$outboundSchema),
+  externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
+  source: z.literal("system"),
+  name: z.literal("order.refunded"),
+  metadata: OrderRefundedMetadata$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    customerId: "customer_id",
+    externalCustomerId: "external_customer_id",
+    childCount: "child_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderRefundedEvent$ {
+  /** @deprecated use `OrderRefundedEvent$inboundSchema` instead. */
+  export const inboundSchema = OrderRefundedEvent$inboundSchema;
+  /** @deprecated use `OrderRefundedEvent$outboundSchema` instead. */
+  export const outboundSchema = OrderRefundedEvent$outboundSchema;
+  /** @deprecated use `OrderRefundedEvent$Outbound` instead. */
+  export type Outbound = OrderRefundedEvent$Outbound;
+}
+
+export function orderRefundedEventToJSON(
+  orderRefundedEvent: OrderRefundedEvent,
+): string {
+  return JSON.stringify(
+    OrderRefundedEvent$outboundSchema.parse(orderRefundedEvent),
+  );
+}
+
+export function orderRefundedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderRefundedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderRefundedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderRefundedEvent' from JSON`,
+  );
+}

package/src/models/components/orderrefundedmetadata.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export type OrderRefundedMetadata = {
+  orderId: string;
+  refundedAmount: number;
+  currency: string;
+  backfilled?: boolean | undefined;
+};
+
+/** @internal */
+export const OrderRefundedMetadata$inboundSchema: z.ZodType<
+  OrderRefundedMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  order_id: z.string(),
+  refunded_amount: z.number().int(),
+  currency: z.string(),
+  backfilled: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "order_id": "orderId",
+    "refunded_amount": "refundedAmount",
+  });
+});
+
+/** @internal */
+export type OrderRefundedMetadata$Outbound = {
+  order_id: string;
+  refunded_amount: number;
+  currency: string;
+  backfilled?: boolean | undefined;
+};
+
+/** @internal */
+export const OrderRefundedMetadata$outboundSchema: z.ZodType<
+  OrderRefundedMetadata$Outbound,
+  z.ZodTypeDef,
+  OrderRefundedMetadata
+> = z.object({
+  orderId: z.string(),
+  refundedAmount: z.number().int(),
+  currency: z.string(),
+  backfilled: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    orderId: "order_id",
+    refundedAmount: "refunded_amount",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrderRefundedMetadata$ {
+  /** @deprecated use `OrderRefundedMetadata$inboundSchema` instead. */
+  export const inboundSchema = OrderRefundedMetadata$inboundSchema;
+  /** @deprecated use `OrderRefundedMetadata$outboundSchema` instead. */
+  export const outboundSchema = OrderRefundedMetadata$outboundSchema;
+  /** @deprecated use `OrderRefundedMetadata$Outbound` instead. */
+  export type Outbound = OrderRefundedMetadata$Outbound;
+}
+
+export function orderRefundedMetadataToJSON(
+  orderRefundedMetadata: OrderRefundedMetadata,
+): string {
+  return JSON.stringify(
+    OrderRefundedMetadata$outboundSchema.parse(orderRefundedMetadata),
+  );
+}
+
+export function orderRefundedMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<OrderRefundedMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OrderRefundedMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OrderRefundedMetadata' from JSON`,
+  );
+}

package/src/models/components/organization.ts

@@ -31,17 +31,17 @@ import {
   OrganizationSocialLink$Outbound,
   OrganizationSocialLink$outboundSchema,
 } from "./organizationsociallink.js";
+import {
+  OrganizationStatus,
+  OrganizationStatus$inboundSchema,
+  OrganizationStatus$outboundSchema,
+} from "./organizationstatus.js";
 import {
   OrganizationSubscriptionSettings,
   OrganizationSubscriptionSettings$inboundSchema,
   OrganizationSubscriptionSettings$Outbound,
   OrganizationSubscriptionSettings$outboundSchema,
 } from "./organizationsubscriptionsettings.js";
-import {
-  Status,
-  Status$inboundSchema,
-  Status$outboundSchema,
-} from "./status.js";
 
 export type Organization = {
   /**
@@ -80,7 +80,7 @@ export type Organization = {
    * Links to social profiles.
    */
   socials: Array<OrganizationSocialLink>;
-  status: Status;
+  status: OrganizationStatus;
   /**
    * When the business details were submitted.
    */
@@ -111,7 +111,7 @@ export const Organization$inboundSchema: z.ZodType<
   email: z.nullable(z.string()),
   website: z.nullable(z.string()),
   socials: z.array(OrganizationSocialLink$inboundSchema),
-  status: Status$inboundSchema,
+  status: OrganizationStatus$inboundSchema,
   details_submitted_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
@@ -166,7 +166,7 @@ export const Organization$outboundSchema: z.ZodType<
   email: z.nullable(z.string()),
   website: z.nullable(z.string()),
   socials: z.array(OrganizationSocialLink$outboundSchema),
-  status: Status$outboundSchema,
+  status: OrganizationStatus$outboundSchema,
   detailsSubmittedAt: z.nullable(z.date().transform(v => v.toISOString())),
   featureSettings: z.nullable(OrganizationFeatureSettings$outboundSchema),
   subscriptionSettings: OrganizationSubscriptionSettings$outboundSchema,

package/src/models/components/organizationfeaturesettings.ts

@@ -21,6 +21,10 @@ export type OrganizationFeatureSettings = {
    * If this organization has RevOps enabled
    */
   revopsEnabled?: boolean | undefined;
+  /**
+   * If this organization has Wallets enabled
+   */
+  walletsEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -32,11 +36,13 @@ export const OrganizationFeatureSettings$inboundSchema: z.ZodType<
   issue_funding_enabled: z.boolean().default(false),
   seat_based_pricing_enabled: z.boolean().default(false),
   revops_enabled: z.boolean().default(false),
+  wallets_enabled: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     "issue_funding_enabled": "issueFundingEnabled",
     "seat_based_pricing_enabled": "seatBasedPricingEnabled",
     "revops_enabled": "revopsEnabled",
+    "wallets_enabled": "walletsEnabled",
   });
 });
 
@@ -45,6 +51,7 @@ export type OrganizationFeatureSettings$Outbound = {
   issue_funding_enabled: boolean;
   seat_based_pricing_enabled: boolean;
   revops_enabled: boolean;
+  wallets_enabled: boolean;
 };
 
 /** @internal */
@@ -56,11 +63,13 @@ export const OrganizationFeatureSettings$outboundSchema: z.ZodType<
   issueFundingEnabled: z.boolean().default(false),
   seatBasedPricingEnabled: z.boolean().default(false),
   revopsEnabled: z.boolean().default(false),
+  walletsEnabled: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     issueFundingEnabled: "issue_funding_enabled",
     seatBasedPricingEnabled: "seat_based_pricing_enabled",
     revopsEnabled: "revops_enabled",
+    walletsEnabled: "wallets_enabled",
   });
 });
 

package/src/models/components/organizationstatus.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const OrganizationStatus = {
+  Created: "created",
+  OnboardingStarted: "onboarding_started",
+  UnderReview: "under_review",
+  Denied: "denied",
+  Active: "active",
+} as const;
+export type OrganizationStatus = ClosedEnum<typeof OrganizationStatus>;
+
+/** @internal */
+export const OrganizationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OrganizationStatus
+> = z.nativeEnum(OrganizationStatus);
+
+/** @internal */
+export const OrganizationStatus$outboundSchema: z.ZodNativeEnum<
+  typeof OrganizationStatus
+> = OrganizationStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OrganizationStatus$ {
+  /** @deprecated use `OrganizationStatus$inboundSchema` instead. */
+  export const inboundSchema = OrganizationStatus$inboundSchema;
+  /** @deprecated use `OrganizationStatus$outboundSchema` instead. */
+  export const outboundSchema = OrganizationStatus$outboundSchema;
+}

package/src/models/components/organizationsubscriptionsettings.ts

@@ -17,6 +17,7 @@ export type OrganizationSubscriptionSettings = {
   allowMultipleSubscriptions: boolean;
   allowCustomerUpdates: boolean;
   prorationBehavior: SubscriptionProrationBehavior;
+  benefitRevocationGracePeriod: number;
 };
 
 /** @internal */
@@ -28,11 +29,13 @@ export const OrganizationSubscriptionSettings$inboundSchema: z.ZodType<
   allow_multiple_subscriptions: z.boolean(),
   allow_customer_updates: z.boolean(),
   proration_behavior: SubscriptionProrationBehavior$inboundSchema,
+  benefit_revocation_grace_period: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
     "allow_multiple_subscriptions": "allowMultipleSubscriptions",
     "allow_customer_updates": "allowCustomerUpdates",
     "proration_behavior": "prorationBehavior",
+    "benefit_revocation_grace_period": "benefitRevocationGracePeriod",
   });
 });
 
@@ -41,6 +44,7 @@ export type OrganizationSubscriptionSettings$Outbound = {
   allow_multiple_subscriptions: boolean;
   allow_customer_updates: boolean;
   proration_behavior: string;
+  benefit_revocation_grace_period: number;
 };
 
 /** @internal */
@@ -52,11 +56,13 @@ export const OrganizationSubscriptionSettings$outboundSchema: z.ZodType<
   allowMultipleSubscriptions: z.boolean(),
   allowCustomerUpdates: z.boolean(),
   prorationBehavior: SubscriptionProrationBehavior$outboundSchema,
+  benefitRevocationGracePeriod: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
     allowMultipleSubscriptions: "allow_multiple_subscriptions",
     allowCustomerUpdates: "allow_customer_updates",
     prorationBehavior: "proration_behavior",
+    benefitRevocationGracePeriod: "benefit_revocation_grace_period",
   });
 });
 

package/src/models/components/scope.ts

@@ -40,6 +40,8 @@ export const Scope = {
   SubscriptionsWrite: "subscriptions:write",
   CustomersRead: "customers:read",
   CustomersWrite: "customers:write",
+  WalletsRead: "wallets:read",
+  WalletsWrite: "wallets:write",
   CustomerMetersRead: "customer_meters:read",
   CustomerSessionsWrite: "customer_sessions:write",
   CustomerSeatsRead: "customer_seats:read",