@polar-sh/sdk 0.20.0 → 0.20.2

package/src/models/components/customersubscription.ts

@@ -7,6 +7,11 @@ 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 {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
 import {
   CustomerSubscriptionProduct,
   CustomerSubscriptionProduct$inboundSchema,
@@ -50,13 +55,17 @@ export type CustomerSubscription = {
   currentPeriodStart: Date;
   currentPeriodEnd: Date | null;
   cancelAtPeriodEnd: boolean;
+  canceledAt: Date | null;
   startedAt: Date | null;
+  endsAt: Date | null;
   endedAt: Date | null;
   customerId: string;
   productId: string;
   priceId: string;
   discountId: string | null;
   checkoutId: string | null;
+  customerCancellationReason: CustomerCancellationReason | null;
+  customerCancellationComment: string | null;
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -87,9 +96,15 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
   cancel_at_period_end: z.boolean(),
+  canceled_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   started_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  ends_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   ended_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
@@ -98,6 +113,10 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
   price_id: z.string(),
   discount_id: z.nullable(z.string()),
   checkout_id: z.nullable(z.string()),
+  customer_cancellation_reason: z.nullable(
+    CustomerCancellationReason$inboundSchema,
+  ),
+  customer_cancellation_comment: z.nullable(z.string()),
   user_id: z.string(),
   product: CustomerSubscriptionProduct$inboundSchema,
   price: ProductPrice$inboundSchema,
@@ -109,13 +128,17 @@ export const CustomerSubscription$inboundSchema: z.ZodType<
     "current_period_start": "currentPeriodStart",
     "current_period_end": "currentPeriodEnd",
     "cancel_at_period_end": "cancelAtPeriodEnd",
+    "canceled_at": "canceledAt",
     "started_at": "startedAt",
+    "ends_at": "endsAt",
     "ended_at": "endedAt",
     "customer_id": "customerId",
     "product_id": "productId",
     "price_id": "priceId",
     "discount_id": "discountId",
     "checkout_id": "checkoutId",
+    "customer_cancellation_reason": "customerCancellationReason",
+    "customer_cancellation_comment": "customerCancellationComment",
     "user_id": "userId",
   });
 });
@@ -132,13 +155,17 @@ export type CustomerSubscription$Outbound = {
   current_period_start: string;
   current_period_end: string | null;
   cancel_at_period_end: boolean;
+  canceled_at: string | null;
   started_at: string | null;
+  ends_at: string | null;
   ended_at: string | null;
   customer_id: string;
   product_id: string;
   price_id: string;
   discount_id: string | null;
   checkout_id: string | null;
+  customer_cancellation_reason: string | null;
+  customer_cancellation_comment: string | null;
   user_id: string;
   product: CustomerSubscriptionProduct$Outbound;
   price: ProductPrice$Outbound;
@@ -160,13 +187,19 @@ export const CustomerSubscription$outboundSchema: z.ZodType<
   currentPeriodStart: z.date().transform(v => v.toISOString()),
   currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())),
   cancelAtPeriodEnd: z.boolean(),
+  canceledAt: z.nullable(z.date().transform(v => v.toISOString())),
   startedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  endsAt: z.nullable(z.date().transform(v => v.toISOString())),
   endedAt: z.nullable(z.date().transform(v => v.toISOString())),
   customerId: z.string(),
   productId: z.string(),
   priceId: z.string(),
   discountId: z.nullable(z.string()),
   checkoutId: z.nullable(z.string()),
+  customerCancellationReason: z.nullable(
+    CustomerCancellationReason$outboundSchema,
+  ),
+  customerCancellationComment: z.nullable(z.string()),
   userId: z.string(),
   product: CustomerSubscriptionProduct$outboundSchema,
   price: ProductPrice$outboundSchema,
@@ -178,13 +211,17 @@ export const CustomerSubscription$outboundSchema: z.ZodType<
     currentPeriodStart: "current_period_start",
     currentPeriodEnd: "current_period_end",
     cancelAtPeriodEnd: "cancel_at_period_end",
+    canceledAt: "canceled_at",
     startedAt: "started_at",
+    endsAt: "ends_at",
     endedAt: "ended_at",
     customerId: "customer_id",
     productId: "product_id",
     priceId: "price_id",
     discountId: "discount_id",
     checkoutId: "checkout_id",
+    customerCancellationReason: "customer_cancellation_reason",
+    customerCancellationComment: "customer_cancellation_comment",
     userId: "user_id",
   });
 });

