@polar-sh/sdk 0.13.1 → 0.13.2

package/src/funcs/checkoutLinksList.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List Checkout Links
+ *
+ * @remarks
+ * List checkout links.
+ */
+export async function checkoutLinksList(
+  client: PolarCore,
+  request: operations.CheckoutLinksListRequest,
+  options?: RequestOptions,
+): Promise<
+  PageIterator<
+    Result<
+      operations.CheckoutLinksListResponse,
+      | errors.HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.CheckoutLinksListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return haltIterator(parsed);
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/checkout-links/")();
+
+  const query = encodeFormQuery({
+    "limit": payload.limit,
+    "organization_id": payload.organization_id,
+    "page": payload.page,
+    "product_id": payload.product_id,
+    "sorting": payload.sorting,
+  });
+
+  const headers = new Headers({
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const context = {
+    operationID: "checkout-links:list",
+    oAuth2Scopes: [],
+    securitySource: client._options.accessToken,
+  };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return haltIterator(requestRes);
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: options?.retries
+      || client._options.retryConfig,
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  });
+  if (!doResult.ok) {
+    return haltIterator(doResult);
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.CheckoutLinksListResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.CheckoutLinksListResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return haltIterator(result);
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): Paginator<
+    Result<
+      operations.CheckoutLinksListResponse,
+      | errors.HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >
+  > => {
+    const page = request?.page || 0;
+    const nextPage = page + 1;
+    const numPages = dlv(responseData, "pagination.max_page");
+    if (numPages == null || numPages <= page) {
+      return () => null;
+    }
+
+    if (!responseData) {
+      return () => null;
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return () => null;
+    }
+    const limit = request?.limit || 0;
+    if (results.length < limit) {
+      return () => null;
+    }
+
+    return () =>
+      checkoutLinksList(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+  };
+
+  const page = { ...result, next: nextFunc(raw) };
+  return { ...page, ...createPageIterator(page, (v) => !v.ok) };
+}

package/src/funcs/checkoutLinksUpdate.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update Checkout Link
+ *
+ * @remarks
+ * Update a checkout link.
+ */
+export async function checkoutLinksUpdate(
+  client: PolarCore,
+  request: operations.CheckoutLinksUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.CheckoutLink,
+    | errors.ResourceNotFound
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CheckoutLinksUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.CheckoutLinkUpdate, {
+    explode: true,
+  });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/checkout-links/{id}")(pathParams);
+
+  const headers = new Headers({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const context = {
+    operationID: "checkout-links:update",
+    oAuth2Scopes: [],
+    securitySource: client._options.accessToken,
+  };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "422", "4XX", "5XX"],
+    retryConfig: options?.retries
+      || client._options.retryConfig,
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.CheckoutLink,
+    | errors.ResourceNotFound
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.CheckoutLink$inboundSchema),
+    M.jsonErr(404, errors.ResourceNotFound$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/lib/config.ts

@@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.13.1",
+  sdkVersion: "0.13.2",
   genVersion: "2.438.3",
-  userAgent: "speakeasy-sdk/typescript 0.13.1 2.438.3 0.1.0 @polar-sh/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.13.2 2.438.3 0.1.0 @polar-sh/sdk",
 } as const;

