ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.418.4

polarsource · Oct 16, 2024 · 799619b · 799619b
1 parent 6562264
commit 799619b
Show file tree

Hide file tree

Showing 303 changed files with 3,396 additions and 3,471 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -15,7 +15,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 typescript:
-  version: 0.13.0
+  version: 0.13.1
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,18 @@
-speakeasyVersion: 1.414.1
+speakeasyVersion: 1.418.4
 sources:
     Polar-OAS:
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:42496c2c1381522d95c89a43a7bbb5d2598aed8b34542782ced0831e3121b723
-        sourceBlobDigest: sha256:e17ea29a2bc4fc5f01ead9a66ea39f07913e6ea3732e5ecf47675de704af2041
+        sourceRevisionDigest: sha256:f87d955636fb8c810a7062a8e3ed99ec716281562a4cb47b3053856bc2e8fb73
+        sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed
         tags:
             - latest
             - main
 targets:
     polar:
         source: Polar-OAS
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:42496c2c1381522d95c89a43a7bbb5d2598aed8b34542782ced0831e3121b723
-        sourceBlobDigest: sha256:e17ea29a2bc4fc5f01ead9a66ea39f07913e6ea3732e5ecf47675de704af2041
+        sourceRevisionDigest: sha256:f87d955636fb8c810a7062a8e3ed99ec716281562a4cb47b3053856bc2e8fb73
+        sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -117,6 +117,7 @@ run();
 
 * [list](docs/sdks/articles/README.md#list) - List Articles
 * [create](docs/sdks/articles/README.md#create) - Create Article
+* [export](docs/sdks/articles/README.md#export) - Export Articles
 * [get](docs/sdks/articles/README.md#get) - Get Article
 * [update](docs/sdks/articles/README.md#update) - Update Article
 * [delete](docs/sdks/articles/README.md#delete) - Delete Article
@@ -285,6 +286,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`advertisementsList`](docs/sdks/advertisements/README.md#list) - List Campaigns
 - [`articlesCreate`](docs/sdks/articles/README.md#create) - Create Article
 - [`articlesDelete`](docs/sdks/articles/README.md#delete) - Delete Article
+- [`articlesExport`](docs/sdks/articles/README.md#export) - Export Articles
 - [`articlesGet`](docs/sdks/articles/README.md#get) - Get Article
 - [`articlesList`](docs/sdks/articles/README.md#list) - List Articles
 - [`articlesPreview`](docs/sdks/articles/README.md#preview) - Send Article Preview

diff --git a/RELEASES.md b/RELEASES.md
@@ -118,4 +118,14 @@ Based on:
 ### Generated
 - [typescript v0.13.0] .
 ### Releases
-- [NPM v0.13.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.0 - .
+- [NPM v0.13.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.0 - .
+
+## 2024-10-16 00:25:52
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.418.4 (2.438.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.13.1] .
+### Releases
+- [NPM v0.13.1] https://www.npmjs.com/package/@polar-sh/sdk/v/0.13.1 - .
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -27,6 +27,12 @@ actions:
         - "lang": "typescript"
           "label": "create"
           "source": "import { Polar } from \"@polar-sh/sdk\";\n\nconst polar = new Polar({\n  accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await polar.articles.create({\n    title: \"<value>\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
+  - target: $["paths"]["/v1/articles/export"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "typescript"
+          "label": "export"
+          "source": "import { Polar } from \"@polar-sh/sdk\";\n\nconst polar = new Polar({\n  accessToken: process.env[\"POLAR_ACCESS_TOKEN\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await polar.articles.export({\n    organizationId: \"cf4e3d5e-2b50-4470-a85b-8d021391fabb\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
   - target: $["paths"]["/v1/articles/{id}"]["delete"]
     update:
       "x-codeSamples":

diff --git a/docs/models/components/address.md b/docs/models/components/address.md
@@ -6,7 +6,7 @@
 import { Address } from "@polar-sh/sdk/models/components";
 
 let value: Address = {
-  country: "Liechtenstein",
+  country: "Papua New Guinea",
 };
 ```
 

diff --git a/docs/models/components/advertisementcampaign.md b/docs/models/components/advertisementcampaign.md
@@ -6,13 +6,13 @@
 import { AdvertisementCampaign } from "@polar-sh/sdk/models/components";
 
 let value: AdvertisementCampaign = {
-  createdAt: new Date("2024-08-30T20:05:14.177Z"),
-  modifiedAt: new Date("2024-08-16T19:55:21.868Z"),
+  createdAt: new Date("2023-12-22T00:45:52.216Z"),
+  modifiedAt: new Date("2022-10-03T04:08:49.934Z"),
   id: "<value>",
-  imageUrl: "https://square-fowl.org/",
-  imageUrlDark: "https://narrow-interior.name",
+  imageUrl: "https://burly-replacement.info",
+  imageUrlDark: "https://damp-advertisement.net/",
   text: "<value>",
-  linkUrl: "https://brown-governance.net/",
+  linkUrl: "https://lovely-excess.info",
 };
 ```
 

diff --git a/docs/models/components/advertisementcampaignlistresource.md b/docs/models/components/advertisementcampaignlistresource.md
@@ -8,21 +8,21 @@ import { AdvertisementCampaignListResource } from "@polar-sh/sdk/models/componen
 let value: AdvertisementCampaignListResource = {
   items: [
     {
-      createdAt: new Date("2023-07-11T03:19:08.621Z"),
-      modifiedAt: new Date("2024-01-18T21:54:07.604Z"),
+      createdAt: new Date("2024-03-01T07:32:00.160Z"),
+      modifiedAt: new Date("2023-10-16T13:56:30.312Z"),
       id: "<value>",
-      imageUrl: "https://awful-swim.biz",
-      imageUrlDark: "https://oblong-finer.org",
+      imageUrl: "https://extra-large-daughter.info/",
+      imageUrlDark: "https://forsaken-recommendation.name/",
       text: "<value>",
-      linkUrl: "https://foolhardy-cow.info",
+      linkUrl: "https://silky-airbus.name",
     },
   ],
   pagination: {
-    totalCount: 332116,
-    maxPage: 159757,
+    totalCount: 438417,
+    maxPage: 361300,
   },
   dimensions: [
-    937408,
+    992382,
   ],
 };
 ```

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

diff --git a/docs/models/components/article.md b/docs/models/components/article.md
@@ -12,40 +12,40 @@ let value: Article = {
   body: "<value>",
   byline: {
     name: "<value>",
-    avatarUrl: "https://bleak-median.com",
+    avatarUrl: "https://yellowish-resolve.info",
   },
   visibility: "private",
   userId: "<value>",
   organizationId: "<value>",
   organization: {
-    createdAt: new Date("2023-04-30T01:03:37.412Z"),
-    modifiedAt: new Date("2024-09-30T03:17:45.166Z"),
+    createdAt: new Date("2024-03-11T04:48:45.754Z"),
+    modifiedAt: new Date("2022-12-10T00:54:33.907Z"),
     id: "<value>",
     name: "<value>",
     slug: "<value>",
-    avatarUrl: "https://wry-bakeware.com/",
+    avatarUrl: "https://cooperative-fuel.name",
     bio: "<value>",
-    company: "Sanford, Franey and Franecki",
+    company: "Pagac and Sons",
     blog: "<value>",
     location: "<value>",
-    email: "Tyra_Sipes@yahoo.com",
+    email: "Noah.Grady@gmail.com",
     twitterUsername: "<value>",
-    pledgeMinimumAmount: 986941,
+    pledgeMinimumAmount: 507819,
     pledgeBadgeShowAmount: false,
-    defaultUpfrontSplitToContributors: 95645,
+    defaultUpfrontSplitToContributors: 211584,
     donationsEnabled: false,
     profileSettings: {},
     featureSettings: {},
   },
-  publishedAt: new Date("2023-05-02T03:02:44.155Z"),
+  publishedAt: new Date("2023-06-26T04:55:39.703Z"),
   paidSubscribersOnly: false,
-  paidSubscribersOnlyEndsAt: new Date("2024-04-18T06:42:06.014Z"),
+  paidSubscribersOnlyEndsAt: new Date("2024-06-09T18:38:23.027Z"),
   isPreview: false,
   isPinned: false,
   notifySubscribers: false,
-  notificationsSentAt: new Date("2024-12-20T13:50:06.096Z"),
-  emailSentToCount: 119716,
-  ogImageUrl: "https://sleepy-mythology.org/",
+  notificationsSentAt: new Date("2024-08-25T15:21:53.101Z"),
+  emailSentToCount: 666762,
+  ogImageUrl: "https://trusty-heroine.biz/",
   ogDescription: "<value>",
 };
 ```

diff --git a/docs/models/components/articlebyline.md b/docs/models/components/articlebyline.md
@@ -5,7 +5,7 @@
 ```typescript
 import { ArticleByline } from "@polar-sh/sdk/models/components";
 
-let value: ArticleByline = "user";
+let value: ArticleByline = "organization";
 ```
 
 ## Values

diff --git a/docs/models/components/articlecreate.md b/docs/models/components/articlecreate.md
@@ -19,8 +19,8 @@ let value: ArticleCreate = {
 | `body`                                                                                                                                                                           | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | Body in string format. Either one of body or body_base64 is required.                                                                                                            |
 | `bodyBase64`                                                                                                                                                                     | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | Body in base64-encoded format. Can be helpful to bypass Web Application Firewalls (WAF). Either one of body or body_base64 is required.                                          |
 | `organizationId`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                               | The ID of the organization owning the article. **Required unless you use an organization token.**                                                                                |
-| `byline`                                                                                                                                                                         | [components.ArticleCreateArticleByline](../../models/components/articlecreatearticlebyline.md)                                                                                   | :heavy_minus_sign:                                                                                                                                                               | If the user or organization should be credited in the byline.                                                                                                                    |
-| `visibility`                                                                                                                                                                     | [components.ArticleCreateArticleVisibility](../../models/components/articlecreatearticlevisibility.md)                                                                           | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `byline`                                                                                                                                                                         | [components.ArticleByline](../../models/components/articlebyline.md)                                                                                                             | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `visibility`                                                                                                                                                                     | [components.ArticleVisibility](../../models/components/articlevisibility.md)                                                                                                     | :heavy_minus_sign:                                                                                                                                                               | N/A                                                                                                                                                                              |
 | `paidSubscribersOnly`                                                                                                                                                            | *boolean*                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                               | Set to true to only make this article available for subscribers to a paid subscription tier in the organization.                                                                 |
 | `paidSubscribersOnlyEndsAt`                                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | If specified, time at which the article should no longer be restricted to paid subscribers. Only relevant if `paid_subscribers_only` is true.                                    |
 | `publishedAt`                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                    | :heavy_minus_sign:                                                                                                                                                               | Time of publishing. If this date is in the future, the post will be scheduled to publish at this time. If visibility is 'public', published_at will default to the current time. |

diff --git a/docs/models/components/articlecreatearticlebyline.md b/docs/models/components/articlecreatearticlebyline.md
diff --git a/docs/models/components/articlecreatearticlevisibility.md b/docs/models/components/articlecreatearticlevisibility.md
diff --git a/docs/models/components/articlepreview.md b/docs/models/components/articlepreview.md
@@ -6,7 +6,7 @@
 import { ArticlePreview } from "@polar-sh/sdk/models/components";
 
 let value: ArticlePreview = {
-  email: "Velma51@yahoo.com",
+  email: "Malachi_Windler38@hotmail.com",
 };
 ```
 

diff --git a/docs/models/components/articlereceivers.md b/docs/models/components/articlereceivers.md
@@ -6,9 +6,9 @@
 import { ArticleReceivers } from "@polar-sh/sdk/models/components";
 
 let value: ArticleReceivers = {
-  freeSubscribers: 689029,
-  premiumSubscribers: 15446,
-  organizationMembers: 647089,
+  freeSubscribers: 194526,
+  premiumSubscribers: 736480,
+  organizationMembers: 165116,
 };
 ```
 

diff --git a/docs/models/components/assignee.md b/docs/models/components/assignee.md
@@ -6,10 +6,10 @@
 import { Assignee } from "@polar-sh/sdk/models/components";
 
 let value: Assignee = {
-  id: 26189,
-  login: "Madalyn_Quigley5",
-  htmlUrl: "https://twin-singing.name",
-  avatarUrl: "https://which-thorn.com/",
+  id: 636696,
+  login: "Stella.Champlin94",
+  htmlUrl: "https://esteemed-lay.info",
+  avatarUrl: "https://sugary-zebra.biz",
 };
 ```
 

diff --git a/docs/models/components/author.md b/docs/models/components/author.md
@@ -6,10 +6,10 @@
 import { Author } from "@polar-sh/sdk/models/components";
 
 let value: Author = {
-  id: 121066,
-  login: "Kariane.Kohler42",
-  htmlUrl: "https://near-hammock.com",
-  avatarUrl: "https://obvious-pendant.net",
+  id: 436663,
+  login: "Garrick_Ferry87",
+  htmlUrl: "https://wasteful-confusion.com",
+  avatarUrl: "https://avaricious-earth.org",
 };
 ```