@polar-sh/sdk 0.22.2 → 0.24.0

package/docs/sdks/customers/README.md

@@ -25,10 +25,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.customers.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.customers.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -54,10 +51,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await customersList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await customersList(polar, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/customfields/README.md

@@ -25,10 +25,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.customFields.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.customFields.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -54,10 +51,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await customFieldsList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await customFieldsList(polar, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/discounts/README.md

@@ -25,10 +25,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.discounts.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.discounts.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -54,10 +51,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await discountsList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await discountsList(polar, {});
 
   if (!res.ok) {
     throw res.error;
@@ -275,9 +269,7 @@ const polar = new Polar({
 async function run() {
   const result = await polar.discounts.update({
     id: "<value>",
-    discountUpdate: {
-      currency: "usd",
-    },
+    discountUpdate: {},
   });
 
   // Handle the result
@@ -304,9 +296,7 @@ const polar = new PolarCore({
 async function run() {
   const res = await discountsUpdate(polar, {
     id: "<value>",
-    discountUpdate: {
-      currency: "usd",
-    },
+    discountUpdate: {},
   });
 
   if (!res.ok) {

package/docs/sdks/downloadables/README.md

@@ -22,10 +22,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.customerPortal.downloadables.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.customerPortal.downloadables.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -51,10 +48,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await customerPortalDownloadablesList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await customerPortalDownloadablesList(polar, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/events/README.md

@@ -0,0 +1,260 @@
+# Events
+(*events*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List Events
+* [get](#get) - Get Event
+* [ingest](#ingest) - Ingest Events
+
+## list
+
+List events.
+
+### Example Usage
+
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.events.list({});
+
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { eventsList } from "@polar-sh/sdk/funcs/eventsList.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await eventsList(polar, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  for await (const page of result) {
+    // Handle the page
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.EventsListRequest](../../models/operations/eventslistrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.EventsListResponse](../../models/operations/eventslistresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## get
+
+Get an event by ID.
+
+### Example Usage
+
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.events.get({
+    id: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { eventsGet } from "@polar-sh/sdk/funcs/eventsGet.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await eventsGet(polar, {
+    id: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.EventsGetRequest](../../models/operations/eventsgetrequest.md)                                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.Event](../../models/components/event.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ResourceNotFound    | 404                        | application/json           |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## ingest
+
+Ingest batch of events.
+
+### Example Usage
+
+```typescript
+import { Polar } from "@polar-sh/sdk";
+
+const polar = new Polar({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await polar.events.ingest({
+    events: [
+      {
+        name: "<value>",
+        customerId: "<value>",
+      },
+      {
+        name: "<value>",
+        externalCustomerId: "<id>",
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { PolarCore } from "@polar-sh/sdk/core.js";
+import { eventsIngest } from "@polar-sh/sdk/funcs/eventsIngest.js";
+
+// Use `PolarCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const polar = new PolarCore({
+  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const res = await eventsIngest(polar, {
+    events: [
+      {
+        name: "<value>",
+        customerId: "<value>",
+      },
+      {
+        name: "<value>",
+        externalCustomerId: "<id>",
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.EventsIngest](../../models/components/eventsingest.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.EventsIngestResponse](../../models/components/eventsingestresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/externalorganizations/README.md

@@ -21,10 +21,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.externalOrganizations.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.externalOrganizations.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -50,10 +47,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await externalOrganizationsList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await externalOrganizationsList(polar, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/files/README.md

@@ -25,10 +25,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.files.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.files.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -54,10 +51,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await filesList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await filesList(polar, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/licensekeys/README.md

@@ -24,10 +24,7 @@ const polar = new Polar({
 });
 
 async function run() {
-  const result = await polar.licenseKeys.list({
-    page: 1,
-    limit: 10,
-  });
+  const result = await polar.licenseKeys.list({});
 
   for await (const page of result) {
     // Handle the page
@@ -53,10 +50,7 @@ const polar = new PolarCore({
 });
 
 async function run() {
-  const res = await licenseKeysList(polar, {
-    page: 1,
-    limit: 10,
-  });
+  const res = await licenseKeysList(polar, {});
 
   if (!res.ok) {
     throw res.error;
@@ -190,9 +184,7 @@ const polar = new Polar({
 async function run() {
   const result = await polar.licenseKeys.update({
     id: "<value>",
-    licenseKeyUpdate: {
-      usage: 0,
-    },
+    licenseKeyUpdate: {},
   });
 
   // Handle the result
@@ -219,9 +211,7 @@ const polar = new PolarCore({
 async function run() {
   const res = await licenseKeysUpdate(polar, {
     id: "<value>",
-    licenseKeyUpdate: {
-      usage: 0,
-    },
+    licenseKeyUpdate: {},
   });
 
   if (!res.ok) {