package/src/models/components/checkoutlink.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ProductPrice,
+  ProductPrice$inboundSchema,
+  ProductPrice$Outbound,
+  ProductPrice$outboundSchema,
+} from "./productprice.js";
+
+/**
+ * Checkout link data.
+ */
+export type CheckoutLink = {
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  metadata: { [k: string]: string };
+  paymentProcessor?: "stripe" | undefined;
+  /**
+   * Client secret used to access the checkout link.
+   */
+  clientSecret: string;
+  /**
+   * URL where the customer will be redirected after a successful payment.
+   */
+  successUrl: string | null;
+  /**
+   * ID of the product price to checkout.
+   */
+  productPriceId: string;
+  productPrice: ProductPrice;
+  url: string;
+};
+
+/** @internal */
+export const CheckoutLink$inboundSchema: z.ZodType<
+  CheckoutLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  modified_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  id: z.string(),
+  metadata: z.record(z.string()),
+  payment_processor: z.literal("stripe").optional(),
+  client_secret: z.string(),
+  success_url: z.nullable(z.string()),
+  product_price_id: z.string(),
+  product_price: ProductPrice$inboundSchema,
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "payment_processor": "paymentProcessor",
+    "client_secret": "clientSecret",
+    "success_url": "successUrl",
+    "product_price_id": "productPriceId",
+    "product_price": "productPrice",
+  });
+});
+
+/** @internal */
+export type CheckoutLink$Outbound = {
+  created_at: string;
+  modified_at: string | null;
+  id: string;
+  metadata: { [k: string]: string };
+  payment_processor: "stripe";
+  client_secret: string;
+  success_url: string | null;
+  product_price_id: string;
+  product_price: ProductPrice$Outbound;
+  url: string;
+};
+
+/** @internal */
+export const CheckoutLink$outboundSchema: z.ZodType<
+  CheckoutLink$Outbound,
+  z.ZodTypeDef,
+  CheckoutLink
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  id: z.string(),
+  metadata: z.record(z.string()),
+  paymentProcessor: z.literal("stripe").default("stripe"),
+  clientSecret: z.string(),
+  successUrl: z.nullable(z.string()),
+  productPriceId: z.string(),
+  productPrice: ProductPrice$outboundSchema,
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    paymentProcessor: "payment_processor",
+    clientSecret: "client_secret",
+    successUrl: "success_url",
+    productPriceId: "product_price_id",
+    productPrice: "product_price",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLink$ {
+  /** @deprecated use `CheckoutLink$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLink$inboundSchema;
+  /** @deprecated use `CheckoutLink$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLink$outboundSchema;
+  /** @deprecated use `CheckoutLink$Outbound` instead. */
+  export type Outbound = CheckoutLink$Outbound;
+}

