npm - @polar-sh/sdk - Versions diffs - 0.40.2 → 0.41.0 - Mend

@polar-sh/sdk 0.40.2 → 0.41.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 (751) hide show

package/docs/sdks/subscriptions/README.md DELETED Viewed

@@ -1,493 +0,0 @@
-# Subscriptions
-(*subscriptions*)
-## Overview
-### Available Operations
-* [list](#list) - List Subscriptions
-* [create](#create) - Create Subscription
-* [export](#export) - Export Subscriptions
-* [get](#get) - Get Subscription
-* [update](#update) - Update Subscription
-* [revoke](#revoke) - Revoke Subscription
-## list
-List subscriptions.
-**Scopes**: `subscriptions:read` `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:list" method="get" path="/v1/subscriptions/" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.list({
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsList } from "@polar-sh/sdk/funcs/subscriptionsList.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 subscriptionsList(polar, {
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("subscriptionsList failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsListRequest](../../models/operations/subscriptionslistrequest.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.SubscriptionsListResponse](../../models/operations/subscriptionslistresponse.md)\>**
-### Errors
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-## create
-Create a subscription programmatically.
-This endpoint only allows to create subscription on free products.
-For paid products, use the checkout flow.
-No initial order will be created and no confirmation email will be sent.
-**Scopes**: `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:create" method="post" path="/v1/subscriptions/" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.create({
-    productId: "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23",
-    customerId: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsCreate } from "@polar-sh/sdk/funcs/subscriptionsCreate.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 subscriptionsCreate(polar, {
-    productId: "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23",
-    customerId: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("subscriptionsCreate failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsCreateSubscriptionCreate](../../models/operations/subscriptionscreatesubscriptioncreate.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.Subscription](../../models/components/subscription.md)\>**
-### Errors
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-## export
-Export subscriptions as a CSV file.
-**Scopes**: `subscriptions:read` `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:export" method="get" path="/v1/subscriptions/export" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.export({
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsExport } from "@polar-sh/sdk/funcs/subscriptionsExport.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 subscriptionsExport(polar, {
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("subscriptionsExport failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsExportRequest](../../models/operations/subscriptionsexportrequest.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\<[any](../../models/.md)\>**
-### Errors
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-## get
-Get a subscription by ID.
-**Scopes**: `subscriptions:read` `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:get" method="get" path="/v1/subscriptions/{id}" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.get({
-    id: "<value>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsGet } from "@polar-sh/sdk/funcs/subscriptionsGet.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 subscriptionsGet(polar, {
-    id: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("subscriptionsGet failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsGetRequest](../../models/operations/subscriptionsgetrequest.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.Subscription](../../models/components/subscription.md)\>**
-### Errors
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.ResourceNotFound    | 404                        | application/json           |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
-## update
-Update a subscription.
-**Scopes**: `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:update" method="patch" path="/v1/subscriptions/{id}" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.update({
-    id: "<value>",
-    subscriptionUpdate: {
-      productId: "<value>",
-    },
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsUpdate } from "@polar-sh/sdk/funcs/subscriptionsUpdate.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 subscriptionsUpdate(polar, {
-    id: "<value>",
-    subscriptionUpdate: {
-      productId: "<value>",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("subscriptionsUpdate failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsUpdateRequest](../../models/operations/subscriptionsupdaterequest.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.Subscription](../../models/components/subscription.md)\>**
-### Errors
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.AlreadyCanceledSubscription | 403                                | application/json                   |
-| errors.ResourceNotFound            | 404                                | application/json                   |
-| errors.SubscriptionLocked          | 409                                | application/json                   |
-| errors.HTTPValidationError         | 422                                | application/json                   |
-| errors.SDKError                    | 4XX, 5XX                           | \*/\*                              |
-## revoke
-Revoke a subscription, i.e cancel immediately.
-**Scopes**: `subscriptions:write`
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="subscriptions:revoke" method="delete" path="/v1/subscriptions/{id}" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await polar.subscriptions.revoke({
-    id: "<value>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { subscriptionsRevoke } from "@polar-sh/sdk/funcs/subscriptionsRevoke.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 subscriptionsRevoke(polar, {
-    id: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("subscriptionsRevoke failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscriptionsRevokeRequest](../../models/operations/subscriptionsrevokerequest.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.Subscription](../../models/components/subscription.md)\>**
-### Errors
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.AlreadyCanceledSubscription | 403                                | application/json                   |
-| errors.ResourceNotFound            | 404                                | application/json                   |
-| errors.SubscriptionLocked          | 409                                | application/json                   |
-| errors.HTTPValidationError         | 422                                | application/json                   |
-| errors.SDKError                    | 4XX, 5XX                           | \*/\*                              |