Merge pull request #6 from clerk/speakeasy-sdk-regen-1723006051

chore: 🐝 Update SDK - Generate 0.5.0-alpha.11

Author: speakeasybot

.gitignore

@@ -1,3 +1,4 @@
+.venv/
 venv/
 src/*.egg-info/
 __pycache__/

.speakeasy/gen.lock

@@ -1,39 +1,39 @@
 lockVersion: 2.0.0
 id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8
 management:
-  docChecksum: d97ee97edfea8f73b38df0fd96c23f3b
+  docChecksum: c41c5490f198f58506f13380ae55aa59
   docVersion: v1
-  speakeasyVersion: 1.335.2
-  generationVersion: 2.372.3
-  releaseVersion: 0.5.0-alpha.10
-  configChecksum: 04c964a33a78dc3f8ceed07ac0dea497
+  speakeasyVersion: 1.355.0
+  generationVersion: 2.387.0
+  releaseVersion: 0.5.0-alpha.11
+  configChecksum: 1804e08e82b6b13125dccf9edf256490
   repoURL: https://github.com/clerk/clerk-sdk-python.git
   installationURL: https://github.com/clerk/clerk-sdk-python.git
   published: true
 features:
   python:
     additionalDependencies: 1.0.0
-    constsAndDefaults: 1.0.0
-    core: 5.1.2
+    constsAndDefaults: 1.0.2
+    core: 5.3.4
     defaultEnabledRetries: 0.2.0
     deprecations: 3.0.0
-    envVarSecurityUsage: 0.2.0
+    envVarSecurityUsage: 0.3.1
     examples: 3.0.0
-    flatRequests: 1.0.0
+    flatRequests: 1.0.1
     flattening: 3.0.0
-    globalSecurity: 3.0.0
+    globalSecurity: 3.0.1
     globalSecurityCallbacks: 1.0.0
     globalSecurityFlattening: 1.0.0
     globalServerURLs: 3.0.0
     groups: 3.0.0
     multipartFileContentType: 1.0.0
     nameOverrides: 3.0.0
     nullables: 1.0.0
-    pagination: 3.0.0
+    pagination: 3.0.1
     responseFormat: 1.0.0
     retries: 3.0.0
     sdkHooks: 1.0.0
-    unions: 3.0.0
+    unions: 3.0.1
     uploadStreams: 1.0.0
 generatedFiles:
   - src/clerk_backend_api/sdkconfiguration.py
@@ -66,20 +66,25 @@ generatedFiles:
   - src/clerk_backend_api/testingtokens.py
   - src/clerk_backend_api/sdk.py
   - .vscode/settings.json
+  - poetry.toml
   - py.typed
   - pylintrc
   - pyproject.toml
+  - scripts/compile.sh
   - scripts/publish.sh
   - src/clerk_backend_api/__init__.py
   - src/clerk_backend_api/basesdk.py
   - src/clerk_backend_api/httpclient.py
+  - src/clerk_backend_api/py.typed
   - src/clerk_backend_api/types/__init__.py
   - src/clerk_backend_api/types/basemodel.py
   - src/clerk_backend_api/utils/__init__.py
+  - src/clerk_backend_api/utils/annotations.py
   - src/clerk_backend_api/utils/enums.py
   - src/clerk_backend_api/utils/eventstreaming.py
   - src/clerk_backend_api/utils/forms.py
   - src/clerk_backend_api/utils/headers.py
+  - src/clerk_backend_api/utils/logger.py
   - src/clerk_backend_api/utils/metadata.py
   - src/clerk_backend_api/utils/queryparams.py
   - src/clerk_backend_api/utils/requestbodies.py
@@ -611,3 +616,4 @@ generatedFiles:
   - src/clerk_backend_api/_hooks/sdkhooks.py
   - src/clerk_backend_api/_hooks/types.py
   - src/clerk_backend_api/_hooks/__init__.py
+  - CONTRIBUTING.md

.speakeasy/gen.yaml

@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 python:
-  version: 0.5.0-alpha.10
+  version: 0.5.0-alpha.11
   additionalDependencies:
     dev: {}
     main: {}

.speakeasy/workflow.lock

@@ -1,18 +1,18 @@
-speakeasyVersion: 1.335.2
+speakeasyVersion: 1.355.0
 sources:
     clerk-openapi:
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:b27dc2dcbc018f51bdb0c345fb124285ef73bf144da22f1d6f965c95821de0ad
-        sourceBlobDigest: sha256:9fef9c84dbf7932b587e89710f9589daefcd4feecfa103ed6ef006e3a1e532fa
+        sourceRevisionDigest: sha256:cb8608ec7757028df6422016affe39a59400a122606fe3a64561019546196545
+        sourceBlobDigest: sha256:5491a54b7c32b3f8a39f3496ab1df0c4858e2ff6f0855d844d2d854bc887cec5
         tags:
             - latest
             - main
 targets:
     clerk-sdk-python:
         source: clerk-openapi
         sourceNamespace: clerk-openapi
-        sourceRevisionDigest: sha256:b27dc2dcbc018f51bdb0c345fb124285ef73bf144da22f1d6f965c95821de0ad
-        sourceBlobDigest: sha256:9fef9c84dbf7932b587e89710f9589daefcd4feecfa103ed6ef006e3a1e532fa
+        sourceRevisionDigest: sha256:cb8608ec7757028df6422016affe39a59400a122606fe3a64561019546196545
+        sourceBlobDigest: sha256:5491a54b7c32b3f8a39f3496ab1df0c4858e2ff6f0855d844d2d854bc887cec5
         outLocation: .
 workflow:
     workflowVersion: 1.0.0

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "python.testing.pytestArgs": ["tests", "-vv"],
   "python.testing.unittestEnabled": false,
-  "python.testing.pytestEnabled": true
+  "python.testing.pytestEnabled": true,
+  "pylint.args": ["--rcfile=pylintrc"]
 }

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to This Repository
+
+Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
+
+## How to Report Issues
+
+If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Any relevant logs, screenshots, or error messages
+- Information about your environment (e.g., operating system, software versions)
+    - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
+
+## Issue Triage and Upstream Fixes
+
+We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
+
+## Contact
+
+If you have any questions or need further assistance, please feel free to reach out by opening an issue.
+
+Thank you for your understanding and cooperation!
+
+The Maintainers

README.md

@@ -30,10 +30,9 @@ poetry add clerk-backend-api
 ```python
 # Synchronous Example
 from clerk_backend_api import Clerk
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
@@ -51,11 +50,10 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from clerk_backend_api import Clerk
-import os
 
 async def main():
     s = Clerk(
-        bearer_auth=os.getenv("BEARER_AUTH", ""),
+        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
     )
     res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
     if res is not None:
@@ -271,10 +269,9 @@ 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_backend_api import Clerk
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
@@ -304,10 +301,9 @@ Certain SDK methods accept file objects as part of a request body or multi-part
 
 ```python
 from clerk_backend_api import Clerk
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
@@ -375,10 +371,9 @@ Handling errors in this SDK should largely match your expectations.  All operati
 
 ```python
 from clerk_backend_api import Clerk, models
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 res = None
@@ -542,13 +537,12 @@ This SDK supports the following security scheme globally:
 | ------------- | ------------- | ------------- |
 | `bearer_auth` | http          | HTTP Bearer   |
 
-To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `null` parameter must be set when initializing the SDK client instance. For example:
 ```python
 from clerk_backend_api import Clerk
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
@@ -559,6 +553,20 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Debugging [debug] -->
+## Debugging
+
+To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
+
+```python
+from clerk_backend_api import Clerk
+import logging
+
+logging.basicConfig(level=logging.DEBUG)
+s = Clerk(debug_logger=logging.getLogger("clerk_backend_api"))
+```
+<!-- End Debugging [debug] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

RELEASES.md

@@ -48,4 +48,14 @@ Based on:
 ### Generated
 - [python v0.5.0-alpha.10] .
 ### Releases
-- [PyPI v0.5.0-alpha.10] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.10 - .
+- [PyPI v0.5.0-alpha.10] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.10 - .
+
+## 2024-08-07 04:47:28
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.355.0 (2.387.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.5.0-alpha.11] .
+### Releases
+- [PyPI v0.5.0-alpha.11] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.11 - .

USAGE.md

@@ -2,10 +2,9 @@
 ```python
 # Synchronous Example
 from clerk_backend_api import Clerk
-import os
 
 s = Clerk(
-    bearer_auth=os.getenv("BEARER_AUTH", ""),
+    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
@@ -23,11 +22,10 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from clerk_backend_api import Clerk
-import os
 
 async def main():
     s = Clerk(
-        bearer_auth=os.getenv("BEARER_AUTH", ""),
+        bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
     )
     res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
     if res is not None:

docs/models/security.md

@@ -5,4 +5,4 @@
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `bearer_auth`      | *str*              | :heavy_check_mark: | N/A                |
+| `bearer_auth`      | *Optional[str]*    | :heavy_minus_sign: | N/A                |