@polar-sh/sdk 1.0.0-alpha.10 → 1.0.0-alpha.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Polar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,54 @@
 # Polar TypeScript SDK
+
+The official TypeScript client for the [Polar API](https://polar.sh/docs/api-reference).
+
+## Installation
+
+```bash
+pnpm add @polar-sh/sdk
+```
+
+or, with `npm`:
+
+```bash
+npm install @polar-sh/sdk
+```
+
+## Quick Start
+
+Create an [organization access token](https://polar.sh/docs/integrate/oat) and use the client for
+the current API version:
+
+```typescript
+import { createPolar } from "@polar-sh/sdk/2026-04";
+
+const polar = createPolar({
+    accessToken: "polar_oat_xxx",
+});
+
+const customerState = await polar.customers.getStateExternal("customer_external_id");
+console.log(customerState);
+```
+
+The client uses the production environment by default. To use the sandbox, pass
+`environment: "sandbox"` to `createPolar`. Sandbox and production access tokens are separate.
+
+Keep organization access tokens on the server and never expose them in browser or client-side
+code.
+
+## Individual API Functions
+
+To import individual API functions for tree-shaking, create a core client and pass it to the
+function:
+
+```typescript
+import { createPolarCore } from "@polar-sh/sdk/2026-04";
+import { getStateExternalCustomers } from "@polar-sh/sdk/2026-04/services/customers";
+
+const polar = createPolarCore({
+    accessToken: "polar_oat_xxx",
+});
+
+const customerState = await getStateExternalCustomers(polar)("customer_external_id");
+console.log(customerState);
+```