ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.454.0

clerk · Dec 12, 2024 · 67916c2 · 67916c2
1 parent 1fdbc0a
commit 67916c2
Show file tree

Hide file tree

Showing 44 changed files with 550 additions and 393 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8
 management:
-  docChecksum: 264c7cf574c4fa453587755d1bf79bcb
+  docChecksum: 3b85d94743e8bef36aebfc53ac120e1b
   docVersion: v1
-  speakeasyVersion: 1.452.0
-  generationVersion: 2.472.1
-  releaseVersion: 1.4.1
-  configChecksum: b9e0a4731aec79a52c8180337d03b9fc
+  speakeasyVersion: 1.454.0
+  generationVersion: 2.477.0
+  releaseVersion: 1.4.2
+  configChecksum: 11bf6c807a8ec891dc998697b5ca7a20
   repoURL: https://github.com/clerk/clerk-sdk-python.git
   installationURL: https://github.com/clerk/clerk-sdk-python.git
   published: true
@@ -15,7 +15,7 @@ features:
     additionalDependencies: 1.0.0
     additionalProperties: 1.0.1
     constsAndDefaults: 1.0.5
-    core: 5.6.9
+    core: 5.6.11
     defaultEnabledRetries: 0.2.0
     deprecations: 3.0.0
     enumUnions: 0.1.0

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 python:
-  version: 1.4.1
+  version: 1.4.2
   additionalDependencies:
     dev:
       pytest: ^8.3.3

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.452.0
+speakeasyVersion: 1.454.0
 sources:
     clerk-openapi:
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:7da727290006ebb62433a01f6a49c2ec36146cbb44f17b66f3571a5c6fbe424b
-        sourceBlobDigest: sha256:3da8e4d311eedde5131701594c5daf8126a73b6270919fe34090c43876777eeb
+        sourceRevisionDigest: sha256:af0ea7eedcdba6cddabe9d1a3364e2cfab83873e715c03c253ca6e9523ad0b30
+        sourceBlobDigest: sha256:7b41f36bbee97872160a060f96cfaec9693350316134a3f6001fd772dd625c66
         tags:
             - latest
-            - speakeasy-sdk-regen-1733345998
+            - speakeasy-sdk-regen-1733790071
             - v1
 targets:
     clerk-sdk-python:
         source: clerk-openapi
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:7da727290006ebb62433a01f6a49c2ec36146cbb44f17b66f3571a5c6fbe424b
-        sourceBlobDigest: sha256:3da8e4d311eedde5131701594c5daf8126a73b6270919fe34090c43876777eeb
+        sourceRevisionDigest: sha256:af0ea7eedcdba6cddabe9d1a3364e2cfab83873e715c03c253ca6e9523ad0b30
+        sourceBlobDigest: sha256:7b41f36bbee97872160a060f96cfaec9693350316134a3f6001fd772dd625c66
         codeSamplesNamespace: clerk-openapi-python-code-samples
-        codeSamplesRevisionDigest: sha256:5856924712a525f2b8018e4981f1117d78f90b5251f595d767739e4ff637e6ff
+        codeSamplesRevisionDigest: sha256:12c37bfa74f9132d5e67547bc1a7fcda550c3cba89abf1d03879993b237e6e47
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -95,8 +95,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.email_addresses.get(email_address_id="email_address_id_example")
+) as clerk:
+
+    res = clerk.email_addresses.get(email_address_id="email_address_id_example")
 
     if res is not None:
         # handle response
@@ -114,8 +115,9 @@ from clerk_backend_api import Clerk
 async def main():
     async with Clerk(
         bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as s:
-        res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
+    ) as clerk:
+
+        res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")
 
         if res is not None:
             # handle response
@@ -142,8 +144,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
+) as clerk:
+
+    clerk.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
 
     # Use the SDK ...
 
@@ -420,8 +423,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.users.set_profile_image(user_id="usr_test123", file={
+) as clerk:
+
+    res = clerk.users.set_profile_image(user_id="usr_test123", file={
         "file_name": "example.file",
         "content": open("example.file", "rb"),
         "content_type": "<value>",
@@ -441,11 +445,12 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from clerk.utils import BackoffStrategy, RetryConfig
 from clerk_backend_api import Clerk
+from clerk_backend_api.utils import BackoffStrategy, RetryConfig
 
-with Clerk() as s:
-    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
+with Clerk() as clerk:
+
+    clerk.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Use the SDK ...
@@ -454,13 +459,14 @@ with Clerk() as s:
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from clerk.utils import BackoffStrategy, RetryConfig
 from clerk_backend_api import Clerk
+from clerk_backend_api.utils import BackoffStrategy, RetryConfig
 
 with Clerk(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
-) as s:
-    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
+) as clerk:
+
+    clerk.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
 
     # Use the SDK ...
 
@@ -495,10 +501,11 @@ from clerk_backend_api import Clerk, models
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
+) as clerk:
     res = None
     try:
-        res = s.clients.verify(request={
+
+        res = clerk.clients.verify(request={
             "token": "jwt_token_example",
         })
 
@@ -526,8 +533,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     server_url="https://api.clerk.com/v1",
-) as s:
-    s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
+) as clerk:
+
+    clerk.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
 
     # Use the SDK ...
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -208,4 +208,14 @@ Based on:
 ### Generated
 - [python v1.4.1] .
 ### Releases
-- [PyPI v1.4.1] https://pypi.org/project/clerk-backend-api/1.4.1 - .
+- [PyPI v1.4.1] https://pypi.org/project/clerk-backend-api/1.4.1 - .
+
+## 2024-12-12 00:20:46
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.454.0 (2.477.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v1.4.2] .
+### Releases
+- [PyPI v1.4.2] https://pypi.org/project/clerk-backend-api/1.4.2 - .
diff --git a/USAGE.md b/USAGE.md
@@ -5,8 +5,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.email_addresses.get(email_address_id="email_address_id_example")
+) as clerk:
+
+    res = clerk.email_addresses.get(email_address_id="email_address_id_example")
 
     if res is not None:
         # handle response
