@polar-sh/sdk 0.30.0 → 0.32.0

package/src/models/components/webhookordercreatedpayload.ts

@@ -23,7 +23,9 @@ import {
  * * A customer purchases a one-time product. In this case, `billing_reason` is set to `purchase`.
  * * A customer starts a subscription. In this case, `billing_reason` is set to `subscription_create`.
  * * A subscription is renewed. In this case, `billing_reason` is set to `subscription_cycle`.
- * * A subscription is upgraded, downgraded or revoked with an immediate proration invoice. In this case, `billing_reason` is set to `subscription_update`.
+ * * A subscription is upgraded or downgraded with an immediate proration invoice. In this case, `billing_reason` is set to `subscription_update`.
+ *
+ * <Warning>The order might not be paid yet, so the `status` field might be `pending`.</Warning>
  *
  * **Discord & Slack support:** Full
  */

package/src/models/components/webhookorderpaidpayload.ts

@@ -0,0 +1,85 @@
+/*
+ * 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 {
+  Order,
+  Order$inboundSchema,
+  Order$Outbound,
+  Order$outboundSchema,
+} from "./order.js";
+
+/**
+ * Sent when an order is paid.
+ *
+ * @remarks
+ *
+ * When you receive this event, the order is fully processed and payment has been received.
+ *
+ * **Discord & Slack support:** Full
+ */
+export type WebhookOrderPaidPayload = {
+  type?: "order.paid" | undefined;
+  data: Order;
+};
+
+/** @internal */
+export const WebhookOrderPaidPayload$inboundSchema: z.ZodType<
+  WebhookOrderPaidPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("order.paid").optional(),
+  data: Order$inboundSchema,
+});
+
+/** @internal */
+export type WebhookOrderPaidPayload$Outbound = {
+  type: "order.paid";
+  data: Order$Outbound;
+};
+
+/** @internal */
+export const WebhookOrderPaidPayload$outboundSchema: z.ZodType<
+  WebhookOrderPaidPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookOrderPaidPayload
+> = z.object({
+  type: z.literal("order.paid").default("order.paid" as const),
+  data: Order$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookOrderPaidPayload$ {
+  /** @deprecated use `WebhookOrderPaidPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookOrderPaidPayload$inboundSchema;
+  /** @deprecated use `WebhookOrderPaidPayload$outboundSchema` instead. */
+  export const outboundSchema = WebhookOrderPaidPayload$outboundSchema;
+  /** @deprecated use `WebhookOrderPaidPayload$Outbound` instead. */
+  export type Outbound = WebhookOrderPaidPayload$Outbound;
+}
+
+export function webhookOrderPaidPayloadToJSON(
+  webhookOrderPaidPayload: WebhookOrderPaidPayload,
+): string {
+  return JSON.stringify(
+    WebhookOrderPaidPayload$outboundSchema.parse(webhookOrderPaidPayload),
+  );
+}
+
+export function webhookOrderPaidPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookOrderPaidPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookOrderPaidPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookOrderPaidPayload' from JSON`,
+  );
+}

package/src/models/components/webhookorderupdatedpayload.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  Order,
+  Order$inboundSchema,
+  Order$Outbound,
+  Order$outboundSchema,
+} from "./order.js";
+
+/**
+ * Sent when an order is updated.
+ *
+ * @remarks
+ *
+ * An order is updated when:
+ *
+ * * Its status changes, e.g. from `pending` to `paid`.
+ * * It's refunded, partially or fully.
+ *
+ * **Discord & Slack support:** Full
+ */
+export type WebhookOrderUpdatedPayload = {
+  type?: "order.updated" | undefined;
+  data: Order;
+};
+
+/** @internal */
+export const WebhookOrderUpdatedPayload$inboundSchema: z.ZodType<
+  WebhookOrderUpdatedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("order.updated").optional(),
+  data: Order$inboundSchema,
+});
+
+/** @internal */
+export type WebhookOrderUpdatedPayload$Outbound = {
+  type: "order.updated";
+  data: Order$Outbound;
+};
+
+/** @internal */
+export const WebhookOrderUpdatedPayload$outboundSchema: z.ZodType<
+  WebhookOrderUpdatedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookOrderUpdatedPayload
+> = z.object({
+  type: z.literal("order.updated").default("order.updated" as const),
+  data: Order$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookOrderUpdatedPayload$ {
+  /** @deprecated use `WebhookOrderUpdatedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookOrderUpdatedPayload$inboundSchema;
+  /** @deprecated use `WebhookOrderUpdatedPayload$outboundSchema` instead. */
+  export const outboundSchema = WebhookOrderUpdatedPayload$outboundSchema;
+  /** @deprecated use `WebhookOrderUpdatedPayload$Outbound` instead. */
+  export type Outbound = WebhookOrderUpdatedPayload$Outbound;
+}
+
+export function webhookOrderUpdatedPayloadToJSON(
+  webhookOrderUpdatedPayload: WebhookOrderUpdatedPayload,
+): string {
+  return JSON.stringify(
+    WebhookOrderUpdatedPayload$outboundSchema.parse(webhookOrderUpdatedPayload),
+  );
+}
+
+export function webhookOrderUpdatedPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookOrderUpdatedPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookOrderUpdatedPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookOrderUpdatedPayload' from JSON`,
+  );
+}

