@polar-sh/sdk 0.34.4 → 0.34.5

package/docs/sdks/checkouts/README.md

@@ -354,7 +354,9 @@ Get a checkout session by client secret.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.checkouts.clientGet({
@@ -377,7 +379,9 @@ import { checkoutsClientGet } from "@polar-sh/sdk/funcs/checkoutsClientGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await checkoutsClientGet(polar, {
@@ -425,7 +429,9 @@ Update a checkout session by client secret.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.checkouts.clientUpdate({
@@ -453,7 +459,9 @@ import { checkoutsClientUpdate } from "@polar-sh/sdk/funcs/checkoutsClientUpdate
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await checkoutsClientUpdate(polar, {

package/docs/sdks/customfields/README.md

@@ -107,6 +107,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.customFields.create({
+    type: "select",
     slug: "<value>",
     name: "<value>",
     organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
@@ -137,6 +138,7 @@ const polar = new PolarCore({
 
 async function run() {
   const res = await customFieldsCreate(polar, {
+    type: "select",
     slug: "<value>",
     name: "<value>",
     organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
@@ -269,7 +271,9 @@ const polar = new Polar({
 async function run() {
   const result = await polar.customFields.update({
     id: "<value>",
-    customFieldUpdate: {},
+    customFieldUpdate: {
+      type: "date",
+    },
   });
 
   console.log(result);
@@ -295,7 +299,9 @@ const polar = new PolarCore({
 async function run() {
   const res = await customFieldsUpdate(polar, {
     id: "<value>",
-    customFieldUpdate: {},
+    customFieldUpdate: {
+      type: "date",
+    },
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/files/README.md

@@ -114,6 +114,7 @@ async function run() {
     upload: {
       parts: [],
     },
+    service: "downloadable",
   });
 
   console.log(result);
@@ -145,6 +146,7 @@ async function run() {
     upload: {
       parts: [],
     },
+    service: "downloadable",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/oauth2/README.md

@@ -87,10 +87,13 @@ Request an access token using a valid grant.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.oauth2.token({
+    grantType: "authorization_code",
     clientId: "<id>",
     clientSecret: "<value>",
     code: "<value>",
@@ -113,10 +116,13 @@ import { oauth2Token } from "@polar-sh/sdk/funcs/oauth2Token.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await oauth2Token(polar, {
+    grantType: "authorization_code",
     clientId: "<id>",
     clientSecret: "<value>",
     code: "<value>",
@@ -161,7 +167,9 @@ Revoke an access token or a refresh token.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.oauth2.revoke({
@@ -186,7 +194,9 @@ import { oauth2Revoke } from "@polar-sh/sdk/funcs/oauth2Revoke.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await oauth2Revoke(polar, {
@@ -233,7 +243,9 @@ Get information about an access token.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.oauth2.introspect({
@@ -258,7 +270,9 @@ import { oauth2Introspect } from "@polar-sh/sdk/funcs/oauth2Introspect.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await oauth2Introspect(polar, {

package/docs/sdks/polarlicensekeys/README.md

@@ -177,7 +177,9 @@ Validate a license key.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.customerPortal.licenseKeys.validate({
@@ -201,7 +203,9 @@ import { customerPortalLicenseKeysValidate } from "@polar-sh/sdk/funcs/customerP
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await customerPortalLicenseKeysValidate(polar, {
@@ -249,7 +253,9 @@ Activate a license key instance.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const result = await polar.customerPortal.licenseKeys.activate({
@@ -274,7 +280,9 @@ import { customerPortalLicenseKeysActivate } from "@polar-sh/sdk/funcs/customerP
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await customerPortalLicenseKeysActivate(polar, {
@@ -324,7 +332,9 @@ Deactivate a license key instance.
 ```typescript
 import { Polar } from "@polar-sh/sdk";
 
-const polar = new Polar();
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   await polar.customerPortal.licenseKeys.deactivate({
@@ -349,7 +359,9 @@ import { customerPortalLicenseKeysDeactivate } from "@polar-sh/sdk/funcs/custome
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const polar = new PolarCore();
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
 
 async function run() {
   const res = await customerPortalLicenseKeysDeactivate(polar, {

package/docs/sdks/products/README.md

@@ -111,10 +111,13 @@ async function run() {
     recurringInterval: "year",
     prices: [
       {
+        amountType: "fixed",
         priceAmount: 677078,
         priceCurrency: "usd",
       },
-      {},
+      {
+        amountType: "free",
+      },
     ],
     organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
   });
@@ -145,10 +148,13 @@ async function run() {
     recurringInterval: "year",
     prices: [
       {
+        amountType: "fixed",
         priceAmount: 677078,
         priceCurrency: "usd",
       },
-      {},
+      {
+        amountType: "free",
+      },
     ],
     organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
   });

package/examples/README.md

@@ -0,0 +1,26 @@
+# @polar-sh/sdk Examples
+
+This directory contains example scripts demonstrating how to use the @polar-sh/sdk SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+

package/examples/organizationsList.example.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Example usage of the @polar-sh/sdk SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx organizationsList.ts
+ */
+
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function main() {
+  const result = await polar.list({});
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+main().catch(console.error);