Merge pull request #129 from clerk/speakeasy-sdk-regen-1748564552

chore: 🐝 Update SDK - Generate 3.0.0

Author: speakeasybot

.speakeasy/gen.lock

@@ -4,6 +4,7 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: always
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
@@ -16,7 +17,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 python:
-  version: 2.2.0
+  version: 3.0.0
   additionalDependencies:
     dev:
       pytest: ^8.3.3
@@ -47,8 +48,10 @@ python:
   inputModelSuffix: input
   maxMethodParams: 20
   methodArguments: infer-optional-args
+  moduleName: ""
   outputModelSuffix: output
   packageName: clerk-backend-api
+  pytestFilterWarnings: []
   pytestTimeout: 0
   responseFormat: flat
   templateVersion: v2

.speakeasy/gen.yaml

@@ -1,28 +1,28 @@
-speakeasyVersion: 1.544.0
+speakeasyVersion: 1.554.1
 sources:
     clerk-openapi:
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:de9c2e88aec282e2babce91d125306ce397fd12d4cb85f9d12f9cd7cdba60f69
-        sourceBlobDigest: sha256:d64d439a324819076eb2941bddebe10c544f5d276cd95788970d49c8f643bcf1
+        sourceRevisionDigest: sha256:624c66ae617f010f4726fbb72959d666d2ec864146f0d8d2a901d9d21a13d62e
+        sourceBlobDigest: sha256:a82c310fc15cfea1ba234d207461311ad01e41fba0c5b4acb306797703c6de31
         tags:
             - latest
-            - speakeasy-sdk-regen-1747144886
-            - "2024-10-01"
+            - speakeasy-sdk-regen-1748564552
+            - "2025-03-12"
 targets:
     clerk-sdk-python:
         source: clerk-openapi
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:de9c2e88aec282e2babce91d125306ce397fd12d4cb85f9d12f9cd7cdba60f69
-        sourceBlobDigest: sha256:d64d439a324819076eb2941bddebe10c544f5d276cd95788970d49c8f643bcf1
+        sourceRevisionDigest: sha256:624c66ae617f010f4726fbb72959d666d2ec864146f0d8d2a901d9d21a13d62e
+        sourceBlobDigest: sha256:a82c310fc15cfea1ba234d207461311ad01e41fba0c5b4acb306797703c6de31
         codeSamplesNamespace: clerk-openapi-python-code-samples
-        codeSamplesRevisionDigest: sha256:ea80d8442e2d861fe6e5910b6a862b325e94fc1058dd73aee41eb2007a1a525f
+        codeSamplesRevisionDigest: sha256:85efd46de20e69b3420d5a775ba052a15b45b5fca464746fbfe1f724b4e875ea
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
     sources:
         clerk-openapi:
             inputs:
-                - location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2024-10-01.yml
+                - location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2025-03-12.yml
             overlays:
                 - location: ./examples.yaml
                 - location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/.speakeasy/bapi/fixes.yml

.speakeasy/workflow.lock

@@ -22,7 +22,7 @@ Clerk Backend API: The Clerk REST Backend API, meant to be accessed by backend s
 ### Versions
 
 When the API changes in a way that isn't compatible with older versions, a new version is released.
-Each version is identified by its release date, e.g. `2024-10-01`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).
+Each version is identified by its release date, e.g. `2025-03-12`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).
 
 Please see https://clerk.com/docs for more information.
 
@@ -129,16 +129,11 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 from clerk_backend_api import Clerk
 
 
-with Clerk(
-    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as clerk:
-
-    res = clerk.email_addresses.get(email_address_id="email_address_id_example")
+with Clerk() as clerk:
 
-    assert res is not None
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
-    # Handle response
-    print(res)
+    # Use the SDK ...
 ```
 
 </br>
@@ -151,16 +146,11 @@ from clerk_backend_api import Clerk
 
 async def main():
 
-    async with Clerk(
-        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as clerk:
-
-        res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")
+    async with Clerk() as clerk:
 
-        assert res is not None
+        await clerk.miscellaneous.get_public_interstitial_async(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
-        # Handle response
-        print(res)
+        # Use the SDK ...
 
 asyncio.run(main())
 ```
@@ -186,7 +176,7 @@ with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 ) as clerk:
 
-    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
     # Use the SDK ...
 
