@polar-sh/sdk 0.6.1 → 0.7.1

package/docs/sdks/downloadables/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [list](#list) - List Downloadables
-* [retrieve](#retrieve) - Get Downloadable
+* [get](#get) - Get Downloadable
 
 ## list
 
@@ -23,7 +23,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.users.downloadables.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -86,7 +86,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get Downloadable
 
@@ -100,10 +100,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.users.downloadables.retrieve({
+  const result = await polar.users.downloadables.get({
     token: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -117,7 +117,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { usersDownloadablesRetrieve } from "@polar-sh/sdk/funcs/usersDownloadablesRetrieve.js";
+import { usersDownloadablesGet } from "@polar-sh/sdk/funcs/usersDownloadablesGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -126,7 +126,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await usersDownloadablesRetrieve(polar, {
+  const res = await usersDownloadablesGet(polar, {
     token: "<value>",
   });
 

package/docs/sdks/externalorganizations/README.md

@@ -22,7 +22,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.externalOrganizations.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);

package/docs/sdks/files/README.md

@@ -26,7 +26,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.files.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -117,7 +117,7 @@ async function run() {
       ],
     },
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -217,7 +217,7 @@ async function run() {
       ],
     },
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -307,7 +307,7 @@ async function run() {
     id: "<value>",
     filePatch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -386,8 +386,6 @@ async function run() {
   await polar.files.delete({
     id: "<value>",
   });
-
-  
 }
 
 run();

package/docs/sdks/licensekeys/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [list](#list) - List License Keys
-* [retrieve](#retrieve) - Get License Key
+* [get](#get) - Get License Key
 * [update](#update) - Update License Key
 * [getActivation](#getactivation) - Get Activation
 
@@ -25,7 +25,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.licenseKeys.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -90,7 +90,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get a license key.
 
@@ -104,10 +104,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.licenseKeys.retrieve({
+  const result = await polar.licenseKeys.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -121,7 +121,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { licenseKeysRetrieve } from "@polar-sh/sdk/funcs/licenseKeysRetrieve.js";
+import { licenseKeysGet } from "@polar-sh/sdk/funcs/licenseKeysGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -130,7 +130,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await licenseKeysRetrieve(polar, {
+  const res = await licenseKeysGet(polar, {
     id: "<value>",
   });
 
@@ -188,7 +188,7 @@ async function run() {
     id: "<value>",
     licenseKeyUpdate: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -270,7 +270,7 @@ async function run() {
     id: "<value>",
     activationId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/metrics/README.md

@@ -5,10 +5,10 @@
 
 ### Available Operations
 
-* [retrieve](#retrieve) - Get Metrics
+* [get](#get) - Get Metrics
 * [limits](#limits) - Get Metrics Limits
 
-## retrieve
+## get
 
 Get metrics about your orders and subscriptions.
 
@@ -23,12 +23,12 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.metrics.retrieve({
-    startDate: new RFCDate("2023-02-11"),
-    endDate: new RFCDate("2024-11-01"),
-    interval: "hour",
+  const result = await polar.metrics.get({
+    startDate: new RFCDate("2024-02-07"),
+    endDate: new RFCDate("2022-04-09"),
+    interval: "week",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -42,7 +42,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { metricsRetrieve } from "@polar-sh/sdk/funcs/metricsRetrieve.js";
+import { metricsGet } from "@polar-sh/sdk/funcs/metricsGet.js";
 import { RFCDate } from "@polar-sh/sdk/types";
 
 // Use `PolarCore` for best tree-shaking performance.
@@ -52,10 +52,10 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await metricsRetrieve(polar, {
-    startDate: new RFCDate("2022-12-21"),
-    endDate: new RFCDate("2023-10-22"),
-    interval: "year",
+  const res = await metricsGet(polar, {
+    startDate: new RFCDate("2023-07-26"),
+    endDate: new RFCDate("2022-03-28"),
+    interval: "hour",
   });
 
   if (!res.ok) {
@@ -107,7 +107,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.metrics.limits();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/oauth2/README.md

@@ -30,7 +30,7 @@ async function run() {
     code: "<value>",
     redirectUri: "http://multicolored-chivalry.name",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -112,7 +112,7 @@ async function run() {
     clientId: "<value>",
     clientSecret: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -193,7 +193,7 @@ async function run() {
     clientId: "<value>",
     clientSecret: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -270,7 +270,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.oauth2.userinfo();
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/orders/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [list](#list) - List Orders
-* [retrieve](#retrieve) - Get Order
+* [get](#get) - Get Order
 * [invoice](#invoice) - Get Order Invoice
 
 ## list
@@ -24,7 +24,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.orders.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -87,7 +87,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get an order by ID.
 
@@ -101,10 +101,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.orders.retrieve({
+  const result = await polar.orders.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -118,7 +118,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { ordersRetrieve } from "@polar-sh/sdk/funcs/ordersRetrieve.js";
+import { ordersGet } from "@polar-sh/sdk/funcs/ordersGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -127,7 +127,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await ordersRetrieve(polar, {
+  const res = await ordersGet(polar, {
     id: "<value>",
   });
 
@@ -183,7 +183,7 @@ async function run() {
   const result = await polar.orders.invoice({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/organizations/README.md

@@ -7,7 +7,7 @@
 
 * [list](#list) - List Organizations
 * [create](#create) - Create Organization
-* [retrieve](#retrieve) - Get Organization
+* [get](#get) - Get Organization
 * [update](#update) - Update Organization
 
 ## list
@@ -25,7 +25,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.organizations.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -106,7 +106,7 @@ async function run() {
     name: "<value>",
     slug: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -168,7 +168,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get an organization by ID.
 
@@ -182,10 +182,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.organizations.retrieve({
+  const result = await polar.organizations.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -199,7 +199,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { organizationsRetrieve } from "@polar-sh/sdk/funcs/organizationsRetrieve.js";
+import { organizationsGet } from "@polar-sh/sdk/funcs/organizationsGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -208,7 +208,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await organizationsRetrieve(polar, {
+  const res = await organizationsGet(polar, {
     id: "<value>",
   });
 
@@ -265,7 +265,7 @@ async function run() {
     id: "<value>",
     organizationUpdate: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/polaradvertisements/README.md

@@ -7,7 +7,7 @@
 
 * [list](#list) - List Advertisements
 * [create](#create) - Create Advertisement
-* [retrieve](#retrieve) - Get Advertisement
+* [get](#get) - Get Advertisement
 * [update](#update) - Update Advertisement
 * [delete](#delete) - Delete Advertisement
 * [enable](#enable) - Enable Advertisement
@@ -27,7 +27,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.users.advertisements.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -109,7 +109,7 @@ async function run() {
     text: "<value>",
     linkUrl: "http://flashy-cartload.net",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -172,7 +172,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get an advertisement campaign by ID.
 
@@ -186,10 +186,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.users.advertisements.retrieve({
+  const result = await polar.users.advertisements.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -203,7 +203,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { usersAdvertisementsRetrieve } from "@polar-sh/sdk/funcs/usersAdvertisementsRetrieve.js";
+import { usersAdvertisementsGet } from "@polar-sh/sdk/funcs/usersAdvertisementsGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -212,7 +212,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await usersAdvertisementsRetrieve(polar, {
+  const res = await usersAdvertisementsGet(polar, {
     id: "<value>",
   });
 
@@ -269,7 +269,7 @@ async function run() {
     id: "<value>",
     userAdvertisementCampaignUpdate: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -351,7 +351,7 @@ async function run() {
   const result = await polar.users.advertisements.delete({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -433,8 +433,6 @@ async function run() {
       benefitId: "<value>",
     },
   });
-
-  
 }
 
 run();

package/docs/sdks/polarbenefits/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [list](#list) - List Benefits
-* [retrieve](#retrieve) - Get Benefit
+* [get](#get) - Get Benefit
 
 ## list
 
@@ -23,7 +23,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.users.benefits.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -86,7 +86,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get a granted benefit by ID.
 
@@ -100,10 +100,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.users.benefits.retrieve({
+  const result = await polar.users.benefits.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -117,7 +117,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { usersBenefitsRetrieve } from "@polar-sh/sdk/funcs/usersBenefitsRetrieve.js";
+import { usersBenefitsGet } from "@polar-sh/sdk/funcs/usersBenefitsGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -126,7 +126,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await usersBenefitsRetrieve(polar, {
+  const res = await usersBenefitsGet(polar, {
     id: "<value>",
   });
 

package/docs/sdks/polarlicensekeys/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [list](#list) - List License Keys
-* [retrieve](#retrieve) - Get License Key
+* [get](#get) - Get License Key
 * [validate](#validate) - Validate License Key
 * [activate](#activate) - Activate License Key
 * [deactivate](#deactivate) - Deactivate License Key
@@ -26,7 +26,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.users.licenseKeys.list({});
-
+  
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -91,7 +91,7 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## retrieve
+## get
 
 Get a license key.
 
@@ -105,10 +105,10 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.users.licenseKeys.retrieve({
+  const result = await polar.users.licenseKeys.get({
     id: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -122,7 +122,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PolarCore } from "@polar-sh/sdk/core.js";
-import { usersLicenseKeysRetrieve } from "@polar-sh/sdk/funcs/usersLicenseKeysRetrieve.js";
+import { usersLicenseKeysGet } from "@polar-sh/sdk/funcs/usersLicenseKeysGet.js";
 
 // Use `PolarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -131,7 +131,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await usersLicenseKeysRetrieve(polar, {
+  const res = await usersLicenseKeysGet(polar, {
     id: "<value>",
   });
 
@@ -189,7 +189,7 @@ async function run() {
     key: "<key>",
     organizationId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -271,7 +271,7 @@ async function run() {
     organizationId: "<value>",
     label: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -355,8 +355,6 @@ async function run() {
     organizationId: "<value>",
     activationId: "<value>",
   });
-
-  
 }
 
 run();