Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 39 additions & 38 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ generation:
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
nameResolutionFeb2025: false
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 1.7.2
version: 1.8.0
additionalDependencies:
dev:
pytest: ^8.3.3
Expand Down Expand Up @@ -46,5 +48,6 @@ python:
methodArguments: infer-optional-args
outputModelSuffix: output
packageName: clerk-backend-api
pytestTimeout: 0
responseFormat: flat
templateVersion: v2
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.476.2
speakeasyVersion: 1.495.1
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:e62e325e0873c460e0721bc6d2b981344e31422506daf0046387149d34d181b1
sourceBlobDigest: sha256:44db509095f005a99fa7dfa4639cf59e2ff18bbb131c2fcbb353338188c19867
sourceRevisionDigest: sha256:d4b68e7b261c9fd23c346291e7ca8c925d1c834140e3f0a1807a11ef7f3d41bb
sourceBlobDigest: sha256:d384523908f855f5394f6242512679e5215cfdaf50bc8a7053f15a46cc565a61
tags:
- latest
- speakeasy-sdk-regen-1738023555
- speakeasy-sdk-regen-1739751656
- v1
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:e62e325e0873c460e0721bc6d2b981344e31422506daf0046387149d34d181b1
sourceBlobDigest: sha256:44db509095f005a99fa7dfa4639cf59e2ff18bbb131c2fcbb353338188c19867
sourceRevisionDigest: sha256:d4b68e7b261c9fd23c346291e7ca8c925d1c834140e3f0a1807a11ef7f3d41bb
sourceBlobDigest: sha256:d384523908f855f5394f6242512679e5215cfdaf50bc8a7053f15a46cc565a61
codeSamplesNamespace: clerk-openapi-python-code-samples
codeSamplesRevisionDigest: sha256:2b50cd962c45919ae71be3aefb2e772eb47f89bf6ecabd3de17c21bfc6f1b3c4
codeSamplesRevisionDigest: sha256:366daf506ce8c8a843d3a1fb9b5a300d0afec1dac988ef6aa32b312f43e49f0e
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,37 @@ pip install clerk-backend-api
```bash
poetry add clerk-backend-api
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from clerk-backend-api python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "clerk-backend-api",
# ]
# ///

from clerk_backend_api import Clerk

sdk = Clerk(
# SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
Expand Down Expand Up @@ -407,7 +438,6 @@ If the request is correctly authenticated, the token's payload is made available
* [delete_backup_codes](docs/sdks/users/README.md#delete_backup_codes) - Disable all user's Backup codes
* [delete_passkey](docs/sdks/users/README.md#delete_passkey) - Delete a user passkey
* [delete_web3_wallet](docs/sdks/users/README.md#delete_web3_wallet) - Delete a user web3 wallet
* [create_totp](docs/sdks/users/README.md#create_totp) - Create a TOTP for a user
* [delete_totp](docs/sdks/users/README.md#delete_totp) - Delete all the user's TOTPs
* [delete_external_account](docs/sdks/users/README.md#delete_external_account) - Delete External Account

Expand Down Expand Up @@ -546,7 +576,7 @@ with Clerk(

### Override Server URL Per-Client

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:
The default server can 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_backend_api import Clerk

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,4 +248,14 @@ Based on:
### Generated
- [python v1.7.2] .
### Releases
- [PyPI v1.7.2] https://pypi.org/project/clerk-backend-api/1.7.2 - .
- [PyPI v1.7.2] https://pypi.org/project/clerk-backend-api/1.7.2 - .

## 2025-02-19 19:06:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.495.1 (2.515.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v1.8.0] .
### Releases
- [PyPI v1.8.0] https://pypi.org/project/clerk-backend-api/1.8.0 - .
5 changes: 3 additions & 2 deletions docs/models/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `status` | [models.AdminVerificationStatus](../models/adminverificationstatus.md) | :heavy_check_mark: | N/A | verified |
| `strategy` | [models.VerificationStrategy](../models/verificationstrategy.md) | :heavy_check_mark: | N/A | admin |
| `attempts` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 |
| `expire_at` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 1620000000 |
| `attempts` | *Nullable[int]* | :heavy_check_mark: | N/A | 0 |
| `expire_at` | *Nullable[int]* | :heavy_check_mark: | N/A | 1620000000 |
| `verified_at_client` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | |
Loading