package/src/models/components/checkoutlinkcreate.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Payment processor to use. Currently only Stripe is supported.
+ */
+export const CheckoutLinkCreatePaymentProcessor = {
+  Stripe: "stripe",
+} as const;
+/**
+ * Payment processor to use. Currently only Stripe is supported.
+ */
+export type CheckoutLinkCreatePaymentProcessor = ClosedEnum<
+  typeof CheckoutLinkCreatePaymentProcessor
+>;
+
+/**
+ * Schema to create a new checkout link.
+ */
+export type CheckoutLinkCreate = {
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be a string with a maximum length of **500 characters**.
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string } | undefined;
+  /**
+   * Payment processor to use. Currently only Stripe is supported.
+   */
+  paymentProcessor?: "stripe" | undefined;
+  /**
+   * ID of the product price to checkout.
+   */
+  productPriceId: string;
+  /**
+   * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.
+   */
+  successUrl?: string | null | undefined;
+};
+
+/** @internal */
+export const CheckoutLinkCreatePaymentProcessor$inboundSchema: z.ZodNativeEnum<
+  typeof CheckoutLinkCreatePaymentProcessor
+> = z.nativeEnum(CheckoutLinkCreatePaymentProcessor);
+
+/** @internal */
+export const CheckoutLinkCreatePaymentProcessor$outboundSchema: z.ZodNativeEnum<
+  typeof CheckoutLinkCreatePaymentProcessor
+> = CheckoutLinkCreatePaymentProcessor$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinkCreatePaymentProcessor$ {
+  /** @deprecated use `CheckoutLinkCreatePaymentProcessor$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinkCreatePaymentProcessor$inboundSchema;
+  /** @deprecated use `CheckoutLinkCreatePaymentProcessor$outboundSchema` instead. */
+  export const outboundSchema =
+    CheckoutLinkCreatePaymentProcessor$outboundSchema;
+}
+
+/** @internal */
+export const CheckoutLinkCreate$inboundSchema: z.ZodType<
+  CheckoutLinkCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metadata: z.record(z.string()).optional(),
+  payment_processor: z.literal("stripe").optional(),
+  product_price_id: z.string(),
+  success_url: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "payment_processor": "paymentProcessor",
+    "product_price_id": "productPriceId",
+    "success_url": "successUrl",
+  });
+});
+
+/** @internal */
+export type CheckoutLinkCreate$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+  payment_processor: "stripe";
+  product_price_id: string;
+  success_url?: string | null | undefined;
+};
+
+/** @internal */
+export const CheckoutLinkCreate$outboundSchema: z.ZodType<
+  CheckoutLinkCreate$Outbound,
+  z.ZodTypeDef,
+  CheckoutLinkCreate
+> = z.object({
+  metadata: z.record(z.string()).optional(),
+  paymentProcessor: z.literal("stripe").default("stripe"),
+  productPriceId: z.string(),
+  successUrl: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    paymentProcessor: "payment_processor",
+    productPriceId: "product_price_id",
+    successUrl: "success_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinkCreate$ {
+  /** @deprecated use `CheckoutLinkCreate$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinkCreate$inboundSchema;
+  /** @deprecated use `CheckoutLinkCreate$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinkCreate$outboundSchema;
+  /** @deprecated use `CheckoutLinkCreate$Outbound` instead. */
+  export type Outbound = CheckoutLinkCreate$Outbound;
+}

package/src/models/components/checkoutlinksortproperty.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CheckoutLinkSortProperty = {
+  CreatedAt: "created_at",
+  MinusCreatedAt: "-created_at",
+} as const;
+export type CheckoutLinkSortProperty = ClosedEnum<
+  typeof CheckoutLinkSortProperty
+>;
+
+/** @internal */
+export const CheckoutLinkSortProperty$inboundSchema: z.ZodNativeEnum<
+  typeof CheckoutLinkSortProperty
+> = z.nativeEnum(CheckoutLinkSortProperty);
+
+/** @internal */
+export const CheckoutLinkSortProperty$outboundSchema: z.ZodNativeEnum<
+  typeof CheckoutLinkSortProperty
+> = CheckoutLinkSortProperty$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinkSortProperty$ {
+  /** @deprecated use `CheckoutLinkSortProperty$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinkSortProperty$inboundSchema;
+  /** @deprecated use `CheckoutLinkSortProperty$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinkSortProperty$outboundSchema;
+}

package/src/models/components/checkoutlinkupdate.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Schema to update an existing checkout link.
+ */
+export type CheckoutLinkUpdate = {
+  /**
+   * Key-value object allowing you to store additional information.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be a string with a maximum length of **500 characters**.
+   * You can store up to **50 key-value pairs**.
+   */
+  metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.
+   */
+  successUrl?: string | null | undefined;
+};
+
+/** @internal */
+export const CheckoutLinkUpdate$inboundSchema: z.ZodType<
+  CheckoutLinkUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metadata: z.nullable(z.record(z.string())).optional(),
+  success_url: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "success_url": "successUrl",
+  });
+});
+
+/** @internal */
+export type CheckoutLinkUpdate$Outbound = {
+  metadata?: { [k: string]: string } | null | undefined;
+  success_url?: string | null | undefined;
+};
+
+/** @internal */
+export const CheckoutLinkUpdate$outboundSchema: z.ZodType<
+  CheckoutLinkUpdate$Outbound,
+  z.ZodTypeDef,
+  CheckoutLinkUpdate
+> = z.object({
+  metadata: z.nullable(z.record(z.string())).optional(),
+  successUrl: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    successUrl: "success_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutLinkUpdate$ {
+  /** @deprecated use `CheckoutLinkUpdate$inboundSchema` instead. */
+  export const inboundSchema = CheckoutLinkUpdate$inboundSchema;
+  /** @deprecated use `CheckoutLinkUpdate$outboundSchema` instead. */
+  export const outboundSchema = CheckoutLinkUpdate$outboundSchema;
+  /** @deprecated use `CheckoutLinkUpdate$Outbound` instead. */
+  export type Outbound = CheckoutLinkUpdate$Outbound;
+}