package/src/models/components/customersubscriptioncancel.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
+
+export type CustomerSubscriptionCancel = {
+  /**
+   * Cancel an active subscription once the current period ends.
+   *
+   * @remarks
+   *
+   * Or uncancel a subscription currently set to be revoked at period end.
+   */
+  cancelAtPeriodEnd?: boolean | null | undefined;
+  /**
+   * Customers reason for cancellation.
+   *
+   * @remarks
+   *
+   * * `too_expensive`: Too expensive for the customer.
+   * * `missing_features`: Customer is missing certain features.
+   * * `switched_service`: Customer switched to another service.
+   * * `unused`: Customer is not using it enough.
+   * * `customer_service`: Customer is not satisfied with the customer service.
+   * * `low_quality`: Customer is unhappy with the quality.
+   * * `too_complex`: Customer considers the service too complicated.
+   * * `other`: Other reason(s).
+   */
+  cancellationReason?: CustomerCancellationReason | null | undefined;
+  /**
+   * Customer feedback and why they decided to cancel.
+   */
+  cancellationComment?: string | null | undefined;
+};
+
+/** @internal */
+export const CustomerSubscriptionCancel$inboundSchema: z.ZodType<
+  CustomerSubscriptionCancel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cancel_at_period_end: z.nullable(z.boolean()).optional(),
+  cancellation_reason: z.nullable(CustomerCancellationReason$inboundSchema)
+    .optional(),
+  cancellation_comment: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "cancel_at_period_end": "cancelAtPeriodEnd",
+    "cancellation_reason": "cancellationReason",
+    "cancellation_comment": "cancellationComment",
+  });
+});
+
+/** @internal */
+export type CustomerSubscriptionCancel$Outbound = {
+  cancel_at_period_end?: boolean | null | undefined;
+  cancellation_reason?: string | null | undefined;
+  cancellation_comment?: string | null | undefined;
+};
+
+/** @internal */
+export const CustomerSubscriptionCancel$outboundSchema: z.ZodType<
+  CustomerSubscriptionCancel$Outbound,
+  z.ZodTypeDef,
+  CustomerSubscriptionCancel
+> = z.object({
+  cancelAtPeriodEnd: z.nullable(z.boolean()).optional(),
+  cancellationReason: z.nullable(CustomerCancellationReason$outboundSchema)
+    .optional(),
+  cancellationComment: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    cancelAtPeriodEnd: "cancel_at_period_end",
+    cancellationReason: "cancellation_reason",
+    cancellationComment: "cancellation_comment",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerSubscriptionCancel$ {
+  /** @deprecated use `CustomerSubscriptionCancel$inboundSchema` instead. */
+  export const inboundSchema = CustomerSubscriptionCancel$inboundSchema;
+  /** @deprecated use `CustomerSubscriptionCancel$outboundSchema` instead. */
+  export const outboundSchema = CustomerSubscriptionCancel$outboundSchema;
+  /** @deprecated use `CustomerSubscriptionCancel$Outbound` instead. */
+  export type Outbound = CustomerSubscriptionCancel$Outbound;
+}
+
+export function customerSubscriptionCancelToJSON(
+  customerSubscriptionCancel: CustomerSubscriptionCancel,
+): string {
+  return JSON.stringify(
+    CustomerSubscriptionCancel$outboundSchema.parse(customerSubscriptionCancel),
+  );
+}
+
+export function customerSubscriptionCancelFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerSubscriptionCancel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerSubscriptionCancel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerSubscriptionCancel' from JSON`,
+  );
+}

package/src/models/components/customersubscriptionupdate.ts

@@ -3,45 +3,50 @@
  */
 
 import * as z from "zod";
-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 {
+  CustomerSubscriptionCancel,
+  CustomerSubscriptionCancel$inboundSchema,
+  CustomerSubscriptionCancel$Outbound,
+  CustomerSubscriptionCancel$outboundSchema,
+} from "./customersubscriptioncancel.js";
+import {
+  CustomerSubscriptionUpdatePrice,
+  CustomerSubscriptionUpdatePrice$inboundSchema,
+  CustomerSubscriptionUpdatePrice$Outbound,
+  CustomerSubscriptionUpdatePrice$outboundSchema,
+} from "./customersubscriptionupdateprice.js";
 
-export type CustomerSubscriptionUpdate = {
-  productPriceId: string;
-};
+export type CustomerSubscriptionUpdate =
+  | CustomerSubscriptionUpdatePrice
+  | CustomerSubscriptionCancel;
 
 /** @internal */
 export const CustomerSubscriptionUpdate$inboundSchema: z.ZodType<
   CustomerSubscriptionUpdate,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  product_price_id: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "product_price_id": "productPriceId",
-  });
-});
+> = z.union([
+  CustomerSubscriptionUpdatePrice$inboundSchema,
+  CustomerSubscriptionCancel$inboundSchema,
+]);
 
 /** @internal */
