@polar-sh/sdk 0.9.0 → 0.11.0

package/src/models/components/webhookbenefitgrantupdatedpayload.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  BenefitGrantWebhook,
+  BenefitGrantWebhook$inboundSchema,
+  BenefitGrantWebhook$Outbound,
+  BenefitGrantWebhook$outboundSchema,
+} from "./benefitgrantwebhook.js";
+
+export const WebhookBenefitGrantUpdatedPayloadType = {
+  BenefitGrantUpdated: "benefit_grant.updated",
+} as const;
+export type WebhookBenefitGrantUpdatedPayloadType = ClosedEnum<
+  typeof WebhookBenefitGrantUpdatedPayloadType
+>;
+
+/**
+ * Sent when a new benefit grant is updated.
+ *
+ * @remarks
+ *
+ * **Discord & Slack support:** Basic
+ */
+export type WebhookBenefitGrantUpdatedPayload = {
+  type?: "benefit_grant.updated" | undefined;
+  data: BenefitGrantWebhook;
+};
+
+/** @internal */
+export const WebhookBenefitGrantUpdatedPayloadType$inboundSchema:
+  z.ZodNativeEnum<typeof WebhookBenefitGrantUpdatedPayloadType> = z.nativeEnum(
+    WebhookBenefitGrantUpdatedPayloadType,
+  );
+
+/** @internal */
+export const WebhookBenefitGrantUpdatedPayloadType$outboundSchema:
+  z.ZodNativeEnum<typeof WebhookBenefitGrantUpdatedPayloadType> =
+    WebhookBenefitGrantUpdatedPayloadType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookBenefitGrantUpdatedPayloadType$ {
+  /** @deprecated use `WebhookBenefitGrantUpdatedPayloadType$inboundSchema` instead. */
+  export const inboundSchema =
+    WebhookBenefitGrantUpdatedPayloadType$inboundSchema;
+  /** @deprecated use `WebhookBenefitGrantUpdatedPayloadType$outboundSchema` instead. */
+  export const outboundSchema =
+    WebhookBenefitGrantUpdatedPayloadType$outboundSchema;
+}
+
+/** @internal */
+export const WebhookBenefitGrantUpdatedPayload$inboundSchema: z.ZodType<
+  WebhookBenefitGrantUpdatedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("benefit_grant.updated").optional(),
+  data: BenefitGrantWebhook$inboundSchema,
+});
+
+/** @internal */
+export type WebhookBenefitGrantUpdatedPayload$Outbound = {
+  type: "benefit_grant.updated";
+  data: BenefitGrantWebhook$Outbound;
+};
+
+/** @internal */
+export const WebhookBenefitGrantUpdatedPayload$outboundSchema: z.ZodType<
+  WebhookBenefitGrantUpdatedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookBenefitGrantUpdatedPayload
+> = z.object({
+  type: z.literal("benefit_grant.updated").default("benefit_grant.updated"),
+  data: BenefitGrantWebhook$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookBenefitGrantUpdatedPayload$ {
+  /** @deprecated use `WebhookBenefitGrantUpdatedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookBenefitGrantUpdatedPayload$inboundSchema;
+  /** @deprecated use `WebhookBenefitGrantUpdatedPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    WebhookBenefitGrantUpdatedPayload$outboundSchema;
+  /** @deprecated use `WebhookBenefitGrantUpdatedPayload$Outbound` instead. */
+  export type Outbound = WebhookBenefitGrantUpdatedPayload$Outbound;
+}

package/src/models/errors/httpvalidationerror.ts

@@ -5,16 +5,10 @@
 import * as z from "zod";
 import * as components from "../components/index.js";
 
-/**
- * Validation Error
- */
 export type HTTPValidationErrorData = {
   detail?: Array<components.ValidationError> | undefined;
 };
 
-/**
- * Validation Error
- */
 export class HTTPValidationError extends Error {
   detail?: Array<components.ValidationError> | undefined;
 

package/src/models/errors/index.ts

@@ -3,9 +3,7 @@
  */
 
 export * from "./alreadycanceledsubscription.js";
-export * from "./alreadysubscribed.js";
 export * from "./filenotfound.js";
-export * from "./freesubscriptionupgrade.js";
 export * from "./httpclienterrors.js";
 export * from "./httpvalidationerror.js";
 export * from "./notpermitted.js";

package/src/models/errors/notpermitted.ts

@@ -10,17 +10,11 @@ export const NotPermittedType = {
 } as const;
 export type NotPermittedType = ClosedEnum<typeof NotPermittedType>;
 
-/**
- * You don't have the permission to update this repository.
- */
 export type NotPermittedData = {
   type: "NotPermitted";
   detail: string;
 };
 
-/**
- * You don't have the permission to update this repository.
- */
 export class NotPermitted extends Error {
   type: "NotPermitted";
   detail: string;

package/src/models/errors/resourcenotfound.ts

@@ -10,17 +10,11 @@ export const Type = {
 } as const;
 export type Type = ClosedEnum<typeof Type>;
 
-/**
- * Order not found.
- */
 export type ResourceNotFoundData = {
   type: "ResourceNotFound";
   detail: string;
 };
 
-/**
- * Order not found.
- */
 export class ResourceNotFound extends Error {
   type: "ResourceNotFound";
   detail: string;

package/src/models/errors/unauthorized.ts

@@ -10,17 +10,11 @@ export const UnauthorizedType = {
 } as const;
 export type UnauthorizedType = ClosedEnum<typeof UnauthorizedType>;
 
-/**
- * Not authorized to manage license key.
- */
 export type UnauthorizedData = {
   type: "Unauthorized";
   detail: string;
 };
 
-/**
- * Not authorized to manage license key.
- */
 export class Unauthorized extends Error {
   type: "Unauthorized";
   detail: string;

package/src/models/operations/productscreate.ts

@@ -6,8 +6,8 @@ import * as z from "zod";
 import * as components from "../components/index.js";
 
 export type ProductsCreateProductCreate =
-  | components.ProductOneTimeCreate
-  | components.ProductRecurringCreate;
+  | components.ProductRecurringCreate
+  | components.ProductOneTimeCreate;
 
 /** @internal */
 export const ProductsCreateProductCreate$inboundSchema: z.ZodType<
@@ -15,14 +15,14 @@ export const ProductsCreateProductCreate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  components.ProductOneTimeCreate$inboundSchema,
   components.ProductRecurringCreate$inboundSchema,
+  components.ProductOneTimeCreate$inboundSchema,
 ]);
 
 /** @internal */
 export type ProductsCreateProductCreate$Outbound =
-  | components.ProductOneTimeCreate$Outbound
-  | components.ProductRecurringCreate$Outbound;
+  | components.ProductRecurringCreate$Outbound
+  | components.ProductOneTimeCreate$Outbound;
 
 /** @internal */
 export const ProductsCreateProductCreate$outboundSchema: z.ZodType<
@@ -30,8 +30,8 @@ export const ProductsCreateProductCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ProductsCreateProductCreate
 > = z.union([
-  components.ProductOneTimeCreate$outboundSchema,
   components.ProductRecurringCreate$outboundSchema,
+  components.ProductOneTimeCreate$outboundSchema,
 ]);
 
 /**

package/src/models/operations/productslist.ts

@@ -16,13 +16,6 @@ export type ProductsListQueryParamOrganizationIDFilter = string | Array<string>;
  */
 export type QueryParamBenefitIDFilter = string | Array<string>;
 
-/**
- * Filter by subscription tier type.
- */
-export type QueryParamSubscriptionTierTypeFilter =
-  | components.SubscriptionTierType
-  | Array<components.SubscriptionTierType>;
-
 export type ProductsListRequest = {
   /**
    * Filter by organization ID.
@@ -40,14 +33,6 @@ export type ProductsListRequest = {
    * Filter products granting specific benefit.
    */
   benefitId?: string | Array<string> | null | undefined;
-  /**
-   * Filter by subscription tier type.
-   */
-  typeFilter?:
-    | components.SubscriptionTierType
-    | Array<components.SubscriptionTierType>
-    | null
-    | undefined;
   /**
    * Page number, defaults to 1.
    */
@@ -125,46 +110,6 @@ export namespace QueryParamBenefitIDFilter$ {
   export type Outbound = QueryParamBenefitIDFilter$Outbound;
 }
 
-/** @internal */
-export const QueryParamSubscriptionTierTypeFilter$inboundSchema: z.ZodType<
-  QueryParamSubscriptionTierTypeFilter,
-  z.ZodTypeDef,
-  unknown
-> = z.union([
-  components.SubscriptionTierType$inboundSchema,
-  z.array(components.SubscriptionTierType$inboundSchema),
-]);
-
-/** @internal */
-export type QueryParamSubscriptionTierTypeFilter$Outbound =
-  | string
-  | Array<string>;
-
-/** @internal */
-export const QueryParamSubscriptionTierTypeFilter$outboundSchema: z.ZodType<
-  QueryParamSubscriptionTierTypeFilter$Outbound,
-  z.ZodTypeDef,
-  QueryParamSubscriptionTierTypeFilter
-> = z.union([
-  components.SubscriptionTierType$outboundSchema,
-  z.array(components.SubscriptionTierType$outboundSchema),
-]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace QueryParamSubscriptionTierTypeFilter$ {
-  /** @deprecated use `QueryParamSubscriptionTierTypeFilter$inboundSchema` instead. */
-  export const inboundSchema =
-    QueryParamSubscriptionTierTypeFilter$inboundSchema;
-  /** @deprecated use `QueryParamSubscriptionTierTypeFilter$outboundSchema` instead. */
-  export const outboundSchema =
-    QueryParamSubscriptionTierTypeFilter$outboundSchema;
-  /** @deprecated use `QueryParamSubscriptionTierTypeFilter$Outbound` instead. */
-  export type Outbound = QueryParamSubscriptionTierTypeFilter$Outbound;
-}
-
 /** @internal */
 export const ProductsListRequest$inboundSchema: z.ZodType<
   ProductsListRequest,
@@ -175,12 +120,6 @@ export const ProductsListRequest$inboundSchema: z.ZodType<
   is_archived: z.nullable(z.boolean()).optional(),
   is_recurring: z.nullable(z.boolean()).optional(),
   benefit_id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
-  type_filter: z.nullable(
-    z.union([
-      components.SubscriptionTierType$inboundSchema,
-      z.array(components.SubscriptionTierType$inboundSchema),
-    ]),
-  ).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
 }).transform((v) => {
@@ -189,7 +128,6 @@ export const ProductsListRequest$inboundSchema: z.ZodType<
     "is_archived": "isArchived",
     "is_recurring": "isRecurring",
     "benefit_id": "benefitId",
-    "type_filter": "typeFilter",
   });
 });
 
@@ -199,7 +137,6 @@ export type ProductsListRequest$Outbound = {
   is_archived?: boolean | null | undefined;
   is_recurring?: boolean | null | undefined;
   benefit_id?: string | Array<string> | null | undefined;
-  type_filter?: string | Array<string> | null | undefined;
   page: number;
   limit: number;
 };
@@ -214,12 +151,6 @@ export const ProductsListRequest$outboundSchema: z.ZodType<
   isArchived: z.nullable(z.boolean()).optional(),
   isRecurring: z.nullable(z.boolean()).optional(),
   benefitId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
-  typeFilter: z.nullable(
-    z.union([
-      components.SubscriptionTierType$outboundSchema,
-      z.array(components.SubscriptionTierType$outboundSchema),
-    ]),
-  ).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
 }).transform((v) => {
@@ -228,7 +159,6 @@ export const ProductsListRequest$outboundSchema: z.ZodType<
     isArchived: "is_archived",
     isRecurring: "is_recurring",
     benefitId: "benefit_id",
-    typeFilter: "type_filter",
   });
 });
 

