ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.475.0

polarsource · Jan 24, 2025 · 5faa5eb · 5faa5eb
1 parent 32e6966
commit 5faa5eb
Show file tree

Hide file tree

Showing 647 changed files with 4,835 additions and 3,270 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 typescript:
-  version: 0.21.3
+  version: 0.22.0
   additionalDependencies:
     dependencies:
       standardwebhooks: ^1.0.0

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.474.0
+speakeasyVersion: 1.475.0
 sources:
     Polar-OAS:
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:2caa144dc82e70c044b00f129338bb160d9f4d529b3bb2d827ada0162e0df39f
+        sourceRevisionDigest: sha256:66a404e8dead21b781a713e2dacfa0818742678a2b85c68d4a885e021ec5bb89
         sourceBlobDigest: sha256:a2c4a9d1003b730a2305769700bfb4c9028732a336ffa7c8c219658d82bd24a1
         tags:
             - latest
-            - speakeasy-sdk-regen-1737591955
+            - speakeasy-sdk-regen-1737734302
             - 0.1.0
 targets:
     polar:
         source: Polar-OAS
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:2caa144dc82e70c044b00f129338bb160d9f4d529b3bb2d827ada0162e0df39f
+        sourceRevisionDigest: sha256:66a404e8dead21b781a713e2dacfa0818742678a2b85c68d4a885e021ec5bb89
         sourceBlobDigest: sha256:a2c4a9d1003b730a2305769700bfb4c9028732a336ffa7c8c219658d82bd24a1
         codeSamplesNamespace: polar-oas-ts-code-samples
-        codeSamplesRevisionDigest: sha256:999957128f23bb79cc528f8cee488b03d0706088496c93fbdb858cb82fb869a0
+        codeSamplesRevisionDigest: sha256:4404606551c3b133d33d7fd0fe71c90470d17671b2fceb0f9302adbf14a2820e
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -73,6 +73,9 @@ yarn add @polar-sh/sdk zod
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -752,10 +755,8 @@ If the method throws an error and it is not captured by the known errors, it wil
 
 ```typescript
 import { Polar } from "@polar-sh/sdk";
-import {
-  HTTPValidationError,
-  SDKValidationError,
-} from "@polar-sh/sdk/models/errors";
+import { HTTPValidationError } from "@polar-sh/sdk/models/errors/httpvalidationerror.js";
+import { SDKValidationError } from "@polar-sh/sdk/models/errors/sdkvalidationerror.js";
 
 const polar = new Polar({
   accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",

diff --git a/RELEASES.md b/RELEASES.md
@@ -398,4 +398,14 @@ Based on:
 ### Generated
 - [typescript v0.21.3] .
 ### Releases
-- [NPM v0.21.3] https://www.npmjs.com/package/@polar-sh/sdk/v/0.21.3 - .
+- [NPM v0.21.3] https://www.npmjs.com/package/@polar-sh/sdk/v/0.21.3 - .
+
+## 2025-01-24 16:02:12
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.475.0 (2.495.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.22.0] .
+### Releases
+- [NPM v0.22.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.22.0 - .
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -398,7 +398,7 @@ actions:
       "x-codeSamples":
         - "lang": "typescript"
           "label": "Typescript (SDK)"
-          "source": "import { Polar } from \"@polar-sh/sdk\";\nimport { RFCDate } from \"@polar-sh/sdk/types\";\n\nconst polar = new Polar({\n  accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await polar.metrics.get({\n    startDate: new RFCDate(\"2025-02-06\"),\n    endDate: new RFCDate(\"2024-09-04\"),\n    interval: \"week\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
+          "source": "import { Polar } from \"@polar-sh/sdk\";\nimport { RFCDate } from \"@polar-sh/sdk/types/rfcdate.js\";\n\nconst polar = new Polar({\n  accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await polar.metrics.get({\n    startDate: new RFCDate(\"2025-02-06\"),\n    endDate: new RFCDate(\"2024-09-04\"),\n    interval: \"week\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
   - target: $["paths"]["/v1/metrics/limits"]["get"]
     update:
       "x-codeSamples":

diff --git a/docs/models/components/address.md b/docs/models/components/address.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { Address } from "@polar-sh/sdk/models/components";
+import { Address } from "@polar-sh/sdk/models/components/address.js";
 
 let value: Address = {
   country: "Nauru",

diff --git a/docs/models/components/advertisementcampaign.md b/docs/models/components/advertisementcampaign.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AdvertisementCampaign } from "@polar-sh/sdk/models/components";
+import { AdvertisementCampaign } from "@polar-sh/sdk/models/components/advertisementcampaign.js";
 
 let value: AdvertisementCampaign = {
   createdAt: new Date("2023-10-13T09:29:12.610Z"),

diff --git a/docs/models/components/advertisementcampaignlistresource.md b/docs/models/components/advertisementcampaignlistresource.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AdvertisementCampaignListResource } from "@polar-sh/sdk/models/components";
+import { AdvertisementCampaignListResource } from "@polar-sh/sdk/models/components/advertisementcampaignlistresource.js";
 
 let value: AdvertisementCampaignListResource = {
   items: [

diff --git a/docs/models/components/advertisementsortproperty.md b/docs/models/components/advertisementsortproperty.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AdvertisementSortProperty } from "@polar-sh/sdk/models/components";
+import { AdvertisementSortProperty } from "@polar-sh/sdk/models/components/advertisementsortproperty.js";
 
 let value: AdvertisementSortProperty = "clicks";
 ```