-export type CustomerSubscriptionUpdate$Outbound = {
-  product_price_id: string;
-};
+export type CustomerSubscriptionUpdate$Outbound =
+  | CustomerSubscriptionUpdatePrice$Outbound
+  | CustomerSubscriptionCancel$Outbound;
 
 /** @internal */
 export const CustomerSubscriptionUpdate$outboundSchema: z.ZodType<
   CustomerSubscriptionUpdate$Outbound,
   z.ZodTypeDef,
   CustomerSubscriptionUpdate
-> = z.object({
-  productPriceId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    productPriceId: "product_price_id",
-  });
-});
+> = z.union([
+  CustomerSubscriptionUpdatePrice$outboundSchema,
+  CustomerSubscriptionCancel$outboundSchema,
+]);
 
 /**
  * @internal

package/src/models/components/customersubscriptionupdateprice.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CustomerSubscriptionUpdatePrice = {
+  /**
+   * Update subscription to another price.
+   */
+  productPriceId: string;
+};
+
+/** @internal */
+export const CustomerSubscriptionUpdatePrice$inboundSchema: z.ZodType<
+  CustomerSubscriptionUpdatePrice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  product_price_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "product_price_id": "productPriceId",
+  });
+});
+
+/** @internal */
+export type CustomerSubscriptionUpdatePrice$Outbound = {
+  product_price_id: string;
+};
+
+/** @internal */
+export const CustomerSubscriptionUpdatePrice$outboundSchema: z.ZodType<
+  CustomerSubscriptionUpdatePrice$Outbound,
+  z.ZodTypeDef,
+  CustomerSubscriptionUpdatePrice
+> = z.object({
+  productPriceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    productPriceId: "product_price_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerSubscriptionUpdatePrice$ {
+  /** @deprecated use `CustomerSubscriptionUpdatePrice$inboundSchema` instead. */
+  export const inboundSchema = CustomerSubscriptionUpdatePrice$inboundSchema;
+  /** @deprecated use `CustomerSubscriptionUpdatePrice$outboundSchema` instead. */
+  export const outboundSchema = CustomerSubscriptionUpdatePrice$outboundSchema;
+  /** @deprecated use `CustomerSubscriptionUpdatePrice$Outbound` instead. */
+  export type Outbound = CustomerSubscriptionUpdatePrice$Outbound;
+}
+
+export function customerSubscriptionUpdatePriceToJSON(
+  customerSubscriptionUpdatePrice: CustomerSubscriptionUpdatePrice,
+): string {
+  return JSON.stringify(
+    CustomerSubscriptionUpdatePrice$outboundSchema.parse(
+      customerSubscriptionUpdatePrice,
+    ),
+  );
+}
+
+export function customerSubscriptionUpdatePriceFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerSubscriptionUpdatePrice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerSubscriptionUpdatePrice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerSubscriptionUpdatePrice' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -112,6 +112,7 @@ export * from "./customerbenefitgrantlicensekeys.js";
 export * from "./customerbenefitgrantlicensekeysupdate.js";
 export * from "./customerbenefitgrantsortproperty.js";
 export * from "./customerbenefitgrantupdate.js";
+export * from "./customercancellationreason.js";
 export * from "./customercreate.js";
 export * from "./customerorder.js";
 export * from "./customerorderinvoice.js";
@@ -124,9 +125,11 @@ export * from "./customersession.js";
 export * from "./customersessioncreate.js";
 export * from "./customersortproperty.js";
 export * from "./customersubscription.js";
+export * from "./customersubscriptioncancel.js";
 export * from "./customersubscriptionproduct.js";
 export * from "./customersubscriptionsortproperty.js";
 export * from "./customersubscriptionupdate.js";
+export * from "./customersubscriptionupdateprice.js";
 export * from "./customerupdate.js";
 export * from "./customfield.js";
 export * from "./customfieldcheckbox.js";
@@ -300,10 +303,13 @@ export * from "./scope.js";
 export * from "./security.js";
 export * from "./state.js";
 export * from "./subscription.js";
+export * from "./subscriptioncancel.js";
 export * from "./subscriptioncustomer.js";
 export * from "./subscriptionrecurringinterval.js";
 export * from "./subscriptionsortproperty.js";
 export * from "./subscriptionstatus.js";
+export * from "./subscriptionupdate.js";
+export * from "./subscriptionupdateprice.js";
 export * from "./subscriptionuser.js";
 export * from "./subtype.js";
 export * from "./taxidformat.js";
@@ -329,4 +335,5 @@ export * from "./webhooksubscriptionactivepayload.js";
 export * from "./webhooksubscriptioncanceledpayload.js";
 export * from "./webhooksubscriptioncreatedpayload.js";
 export * from "./webhooksubscriptionrevokedpayload.js";
+export * from "./webhooksubscriptionuncanceledpayload.js";
 export * from "./webhooksubscriptionupdatedpayload.js";

package/src/models/components/ordersubscription.ts

@@ -7,6 +7,11 @@ 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 {
+  CustomerCancellationReason,
+  CustomerCancellationReason$inboundSchema,
+  CustomerCancellationReason$outboundSchema,
+} from "./customercancellationreason.js";
 import {
   SubscriptionRecurringInterval,
   SubscriptionRecurringInterval$inboundSchema,
@@ -41,13 +46,17 @@ export type OrderSubscription = {
   currentPeriodStart: Date;
   currentPeriodEnd: Date | null;
   cancelAtPeriodEnd: boolean;
+  canceledAt: Date | null;
   startedAt: Date | null;
+  endsAt: Date | null;
   endedAt: Date | null;
   customerId: string;
   productId: string;
   priceId: string;
   discountId: string | null;
   checkoutId: string | null;
+  customerCancellationReason: CustomerCancellationReason | null;
+  customerCancellationComment: string | null;
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -125,9 +134,15 @@ export const OrderSubscription$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
   cancel_at_period_end: z.boolean(),
+  canceled_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   started_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  ends_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   ended_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
@@ -136,6 +151,10 @@ export const OrderSubscription$inboundSchema: z.ZodType<
   price_id: z.string(),
   discount_id: z.nullable(z.string()),
   checkout_id: z.nullable(z.string()),
+  customer_cancellation_reason: z.nullable(
+    CustomerCancellationReason$inboundSchema,
+  ),
+  customer_cancellation_comment: z.nullable(z.string()),
   user_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -145,13 +164,17 @@ export const OrderSubscription$inboundSchema: z.ZodType<
     "current_period_start": "currentPeriodStart",
     "current_period_end": "currentPeriodEnd",
     "cancel_at_period_end": "cancelAtPeriodEnd",
+    "canceled_at": "canceledAt",
     "started_at": "startedAt",
+    "ends_at": "endsAt",
     "ended_at": "endedAt",
     "customer_id": "customerId",
     "product_id": "productId",
     "price_id": "priceId",
     "discount_id": "discountId",
     "checkout_id": "checkoutId",
+    "customer_cancellation_reason": "customerCancellationReason",
+    "customer_cancellation_comment": "customerCancellationComment",
     "user_id": "userId",
   });
 });
