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
12 changes: 6 additions & 6 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -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.455.5
generationVersion: 2.479.3
releaseVersion: 1.5.0
configChecksum: a7a47d1edde189269bbfa1a50e5cdae5
repoURL: https://github.com/clerk/clerk-sdk-python.git
installationURL: https://github.com/clerk/clerk-sdk-python.git
published: true
Expand All @@ -15,7 +15,7 @@ features:
additionalDependencies: 1.0.0
additionalProperties: 1.0.1
constsAndDefaults: 1.0.5
core: 5.6.9
core: 5.7.2
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
enumUnions: 0.1.0
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 1.4.1
version: 1.5.0
additionalDependencies:
dev:
pytest: ^8.3.3
Expand Down
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.452.0
speakeasyVersion: 1.455.5
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:7da727290006ebb62433a01f6a49c2ec36146cbb44f17b66f3571a5c6fbe424b
sourceBlobDigest: sha256:3da8e4d311eedde5131701594c5daf8126a73b6270919fe34090c43876777eeb
sourceRevisionDigest: sha256:561a07af1c71ed18def035a6cd44c2ea804faad92bc60b1d6c473d723b5d977d
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:561a07af1c71ed18def035a6cd44c2ea804faad92bc60b1d6c473d723b5d977d
sourceBlobDigest: sha256:7b41f36bbee97872160a060f96cfaec9693350316134a3f6001fd772dd625c66
codeSamplesNamespace: clerk-openapi-python-code-samples
codeSamplesRevisionDigest: sha256:5856924712a525f2b8018e4981f1117d78f90b5251f595d767739e4ff637e6ff
codeSamplesRevisionDigest: sha256:13e54cc17098ee19ec2e92ef0a5e6e02286cd69b19a702028fa5d14acd1365c2
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
72 changes: 42 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,14 @@ 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:

if res is not None:
# handle response
pass
res = clerk.email_addresses.get(email_address_id="email_address_id_example")

assert res is not None

# Handle response
print(res)
```

</br>
Expand All @@ -114,12 +116,14 @@ 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
pass
assert res is not None

# Handle response
print(res)

asyncio.run(main())
```
Expand All @@ -142,8 +146,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 ...

Expand Down Expand Up @@ -420,16 +425,18 @@ 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>",
})

if res is not None:
# handle response
pass
assert res is not None

# Handle response
print(res)

```
<!-- End File uploads [file-upload] -->
Expand All @@ -441,11 +448,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 clerk:

with Clerk() as s:
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
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 ...
Expand All @@ -454,13 +462,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 ...

Expand Down Expand Up @@ -495,16 +504,18 @@ 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",
})

if res is not None:
# handle response
pass
assert res is not None

# Handle response
print(res)

except models.ClerkErrors as e:
# handle e.data: models.ClerkErrorsData
Expand All @@ -526,8 +537,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 ...

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-16 14:30:11
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.455.5 (2.479.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v1.5.0] .
### Releases
- [PyPI v1.5.0] https://pypi.org/project/clerk-backend-api/1.5.0 - .
24 changes: 14 additions & 10 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ 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:

if res is not None:
# handle response
pass
res = clerk.email_addresses.get(email_address_id="email_address_id_example")

assert res is not None

# Handle response
print(res)
```

</br>
Expand All @@ -24,12 +26,14 @@ 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")

assert res is not None

if res is not None:
# handle response
pass
# Handle response
print(res)

asyncio.run(main())
```
Expand Down
24 changes: 14 additions & 10 deletions docs/sdks/actortokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ 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:

if res is not None:
# handle response
pass
res = clerk.actor_tokens.create(user_id="user_1a2b3c", actor={}, expires_in_seconds=3600, session_max_duration_in_seconds=1800)

assert res is not None

# Handle response
print(res)

```

Expand Down Expand Up @@ -61,12 +63,14 @@ 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")

assert res is not None

if res is not None:
# handle response
pass
# Handle response
print(res)

```

Expand Down
48 changes: 28 additions & 20 deletions docs/sdks/allowlistblocklist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ 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:

if res is not None:
# handle response
pass
res = clerk.allowlist_blocklist.list_allowlist_identifiers()

assert res is not None

# Handle response
print(res)

```

Expand Down Expand Up @@ -58,12 +60,14 @@ from clerk_backend_api import Clerk

with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.allowlist_blocklist.create_allowlist_identifier(identifier="user@example.com", notify=True)
) as clerk:

res = clerk.allowlist_blocklist.create_allowlist_identifier(identifier="user@example.com", notify=True)

assert res is not None

if res is not None:
# handle response
pass
# Handle response
print(res)

```

Expand Down Expand Up @@ -97,12 +101,14 @@ from clerk_backend_api import Clerk

with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
res = s.allowlist_blocklist.create_blocklist_identifier(identifier="example@example.com")
) as clerk:

if res is not None:
# handle response
pass
res = clerk.allowlist_blocklist.create_blocklist_identifier(identifier="example@example.com")

assert res is not None

# Handle response
print(res)

```

Expand Down Expand Up @@ -135,12 +141,14 @@ 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")

assert res is not None

if res is not None:
# handle response
pass
# Handle response
print(res)

```

Expand Down
Loading
Loading