@@ -499,7 +489,7 @@ from clerk_backend_api.utils import BackoffStrategy, RetryConfig
 
 with Clerk() as clerk:
 
-    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True,
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Use the SDK ...
@@ -516,7 +506,7 @@ with Clerk(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
 ) as clerk:
 
-    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
     # Use the SDK ...
 
@@ -588,7 +578,7 @@ with Clerk(
     server_url="https://api.clerk.com/v1",
 ) as clerk:
 
-    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
     # Use the SDK ...
 
@@ -687,18 +677,14 @@ The `Clerk` class implements the context manager protocol and registers a finali
 from clerk_backend_api import Clerk
 def main():
 
-    with Clerk(
-        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as clerk:
+    with Clerk() as clerk:
         # Rest of application here...
 
 
 # Or when using async:
 async def amain():
 
-    async with Clerk(
-        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as clerk:
+    async with Clerk() as clerk:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->

README.md

@@ -308,4 +308,14 @@ Based on:
 ### Generated
 - [python v2.2.0] .
 ### Releases
-- [PyPI v2.2.0] https://pypi.org/project/clerk-backend-api/2.2.0 - .
+- [PyPI v2.2.0] https://pypi.org/project/clerk-backend-api/2.2.0 - .
+
+## 2025-05-30 21:03:43
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.554.1 (2.616.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v3.0.0] .
+### Releases
+- [PyPI v3.0.0] https://pypi.org/project/clerk-backend-api/3.0.0 - .

RELEASES.md

@@ -4,16 +4,11 @@
 from clerk_backend_api import Clerk
 
 
-with Clerk(
-    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as clerk:
+with Clerk() as clerk:
 
-    res = clerk.email_addresses.get(email_address_id="email_address_id_example")
+    clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
-    assert res is not None
-
-    # Handle response
-    print(res)
+    # Use the SDK ...
 ```
 
 </br>
@@ -26,16 +21,11 @@ from clerk_backend_api import Clerk
 
 async def main():
 
-    async with Clerk(
-        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as clerk:
-
-        res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")
+    async with Clerk() as clerk:
 
-        assert res is not None
+        await clerk.miscellaneous.get_public_interstitial_async(frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://fine-tarragon.info", domain="great-director.net", sign_in_url="https://likable-freckle.net/", use_domain_for_script=False)
 
-        # Handle response
-        print(res)
+        # Use the SDK ...
 
 asyncio.run(main())
 ```

USAGE.md

@@ -17,4 +17,5 @@
 | `expire_at`                                                                              | *int*                                                                                    | :heavy_check_mark:                                                                       | Unix timestamp of expiration.<br/>                                                       | 1685471123                                                                               |
 | `abandon_at`                                                                             | *int*                                                                                    | :heavy_check_mark:                                                                       | Unix timestamp of abandonment.<br/>                                                      | 1630471123                                                                               |
 | `updated_at`                                                                             | *int*                                                                                    | :heavy_check_mark:                                                                       | Unix timestamp of last update.<br/>                                                      | 1622532323                                                                               |
-| `created_at`                                                                             | *int*                                                                                    | :heavy_check_mark:                                                                       | Unix timestamp of creation.<br/>                                                         | 1622470000                                                                               |
+| `created_at`                                                                             | *int*                                                                                    | :heavy_check_mark:                                                                       | Unix timestamp of creation.<br/>                                                         | 1622470000                                                                               |
+| `tasks`                                                                                  | List[[models.SessionTask](../models/sessiontask.md)]                                     | :heavy_minus_sign:                                                                       | N/A                                                                                      |                                                                                          |

docs/models/session.md

@@ -0,0 +1,8 @@
+# SessionTask
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `key`              | *str*              | :heavy_check_mark: | N/A                |

docs/models/sessiontask.md

@@ -11,4 +11,5 @@
 | `EXPIRED`   | expired     |
 | `REMOVED`   | removed     |
 | `ABANDONED` | abandoned   |
-| `REPLACED`  | replaced    |
+| `REPLACED`  | replaced    |
+| `PENDING`   | pending     |

docs/models/status.md

@@ -76,7 +76,7 @@ with Clerk(
 
     clerk.beta_features.update_production_instance_domain(request={
         "home_url": "https://www.example.com",
-        "is_secondary": False,
+        "is_secondary": True,
     })
 
     # Use the SDK ...