@@ -169,13 +192,17 @@ export type OrderSubscription$Outbound = {
   current_period_start: string;
   current_period_end: string | null;
   cancel_at_period_end: boolean;
+  canceled_at: string | null;
   started_at: string | null;
+  ends_at: string | null;
   ended_at: string | null;
   customer_id: string;
   product_id: string;
   price_id: string;
   discount_id: string | null;
   checkout_id: string | null;
+  customer_cancellation_reason: string | null;
+  customer_cancellation_comment: string | null;
   user_id: string;
 };
 
@@ -196,13 +223,19 @@ export const OrderSubscription$outboundSchema: z.ZodType<
   currentPeriodStart: z.date().transform(v => v.toISOString()),
   currentPeriodEnd: z.nullable(z.date().transform(v => v.toISOString())),
   cancelAtPeriodEnd: z.boolean(),
+  canceledAt: z.nullable(z.date().transform(v => v.toISOString())),
   startedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  endsAt: z.nullable(z.date().transform(v => v.toISOString())),
   endedAt: z.nullable(z.date().transform(v => v.toISOString())),
   customerId: z.string(),
   productId: z.string(),
   priceId: z.string(),
   discountId: z.nullable(z.string()),
   checkoutId: z.nullable(z.string()),
+  customerCancellationReason: z.nullable(
+    CustomerCancellationReason$outboundSchema,
+  ),
+  customerCancellationComment: z.nullable(z.string()),
   userId: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -212,13 +245,17 @@ export const OrderSubscription$outboundSchema: z.ZodType<
     currentPeriodStart: "current_period_start",
     currentPeriodEnd: "current_period_end",
     cancelAtPeriodEnd: "cancel_at_period_end",
+    canceledAt: "canceled_at",
     startedAt: "started_at",
+    endsAt: "ends_at",
     endedAt: "ended_at",
     customerId: "customer_id",
     productId: "product_id",
     priceId: "price_id",
     discountId: "discount_id",
     checkoutId: "checkout_id",
+    customerCancellationReason: "customer_cancellation_reason",
+    customerCancellationComment: "customer_cancellation_comment",
     userId: "user_id",
   });
 });