package/src/models/operations/subscriptionslist.ts

@@ -18,13 +18,6 @@ export type SubscriptionsListQueryParamOrganizationIDFilter =
  */
 export type SubscriptionsListQueryParamProductIDFilter = string | Array<string>;
 
-/**
- * Filter by subscription tier type.
- */
-export type SubscriptionTierTypeFilter =
-  | components.SubscriptionTierType
-  | Array<components.SubscriptionTierType>;
-
 export type SubscriptionsListRequest = {
   /**
    * Filter by organization ID.
@@ -34,16 +27,6 @@ export type SubscriptionsListRequest = {
    * Filter by product ID.
    */
   productId?: string | Array<string> | null | undefined;
-  /**
-   * Filter by subscription tier type.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  typeFilter?:
-    | components.SubscriptionTierType
-    | Array<components.SubscriptionTierType>
-    | null
-    | undefined;
   /**
    * Filter by active or inactive subscription.
    */
@@ -136,42 +119,6 @@ export namespace SubscriptionsListQueryParamProductIDFilter$ {
   export type Outbound = SubscriptionsListQueryParamProductIDFilter$Outbound;
 }
 
-/** @internal */
-export const SubscriptionTierTypeFilter$inboundSchema: z.ZodType<
-  SubscriptionTierTypeFilter,
-  z.ZodTypeDef,
-  unknown
-> = z.union([
-  components.SubscriptionTierType$inboundSchema,
-  z.array(components.SubscriptionTierType$inboundSchema),
-]);
-
-/** @internal */
-export type SubscriptionTierTypeFilter$Outbound = string | Array<string>;
-
-/** @internal */
-export const SubscriptionTierTypeFilter$outboundSchema: z.ZodType<
-  SubscriptionTierTypeFilter$Outbound,
-  z.ZodTypeDef,
-  SubscriptionTierTypeFilter
-> = z.union([
-  components.SubscriptionTierType$outboundSchema,
-  z.array(components.SubscriptionTierType$outboundSchema),
-]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SubscriptionTierTypeFilter$ {
-  /** @deprecated use `SubscriptionTierTypeFilter$inboundSchema` instead. */
-  export const inboundSchema = SubscriptionTierTypeFilter$inboundSchema;
-  /** @deprecated use `SubscriptionTierTypeFilter$outboundSchema` instead. */
-  export const outboundSchema = SubscriptionTierTypeFilter$outboundSchema;
-  /** @deprecated use `SubscriptionTierTypeFilter$Outbound` instead. */
-  export type Outbound = SubscriptionTierTypeFilter$Outbound;
-}
-
 /** @internal */
 export const SubscriptionsListRequest$inboundSchema: z.ZodType<
   SubscriptionsListRequest,
@@ -181,12 +128,6 @@ export const SubscriptionsListRequest$inboundSchema: z.ZodType<
   organization_id: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   product_id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
-  type_filter: z.nullable(
-    z.union([
-      components.SubscriptionTierType$inboundSchema,
-      z.array(components.SubscriptionTierType$inboundSchema),
-    ]),
-  ).optional(),
   active: z.nullable(z.boolean()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
@@ -197,7 +138,6 @@ export const SubscriptionsListRequest$inboundSchema: z.ZodType<
   return remap$(v, {
     "organization_id": "organizationId",
     "product_id": "productId",
-    "type_filter": "typeFilter",
   });
 });
 
@@ -205,7 +145,6 @@ export const SubscriptionsListRequest$inboundSchema: z.ZodType<
 export type SubscriptionsListRequest$Outbound = {
   organization_id?: string | Array<string> | null | undefined;
   product_id?: string | Array<string> | null | undefined;
-  type_filter?: string | Array<string> | null | undefined;
   active?: boolean | null | undefined;
   page: number;
   limit: number;
@@ -221,12 +160,6 @@ export const SubscriptionsListRequest$outboundSchema: z.ZodType<
   organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   productId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
-  typeFilter: z.nullable(
-    z.union([
-      components.SubscriptionTierType$outboundSchema,
-      z.array(components.SubscriptionTierType$outboundSchema),
-    ]),
-  ).optional(),
   active: z.nullable(z.boolean()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
@@ -237,7 +170,6 @@ export const SubscriptionsListRequest$outboundSchema: z.ZodType<
   return remap$(v, {
     organizationId: "organization_id",
     productId: "product_id",
-    typeFilter: "type_filter",
   });
 });
 

package/src/sdk/oauth2.ts

@@ -15,7 +15,7 @@ import { Clients } from "./clients.js";
 export class Oauth2 extends ClientSDK {
   private _clients?: Clients;
   get clients(): Clients {
-    return (this._clients ??= new Clients(this.options$));
+    return (this._clients ??= new Clients(this._options));
   }
 
   /**

package/src/sdk/polarsubscriptions.ts

@@ -3,7 +3,6 @@
  */
 
 import { usersSubscriptionsCancel } from "../funcs/usersSubscriptionsCancel.js";
-import { usersSubscriptionsCreate } from "../funcs/usersSubscriptionsCreate.js";
 import { usersSubscriptionsGet } from "../funcs/usersSubscriptionsGet.js";
 import { usersSubscriptionsList } from "../funcs/usersSubscriptionsList.js";
 import { usersSubscriptionsUpdate } from "../funcs/usersSubscriptionsUpdate.js";
@@ -31,25 +30,6 @@ export class PolarSubscriptions extends ClientSDK {
     ));
   }
 