package/src/models/operations/benefitslist.ts

@@ -38,6 +38,10 @@ export type BenefitsListRequest = {
    * Filter by benefit type.
    */
   typeFilter?: BenefitType | Array<BenefitType> | null | undefined;
+  /**
+   * Filter by description.
+   */
+  query?: string | null | undefined;
   /**
    * Page number, defaults to 1.
    */
@@ -171,6 +175,7 @@ export const BenefitsListRequest$inboundSchema: z.ZodType<
   type_filter: z.nullable(
     z.union([BenefitType$inboundSchema, z.array(BenefitType$inboundSchema)]),
   ).optional(),
+  query: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
 }).transform((v) => {
@@ -184,6 +189,7 @@ export const BenefitsListRequest$inboundSchema: z.ZodType<
 export type BenefitsListRequest$Outbound = {
   organization_id?: string | Array<string> | null | undefined;
   type_filter?: string | Array<string> | null | undefined;
+  query?: string | null | undefined;
   page: number;
   limit: number;
 };
@@ -199,6 +205,7 @@ export const BenefitsListRequest$outboundSchema: z.ZodType<
   typeFilter: z.nullable(
     z.union([BenefitType$outboundSchema, z.array(BenefitType$outboundSchema)]),
   ).optional(),
+  query: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
 }).transform((v) => {

package/src/sdk/customers.ts

@@ -114,7 +114,17 @@ export class Customers extends ClientSDK {
    * @remarks
    * Delete a customer.
    *
-   * Immediately cancels any active subscriptions and revokes any active benefits.
+   * This action cannot be undone and will immediately:
+   * - Cancel any active subscriptions for the customer
+   * - Revoke all their benefits
+   * - Clear any `external_id`
+   *
+   * Use it only in the context of deleting a user within your
+   * own service. Otherwise, use more granular API endpoints to cancel
+   * a specific subscription or revoke certain benefits.
+   *
+   * Note: The customers information will nonetheless be retained for historic
+   * orders and subscriptions.
    *
    * **Scopes**: `customers:write`
    */

package/src/webhooks.ts

@@ -12,6 +12,8 @@ import { WebhookCheckoutCreatedPayload$inboundSchema } from "./models/components
 import { WebhookCheckoutUpdatedPayload$inboundSchema } from "./models/components/webhookcheckoutupdatedpayload.js";
 import { WebhookOrderCreatedPayload$inboundSchema } from "./models/components/webhookordercreatedpayload.js";
 import { WebhookOrderRefundedPayload$inboundSchema } from "./models/components/webhookorderrefundedpayload.js";
+import { WebhookOrderUpdatedPayload$inboundSchema } from "./models/components/webhookorderupdatedpayload.js";
+import { WebhookOrderPaidPayload$inboundSchema } from "./models/components/webhookorderpaidpayload.js";
 import { WebhookOrganizationUpdatedPayload$inboundSchema } from "./models/components/webhookorganizationupdatedpayload.js";
 import { WebhookPledgeCreatedPayload$inboundSchema } from "./models/components/webhookpledgecreatedpayload.js";
 import { WebhookPledgeUpdatedPayload$inboundSchema } from "./models/components/webhookpledgeupdatedpayload.js";
@@ -65,6 +67,10 @@ const parseEvent = (parsed: any) => {
         return WebhookCheckoutUpdatedPayload$inboundSchema.parse(parsed);
       case "order.created":
         return WebhookOrderCreatedPayload$inboundSchema.parse(parsed);
+      case "order.paid":
+        return WebhookOrderPaidPayload$inboundSchema.parse(parsed);
+      case "order.updated":
+        return WebhookOrderUpdatedPayload$inboundSchema.parse(parsed);
       case "order.refunded":
         return WebhookOrderRefundedPayload$inboundSchema.parse(parsed);
       case "organization.updated":