@polar-sh/sdk 0.13.0 → 0.13.2

package/src/models/operations/checkoutlinkslist.ts

@@ -0,0 +1,224 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+/**
+ * Filter by organization ID.
+ */
+export type CheckoutLinksListQueryParamOrganizationIDFilter =
+  | string
+  | Array<string>;
+
+/**
+ * Filter by product ID.
+ */
+export type CheckoutLinksListQueryParamProductIDFilter = string | Array<string>;
+
+export type CheckoutLinksListRequest = {
+  /**
+   * Filter by organization ID.
+   */
+  organizationId?: string | Array<string> | null | undefined;
+  /**
+   * Filter by product ID.
+   */
+  productId?: string | Array<string> | null | undefined;
+  /**
+   * Page number, defaults to 1.
+   */
+  page?: number | undefined;
+  /**
+   * Size of a page, defaults to 10. Maximum is 100.
+   */
+  limit?: number | undefined;
+  /**
+   * Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
+   */
+  sorting?: Array<components.CheckoutLinkSortProperty> | null | undefined;
+};
+
+export type CheckoutLinksListResponse = {
+  result: components.ListResourceCheckoutLink;
+};
+
+/** @internal */
+export const CheckoutLinksListQueryParamOrganizationIDFilter$inboundSchema:
+  z.ZodType<
+    CheckoutLinksListQueryParamOrganizationIDFilter,
+    z.ZodTypeDef,
+    unknown
+  > = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type CheckoutLinksListQueryParamOrganizationIDFilter$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const CheckoutLinksListQueryParamOrganizationIDFilter$outboundSchema:
+  z.ZodType<
+    CheckoutLinksListQueryParamOrganizationIDFilter$Outbound,
+    z.ZodTypeDef,
+    CheckoutLinksListQueryParamOrganizationIDFilter
+  > = z.union([z.string(), z.array(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 CheckoutLinksListQueryParamOrganizationIDFilter$ {
+  /** @deprecated use `CheckoutLinksListQueryParamOrganizationIDFilter$inboundSchema` instead. */
+  export const inboundSchema =
+    CheckoutLinksListQueryParamOrganizationIDFilter$inboundSchema;
+  /** @deprecated use `CheckoutLinksListQueryParamOrganizationIDFilter$outboundSchema` instead. */
+  export const outboundSchema =
+    CheckoutLinksListQueryParamOrganizationIDFilter$outboundSchema;
+  /** @deprecated use `CheckoutLinksListQueryParamOrganizationIDFilter$Outbound` instead. */
+  export type Outbound =
+    CheckoutLinksListQueryParamOrganizationIDFilter$Outbound;
+}
+
+/** @internal */
+export const CheckoutLinksListQueryParamProductIDFilter$inboundSchema:
+  z.ZodType<CheckoutLinksListQueryParamProductIDFilter, z.ZodTypeDef, unknown> =
+    z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type CheckoutLinksListQueryParamProductIDFilter$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const CheckoutLinksListQueryParamProductIDFilter$outboundSchema:
+  z.ZodType<
+    CheckoutLinksListQueryParamProductIDFilter$Outbound,
+    z.ZodTypeDef,
+    CheckoutLinksListQueryParamProductIDFilter
+  > = z.union([z.string(), z.array(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 CheckoutLinksListQueryParamProductIDFilter$ {
+  /** @deprecated use `CheckoutLinksListQueryParamProductIDFilter$inboundSchema` instead. */
+  export const inboundSchema =
+    CheckoutLinksListQueryParamProductIDFilter$inboundSchema;
+  /** @deprecated use `CheckoutLinksListQueryParamProductIDFilter$outboundSchema` instead. */
+  export const outboundSchema =
+    CheckoutLinksListQueryParamProductIDFilter$outboundSchema;
+  /** @deprecated use `CheckoutLinksListQueryParamProductIDFilter$Outbound` instead. */
+  export type Outbound = CheckoutLinksListQueryParamProductIDFilter$Outbound;
+}
+
+/** @internal */
+export const CheckoutLinksListRequest$inboundSchema: z.ZodType<
+  CheckoutLinksListRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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(),
+  page: z.number().int().default(1),
+  limit: z.number().int().default(10),
+  sorting: z.nullable(
+    z.array(components.CheckoutLinkSortProperty$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "product_id": "productId",
+  });
+});
+
+/** @internal */
+export type CheckoutLinksListRequest$Outbound = {
+  organization_id?: string | Array<string> | null | undefined;
+  product_id?: string | Array<string> | null | undefined;
+  page: number;
+  limit: number;
+  sorting?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export const CheckoutLinksListRequest$outboundSchema: z.ZodType<
+  CheckoutLinksListRequest$Outbound,
+  z.ZodTypeDef,
+  CheckoutLinksListRequest
+> = z.object({
+  organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
+    .optional(),
+  productId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  page: z.number().int().default(1),
+  limit: z.number().int().default(10),
+  sorting: z.nullable(
+    z.array(components.CheckoutLinkSortProperty$outboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    productId: "product_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinksListRequest$ {
+  /** @deprecated use `CheckoutLinksListRequest$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinksListRequest$inboundSchema;
+  /** @deprecated use `CheckoutLinksListRequest$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinksListRequest$outboundSchema;
+  /** @deprecated use `CheckoutLinksListRequest$Outbound` instead. */
+  export type Outbound = CheckoutLinksListRequest$Outbound;
+}
+
+/** @internal */
+export const CheckoutLinksListResponse$inboundSchema: z.ZodType<
+  CheckoutLinksListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.ListResourceCheckoutLink$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type CheckoutLinksListResponse$Outbound = {
+  Result: components.ListResourceCheckoutLink$Outbound;
+};
+
+/** @internal */
+export const CheckoutLinksListResponse$outboundSchema: z.ZodType<
+  CheckoutLinksListResponse$Outbound,
+  z.ZodTypeDef,
+  CheckoutLinksListResponse
+> = z.object({
+  result: components.ListResourceCheckoutLink$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinksListResponse$ {
+  /** @deprecated use `CheckoutLinksListResponse$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinksListResponse$inboundSchema;
+  /** @deprecated use `CheckoutLinksListResponse$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinksListResponse$outboundSchema;
+  /** @deprecated use `CheckoutLinksListResponse$Outbound` instead. */
+  export type Outbound = CheckoutLinksListResponse$Outbound;
+}

package/src/models/operations/checkoutlinksupdate.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type CheckoutLinksUpdateRequest = {
+  /**
+   * The checkout link ID.
+   */
+  id: string;
+  checkoutLinkUpdate: components.CheckoutLinkUpdate;
+};
+
+/** @internal */
+export const CheckoutLinksUpdateRequest$inboundSchema: z.ZodType<
+  CheckoutLinksUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  CheckoutLinkUpdate: components.CheckoutLinkUpdate$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "CheckoutLinkUpdate": "checkoutLinkUpdate",
+  });
+});
+
+/** @internal */
+export type CheckoutLinksUpdateRequest$Outbound = {
+  id: string;
+  CheckoutLinkUpdate: components.CheckoutLinkUpdate$Outbound;
+};
+
+/** @internal */
+export const CheckoutLinksUpdateRequest$outboundSchema: z.ZodType<
+  CheckoutLinksUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  CheckoutLinksUpdateRequest
+> = z.object({
+  id: z.string(),
+  checkoutLinkUpdate: components.CheckoutLinkUpdate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    checkoutLinkUpdate: "CheckoutLinkUpdate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinksUpdateRequest$ {
+  /** @deprecated use `CheckoutLinksUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinksUpdateRequest$inboundSchema;
+  /** @deprecated use `CheckoutLinksUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinksUpdateRequest$outboundSchema;
+  /** @deprecated use `CheckoutLinksUpdateRequest$Outbound` instead. */
+  export type Outbound = CheckoutLinksUpdateRequest$Outbound;
+}

package/src/models/operations/index.ts

@@ -5,6 +5,7 @@
 export * from "./advertisementsget.js";
 export * from "./advertisementslist.js";
 export * from "./articlesdelete.js";
+export * from "./articlesexport.js";
 export * from "./articlesget.js";
 export * from "./articleslist.js";
 export * from "./articlespreview.js";
@@ -17,6 +18,10 @@ export * from "./benefitsget.js";
 export * from "./benefitsgrants.js";
 export * from "./benefitslist.js";
 export * from "./benefitsupdate.js";
+export * from "./checkoutlinksdelete.js";
+export * from "./checkoutlinksget.js";
+export * from "./checkoutlinkslist.js";
+export * from "./checkoutlinksupdate.js";
 export * from "./checkoutscustomclientconfirm.js";
 export * from "./checkoutscustomclientget.js";
 export * from "./checkoutscustomclientupdate.js";

package/src/models/operations/metricsget.ts

@@ -4,25 +4,9 @@
 
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { RFCDate } from "../../types/rfcdate.js";
 import * as components from "../components/index.js";
 
-/**
- * Interval between two timestamps.
- */
-export const Interval = {
-  Year: "year",
-  Month: "month",
-  Week: "week",
-  Day: "day",
-  Hour: "hour",
-} as const;
-/**
- * Interval between two timestamps.
- */
-export type Interval = ClosedEnum<typeof Interval>;
-
 /**
  * Filter by organization ID.
  */
@@ -52,7 +36,7 @@ export type MetricsGetRequest = {
   /**
    * Interval between two timestamps.
    */
-  interval: Interval;
+  interval: components.Interval;
   /**
    * Filter by organization ID.
    */
@@ -71,25 +55,6 @@ export type MetricsGetRequest = {
     | undefined;
 };
 
-/** @internal */
-export const Interval$inboundSchema: z.ZodNativeEnum<typeof Interval> = z
-  .nativeEnum(Interval);
-
-/** @internal */
-export const Interval$outboundSchema: z.ZodNativeEnum<typeof Interval> =
-  Interval$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Interval$ {
-  /** @deprecated use `Interval$inboundSchema` instead. */
-  export const inboundSchema = Interval$inboundSchema;
-  /** @deprecated use `Interval$outboundSchema` instead. */
-  export const outboundSchema = Interval$outboundSchema;
-}
-
 /** @internal */
 export const MetricsGetQueryParamOrganizationIDFilter$inboundSchema: z.ZodType<
   MetricsGetQueryParamOrganizationIDFilter,
@@ -205,7 +170,7 @@ export const MetricsGetRequest$inboundSchema: z.ZodType<
 > = z.object({
   start_date: z.string().transform(v => new RFCDate(v)),
   end_date: z.string().transform(v => new RFCDate(v)),
-  interval: Interval$inboundSchema,
+  interval: components.Interval$inboundSchema,
   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(),
@@ -243,7 +208,7 @@ export const MetricsGetRequest$outboundSchema: z.ZodType<
 > = z.object({
   startDate: z.instanceof(RFCDate).transform(v => v.toString()),
   endDate: z.instanceof(RFCDate).transform(v => v.toString()),
-  interval: Interval$outboundSchema,
+  interval: components.Interval$outboundSchema,
   organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
     .optional(),
   productId: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),

package/src/sdk/articles.ts

@@ -4,6 +4,7 @@
 
 import { articlesCreate } from "../funcs/articlesCreate.js";
 import { articlesDelete } from "../funcs/articlesDelete.js";
+import { articlesExport } from "../funcs/articlesExport.js";
 import { articlesGet } from "../funcs/articlesGet.js";
 import { articlesList } from "../funcs/articlesList.js";
 import { articlesPreview } from "../funcs/articlesPreview.js";
@@ -51,6 +52,23 @@ export class Articles extends ClientSDK {
     ));
   }
 
+  /**
+   * Export Articles
+   *
+   * @remarks
+   * Export organization articles.
+   */
+  async export(
+    request: operations.ArticlesExportRequest,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(articlesExport(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get Article
    *

package/src/sdk/benefits.ts

@@ -9,6 +9,7 @@ import { benefitsGrants } from "../funcs/benefitsGrants.js";
 import { benefitsList } from "../funcs/benefitsList.js";
 import { benefitsUpdate } from "../funcs/benefitsUpdate.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";
@@ -40,7 +41,7 @@ export class Benefits extends ClientSDK {
   async create(
     request: operations.BenefitsCreateBenefitCreate,
     options?: RequestOptions,
-  ): Promise<operations.BenefitsCreateResponseBenefitsCreate> {
+  ): Promise<components.Benefit> {
     return unwrapAsync(benefitsCreate(
       this,
       request,
@@ -57,7 +58,7 @@ export class Benefits extends ClientSDK {
   async get(
     request: operations.BenefitsGetRequest,
     options?: RequestOptions,
-  ): Promise<operations.BenefitsGetResponseBenefitsGet> {
+  ): Promise<components.Benefit> {
     return unwrapAsync(benefitsGet(
       this,
       request,
@@ -74,7 +75,7 @@ export class Benefits extends ClientSDK {
   async update(
     request: operations.BenefitsUpdateRequest,
     options?: RequestOptions,
-  ): Promise<operations.BenefitsUpdateResponseBenefitsUpdate> {
+  ): Promise<components.Benefit> {
     return unwrapAsync(benefitsUpdate(
       this,
       request,

package/src/sdk/checkoutlinks.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { checkoutLinksCreate } from "../funcs/checkoutLinksCreate.js";
+import { checkoutLinksDelete } from "../funcs/checkoutLinksDelete.js";
+import { checkoutLinksGet } from "../funcs/checkoutLinksGet.js";
+import { checkoutLinksList } from "../funcs/checkoutLinksList.js";
+import { checkoutLinksUpdate } from "../funcs/checkoutLinksUpdate.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";
+
+export class CheckoutLinks extends ClientSDK {
+  /**
+   * List Checkout Links
+   *
+   * @remarks
+   * List checkout links.
+   */
+  async list(
+    request: operations.CheckoutLinksListRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.CheckoutLinksListResponse>> {
+    return unwrapResultIterator(checkoutLinksList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Checkout Link
+   *
+   * @remarks
+   * Create a checkout link.
+   */
+  async create(
+    request: components.CheckoutLinkCreate,
+    options?: RequestOptions,
+  ): Promise<components.CheckoutLink> {
+    return unwrapAsync(checkoutLinksCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Checkout Link
+   *
+   * @remarks
+   * Get a checkout link by ID.
+   */
+  async get(
+    request: operations.CheckoutLinksGetRequest,
+    options?: RequestOptions,
+  ): Promise<components.CheckoutLink> {
+    return unwrapAsync(checkoutLinksGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Checkout Link
+   *
+   * @remarks
+   * Update a checkout link.
+   */
+  async update(
+    request: operations.CheckoutLinksUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<components.CheckoutLink> {
+    return unwrapAsync(checkoutLinksUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Checkout Link
+   *
+   * @remarks
+   * Delete a checkout link.
+   */
+  async delete(
+    request: operations.CheckoutLinksDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(checkoutLinksDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -6,6 +6,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Advertisements } from "./advertisements.js";
 import { Articles } from "./articles.js";
 import { Benefits } from "./benefits.js";
+import { CheckoutLinks } from "./checkoutlinks.js";
 import { Checkouts } from "./checkouts.js";
 import { ExternalOrganizations } from "./externalorganizations.js";
 import { Files } from "./files.js";
@@ -96,4 +97,9 @@ export class Polar extends ClientSDK {
   get licenseKeys(): LicenseKeys {
     return (this._licenseKeys ??= new LicenseKeys(this._options));
   }
+
+  private _checkoutLinks?: CheckoutLinks;
+  get checkoutLinks(): CheckoutLinks {
+    return (this._checkoutLinks ??= new CheckoutLinks(this._options));
+  }
 }