@@ -24,8 +25,9 @@ from clerk_backend_api import Clerk
 async def main():
     async with Clerk(
         bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-    ) as s:
-        res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
+    ) as clerk:
+
+        res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")
 
         if res is not None:
             # handle response

diff --git a/docs/sdks/actortokens/README.md b/docs/sdks/actortokens/README.md
@@ -20,8 +20,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.actor_tokens.create(user_id="user_1a2b3c", actor={}, expires_in_seconds=3600, session_max_duration_in_seconds=1800)
+) as clerk:
+
+    res = clerk.actor_tokens.create(user_id="user_1a2b3c", actor={}, expires_in_seconds=3600, session_max_duration_in_seconds=1800)
 
     if res is not None:
         # handle response
@@ -61,8 +62,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.actor_tokens.revoke(actor_token_id="act_tok_abcdefghijk")
+) as clerk:
+
+    res = clerk.actor_tokens.revoke(actor_token_id="act_tok_abcdefghijk")
 
     if res is not None:
         # handle response

diff --git a/docs/sdks/allowlistblocklist/README.md b/docs/sdks/allowlistblocklist/README.md
@@ -21,8 +21,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.allowlist_blocklist.list_allowlist_identifiers()
+) as clerk:
+
+    res = clerk.allowlist_blocklist.list_allowlist_identifiers()
 
     if res is not None:
         # handle response
@@ -58,8 +59,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.allowlist_blocklist.create_allowlist_identifier(identifier="[email protected]", notify=True)
+) as clerk:
+
+    res = clerk.allowlist_blocklist.create_allowlist_identifier(identifier="[email protected]", notify=True)
 
     if res is not None:
         # handle response
@@ -97,8 +99,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.allowlist_blocklist.create_blocklist_identifier(identifier="[email protected]")
+) as clerk:
+
+    res = clerk.allowlist_blocklist.create_blocklist_identifier(identifier="[email protected]")
 
     if res is not None:
         # handle response
@@ -135,8 +138,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.allowlist_blocklist.delete_blocklist_identifier(identifier_id="identifier123")
+) as clerk:
+
+    res = clerk.allowlist_blocklist.delete_blocklist_identifier(identifier_id="identifier123")
 
     if res is not None:
         # handle response

diff --git a/docs/sdks/allowlistidentifiers/README.md b/docs/sdks/allowlistidentifiers/README.md
@@ -18,8 +18,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.allowlist_identifiers.delete(identifier_id="example_identifier_id")
+) as clerk:
+
+    res = clerk.allowlist_identifiers.delete(identifier_id="example_identifier_id")
 
     if res is not None:
         # handle response

diff --git a/docs/sdks/betafeatures/README.md b/docs/sdks/betafeatures/README.md
@@ -20,8 +20,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.beta_features.update_instance_settings(request={
+) as clerk:
+
+    res = clerk.beta_features.update_instance_settings(request={
         "restricted_to_allowlist": False,
         "from_email_address": "noreply",
         "progressive_sign_up": True,
@@ -71,8 +72,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    s.beta_features.update_domain(request={
+) as clerk:
+
+    clerk.beta_features.update_domain(request={
         "home_url": "https://www.example.com",
     })
 
@@ -109,8 +111,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    s.beta_features.change_production_instance_domain(request={
+) as clerk:
+
+    clerk.beta_features.change_production_instance_domain(request={
         "home_url": "https://www.newdomain.com",
         "is_secondary": False,
     })

diff --git a/docs/sdks/blocklistidentifierssdk/README.md b/docs/sdks/blocklistidentifierssdk/README.md
@@ -18,8 +18,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.blocklist_identifiers.list()
+) as clerk:
+
+    res = clerk.blocklist_identifiers.list()
 
     if res is not None:
         # handle response

diff --git a/docs/sdks/clerkredirecturls/README.md b/docs/sdks/clerkredirecturls/README.md
@@ -20,8 +20,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.redirect_urls.create(request={
+) as clerk:
+
+    res = clerk.redirect_urls.create(request={
         "url": "https://my-app.com/oauth-callback",
     })
 
@@ -60,8 +61,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.redirect_urls.get(id="redir_01FG4K9G5NWSQ4ZPT4TQE4Z7G3")
+) as clerk:
+
+    res = clerk.redirect_urls.get(id="redir_01FG4K9G5NWSQ4ZPT4TQE4Z7G3")
 
     if res is not None:
         # handle response
@@ -98,8 +100,9 @@ from clerk_backend_api import Clerk
 
 with Clerk(
     bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
-) as s:
-    res = s.redirect_urls.delete(id="redir_01FG4K9G5NWSQ4ZPT4TQE4Z7G3")
+) as clerk:
+
+    res = clerk.redirect_urls.delete(id="redir_01FG4K9G5NWSQ4ZPT4TQE4Z7G3")
 
     if res is not None:
         # handle response