ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.419.0

polarsource · Oct 17, 2024 · 2e6d7af · 2e6d7af
1 parent 16cda15
commit 2e6d7af
Show file tree

Hide file tree

Showing 59 changed files with 2,092 additions and 235 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
 python:
-  version: 0.6.1
+  version: 0.6.2
   additionalDependencies:
     dev: {}
     main: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,18 @@
-speakeasyVersion: 1.418.4
+speakeasyVersion: 1.419.0
 sources:
     Polar-OAS:
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:b083b473d9fd6021a6126b423b2a5516d609a816b8bcce935b1a585d1298290a
-        sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed
+        sourceRevisionDigest: sha256:75503fa4ab4ea2b254b4e893a2865b946fefcad90893824f0598fd9652ba8b81
+        sourceBlobDigest: sha256:f08236b46e40d4b60554aac287a0268ce101aeefda19b36c22f9fdfde9068091
         tags:
             - latest
             - main
 targets:
     polar:
         source: Polar-OAS
         sourceNamespace: polar-oas
-        sourceRevisionDigest: sha256:b083b473d9fd6021a6126b423b2a5516d609a816b8bcce935b1a585d1298290a
-        sourceBlobDigest: sha256:8aa5bbab824b689955e2c1763c1751ce61965e9bddb63c207b0cbdaefac8d5ed
+        sourceRevisionDigest: sha256:75503fa4ab4ea2b254b4e893a2865b946fefcad90893824f0598fd9652ba8b81
+        sourceBlobDigest: sha256:f08236b46e40d4b60554aac287a0268ce101aeefda19b36c22f9fdfde9068091
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -120,6 +120,14 @@ asyncio.run(main())
 * [delete](docs/sdks/benefits/README.md#delete) - Delete Benefit
 * [grants](docs/sdks/benefits/README.md#grants) - List Benefit Grants
 
+### [checkout_links](docs/sdks/checkoutlinks/README.md)
+
+* [list](docs/sdks/checkoutlinks/README.md#list) - List Checkout Links
+* [create](docs/sdks/checkoutlinks/README.md#create) - Create Checkout Link
+* [get](docs/sdks/checkoutlinks/README.md#get) - Get Checkout Link
+* [update](docs/sdks/checkoutlinks/README.md#update) - Update Checkout Link
+* [delete](docs/sdks/checkoutlinks/README.md#delete) - Delete Checkout Link
+
 ### [checkouts](docs/sdks/checkouts/README.md)
 
 * [~~create~~](docs/sdks/checkouts/README.md#create) - Create Checkout :warning: **Deprecated** Use `create` instead.

diff --git a/RELEASES.md b/RELEASES.md
@@ -223,4 +223,14 @@ Based on:
 ### Generated
 - [python v0.6.1] .
 ### Releases
-- [PyPI v0.6.1] https://pypi.org/project/polar-sdk/0.6.1 - .
+- [PyPI v0.6.1] https://pypi.org/project/polar-sdk/0.6.1 - .
+
+## 2024-10-17 00:11:45
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.419.0 (2.438.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.6.2] .
+### Releases
+- [PyPI v0.6.2] https://pypi.org/project/polar-sdk/0.6.2 - .
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -105,6 +105,36 @@ actions:
         - "lang": "python"
           "label": "grants"
           "source": "from polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nres = s.benefits.grants(id=\"<value>\")\n\nif res is not None:\n    while True:\n        # handle items\n\n        res = res.next()\n        if res is None:\n            break"
+  - target: $["paths"]["/v1/checkout-links/"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "list"
+          "source": "from polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nres = s.checkout_links.list()\n\nif res is not None:\n    while True:\n        # handle items\n\n        res = res.next()\n        if res is None:\n            break"
+  - target: $["paths"]["/v1/checkout-links/"]["post"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "create"
+          "source": "import polar_sdk\nfrom polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nres = s.checkout_links.create(request={\n    \"payment_processor\": polar_sdk.CheckoutLinkCreatePaymentProcessor.STRIPE,\n    \"product_price_id\": \"<value>\",\n})\n\nif res is not None:\n    # handle response\n    pass"
+  - target: $["paths"]["/v1/checkout-links/{id}"]["delete"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "delete"
+          "source": "from polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\ns.checkout_links.delete(id=\"<value>\")\n\n# Use the SDK ..."
+  - target: $["paths"]["/v1/checkout-links/{id}"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "get"
+          "source": "from polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nres = s.checkout_links.get(id=\"<value>\")\n\nif res is not None:\n    # handle response\n    pass"
+  - target: $["paths"]["/v1/checkout-links/{id}"]["patch"]
+    update:
+      "x-codeSamples":
+        - "lang": "python"
+          "label": "update"
+          "source": "from polar_sdk import Polar\n\ns = Polar(\n    access_token=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nres = s.checkout_links.update(id=\"<value>\", checkout_link_update={})\n\nif res is not None:\n    # handle response\n    pass"
   - target: $["paths"]["/v1/checkouts/custom/"]["get"]
     update:
       "x-codeSamples":

diff --git a/docs/models/checkoutlink.md b/docs/models/checkoutlink.md
@@ -0,0 +1,19 @@
+# CheckoutLink
+
+Checkout link data.
+
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `created_at`                                                                 | [date](https://docs.python.org/3/library/datetime.html#date-objects)         | :heavy_check_mark:                                                           | Creation timestamp of the object.                                            |
+| `modified_at`                                                                | [date](https://docs.python.org/3/library/datetime.html#date-objects)         | :heavy_check_mark:                                                           | Last modification timestamp of the object.                                   |
+| `id`                                                                         | *str*                                                                        | :heavy_check_mark:                                                           | The ID of the object.                                                        |
+| `metadata`                                                                   | Dict[str, *str*]                                                             | :heavy_check_mark:                                                           | N/A                                                                          |
+| `client_secret`                                                              | *str*                                                                        | :heavy_check_mark:                                                           | Client secret used to access the checkout link.                              |
+| `success_url`                                                                | *Nullable[str]*                                                              | :heavy_check_mark:                                                           | URL where the customer will be redirected after a successful payment.        |
+| `product_price_id`                                                           | *str*                                                                        | :heavy_check_mark:                                                           | ID of the product price to checkout.                                         |
+| `product_price`                                                              | [models.ProductPrice](../models/productprice.md)                             | :heavy_check_mark:                                                           | N/A                                                                          |
+| `url`                                                                        | *str*                                                                        | :heavy_check_mark:                                                           | N/A                                                                          |
+| `payment_processor`                                                          | [models.PolarEnumsPaymentProcessor](../models/polarenumspaymentprocessor.md) | :heavy_check_mark:                                                           | N/A                                                                          |
diff --git a/docs/models/checkoutlinkcreate.md b/docs/models/checkoutlinkcreate.md
@@ -0,0 +1,13 @@
+# CheckoutLinkCreate
+
+Schema to create a new checkout link.
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                              |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `product_price_id`                                                                                                                                                                                                                                       | *str*                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                       | ID of the product price to checkout.                                                                                                                                                                                                                     |
+| `metadata`                                                                                                                                                                                                                                               | Dict[str, *str*]                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                       | Key-value object allowing you to store additional information.<br/><br/>The key must be a string with a maximum length of **40 characters**.<br/>The value must be a string with a maximum length of **500 characters**.<br/>You can store up to **50 key-value pairs**. |
+| `payment_processor`                                                                                                                                                                                                                                      | [models.CheckoutLinkCreatePaymentProcessor](../models/checkoutlinkcreatepaymentprocessor.md)                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                                       | Payment processor to use. Currently only Stripe is supported.                                                                                                                                                                                            |
+| `success_url`                                                                                                                                                                                                                                            | *OptionalNullable[str]*                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                       | URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.                                                                                    |
diff --git a/docs/models/checkoutlinkcreatepaymentprocessor.md b/docs/models/checkoutlinkcreatepaymentprocessor.md
@@ -0,0 +1,10 @@
+# CheckoutLinkCreatePaymentProcessor
+
+Payment processor to use. Currently only Stripe is supported.
+
+
+## Values
+
+| Name     | Value    |
+| -------- | -------- |
+| `STRIPE` | stripe   |
diff --git a/docs/models/checkoutlinksdeleterequest.md b/docs/models/checkoutlinksdeleterequest.md
@@ -0,0 +1,8 @@
+# CheckoutLinksDeleteRequest
+
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `id`                  | *str*                 | :heavy_check_mark:    | The checkout link ID. |
diff --git a/docs/models/checkoutlinksgetrequest.md b/docs/models/checkoutlinksgetrequest.md
@@ -0,0 +1,8 @@
+# CheckoutLinksGetRequest
+
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `id`                  | *str*                 | :heavy_check_mark:    | The checkout link ID. |
diff --git a/docs/models/checkoutlinkslistqueryparamorganizationidfilter.md b/docs/models/checkoutlinkslistqueryparamorganizationidfilter.md
@@ -0,0 +1,19 @@
+# CheckoutLinksListQueryParamOrganizationIDFilter
+
+Filter by organization ID.
+
+
+## Supported Types
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
+### `List[str]`
+
+```python
+value: List[str] = /* values here */
+```
+
diff --git a/docs/models/checkoutlinkslistqueryparamproductidfilter.md b/docs/models/checkoutlinkslistqueryparamproductidfilter.md
@@ -0,0 +1,19 @@
+# CheckoutLinksListQueryParamProductIDFilter
+
+Filter by product ID.
+
+
+## Supported Types
+
+### `str`
+
+```python
+value: str = /* values here */
+```
+
+### `List[str]`
+
+```python
+value: List[str] = /* values here */
+```
+