@polar-sh/sdk
v0.8.1
Published
Developer-friendly & type-safe Typescript SDK specifically catered to leverage [Polar](https://polar.sh) API.
Downloads
359
Readme
@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
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- Pagination
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
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({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
Available Resources and Operations
advertisements
articles
- list - List Articles
- create - Create Article
- get - Get Article
- update - Update Article
- delete - Delete Article
- receivers - Get Article Receivers Count
- preview - Send Article Preview
- send - Send Article
benefits
- list - List Benefits
- create - Create Benefit
- get - Get Benefit
- update - Update Benefit
- delete - Delete Benefit
- grants - List Benefit Grants
checkouts
externalOrganizations
- list - List External Organizations
files
- list - List Files
- create - Create File
- uploaded - Complete File Upload
- update - Update File
- delete - Delete File
licenseKeys
- list - List License Keys
- get - Get License Key
- update - Update License Key
- getActivation - Get Activation
metrics
oauth2
- token - Request Token
- revoke - Revoke Token
- introspect - Introspect Token
- userinfo - Get User Info
oauth2.clients
- list - List Clients
- create - Create Client
- get - Get Client
- update - Update Client
- delete - Delete Client
orders
organizations
- list - List Organizations
- create - Create Organization
- get - Get Organization
- update - Update Organization
products
- list - List Products
- create - Create Product
- get - Get Product
- update - Update Product
- updateBenefits - Update Product Benefits
repositories
subscriptions
- list - List Subscriptions
- create - Create Free Subscription
- importSubscriptions - Import Subscriptions
- export - Export Subscriptions
users
users.advertisements
- list - List Advertisements
- create - Create Advertisement
- get - Get Advertisement
- update - Update Advertisement
- delete - Delete Advertisement
- enable - Enable Advertisement
users.benefits
users.downloadables
users.licenseKeys
- list - List License Keys
- get - Get License Key
- validate - Validate License Key
- activate - Activate License Key
- deactivate - Deactivate License Key
users.orders
users.subscriptions
- list - List Subscriptions
- create - Create Free Subscription
- get - Get Subscription
- update - Update Subscription
- cancel - Cancel Subscription
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.
- advertisementsGet
- advertisementsList
- articlesCreate
- articlesDelete
- articlesGet
- articlesList
- articlesPreview
- articlesReceivers
- articlesSend
- articlesUpdate
- benefitsCreate
- benefitsDelete
- benefitsGet
- benefitsGrants
- benefitsList
- benefitsUpdate
- checkoutsCreate
- checkoutsGet
- externalOrganizationsList
- filesCreate
- filesDelete
- filesList
- filesUpdate
- filesUploaded
- licenseKeysGetActivation
- licenseKeysGet
- licenseKeysList
- licenseKeysUpdate
- metricsGet
- metricsLimits
- oauth2ClientsCreate
- oauth2ClientsDelete
- oauth2ClientsGet
- oauth2ClientsList
- oauth2ClientsUpdate
- oauth2Introspect
- oauth2Revoke
- oauth2Token
- oauth2Userinfo
- ordersGet
- ordersInvoice
- ordersList
- organizationsCreate
- organizationsGet
- organizationsList
- organizationsUpdate
- productsCreate
- productsGet
- productsList
- productsUpdateBenefits
- productsUpdate
- repositoriesGet
- repositoriesList
- repositoriesUpdate
- subscriptionsCreate
- subscriptionsExport
- subscriptionsImportSubscriptions
- subscriptionsList
- usersAdvertisementsCreate
- usersAdvertisementsDelete
- usersAdvertisementsEnable
- usersAdvertisementsGet
- usersAdvertisementsList
- usersAdvertisementsUpdate
- usersBenefitsGet
- usersBenefitsList
- usersDownloadablesGet
- usersDownloadablesList
- usersLicenseKeysActivate
- usersLicenseKeysDeactivate
- usersLicenseKeysGet
- usersLicenseKeysList
- usersLicenseKeysValidate
- usersOrdersGet
- usersOrdersInvoice
- usersOrdersList
- usersSubscriptionsCancel
- usersSubscriptionsCreate
- usersSubscriptionsGet
- usersSubscriptionsList
- usersSubscriptionsUpdate
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.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlob
function innode:fs
.- Bun: The native
Bun.file
function produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
File
when reading the value from an<input type="file">
element.- Node.js v18: A file stream can be created using the
fileFrom
helper fromfetch-blob/from.js
.
import { Polar } from "@polar-sh/sdk";
import { openAsBlob } from "node:fs";
const polar = new Polar({
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.subscriptions.importSubscriptions({
file: await openAsBlob("example.file"),
organizationId: "<value>",
});
// Handle the result
console.log(result);
}
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.users.benefits.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.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();
Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.HTTPValidationError | 422 | application/json | | errors.SDKError | 4xx-5xx | / |
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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
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.users.benefits.list({});
for await (const page of result) {
// Handle the page
console.log(page);
}
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
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: {
throw err;
}
}
}
}
run();
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx
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 indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | https://api.polar.sh
| None |
import { Polar } from "@polar-sh/sdk";
const polar = new Polar({
serverIdx: 0,
accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await polar.users.benefits.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
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.users.benefits.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.users.benefits.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.