Merge pull request #2 from clerk/speakeasy-sdk-regen-1720732387

chore: 🐝 Update SDK - Generate
clerk · Jul 11, 2024 · 194fffd · 194fffd
2 parents 4616959 + 981340c
commit 194fffd
Show file tree

Hide file tree

Showing 233 changed files with 31,353 additions and 358 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 python:
-  version: 0.5.0-alpha.6
+  version: 0.5.0-alpha.7
   additionalDependencies:
     dev: {}
     main: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,17 +2,17 @@ speakeasyVersion: 1.331.2
 sources:
     clerk-openapi:
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:4ce22a0cdb7433f376f0842a2dda1143fc61c2da241b5903d6239a44fc978fec
-        sourceBlobDigest: sha256:c715e59591e54f9e2beca3ed567d1a12edc3f20580cac065511ce19c4423e3aa
+        sourceRevisionDigest: sha256:83887503bf502c2b1e816b079beba5218998adb827d73f2ac6de809e14f4389b
+        sourceBlobDigest: sha256:0181726a4ca9a31eae12e6bdd2d42c0aeca0e25a76d8e9c82b57a829b69dff68
         tags:
             - latest
             - main
 targets:
     clerk-sdk-python:
         source: clerk-openapi
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:4ce22a0cdb7433f376f0842a2dda1143fc61c2da241b5903d6239a44fc978fec
-        sourceBlobDigest: sha256:c715e59591e54f9e2beca3ed567d1a12edc3f20580cac065511ce19c4423e3aa
+        sourceRevisionDigest: sha256:83887503bf502c2b1e816b079beba5218998adb827d73f2ac6de809e14f4389b
+        sourceBlobDigest: sha256:0181726a4ca9a31eae12e6bdd2d42c0aeca0e25a76d8e9c82b57a829b69dff68
         outLocation: .
 workflow:
     workflowVersion: 1.0.0

diff --git a/README.md b/README.md
@@ -13,12 +13,12 @@ The Clerk Python library provides convenient access to the Clerk REST API from a
 
 PIP
 ```bash
-pip install clerk
+pip install clerk-backend-api
 ```
 
 Poetry
 ```bash
-poetry add clerk
+poetry add clerk-backend-api
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -29,7 +29,7 @@ poetry add clerk
 
 ```python
 # Synchronous Example
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -50,7 +50,7 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 async def main():
@@ -270,7 +270,7 @@ return value of `Next` is `None`, then there are no more pages to be fetched.
 
 Here's an example of one such pagination call:
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -303,7 +303,7 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 >
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -331,8 +331,8 @@ 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 import Clerk
 from clerk.utils import BackoffStrategy, RetryConfig
+from clerk_backend_api import Clerk
 
 s = Clerk()
 
@@ -346,8 +346,8 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable
 
 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 import Clerk
 from clerk.utils import BackoffStrategy, RetryConfig
+from clerk_backend_api import Clerk
 
 s = Clerk(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
@@ -374,7 +374,7 @@ Handling errors in this SDK should largely match your expectations.  All operati
 ### Example
 
 ```python
-from clerk import Clerk, models
+from clerk_backend_api import Clerk, models
 import os
 
 s = Clerk(
@@ -418,7 +418,7 @@ You can override the default server globally by passing a server index to the `s
 #### Example
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 
 s = Clerk(
     server_idx=0,
@@ -436,7 +436,7 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable
 
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 
 s = Clerk(
     server_url="https://api.clerk.com/v1",
@@ -459,7 +459,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
 
 For example, you could specify a header for every request that this sdk makes as follows:
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
@@ -468,8 +468,8 @@ s = Clerk(client=http_client)
 
 or you could wrap the client with your own custom logic:
 ```python
-from clerk import Clerk
-from clerk.httpclient import AsyncHttpClient
+from clerk_backend_api import Clerk
+from clerk_backend_api.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -544,7 +544,7 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/RELEASES.md b/RELEASES.md
@@ -8,4 +8,14 @@ Based on:
 ### Generated
 - [python v0.5.0-alpha.6] .
 ### Releases
-- [PyPI v0.5.0-alpha.6] https://pypi.org/project/clerk/0.5.0-alpha.6 - .
+- [PyPI v0.5.0-alpha.6] https://pypi.org/project/clerk/0.5.0-alpha.6 - .
+
+## 2024-07-11 21:13:04
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.331.2 (2.366.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.5.0-alpha.7] .
+### Releases
+- [PyPI v0.5.0-alpha.7] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.7 - .
diff --git a/USAGE.md b/USAGE.md
@@ -1,7 +1,7 @@
 <!-- Start SDK Example Usage [usage] -->
 ```python
 # Synchronous Example
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -22,7 +22,7 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 async def main():

diff --git a/docs/sdks/actortokens/README.md b/docs/sdks/actortokens/README.md
@@ -14,7 +14,7 @@ The `actor` parameter needs to include at least a "sub" key whose value is the I
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -60,7 +60,7 @@ Revokes a pending actor token.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/allowlistidentifiers/README.md b/docs/sdks/allowlistidentifiers/README.md
@@ -14,7 +14,7 @@ Get a list of all identifiers allowed to sign up to an instance
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -54,7 +54,7 @@ Create an identifier allowed to sign up to an instance
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -96,7 +96,7 @@ Delete an identifier from the instance allow-list
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/betafeatures/README.md b/docs/sdks/betafeatures/README.md
@@ -14,7 +14,7 @@ Updates the settings of an instance
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -66,7 +66,7 @@ WARNING: Changing your domain will invalidate all current user sessions (i.e. us
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -105,7 +105,7 @@ WARNING: Changing your domain will invalidate all current user sessions (i.e. us
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/blocklistidentifierssdk/README.md b/docs/sdks/blocklistidentifierssdk/README.md
@@ -14,7 +14,7 @@ Get a list of all identifiers which are not allowed to access an instance
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -54,7 +54,7 @@ Create an identifier that is blocked from accessing an instance
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -95,7 +95,7 @@ Delete an identifier from the instance block-list
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/clients/README.md b/docs/sdks/clients/README.md
@@ -18,7 +18,7 @@ Warning: the endpoint is being deprecated and will be removed in future versions
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -65,7 +65,7 @@ Verifies the client in the provided token
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -106,7 +106,7 @@ Returns the details of a client.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/domainssdk/README.md b/docs/sdks/domainssdk/README.md
@@ -16,7 +16,7 @@ The response will contain the primary domain for the instance and any satellite
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -59,7 +59,7 @@ If you're planning to configure the new satellite domain to run behind a proxy,
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -103,7 +103,7 @@ It is currently not possible to delete the instance's primary domain.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -151,7 +151,7 @@ update the instance's home origin, affecting the default application paths.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(

diff --git a/docs/sdks/emailaddresses/README.md b/docs/sdks/emailaddresses/README.md
@@ -15,7 +15,7 @@ Create a new email address
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -59,7 +59,7 @@ Returns the details of an email address.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -100,7 +100,7 @@ Delete the email address with the given ID
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(
@@ -141,7 +141,7 @@ Updates an email address.
 ### Example Usage
 
 ```python
-from clerk import Clerk
+from clerk_backend_api import Clerk
 import os
 
 s = Clerk(