Skip to content

Latest commit

 

History

History
967 lines (774 loc) · 36.8 KB

README.md

File metadata and controls

967 lines (774 loc) · 36.8 KB
Raw

@polar-sh/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage Polar API.

Warning

Starting version >v0.6.0, we changed our SDK generator. It's not backward compatible with previous versions.

Summary

Polar API: Polar HTTP and Webhooks API

Read the docs at https://docs.polar.sh/api

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @polar-sh/sdk

PNPM

pnpm add @polar-sh/sdk

Bun

bun add @polar-sh/sdk

Yarn

yarn add @polar-sh/sdk zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Polar } from "@polar-sh/sdk";

const polar = new Polar();

async function run() {
  const result = await polar.endpointcheckoutCreatedPost({
    data: {
      createdAt: new Date("2024-11-12T14:26:42.882Z"),
      modifiedAt: new Date("2023-05-28T05:08:06.235Z"),
      id: "<value>",
      status: "failed",
      clientSecret: "<value>",
      url: "https://heavy-beret.com/",
      expiresAt: new Date("2022-02-25T02:26:48.460Z"),
      successUrl: "https://sardonic-final.info/",
      embedOrigin: "<value>",
      amount: 962818,
      taxAmount: 6400,
      currency: "Yen",
      subtotalAmount: 648726,
      totalAmount: 210702,
      productId: "<value>",
      productPriceId: "<value>",
      discountId: "<value>",
      allowDiscountCodes: true,
      isDiscountApplicable: false,
      isFreeProductPrice: false,
      isPaymentRequired: false,
      isPaymentSetupRequired: false,
      isPaymentFormRequired: false,
      customerId: "<value>",
      customerName: "<value>",
      customerEmail: "Ryley_Erdman@hotmail.com",
      customerIpAddress: "<value>",
      customerBillingAddress: {
        country: "South Africa",
      },
      customerTaxId: "<id>",
      paymentProcessorMetadata: {},
      metadata: {
        "key": 18677,
        "key1": 95370,
      },
      product: {
        createdAt: new Date("2022-04-02T00:05:42.586Z"),
        modifiedAt: new Date("2023-12-16T03:02:38.803Z"),
        id: "<value>",
        name: "<value>",
        description:
          "for embarrassment untidy long-term near honestly separate yet",
        isRecurring: true,
        isArchived: false,
        organizationId: "<value>",
        prices: [
          {
            createdAt: new Date("2024-11-19T15:59:15.588Z"),
            modifiedAt: new Date("2022-11-17T00:11:23.972Z"),
            id: "<value>",
            isArchived: false,
            productId: "<value>",
            priceCurrency: "<value>",
            minimumAmount: 363560,
            maximumAmount: 75876,
            presetAmount: 82334,
          },
        ],
        benefits: [
          {
            createdAt: new Date("2023-08-22T00:47:02.059Z"),
            modifiedAt: new Date("2023-06-04T10:32:44.101Z"),
            id: "<value>",
            type: "license_keys",
            description: "within jacket unless",
            selectable: false,
            deletable: false,
            organizationId: "<value>",
          },
        ],
        medias: [
          {
            id: "<value>",
            organizationId: "<value>",
            name: "<value>",
            path: "/private/var",
            mimeType: "<value>",
            size: 245189,
            storageVersion: "<value>",
            checksumEtag: "<value>",
            checksumSha256Base64: "<value>",
            checksumSha256Hex: "<value>",
            lastModifiedAt: new Date("2022-11-03T15:00:03.276Z"),
            version: "<value>",
            isUploaded: false,
            createdAt: new Date("2024-06-07T13:47:02.365Z"),
            sizeReadable: "<value>",
            publicUrl: "https://webbed-experience.name/",
          },
        ],
      },
      productPrice: {
        createdAt: new Date("2024-02-15T09:22:19.644Z"),
        modifiedAt: new Date("2022-12-28T20:59:29.904Z"),
        id: "<value>",
        isArchived: false,
        productId: "<value>",
        priceCurrency: "<value>",
        minimumAmount: 417896,
        maximumAmount: 962818,
        presetAmount: 6400,
        recurringInterval: "month",
      },
      discount: {
        duration: "repeating",
        type: "fixed",
        basisPoints: 341163,
        id: "<value>",
        name: "<value>",
        code: "<value>",
      },
      subscriptionId: "<value>",
      attachedCustomFields: [
        {
          customFieldId: "<value>",
          customField: {
            createdAt: new Date("2022-08-19T22:18:44.316Z"),
            modifiedAt: new Date("2023-04-29T23:39:10.699Z"),
            id: "<value>",
            metadata: {
              "key": false,
            },
            slug: "<value>",
            name: "<value>",
            organizationId: "<value>",
            properties: {
              options: [
                {
                  value: "<value>",
                  label: "<value>",
                },
              ],
            },
          },
          order: 996863,
          required: false,
        },
        {
          customFieldId: "<value>",
          customField: {
            createdAt: new Date("2023-07-03T09:46:29.338Z"),
            modifiedAt: new Date("2024-01-25T18:08:49.597Z"),
            id: "<value>",
            metadata: {
              "key": false,
            },
            slug: "<value>",
            name: "<value>",
            organizationId: "<value>",
            properties: {},
          },
          order: 72589,
          required: true,
        },
        {
          customFieldId: "<value>",
          customField: {
            createdAt: new Date("2024-07-31T13:25:31.669Z"),
            modifiedAt: new Date("2022-11-12T09:40:10.044Z"),
            id: "<value>",
            metadata: {
              "key": "<value>",
            },
            slug: "<value>",
            name: "<value>",
            organizationId: "<value>",
            properties: {},
          },
          order: 161325,
          required: true,
        },
      ],
      customerMetadata: {
        "key": "<value>",
        "key1": "<value>",
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();

Webhook support

The SDK has built-in support to validate webhook events. Here is an example with Express.js:

import express, { Request, Response } from "express";
import { validateEvent, WebhookVerificationError } from "@polar-sh/sdk/webhooks";

const app = express();

app.post("/webhook", express.raw({ type: "application/json" }), (req: Request, res: Response) => {
  try {
    const event = validateEvent(req.body, req.headers, process.env["POLAR_WEBHOOK_SECRET"] ?? "");

    // Process the event

    res.status(202).send('')
  } catch (error) {
    if (error instanceof WebhookVerificationError) {
      res.status(403).send('')
    }
    throw error
  }
});

Available Resources and Operations

Available methods

advertisements

  • list - List Campaigns
  • get - Get Campaign

benefits

checkoutLinks

  • list - List Checkout Links
  • create - Create Checkout Link
  • get - Get Checkout Link
  • update - Update Checkout Link
  • delete - Delete Checkout Link

checkouts

  • create - Create Checkout ⚠️ Deprecated Use create instead.
  • get - Get Checkout ⚠️ Deprecated

checkouts.custom

  • list - List Checkout Sessions
  • create - Create Checkout Session
  • get - Get Checkout Session
  • update - Update Checkout Session
  • clientGet - Get Checkout Session from Client
  • clientUpdate - Update Checkout Session from Client
  • clientConfirm - Confirm Checkout Session from Client

customerPortal

customerPortal.benefitGrants

  • list - List Benefit Grants
  • get - Get Benefit Grant
  • update - Update Benefit Grant

customerPortal.customers

  • get - Get Customer

customerPortal.downloadables

  • list - List Downloadables
  • get - Get Downloadable

customerPortal.licenseKeys

customerPortal.orders

customerPortal.organizations

  • get - Get Organization

customerPortal.subscriptions

  • list - List Subscriptions
  • get - Get Subscription
  • update - Update Subscription
  • cancel - Cancel Subscription

customers

customerSessions

  • create - Create Customer Session

customFields

  • list - List Custom Fields
  • create - Create Custom Field
  • get - Get Custom Field
  • update - Update Custom Field
  • delete - Delete Custom Field

discounts

externalOrganizations

  • list - List External Organizations

files

licenseKeys

metrics

  • get - Get Metrics
  • limits - Get Metrics Limits

oauth2

oauth2.clients

orders

organizations

  • list - List Organizations
  • create - Create Organization
  • get - Get Organization
  • update - Update Organization

products

repositories

  • list - List Repositories
  • get - Get Repository
  • update - Update Repository

subscriptions

  • list - List Subscriptions
  • export - Export Subscriptions

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({});

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({});

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the list method may throw the following errors:

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { Polar } from "@polar-sh/sdk";
import {
  HTTPValidationError,
  SDKValidationError,
} from "@polar-sh/sdk/models/errors";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  let result;
  try {
    result = await polar.externalOrganizations.list({});

    for await (const page of result) {
      // Handle the page
      console.log(page);
    }
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof HTTPValidationError): {
        // Handle err.data$: HTTPValidationErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised or unexpected error

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name Server
production https://api.polar.sh
sandbox https://sandbox-api.polar.sh

Example

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  server: "sandbox",
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({});

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  serverURL: "https://api.polar.sh",
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({});

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Polar } from "@polar-sh/sdk";
import { HTTPClient } from "@polar-sh/sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Polar({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
accessToken http HTTP Bearer POLAR_ACCESS_TOKEN

To authenticate with the API the accessToken parameter must be set when initializing the SDK client instance. For example:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.externalOrganizations.list({});

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Polar } from "@polar-sh/sdk";

const sdk = new Polar({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable POLAR_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy