npm - @polar-sh/sdk - Versions diffs - 0.26.0 → 0.27.0 - Mend

@polar-sh/sdk 0.26.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2572) hide show

package/docs/sdks/clients/README.md CHANGED Viewed

@@ -15,6 +15,8 @@
 List OAuth2 clients.
+**Scopes**:
 ### Example Usage
 ```typescript
@@ -92,6 +94,8 @@ run();
 Create an OAuth2 client.
+**Scopes**:
 ### Example Usage
 ```typescript
@@ -175,6 +179,8 @@ run();
 Get an OAuth2 client by Client ID.
+**Scopes**:
 ### Example Usage
 ```typescript
@@ -252,6 +258,8 @@ run();
 Update an OAuth2 client.
+**Scopes**:
 ### Example Usage
 ```typescript
@@ -347,6 +355,8 @@ run();
 Delete an OAuth2 client.
+**Scopes**:
 ### Example Usage
 ```typescript

package/docs/sdks/customers/README.md CHANGED Viewed

@@ -15,6 +15,8 @@
 List customers.
+**Scopes**: `customers:read` `customers:write`
 ### Example Usage
 ```typescript
@@ -92,6 +94,8 @@ run();
 Create a customer.
+**Scopes**: `customers:write`
 ### Example Usage
 ```typescript
@@ -169,6 +173,8 @@ run();
 Get a customer by ID.
+**Scopes**: `customers:read` `customers:write`
 ### Example Usage
 ```typescript
@@ -247,6 +253,8 @@ run();
 Update a customer.
+**Scopes**: `customers:write`
 ### Example Usage
 ```typescript
@@ -329,6 +337,8 @@ Delete a customer.
 Immediately cancels any active subscriptions and revokes any active benefits.
+**Scopes**: `customers:write`
 ### Example Usage
 ```typescript

package/docs/sdks/customersessions/README.md CHANGED Viewed

@@ -11,6 +11,8 @@
 Create a customer session.
+**Scopes**: `customer_sessions:write`
 ### Example Usage
 ```typescript

package/docs/sdks/customfields/README.md CHANGED Viewed

@@ -15,6 +15,8 @@
 List custom fields.
+**Scopes**: `custom_fields:read` `custom_fields:write`
 ### Example Usage
 ```typescript
@@ -92,6 +94,8 @@ run();
 Create a custom field.
+**Scopes**: `custom_fields:write`
 ### Example Usage
 ```typescript
@@ -173,6 +177,8 @@ run();
 Get a custom field by ID.
+**Scopes**: `custom_fields:read` `custom_fields:write`
 ### Example Usage
 ```typescript
@@ -251,6 +257,8 @@ run();
 Update a custom field.
+**Scopes**: `custom_fields:write`
 ### Example Usage
 ```typescript
@@ -331,6 +339,8 @@ run();
 Delete a custom field.
+**Scopes**: `custom_fields:write`
 ### Example Usage
 ```typescript

package/docs/sdks/discounts/README.md CHANGED Viewed

@@ -15,6 +15,8 @@
 List discounts.
+**Scopes**: `discounts:read` `discounts:write`
 ### Example Usage
 ```typescript
@@ -92,6 +94,8 @@ run();
 Create a discount.
+**Scopes**: `discounts:write`
 ### Example Usage
 ```typescript
@@ -179,6 +183,8 @@ run();
 Get a discount by ID.
+**Scopes**: `discounts:read` `discounts:write`
 ### Example Usage
 ```typescript
@@ -257,6 +263,8 @@ run();
 Update a discount.
+**Scopes**: `discounts:write`
 ### Example Usage
 ```typescript
@@ -337,6 +345,8 @@ run();
 Delete a discount.
+**Scopes**: `discounts:write`
 ### Example Usage
 ```typescript

package/docs/sdks/downloadables/README.md CHANGED Viewed

@@ -10,19 +10,19 @@
 ## list
-List Downloadables
+**Scopes**: `customer_portal:read` `customer_portal:write`
 ### Example Usage
 ```typescript
 import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
+const polar = new Polar();
 async function run() {
-  const result = await polar.customerPortal.downloadables.list({});
+  const result = await polar.customerPortal.downloadables.list({
+    customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
+  }, {});
   for await (const page of result) {
     // Handle the page
@@ -43,12 +43,12 @@ import { customerPortalDownloadablesList } from "@polar-sh/sdk/funcs/customerPor
 // 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"] ?? "",
-});
+const polar = new PolarCore();
 async function run() {
-  const res = await customerPortalDownloadablesList(polar, {});
+  const res = await customerPortalDownloadablesList(polar, {
+    customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
+  }, {});
   if (!res.ok) {
     throw res.error;
@@ -70,6 +70,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `request`                                                                                                                                                                      | [operations.CustomerPortalDownloadablesListRequest](../../models/operations/customerportaldownloadableslistrequest.md)                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.CustomerPortalDownloadablesListSecurity](../../models/operations/customerportaldownloadableslistsecurity.md)                                                       | :heavy_check_mark:                                                                                                                                                             | The security requirements 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.                                                                                                               |

package/docs/sdks/events/README.md CHANGED Viewed

@@ -13,6 +13,8 @@
 List events.
+**Scopes**: `events:read` `events:write`
 ### Example Usage
 ```typescript
@@ -90,6 +92,8 @@ run();
 Get an event by ID.
+**Scopes**: `events:read` `events:write`
 ### Example Usage
 ```typescript
@@ -168,6 +172,8 @@ run();
 Ingest batch of events.
+**Scopes**: `events:write`
 ### Example Usage
 ```typescript

package/docs/sdks/externalorganizations/README.md CHANGED Viewed

@@ -11,6 +11,8 @@
 List external organizations.
+**Scopes**: `external_organizations:read`
 ### Example Usage
 ```typescript

package/docs/sdks/files/README.md CHANGED Viewed

@@ -15,6 +15,8 @@
 List files.
+**Scopes**: `files:write`
 ### Example Usage
 ```typescript
@@ -92,6 +94,8 @@ run();
 Create a file.
+**Scopes**: `files:write`
 ### Example Usage
 ```typescript
@@ -191,6 +195,8 @@ run();
 Complete a file upload.
+**Scopes**: `files:write`
 ### Example Usage
 ```typescript
@@ -312,6 +318,8 @@ run();
 Update a file.
+**Scopes**: `files:write`
 ### Example Usage
 ```typescript
@@ -393,6 +401,8 @@ run();
 Delete a file.
+**Scopes**: `files:write`
 ### Example Usage
 ```typescript

package/docs/sdks/licensekeys/README.md CHANGED Viewed

@@ -14,6 +14,8 @@
 Get license keys connected to the given organization & filters.
+**Scopes**: `license_keys:read` `license_keys:write`
 ### Example Usage
 ```typescript
@@ -93,6 +95,8 @@ run();
 Get a license key.
+**Scopes**: `license_keys:read` `license_keys:write`
 ### Example Usage
 ```typescript
@@ -172,6 +176,8 @@ run();
 Update a license key.
+**Scopes**: `license_keys:write`
 ### Example Usage
 ```typescript
@@ -253,6 +259,8 @@ run();
 Get a license key activation.
+**Scopes**: `license_keys:read` `license_keys:write`
 ### Example Usage
 ```typescript

package/docs/sdks/meters/README.md CHANGED Viewed

@@ -16,6 +16,8 @@
 List meters.
+**Scopes**: `meters:read` `meters:write`
 ### Example Usage
 ```typescript
@@ -93,6 +95,8 @@ run();
 Create a meter.
+**Scopes**: `meters:write`
 ### Example Usage
 ```typescript
@@ -190,6 +194,8 @@ run();
 Get a meter by ID.
+**Scopes**: `meters:read` `meters:write`
 ### Example Usage
 ```typescript
@@ -268,6 +274,8 @@ run();
 Update a meter.
+**Scopes**: `meters:write`
 ### Example Usage
 ```typescript
@@ -348,6 +356,8 @@ run();
 Get events matching the filter of a meter.
+**Scopes**: `meters:read` `meters:write`
 ### Example Usage
 ```typescript
@@ -430,6 +440,8 @@ run();
 Get quantities of a meter over a time period.
+**Scopes**: `meters:read` `meters:write`
 ### Example Usage
 ```typescript

package/docs/sdks/metrics/README.md CHANGED Viewed

@@ -12,6 +12,8 @@
 Get metrics about your orders and subscriptions.
+**Scopes**: `metrics:read`
 ### Example Usage
 ```typescript
@@ -95,6 +97,8 @@ run();
 Get the interval limits for the metrics endpoint.
+**Scopes**: `metrics:read`
 ### Example Usage
 ```typescript

package/docs/sdks/oauth2/README.md CHANGED Viewed

@@ -13,7 +13,7 @@
 ## authorize
-Authorize
+**Scopes**:
 ### Example Usage

package/docs/sdks/orders/README.md CHANGED Viewed

@@ -13,6 +13,8 @@
 List orders.
+**Scopes**: `orders:read`
 ### Example Usage
 ```typescript
@@ -90,6 +92,8 @@ run();
 Get an order by ID.
+**Scopes**: `orders:read`
 ### Example Usage
 ```typescript
@@ -168,6 +172,8 @@ run();
 Get an order's invoice data.
+**Scopes**: `orders:read`
 ### Example Usage
 ```typescript

package/docs/sdks/organizations/README.md CHANGED Viewed

@@ -14,6 +14,8 @@
 List organizations.
+**Scopes**: `organizations:read` `organizations:write`
 ### Example Usage
 ```typescript
@@ -91,6 +93,8 @@ run();
 Create an organization.
+**Scopes**: `organizations:write`
 ### Example Usage
 ```typescript
@@ -170,6 +174,8 @@ run();
 Get an organization by ID.
+**Scopes**: `organizations:read` `organizations:write`
 ### Example Usage
 ```typescript
@@ -248,6 +254,8 @@ run();
 Update an organization.
+**Scopes**: `organizations:write`
 ### Example Usage
 ```typescript