@polar-sh/sdk 0.9.0 → 0.11.0

package/docs/sdks/polarsubscriptions/README.md

@@ -6,7 +6,6 @@
 ### Available Operations
 
 * [list](#list) - List Subscriptions
-* [create](#create) - Create Free Subscription
 * [get](#get) - Get Subscription
 * [update](#update) - Update Subscription
 * [cancel](#cancel) - Cancel Subscription
@@ -26,7 +25,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.users.subscriptions.list({});
-  
+
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -89,88 +88,6 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## create
-
-Create a subscription on a **free** tier.
-
-If you want to subscribe to a paid tier, you need to create a checkout session.
-
-### 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.users.subscriptions.create({
-    productId: "<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 { usersSubscriptionsCreate } from "@polar-sh/sdk/funcs/usersSubscriptionsCreate.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 usersSubscriptionsCreate(polar, {
-    productId: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result)
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.UserFreeSubscriptionCreate](../../models/components/userfreesubscriptioncreate.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.UserSubscription](../../models/components/usersubscription.md)\>**
-
-### Errors
-
-| Error Object               | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.AlreadySubscribed   | 400                        | application/json           |
-| errors.ResourceNotFound    | 404                        | application/json           |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
-
-
 ## get
 
 Get a subscription by ID.
@@ -188,9 +105,9 @@ async function run() {
   const result = await polar.users.subscriptions.get({
     id: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -222,7 +139,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -270,9 +187,9 @@ async function run() {
       productPriceId: "<value>",
     },
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -307,7 +224,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -328,12 +245,11 @@ run();
 
 ### Errors
 
-| Error Object                   | Status Code                    | Content Type                   |
-| ------------------------------ | ------------------------------ | ------------------------------ |
-| errors.FreeSubscriptionUpgrade | 403                            | application/json               |
-| errors.ResourceNotFound        | 404                            | application/json               |
-| errors.HTTPValidationError     | 422                            | application/json               |
-| errors.SDKError                | 4xx-5xx                        | */*                            |
+| Error Object               | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.ResourceNotFound    | 404                        | application/json           |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
 ## cancel
@@ -353,9 +269,9 @@ async function run() {
   const result = await polar.users.subscriptions.cancel({
     id: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -387,7 +303,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/products/README.md

@@ -30,7 +30,7 @@ async function run() {
       "<value>",
     ],
   });
-  
+
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -115,15 +115,13 @@ async function run() {
     name: "<value>",
     prices: [
       {
-        priceAmount: 486589,
         recurringInterval: "month",
       },
     ],
-    type: "individual",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -148,11 +146,10 @@ async function run() {
     name: "<value>",
     prices: [
       {
-        priceAmount: 417458,
-        recurringInterval: "month",
+        priceAmount: 89964,
+        recurringInterval: "year",
       },
     ],
-    type: "individual",
   });
 
   if (!res.ok) {
@@ -162,7 +159,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -206,9 +203,9 @@ async function run() {
   const result = await polar.products.get({
     id: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -240,7 +237,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -286,9 +283,9 @@ async function run() {
     id: "<value>",
     productUpdate: {},
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -321,7 +318,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -372,9 +369,9 @@ async function run() {
       ],
     },
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -411,7 +408,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/repositories/README.md

@@ -24,7 +24,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.repositories.list({});
-  
+
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -104,9 +104,9 @@ async function run() {
   const result = await polar.repositories.get({
     id: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -138,7 +138,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -184,9 +184,9 @@ async function run() {
     id: "<value>",
     repositoryUpdate: {},
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -219,7 +219,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/subscriptions/README.md

@@ -6,8 +6,6 @@
 ### Available Operations
 
 * [list](#list) - List Subscriptions
-* [create](#create) - Create Free Subscription
-* [importSubscriptions](#importsubscriptions) - Import Subscriptions
 * [export](#export) - Export Subscriptions
 
 ## list
@@ -25,7 +23,7 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.subscriptions.list({});
-  
+
   for await (const page of result) {
     // Handle the page
     console.log(page);
@@ -88,168 +86,6 @@ run();
 | errors.SDKError            | 4xx-5xx                    | */*                        |
 
 
-## create
-
-Create a subscription on the free tier for a given email.
-
-### 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.subscriptions.create({
-    email: "Jena.Nienow28@yahoo.com",
-    productId: "<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 { 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, {
-    email: "Jena.Nienow28@yahoo.com",
-    productId: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result)
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.SubscriptionCreateEmail](../../models/components/subscriptioncreateemail.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.SubscriptionOutput](../../models/components/subscriptionoutput.md)\>**
-
-### Errors
-
-| Error Object               | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
-
-
-## importSubscriptions
-
-Import subscriptions from a CSV file.
-
-### Example Usage
-
-```typescript
-import { Polar } from "@polar-sh/sdk";
-import { openAsBlob } from "node:fs";
-
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await polar.subscriptions.importSubscriptions({
-    file: await openAsBlob("example.file"),
-    organizationId: "<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 { subscriptionsImportSubscriptions } from "@polar-sh/sdk/funcs/subscriptionsImportSubscriptions.js";
-import { openAsBlob } from "node:fs";
-
-// 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 subscriptionsImportSubscriptions(polar, {
-    file: await openAsBlob("example.file"),
-    organizationId: "<value>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result)
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.BodySubscriptionsImport](../../models/components/bodysubscriptionsimport.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.SubscriptionsImported](../../models/components/subscriptionsimported.md)\>**
-
-### Errors
-
-| Error Object               | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4xx-5xx                    | */*                        |
-
-
 ## export
 
 Export subscriptions as a CSV file.
@@ -265,9 +101,9 @@ const polar = new Polar({
 
 async function run() {
   const result = await polar.subscriptions.export({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -297,7 +133,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/funcs/advertisementsGet.d.ts

@@ -13,5 +13,5 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get an advertisement campaign by ID.
  */
-export declare function advertisementsGet(client$: PolarCore, request: operations.AdvertisementsGetRequest, options?: RequestOptions): Promise<Result<components.AdvertisementCampaign, errors.ResourceNotFound | errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+export declare function advertisementsGet(client: PolarCore, request: operations.AdvertisementsGetRequest, options?: RequestOptions): Promise<Result<components.AdvertisementCampaign, errors.ResourceNotFound | errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=advertisementsGet.d.ts.map

package/funcs/advertisementsGet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"advertisementsGet.d.ts","sourceRoot":"","sources":["../src/funcs/advertisementsGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,qBAAqB,EAC9B,MAAM,CAAC,gBAAgB,GACvB,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAwFA"}
+{"version":3,"file":"advertisementsGet.d.ts","sourceRoot":"","sources":["../src/funcs/advertisementsGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAIvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,qBAAqB,EAC9B,MAAM,CAAC,gBAAgB,GACvB,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAuFA"}