-  /**
-   * Create Free Subscription
-   *
-   * @remarks
-   * Create a subscription on a **free** tier.
-   *
-   * If you want to subscribe to a paid tier, you need to create a checkout session.
-   */
-  async create(
-    request: components.UserFreeSubscriptionCreate,
-    options?: RequestOptions,
-  ): Promise<components.UserSubscription> {
-    return unwrapAsync(usersSubscriptionsCreate(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Get Subscription
    *

package/src/sdk/sdk.ts

@@ -22,78 +22,78 @@ import { Users } from "./users.js";
 export class Polar extends ClientSDK {
   private _users?: Users;
   get users(): Users {
-    return (this._users ??= new Users(this.options$));
+    return (this._users ??= new Users(this._options));
   }
 
   private _externalOrganizations?: ExternalOrganizations;
   get externalOrganizations(): ExternalOrganizations {
     return (this._externalOrganizations ??= new ExternalOrganizations(
-      this.options$,
+      this._options,
     ));
   }
 
   private _repositories?: Repositories;
   get repositories(): Repositories {
-    return (this._repositories ??= new Repositories(this.options$));
+    return (this._repositories ??= new Repositories(this._options));
   }
 
   private _organizations?: Organizations;
   get organizations(): Organizations {
-    return (this._organizations ??= new Organizations(this.options$));
+    return (this._organizations ??= new Organizations(this._options));
   }
 
   private _subscriptions?: Subscriptions;
   get subscriptions(): Subscriptions {
-    return (this._subscriptions ??= new Subscriptions(this.options$));
+    return (this._subscriptions ??= new Subscriptions(this._options));
   }
 
   private _articles?: Articles;
   get articles(): Articles {
-    return (this._articles ??= new Articles(this.options$));
+    return (this._articles ??= new Articles(this._options));
   }
 
   private _advertisements?: Advertisements;
   get advertisements(): Advertisements {
-    return (this._advertisements ??= new Advertisements(this.options$));
+    return (this._advertisements ??= new Advertisements(this._options));
   }
 
   private _oauth2?: Oauth2;
   get oauth2(): Oauth2 {
-    return (this._oauth2 ??= new Oauth2(this.options$));
+    return (this._oauth2 ??= new Oauth2(this._options));
   }
 
   private _benefits?: Benefits;
   get benefits(): Benefits {
-    return (this._benefits ??= new Benefits(this.options$));
+    return (this._benefits ??= new Benefits(this._options));
   }
 
   private _products?: Products;
   get products(): Products {
-    return (this._products ??= new Products(this.options$));
+    return (this._products ??= new Products(this._options));
   }
 
   private _orders?: Orders;
   get orders(): Orders {
-    return (this._orders ??= new Orders(this.options$));
+    return (this._orders ??= new Orders(this._options));
   }
 
   private _checkouts?: Checkouts;
   get checkouts(): Checkouts {
-    return (this._checkouts ??= new Checkouts(this.options$));
+    return (this._checkouts ??= new Checkouts(this._options));
   }
 
   private _files?: Files;
   get files(): Files {
-    return (this._files ??= new Files(this.options$));
+    return (this._files ??= new Files(this._options));
   }
 
   private _metrics?: Metrics;
   get metrics(): Metrics {
-    return (this._metrics ??= new Metrics(this.options$));
+    return (this._metrics ??= new Metrics(this._options));
   }
 
   private _licenseKeys?: LicenseKeys;
   get licenseKeys(): LicenseKeys {
-    return (this._licenseKeys ??= new LicenseKeys(this.options$));
+    return (this._licenseKeys ??= new LicenseKeys(this._options));
   }
 }

package/src/sdk/subscriptions.ts

@@ -2,12 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { subscriptionsCreate } from "../funcs/subscriptionsCreate.js";
 import { subscriptionsExport } from "../funcs/subscriptionsExport.js";
-import { subscriptionsImportSubscriptions } from "../funcs/subscriptionsImportSubscriptions.js";
 import { subscriptionsList } from "../funcs/subscriptionsList.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -30,40 +27,6 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
-  /**
-   * Create Free Subscription
-   *
-   * @remarks
-   * Create a subscription on the free tier for a given email.
-   */
-  async create(
-    request: components.SubscriptionCreateEmail,
-    options?: RequestOptions,
-  ): Promise<components.SubscriptionOutput> {
-    return unwrapAsync(subscriptionsCreate(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Import Subscriptions
-   *
-   * @remarks
-   * Import subscriptions from a CSV file.
-   */
-  async importSubscriptions(
-    request: components.BodySubscriptionsImport,
-    options?: RequestOptions,
-  ): Promise<components.SubscriptionsImported> {
-    return unwrapAsync(subscriptionsImportSubscriptions(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Export Subscriptions
    *