@polar-sh/sdk 0.7.0 → 0.8.0

package/README.md

@@ -86,16 +86,16 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Polar } from "@polar-sh/sdk";
 
 const polar = new Polar({
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -106,86 +106,62 @@ run();
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [users.benefits](docs/sdks/polarbenefits/README.md)
-
-* [list](docs/sdks/polarbenefits/README.md#list) - List Benefits
-* [get](docs/sdks/polarbenefits/README.md#get) - Get Benefit
-
-### [users.orders](docs/sdks/polarorders/README.md)
+<details open>
+<summary>Available methods</summary>
 
-* [list](docs/sdks/polarorders/README.md#list) - List Orders
-* [get](docs/sdks/polarorders/README.md#get) - Get Order
-* [invoice](docs/sdks/polarorders/README.md#invoice) - Get Order Invoice
-
-### [users.subscriptions](docs/sdks/polarsubscriptions/README.md)
+### [advertisements](docs/sdks/advertisements/README.md)
 
-* [list](docs/sdks/polarsubscriptions/README.md#list) - List Subscriptions
-* [create](docs/sdks/polarsubscriptions/README.md#create) - Create Free Subscription
-* [get](docs/sdks/polarsubscriptions/README.md#get) - Get Subscription
-* [update](docs/sdks/polarsubscriptions/README.md#update) - Update Subscription
-* [cancel](docs/sdks/polarsubscriptions/README.md#cancel) - Cancel Subscription
+* [list](docs/sdks/advertisements/README.md#list) - List Campaigns
+* [get](docs/sdks/advertisements/README.md#get) - Get Campaign
 
-### [users.advertisements](docs/sdks/polaradvertisements/README.md)
+### [articles](docs/sdks/articles/README.md)
 
-* [list](docs/sdks/polaradvertisements/README.md#list) - List Advertisements
-* [create](docs/sdks/polaradvertisements/README.md#create) - Create Advertisement
-* [get](docs/sdks/polaradvertisements/README.md#get) - Get Advertisement
-* [update](docs/sdks/polaradvertisements/README.md#update) - Update Advertisement
-* [delete](docs/sdks/polaradvertisements/README.md#delete) - Delete Advertisement
-* [enable](docs/sdks/polaradvertisements/README.md#enable) - Enable Advertisement
+* [list](docs/sdks/articles/README.md#list) - List Articles
+* [create](docs/sdks/articles/README.md#create) - Create Article
+* [get](docs/sdks/articles/README.md#get) - Get Article
+* [update](docs/sdks/articles/README.md#update) - Update Article
+* [delete](docs/sdks/articles/README.md#delete) - Delete Article
+* [receivers](docs/sdks/articles/README.md#receivers) - Get Article Receivers Count
+* [preview](docs/sdks/articles/README.md#preview) - Send Article Preview
+* [send](docs/sdks/articles/README.md#send) - Send Article
 
-### [users.downloadables](docs/sdks/downloadables/README.md)
+### [benefits](docs/sdks/benefits/README.md)
 
-* [list](docs/sdks/downloadables/README.md#list) - List Downloadables
-* [get](docs/sdks/downloadables/README.md#get) - Get Downloadable
+* [list](docs/sdks/benefits/README.md#list) - List Benefits
+* [create](docs/sdks/benefits/README.md#create) - Create Benefit
+* [get](docs/sdks/benefits/README.md#get) - Get Benefit
+* [update](docs/sdks/benefits/README.md#update) - Update Benefit
+* [delete](docs/sdks/benefits/README.md#delete) - Delete Benefit
+* [grants](docs/sdks/benefits/README.md#grants) - List Benefit Grants
 
-### [users.licenseKeys](docs/sdks/polarlicensekeys/README.md)
+### [checkouts](docs/sdks/checkouts/README.md)
 
-* [list](docs/sdks/polarlicensekeys/README.md#list) - List License Keys
-* [get](docs/sdks/polarlicensekeys/README.md#get) - Get License Key
-* [validate](docs/sdks/polarlicensekeys/README.md#validate) - Validate License Key
-* [activate](docs/sdks/polarlicensekeys/README.md#activate) - Activate License Key
-* [deactivate](docs/sdks/polarlicensekeys/README.md#deactivate) - Deactivate License Key
+* [create](docs/sdks/checkouts/README.md#create) - Create Checkout
+* [get](docs/sdks/checkouts/README.md#get) - Get Checkout
 
 ### [externalOrganizations](docs/sdks/externalorganizations/README.md)
 
 * [list](docs/sdks/externalorganizations/README.md#list) - List External Organizations
 
-### [repositories](docs/sdks/repositories/README.md)
-
-* [list](docs/sdks/repositories/README.md#list) - List Repositories
-* [get](docs/sdks/repositories/README.md#get) - Get Repository
-* [update](docs/sdks/repositories/README.md#update) - Update Repository
-
-### [organizations](docs/sdks/organizations/README.md)
-
-* [list](docs/sdks/organizations/README.md#list) - List Organizations
-* [create](docs/sdks/organizations/README.md#create) - Create Organization
-* [get](docs/sdks/organizations/README.md#get) - Get Organization
-* [update](docs/sdks/organizations/README.md#update) - Update Organization
-
-### [subscriptions](docs/sdks/subscriptions/README.md)
+### [files](docs/sdks/files/README.md)
 
-* [list](docs/sdks/subscriptions/README.md#list) - List Subscriptions
-* [create](docs/sdks/subscriptions/README.md#create) - Create Free Subscription
-* [importSubscriptions](docs/sdks/subscriptions/README.md#importsubscriptions) - Import Subscriptions
-* [export](docs/sdks/subscriptions/README.md#export) - Export Subscriptions
+* [list](docs/sdks/files/README.md#list) - List Files
+* [create](docs/sdks/files/README.md#create) - Create File
+* [uploaded](docs/sdks/files/README.md#uploaded) - Complete File Upload
+* [update](docs/sdks/files/README.md#update) - Update File
+* [delete](docs/sdks/files/README.md#delete) - Delete File
 
-### [articles](docs/sdks/articles/README.md)
+### [licenseKeys](docs/sdks/licensekeys/README.md)
 
-* [list](docs/sdks/articles/README.md#list) - List Articles
-* [create](docs/sdks/articles/README.md#create) - Create Article
-* [get](docs/sdks/articles/README.md#get) - Get Article
-* [update](docs/sdks/articles/README.md#update) - Update Article
-* [delete](docs/sdks/articles/README.md#delete) - Delete Article
-* [receivers](docs/sdks/articles/README.md#receivers) - Get Article Receivers Count
-* [preview](docs/sdks/articles/README.md#preview) - Send Article Preview
-* [send](docs/sdks/articles/README.md#send) - Send Article
+* [list](docs/sdks/licensekeys/README.md#list) - List License Keys
+* [get](docs/sdks/licensekeys/README.md#get) - Get License Key
+* [update](docs/sdks/licensekeys/README.md#update) - Update License Key
+* [getActivation](docs/sdks/licensekeys/README.md#getactivation) - Get Activation
 
-### [advertisements](docs/sdks/advertisements/README.md)
+### [metrics](docs/sdks/metrics/README.md)
 
-* [list](docs/sdks/advertisements/README.md#list) - List Campaigns
-* [get](docs/sdks/advertisements/README.md#get) - Get Campaign
+* [get](docs/sdks/metrics/README.md#get) - Get Metrics
+* [limits](docs/sdks/metrics/README.md#limits) - Get Metrics Limits
 
 ### [oauth2](docs/sdks/oauth2/README.md)
 
@@ -194,7 +170,7 @@ run();
 * [introspect](docs/sdks/oauth2/README.md#introspect) - Introspect Token
 * [userinfo](docs/sdks/oauth2/README.md#userinfo) - Get User Info
 
-### [oauth2.clients](docs/sdks/clients/README.md)
+#### [oauth2.clients](docs/sdks/clients/README.md)
 
 * [list](docs/sdks/clients/README.md#list) - List Clients
 * [create](docs/sdks/clients/README.md#create) - Create Client
@@ -202,14 +178,19 @@ run();
 * [update](docs/sdks/clients/README.md#update) - Update Client
 * [delete](docs/sdks/clients/README.md#delete) - Delete Client
 
-### [benefits](docs/sdks/benefits/README.md)
+### [orders](docs/sdks/orders/README.md)
+
+* [list](docs/sdks/orders/README.md#list) - List Orders
+* [get](docs/sdks/orders/README.md#get) - Get Order
+* [invoice](docs/sdks/orders/README.md#invoice) - Get Order Invoice
+
+### [organizations](docs/sdks/organizations/README.md)
+
+* [list](docs/sdks/organizations/README.md#list) - List Organizations
+* [create](docs/sdks/organizations/README.md#create) - Create Organization
+* [get](docs/sdks/organizations/README.md#get) - Get Organization
+* [update](docs/sdks/organizations/README.md#update) - Update Organization
 
-* [list](docs/sdks/benefits/README.md#list) - List Benefits
-* [create](docs/sdks/benefits/README.md#create) - Create Benefit
-* [get](docs/sdks/benefits/README.md#get) - Get Benefit
-* [update](docs/sdks/benefits/README.md#update) - Update Benefit
-* [delete](docs/sdks/benefits/README.md#delete) - Delete Benefit
-* [grants](docs/sdks/benefits/README.md#grants) - List Benefit Grants
 
 ### [products](docs/sdks/products/README.md)
 
@@ -219,36 +200,64 @@ run();
 * [update](docs/sdks/products/README.md#update) - Update Product
 * [updateBenefits](docs/sdks/products/README.md#updatebenefits) - Update Product Benefits
 
-### [orders](docs/sdks/orders/README.md)
+### [repositories](docs/sdks/repositories/README.md)
 
-* [list](docs/sdks/orders/README.md#list) - List Orders
-* [get](docs/sdks/orders/README.md#get) - Get Order
-* [invoice](docs/sdks/orders/README.md#invoice) - Get Order Invoice
+* [list](docs/sdks/repositories/README.md#list) - List Repositories
+* [get](docs/sdks/repositories/README.md#get) - Get Repository
+* [update](docs/sdks/repositories/README.md#update) - Update Repository
 
-### [checkouts](docs/sdks/checkouts/README.md)
+### [subscriptions](docs/sdks/subscriptions/README.md)
 
-* [create](docs/sdks/checkouts/README.md#create) - Create Checkout
-* [get](docs/sdks/checkouts/README.md#get) - Get Checkout
+* [list](docs/sdks/subscriptions/README.md#list) - List Subscriptions
+* [create](docs/sdks/subscriptions/README.md#create) - Create Free Subscription
+* [importSubscriptions](docs/sdks/subscriptions/README.md#importsubscriptions) - Import Subscriptions
+* [export](docs/sdks/subscriptions/README.md#export) - Export Subscriptions
 
-### [files](docs/sdks/files/README.md)
+### [users](docs/sdks/users/README.md)
 
-* [list](docs/sdks/files/README.md#list) - List Files
-* [create](docs/sdks/files/README.md#create) - Create File
-* [uploaded](docs/sdks/files/README.md#uploaded) - Complete File Upload
-* [update](docs/sdks/files/README.md#update) - Update File
-* [delete](docs/sdks/files/README.md#delete) - Delete File
 
-### [metrics](docs/sdks/metrics/README.md)
+#### [users.advertisements](docs/sdks/polaradvertisements/README.md)
 
-* [get](docs/sdks/metrics/README.md#get) - Get Metrics
-* [limits](docs/sdks/metrics/README.md#limits) - Get Metrics Limits
+* [list](docs/sdks/polaradvertisements/README.md#list) - List Advertisements
+* [create](docs/sdks/polaradvertisements/README.md#create) - Create Advertisement
+* [get](docs/sdks/polaradvertisements/README.md#get) - Get Advertisement
+* [update](docs/sdks/polaradvertisements/README.md#update) - Update Advertisement
+* [delete](docs/sdks/polaradvertisements/README.md#delete) - Delete Advertisement
+* [enable](docs/sdks/polaradvertisements/README.md#enable) - Enable Advertisement
 
-### [licenseKeys](docs/sdks/licensekeys/README.md)
+#### [users.benefits](docs/sdks/polarbenefits/README.md)
 
-* [list](docs/sdks/licensekeys/README.md#list) - List License Keys
-* [get](docs/sdks/licensekeys/README.md#get) - Get License Key
-* [update](docs/sdks/licensekeys/README.md#update) - Update License Key
-* [getActivation](docs/sdks/licensekeys/README.md#getactivation) - Get Activation
+* [list](docs/sdks/polarbenefits/README.md#list) - List Benefits
+* [get](docs/sdks/polarbenefits/README.md#get) - Get Benefit
+
+#### [users.downloadables](docs/sdks/downloadables/README.md)
+
+* [list](docs/sdks/downloadables/README.md#list) - List Downloadables
+* [get](docs/sdks/downloadables/README.md#get) - Get Downloadable
+
+#### [users.licenseKeys](docs/sdks/polarlicensekeys/README.md)
+
+* [list](docs/sdks/polarlicensekeys/README.md#list) - List License Keys
+* [get](docs/sdks/polarlicensekeys/README.md#get) - Get License Key
+* [validate](docs/sdks/polarlicensekeys/README.md#validate) - Validate License Key
+* [activate](docs/sdks/polarlicensekeys/README.md#activate) - Activate License Key
+* [deactivate](docs/sdks/polarlicensekeys/README.md#deactivate) - Deactivate License Key
+
+#### [users.orders](docs/sdks/polarorders/README.md)
+
+* [list](docs/sdks/polarorders/README.md#list) - List Orders
+* [get](docs/sdks/polarorders/README.md#get) - Get Order
+* [invoice](docs/sdks/polarorders/README.md#invoice) - Get Order Invoice
+
+#### [users.subscriptions](docs/sdks/polarsubscriptions/README.md)
+
+* [list](docs/sdks/polarsubscriptions/README.md#list) - List Subscriptions
+* [create](docs/sdks/polarsubscriptions/README.md#create) - Create Free Subscription
+* [get](docs/sdks/polarsubscriptions/README.md#get) - Get Subscription
+* [update](docs/sdks/polarsubscriptions/README.md#update) - Update Subscription
+* [cancel](docs/sdks/polarsubscriptions/README.md#cancel) - Cancel Subscription
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Standalone functions [standalone-funcs] -->
@@ -368,16 +377,16 @@ 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"] ?? "",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -404,17 +413,17 @@ import { Polar } from "@polar-sh/sdk";
 import { openAsBlob } from "node:fs";
 
 const polar = new Polar({
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.subscriptions.importSubscriptions({
-        file: await openAsBlob("./sample-file"),
-        organizationId: "<value>",
-    });
+  const result = await polar.subscriptions.importSubscriptions({
+    file: await openAsBlob("example.file"),
+    organizationId: "<value>",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -432,30 +441,27 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Polar } from "@polar-sh/sdk";
 
 const polar = new Polar({
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  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,
-            },
-        }
-    );
+  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);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -467,26 +473,26 @@ If you'd like to override the default retry strategy for all operations that sup
 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,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+    retryConnectionErrors: false,
+  },
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -509,40 +515,43 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```typescript
 import { Polar } from "@polar-sh/sdk";
-import { HTTPValidationError, SDKValidationError } from "@polar-sh/sdk/models/errors";
+import {
+  HTTPValidationError,
+  SDKValidationError,
+} from "@polar-sh/sdk/models/errors";
 
 const polar = new Polar({
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await polar.users.benefits.list({});
-    } 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;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await polar.users.benefits.list({});
 
     for await (const page of result) {
-        // Handle the page
-        console.log(page);
+      // 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();
@@ -565,17 +574,17 @@ You can override the default server globally by passing a server index to the `s
 import { Polar } from "@polar-sh/sdk";
 
 const polar = new Polar({
-    serverIdx: 0,
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  serverIdx: 0,
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -591,17 +600,17 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { Polar } from "@polar-sh/sdk";
 
 const polar = new Polar({
-    serverURL: "https://api.polar.sh",
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  serverURL: "https://api.polar.sh",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();
@@ -674,16 +683,16 @@ To authenticate with the API the `accessToken` parameter must be set when initia
 import { Polar } from "@polar-sh/sdk";
 
 const polar = new Polar({
-    accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-    const result = await polar.users.benefits.list({});
+  const result = await polar.users.benefits.list({});
 
-    for await (const page of result) {
-        // Handle the page
-        console.log(page);
-    }
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
 }
 
 run();

package/docs/sdks/advertisements/README.md

@@ -25,7 +25,7 @@ async function run() {
   const result = await polar.advertisements.list({
     benefitId: "<value>",
   });
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -107,7 +107,7 @@ async function run() {
   const result = await polar.advertisements.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/articles/README.md

@@ -29,7 +29,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.articles.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -109,7 +109,7 @@ async function run() {
   const result = await polar.articles.create({
     title: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -187,7 +187,7 @@ async function run() {
   const result = await polar.articles.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -267,7 +267,7 @@ async function run() {
     id: "<value>",
     articleUpdate: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -348,8 +348,6 @@ async function run() {
   await polar.articles.delete({
     id: "<value>",
   });
-
-  
 }
 
 run();
@@ -426,7 +424,7 @@ async function run() {
   const result = await polar.articles.receivers({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -507,7 +505,7 @@ async function run() {
       email: "Eileen56@yahoo.com",
     },
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -533,7 +531,7 @@ async function run() {
   const res = await articlesPreview(polar, {
     id: "<value>",
     articlePreview: {
-      email: "Christian.Smith@hotmail.com",
+      email: "Eileen56@yahoo.com",
     },
   });
 
@@ -590,7 +588,7 @@ async function run() {
   const result = await polar.articles.send({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }