ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.431.0

polarsource · Nov 6, 2024 · a4e9ef0 · a4e9ef0
1 parent 56117fd
commit a4e9ef0
Show file tree

Hide file tree

Showing 506 changed files with 12,514 additions and 3,163 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -14,8 +14,9 @@ generation:
     requestResponseComponentNamesFeb2024: true
   auth:
     oAuth2ClientCredentialsEnabled: true
+    oAuth2PasswordEnabled: false
 typescript:
-  version: 0.14.0
+  version: 0.15.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,18 @@
-speakeasyVersion: 1.424.0
+speakeasyVersion: 1.431.0
 sources:
     Polar-OAS:
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:e30177eddab893ea89998cc6684acf560f1561b6fca95ad03072054f7f0e23f4
-        sourceBlobDigest: sha256:47c4285003255d7bf61593438fcc7f5cc4650bece8005ac801a6c26cd2eabba7
+        sourceRevisionDigest: sha256:c7e33d349286ddccd4829c8a687488e4605b8e4ee1f7a1f292f49a74872f598e
+        sourceBlobDigest: sha256:7316038513ebb138e351a2af12f12b570b62f9691c2be6df032216ee0406f91a
         tags:
             - latest
             - main
 targets:
     polar:
         source: Polar-OAS
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:e30177eddab893ea89998cc6684acf560f1561b6fca95ad03072054f7f0e23f4
-        sourceBlobDigest: sha256:47c4285003255d7bf61593438fcc7f5cc4650bece8005ac801a6c26cd2eabba7
+        sourceRevisionDigest: sha256:c7e33d349286ddccd4829c8a687488e4605b8e4ee1f7a1f292f49a74872f598e
+        sourceBlobDigest: sha256:7316038513ebb138e351a2af12f12b570b62f9691c2be6df032216ee0406f91a
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -157,6 +157,14 @@ run();
 * [clientUpdate](docs/sdks/custom/README.md#clientupdate) - Update Checkout Session from Client
 * [clientConfirm](docs/sdks/custom/README.md#clientconfirm) - Confirm Checkout Session from Client
 
+### [customFields](docs/sdks/customfields/README.md)
+
+* [list](docs/sdks/customfields/README.md#list) - List Custom Fields
+* [create](docs/sdks/customfields/README.md#create) - Create Custom Field
+* [get](docs/sdks/customfields/README.md#get) - Get Custom Field
+* [update](docs/sdks/customfields/README.md#update) - Update Custom Field
+* [delete](docs/sdks/customfields/README.md#delete) - Delete Custom Field
+
 ### [externalOrganizations](docs/sdks/externalorganizations/README.md)
 
 * [list](docs/sdks/externalorganizations/README.md#list) - List External Organizations
@@ -319,6 +327,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`checkoutsCustomGet`](docs/sdks/custom/README.md#get) - Get Checkout Session
 - [`checkoutsCustomList`](docs/sdks/custom/README.md#list) - List Checkout Sessions
 - [`checkoutsCustomUpdate`](docs/sdks/custom/README.md#update) - Update Checkout Session
+- [`customFieldsCreate`](docs/sdks/customfields/README.md#create) - Create Custom Field
+- [`customFieldsDelete`](docs/sdks/customfields/README.md#delete) - Delete Custom Field
+- [`customFieldsGet`](docs/sdks/customfields/README.md#get) - Get Custom Field
+- [`customFieldsList`](docs/sdks/customfields/README.md#list) - List Custom Fields
+- [`customFieldsUpdate`](docs/sdks/customfields/README.md#update) - Update Custom Field
 - [`externalOrganizationsList`](docs/sdks/externalorganizations/README.md#list) - List External Organizations
 - [`filesCreate`](docs/sdks/files/README.md#create) - Create File
 - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete File

diff --git a/RELEASES.md b/RELEASES.md
@@ -178,4 +178,14 @@ Based on:
 ### Generated
 - [typescript v0.14.0] .
 ### Releases
-- [NPM v0.14.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.14.0 - .
+- [NPM v0.14.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.14.0 - .
+
+## 2024-11-06 00:25:36
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.431.0 (2.451.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.15.0] .
+### Releases
+- [NPM v0.15.0] https://www.npmjs.com/package/@polar-sh/sdk/v/0.15.0 - .
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -177,6 +177,36 @@ actions:
         - "lang": "typescript"
           "label": "update"
           "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.checkouts.custom.update({\n    id: \"<value>\",\n    checkoutUpdate: {},\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
+  - target: $["paths"]["/v1/custom-fields/"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "typescript"
+          "label": "list"
+          "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.customFields.list({});\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\n}\n\nrun();"
+  - target: $["paths"]["/v1/custom-fields/"]["post"]
+    update:
+      "x-codeSamples":
+        - "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.customFields.create({\n    slug: \"<value>\",\n    name: \"<value>\",\n    properties: {},\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
+  - target: $["paths"]["/v1/custom-fields/{id}"]["delete"]
+    update:
+      "x-codeSamples":
+        - "lang": "typescript"
+          "label": "delete"
+          "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  await polar.customFields.delete({\n    id: \"<value>\",\n  });\n\n\n}\n\nrun();"
+  - target: $["paths"]["/v1/custom-fields/{id}"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "typescript"
+          "label": "get"
+          "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.customFields.get({\n    id: \"<value>\",\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
+  - target: $["paths"]["/v1/custom-fields/{id}"]["patch"]
+    update:
+      "x-codeSamples":
+        - "lang": "typescript"
+          "label": "update"
+          "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.customFields.update({\n    id: \"<value>\",\n    customFieldUpdate: {},\n  });\n\n  // Handle the result\n  console.log(result);\n}\n\nrun();"
   - target: $["paths"]["/v1/external_organizations/"]["get"]
     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: "Heard Island and McDonald Islands",
+  country: "Italy",
 };
 ```
 

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("2023-12-22T00:45:52.216Z"),
-  modifiedAt: new Date("2022-10-03T04:08:49.934Z"),
+  createdAt: new Date("2023-07-24T07:58:55.379Z"),
+  modifiedAt: new Date("2023-08-15T05:41:44.857Z"),
   id: "<value>",
-  imageUrl: "https://burly-replacement.info",
-  imageUrlDark: "https://damp-advertisement.net/",
+  imageUrl: "https://short-term-mentor.info",
+  imageUrlDark: "https://clean-essence.net/",
   text: "<value>",
-  linkUrl: "https://lovely-excess.info",
+  linkUrl: "https://competent-bid.org/",
 };
 ```
 

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("2024-03-01T07:32:00.160Z"),
-      modifiedAt: new Date("2023-10-16T13:56:30.312Z"),
+      createdAt: new Date("2023-03-04T12:05:11.807Z"),
+      modifiedAt: new Date("2022-11-29T03:56:04.500Z"),
       id: "<value>",
-      imageUrl: "https://extra-large-daughter.info/",
-      imageUrlDark: "https://forsaken-recommendation.name/",
+      imageUrl: "https://lovely-sandbar.net/",
+      imageUrlDark: "https://unfit-assist.org",
       text: "<value>",
-      linkUrl: "https://silky-airbus.name",
+      linkUrl: "https://digital-vision.net/",
     },
   ],
   pagination: {
-    totalCount: 438417,
-    maxPage: 361300,
+    totalCount: 929724,
+    maxPage: 523154,
   },
   dimensions: [
-    992382,
+    747742,
   ],
 };
 ```

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 = "-clicks";
+let value: AdvertisementSortProperty = "-created_at";
 ```
 
 ## 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://yellowish-resolve.info",
+    avatarUrl: "https://witty-scenario.com/",
   },
-  visibility: "private",
+  visibility: "hidden",
   userId: "<value>",
   organizationId: "<value>",
   organization: {
-    createdAt: new Date("2024-03-11T04:48:45.754Z"),
-    modifiedAt: new Date("2022-12-10T00:54:33.907Z"),
+    createdAt: new Date("2023-06-22T00:09:40.274Z"),
+    modifiedAt: new Date("2022-07-19T21:06:20.014Z"),
     id: "<value>",
     name: "<value>",
     slug: "<value>",
-    avatarUrl: "https://cooperative-fuel.name",
+    avatarUrl: "https://tempting-accelerator.com",
     bio: "<value>",
-    company: "Pagac and Sons",
+    company: "Wyman - Jakubowski",
     blog: "<value>",
     location: "<value>",
-    email: "Noah.Grady@gmail.com",
+    email: "Bo53@gmail.com",
     twitterUsername: "<value>",
-    pledgeMinimumAmount: 507819,
+    pledgeMinimumAmount: 318150,
     pledgeBadgeShowAmount: false,
-    defaultUpfrontSplitToContributors: 211584,
+    defaultUpfrontSplitToContributors: 639855,
     donationsEnabled: false,
     profileSettings: {},
     featureSettings: {},
   },
-  publishedAt: new Date("2023-06-26T04:55:39.703Z"),
+  publishedAt: new Date("2024-03-18T13:58:56.966Z"),
   paidSubscribersOnly: false,
-  paidSubscribersOnlyEndsAt: new Date("2024-06-09T18:38:23.027Z"),
+  paidSubscribersOnlyEndsAt: new Date("2023-09-23T21:51:50.742Z"),
   isPreview: false,
   isPinned: false,
   notifySubscribers: false,
-  notificationsSentAt: new Date("2024-08-25T15:21:53.101Z"),
-  emailSentToCount: 666762,
-  ogImageUrl: "https://trusty-heroine.biz/",
+  notificationsSentAt: new Date("2022-07-04T22:19:31.096Z"),
+  emailSentToCount: 985905,
+  ogImageUrl: "https://lustrous-offset.net",
   ogDescription: "<value>",
 };
 ```

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: "Malachi_Windler38@hotmail.com",
+  email: "Kali.Schultz@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: 194526,
-  premiumSubscribers: 736480,
-  organizationMembers: 165116,
+  freeSubscribers: 554289,
+  premiumSubscribers: 500494,
+  organizationMembers: 58582,
 };
 ```
 

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

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: 462378,
-  login: "Dudley27",
-  htmlUrl: "https://thrifty-porter.com",
-  avatarUrl: "https://clear-cut-issue.net/",
+  id: 706309,
+  login: "Wilford.Bogisich78",
+  htmlUrl: "https://raw-farm.net/",
+  avatarUrl: "https://sweet-marimba.info",
 };
 ```
 

diff --git a/docs/models/components/attachedcustomfield.md b/docs/models/components/attachedcustomfield.md
@@ -0,0 +1,36 @@
+# AttachedCustomField
+
+Schema of a custom field attached to a resource.
+
+## Example Usage
+
+```typescript
+import { AttachedCustomField } from "@polar-sh/sdk/models/components";
+
+let value: AttachedCustomField = {
+  customFieldId: "<value>",
+  customField: {
+    createdAt: new Date("2023-05-30T01:41:52.063Z"),
+    modifiedAt: new Date("2022-06-22T02:05:53.320Z"),
+    id: "<value>",
+    metadata: {
+      "key": "<value>",
+    },
+    slug: "<value>",
+    name: "<value>",
+    organizationId: "<value>",
+    properties: {},
+  },
+  order: 241568,
+  required: false,
+};
+```
+
+## Fields
+
+| Field                                                | Type                                                 | Required                                             | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
+| `customFieldId`                                      | *string*                                             | :heavy_check_mark:                                   | ID of the custom field.                              |
+| `customField`                                        | *components.CustomField*                             | :heavy_check_mark:                                   | N/A                                                  |
+| `order`                                              | *number*                                             | :heavy_check_mark:                                   | Order of the custom field in the resource.           |
+| `required`                                           | *boolean*                                            | :heavy_check_mark:                                   | Whether the value is required for this custom field. |
diff --git a/docs/models/components/attachedcustomfieldcreate.md b/docs/models/components/attachedcustomfieldcreate.md
@@ -0,0 +1,21 @@
+# AttachedCustomFieldCreate
+
+Schema to attach a custom field to a resource.
+
+## Example Usage
+
+```typescript
+import { AttachedCustomFieldCreate } from "@polar-sh/sdk/models/components";
+
+let value: AttachedCustomFieldCreate = {
+  customFieldId: "<value>",
+  required: false,
+};
+```
+
+## Fields
+
+| Field                                                | Type                                                 | Required                                             | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
+| `customFieldId`                                      | *string*                                             | :heavy_check_mark:                                   | ID of the custom field to attach.                    |
+| `required`                                           | *boolean*                                            | :heavy_check_mark:                                   | Whether the value is required for this custom field. |
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: 718185,
-  login: "Coralie_Price",
-  htmlUrl: "https://puzzled-petticoat.org/",
-  avatarUrl: "https://mysterious-in-joke.net/",
+  id: 618463,
+  login: "Christy_Schuppe",
+  htmlUrl: "https://kooky-deduction.biz/",
+  avatarUrl: "https://raw-waist.com",
 };
 ```