diff --git a/docs/models/components/assignee.md b/docs/models/components/assignee.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { Assignee } from "@polar-sh/sdk/models/components";
+import { Assignee } from "@polar-sh/sdk/models/components/assignee.js";
 
 let value: Assignee = {
   id: 522048,

diff --git a/docs/models/components/attachedcustomfield.md b/docs/models/components/attachedcustomfield.md
@@ -5,7 +5,7 @@ Schema of a custom field attached to a resource.
 ## Example Usage
 
 ```typescript
-import { AttachedCustomField } from "@polar-sh/sdk/models/components";
+import { AttachedCustomField } from "@polar-sh/sdk/models/components/attachedcustomfield.js";
 
 let value: AttachedCustomField = {
   customFieldId: "<value>",

diff --git a/docs/models/components/attachedcustomfieldcreate.md b/docs/models/components/attachedcustomfieldcreate.md
@@ -5,7 +5,7 @@ Schema to attach a custom field to a resource.
 ## Example Usage
 
 ```typescript
-import { AttachedCustomFieldCreate } from "@polar-sh/sdk/models/components";
+import { AttachedCustomFieldCreate } from "@polar-sh/sdk/models/components/attachedcustomfieldcreate.js";
 
 let value: AttachedCustomFieldCreate = {
   customFieldId: "<value>",

diff --git a/docs/models/components/author.md b/docs/models/components/author.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { Author } from "@polar-sh/sdk/models/components";
+import { Author } from "@polar-sh/sdk/models/components/author.js";
 
 let value: Author = {
   id: 324872,

diff --git a/docs/models/components/authorizeorganization.md b/docs/models/components/authorizeorganization.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AuthorizeOrganization } from "@polar-sh/sdk/models/components";
+import { AuthorizeOrganization } from "@polar-sh/sdk/models/components/authorizeorganization.js";
 
 let value: AuthorizeOrganization = {
   id: "<value>",

diff --git a/docs/models/components/authorizeresponseorganization.md b/docs/models/components/authorizeresponseorganization.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AuthorizeResponseOrganization } from "@polar-sh/sdk/models/components";
+import { AuthorizeResponseOrganization } from "@polar-sh/sdk/models/components/authorizeresponseorganization.js";
 
 let value: AuthorizeResponseOrganization = {
   client: {

diff --git a/docs/models/components/authorizeresponseuser.md b/docs/models/components/authorizeresponseuser.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AuthorizeResponseUser } from "@polar-sh/sdk/models/components";
+import { AuthorizeResponseUser } from "@polar-sh/sdk/models/components/authorizeresponseuser.js";
 
 let value: AuthorizeResponseUser = {
   client: {

diff --git a/docs/models/components/authorizeuser.md b/docs/models/components/authorizeuser.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { AuthorizeUser } from "@polar-sh/sdk/models/components";
+import { AuthorizeUser } from "@polar-sh/sdk/models/components/authorizeuser.js";
 
 let value: AuthorizeUser = {
   id: "<value>",

diff --git a/docs/models/components/benefitads.md b/docs/models/components/benefitads.md
@@ -7,7 +7,7 @@ Use it so your backers can display ads on your README, website, etc.
 ## Example Usage
 
 ```typescript
-import { BenefitAds } from "@polar-sh/sdk/models/components";
+import { BenefitAds } from "@polar-sh/sdk/models/components/benefitads.js";
 
 let value: BenefitAds = {
   createdAt: new Date("2023-06-27T15:10:04.073Z"),

diff --git a/docs/models/components/benefitadscreate.md b/docs/models/components/benefitadscreate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitAdsCreate } from "@polar-sh/sdk/models/components";
+import { BenefitAdsCreate } from "@polar-sh/sdk/models/components/benefitadscreate.js";
 
 let value: BenefitAdsCreate = {
   description: "oxygenate forenenst uproot",

diff --git a/docs/models/components/benefitadsproperties.md b/docs/models/components/benefitadsproperties.md
@@ -5,7 +5,7 @@ Properties for a benefit of type `ads`.
 ## Example Usage
 
 ```typescript
-import { BenefitAdsProperties } from "@polar-sh/sdk/models/components";
+import { BenefitAdsProperties } from "@polar-sh/sdk/models/components/benefitadsproperties.js";
 
 let value: BenefitAdsProperties = {};
 ```

diff --git a/docs/models/components/benefitadssubscriber.md b/docs/models/components/benefitadssubscriber.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitAdsSubscriber } from "@polar-sh/sdk/models/components";
+import { BenefitAdsSubscriber } from "@polar-sh/sdk/models/components/benefitadssubscriber.js";
 
 let value: BenefitAdsSubscriber = {
   createdAt: new Date("2023-01-10T13:24:18.025Z"),

diff --git a/docs/models/components/benefitadsupdate.md b/docs/models/components/benefitadsupdate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitAdsUpdate } from "@polar-sh/sdk/models/components";
+import { BenefitAdsUpdate } from "@polar-sh/sdk/models/components/benefitadsupdate.js";
 
 let value: BenefitAdsUpdate = {};
 ```

diff --git a/docs/models/components/benefitbase.md b/docs/models/components/benefitbase.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitBase } from "@polar-sh/sdk/models/components";
+import { BenefitBase } from "@polar-sh/sdk/models/components/benefitbase.js";
 
 let value: BenefitBase = {
   createdAt: new Date("2023-11-17T21:39:15.131Z"),

diff --git a/docs/models/components/benefitcustom.md b/docs/models/components/benefitcustom.md
@@ -7,7 +7,7 @@ Use it to grant any kind of benefit that doesn't fit in the other types.
 ## Example Usage
 
 ```typescript
-import { BenefitCustom } from "@polar-sh/sdk/models/components";
+import { BenefitCustom } from "@polar-sh/sdk/models/components/benefitcustom.js";
 
 let value: BenefitCustom = {
   createdAt: new Date("2023-11-28T23:36:29.114Z"),

diff --git a/docs/models/components/benefitcustomcreate.md b/docs/models/components/benefitcustomcreate.md
@@ -5,7 +5,7 @@ Schema to create a benefit of type `custom`.
 ## Example Usage
 
 ```typescript
-import { BenefitCustomCreate } from "@polar-sh/sdk/models/components";
+import { BenefitCustomCreate } from "@polar-sh/sdk/models/components/benefitcustomcreate.js";
 
 let value: BenefitCustomCreate = {
   description: "wire majestically yet",

diff --git a/docs/models/components/benefitcustomcreateproperties.md b/docs/models/components/benefitcustomcreateproperties.md
@@ -5,7 +5,7 @@ Properties for creating a benefit of type `custom`.
 ## Example Usage
 
 ```typescript
-import { BenefitCustomCreateProperties } from "@polar-sh/sdk/models/components";
+import { BenefitCustomCreateProperties } from "@polar-sh/sdk/models/components/benefitcustomcreateproperties.js";
 
 let value: BenefitCustomCreateProperties = {};
 ```

diff --git a/docs/models/components/benefitcustomproperties.md b/docs/models/components/benefitcustomproperties.md
@@ -5,7 +5,7 @@ Properties for a benefit of type `custom`.
 ## Example Usage
 
 ```typescript
-import { BenefitCustomProperties } from "@polar-sh/sdk/models/components";
+import { BenefitCustomProperties } from "@polar-sh/sdk/models/components/benefitcustomproperties.js";
 
 let value: BenefitCustomProperties = {
   note: "<value>",

diff --git a/docs/models/components/benefitcustomsubscriber.md b/docs/models/components/benefitcustomsubscriber.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitCustomSubscriber } from "@polar-sh/sdk/models/components";
+import { BenefitCustomSubscriber } from "@polar-sh/sdk/models/components/benefitcustomsubscriber.js";
 
 let value: BenefitCustomSubscriber = {
   createdAt: new Date("2023-03-05T12:03:53.313Z"),

diff --git a/docs/models/components/benefitcustomsubscriberproperties.md b/docs/models/components/benefitcustomsubscriberproperties.md
@@ -5,7 +5,7 @@ Properties available to subscribers for a benefit of type `custom`.
 ## Example Usage
 
 ```typescript
-import { BenefitCustomSubscriberProperties } from "@polar-sh/sdk/models/components";
+import { BenefitCustomSubscriberProperties } from "@polar-sh/sdk/models/components/benefitcustomsubscriberproperties.js";
 
 let value: BenefitCustomSubscriberProperties = {
   note: "<value>",

diff --git a/docs/models/components/benefitcustomupdate.md b/docs/models/components/benefitcustomupdate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitCustomUpdate } from "@polar-sh/sdk/models/components";
+import { BenefitCustomUpdate } from "@polar-sh/sdk/models/components/benefitcustomupdate.js";
 
 let value: BenefitCustomUpdate = {};
 ```

diff --git a/docs/models/components/benefitdiscord.md b/docs/models/components/benefitdiscord.md
@@ -7,7 +7,7 @@ Use it to automatically invite your backers to a Discord server.
 ## Example Usage
 
 ```typescript
-import { BenefitDiscord } from "@polar-sh/sdk/models/components";
+import { BenefitDiscord } from "@polar-sh/sdk/models/components/benefitdiscord.js";
 
 let value: BenefitDiscord = {
   createdAt: new Date("2025-04-23T02:16:34.389Z"),

diff --git a/docs/models/components/benefitdiscordcreate.md b/docs/models/components/benefitdiscordcreate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordCreate } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordCreate } from "@polar-sh/sdk/models/components/benefitdiscordcreate.js";
 
 let value: BenefitDiscordCreate = {
   description: "unconscious whose ick untimely",

diff --git a/docs/models/components/benefitdiscordcreateproperties.md b/docs/models/components/benefitdiscordcreateproperties.md
@@ -5,7 +5,7 @@ Properties to create a benefit of type `discord`.
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordCreateProperties } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordCreateProperties } from "@polar-sh/sdk/models/components/benefitdiscordcreateproperties.js";
 
 let value: BenefitDiscordCreateProperties = {
   guildToken: "<value>",

diff --git a/docs/models/components/benefitdiscordproperties.md b/docs/models/components/benefitdiscordproperties.md
@@ -5,7 +5,7 @@ Properties for a benefit of type `discord`.
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordProperties } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordProperties } from "@polar-sh/sdk/models/components/benefitdiscordproperties.js";
 
 let value: BenefitDiscordProperties = {
   guildId: "<id>",

diff --git a/docs/models/components/benefitdiscordsubscriber.md b/docs/models/components/benefitdiscordsubscriber.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordSubscriber } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordSubscriber } from "@polar-sh/sdk/models/components/benefitdiscordsubscriber.js";
 
 let value: BenefitDiscordSubscriber = {
   createdAt: new Date("2024-02-04T10:48:51.582Z"),

diff --git a/docs/models/components/benefitdiscordsubscriberproperties.md b/docs/models/components/benefitdiscordsubscriberproperties.md
@@ -5,7 +5,7 @@ Properties available to subscribers for a benefit of type `discord`.
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordSubscriberProperties } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordSubscriberProperties } from "@polar-sh/sdk/models/components/benefitdiscordsubscriberproperties.js";
 
 let value: BenefitDiscordSubscriberProperties = {
   guildId: "<id>",

diff --git a/docs/models/components/benefitdiscordupdate.md b/docs/models/components/benefitdiscordupdate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitDiscordUpdate } from "@polar-sh/sdk/models/components";
+import { BenefitDiscordUpdate } from "@polar-sh/sdk/models/components/benefitdiscordupdate.js";
 
 let value: BenefitDiscordUpdate = {};
 ```

diff --git a/docs/models/components/benefitdownloadables.md b/docs/models/components/benefitdownloadables.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitDownloadables } from "@polar-sh/sdk/models/components";
+import { BenefitDownloadables } from "@polar-sh/sdk/models/components/benefitdownloadables.js";
 
 let value: BenefitDownloadables = {
   createdAt: new Date("2024-05-23T10:17:07.880Z"),

diff --git a/docs/models/components/benefitdownloadablescreate.md b/docs/models/components/benefitdownloadablescreate.md
@@ -3,7 +3,7 @@
 ## Example Usage
 
 ```typescript
-import { BenefitDownloadablesCreate } from "@polar-sh/sdk/models/components";
+import { BenefitDownloadablesCreate } from "@polar-sh/sdk/models/components/benefitdownloadablescreate.js";
 
 let value: BenefitDownloadablesCreate = {
   description: