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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
**/.speakeasy/temp/
**/.speakeasy/logs/
.speakeasy/reports
README-PYPI.md
.venv/
Expand Down
348 changes: 152 additions & 196 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ generation:
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 2.0.2
version: 2.1.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.528.1
speakeasyVersion: 1.542.3
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:bcb46367e22f173faae6063b46646b8ec370811b1c7fee20c505800552a13cfc
sourceBlobDigest: sha256:bdb0513d5af178caa1ad7b99d0efd1c795975e712a5c4695cadc8d27cfcace05
sourceRevisionDigest: sha256:b04b66d6cf242e4b34536e792b8cf9fe2241bf8c772d48a5c332cfbd2450cf30
sourceBlobDigest: sha256:d64d439a324819076eb2941bddebe10c544f5d276cd95788970d49c8f643bcf1
tags:
- latest
- speakeasy-sdk-regen-1743708685
- speakeasy-sdk-regen-1744935656
- "2024-10-01"
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:bcb46367e22f173faae6063b46646b8ec370811b1c7fee20c505800552a13cfc
sourceBlobDigest: sha256:bdb0513d5af178caa1ad7b99d0efd1c795975e712a5c4695cadc8d27cfcace05
sourceRevisionDigest: sha256:b04b66d6cf242e4b34536e792b8cf9fe2241bf8c772d48a5c332cfbd2450cf30
sourceBlobDigest: sha256:d64d439a324819076eb2941bddebe10c544f5d276cd95788970d49c8f643bcf1
codeSamplesNamespace: clerk-openapi-python-code-samples
codeSamplesRevisionDigest: sha256:008b9e0938b911c8e0a4e1676fc1593d5e7971342ba3d67facfe2d836edb7195
codeSamplesRevisionDigest: sha256:b0fbbc5d5ff733c77b578b8859510557fdb669a43976e256d33bd32732cf1e15
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,16 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
from clerk_backend_api import Clerk


with Clerk() as clerk:
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
res = clerk.email_addresses.get(email_address_id="email_address_id_example")

# Use the SDK ...
assert res is not None

# Handle response
print(res)
```

</br>
Expand All @@ -146,11 +151,16 @@ from clerk_backend_api import Clerk

async def main():

async with Clerk() as clerk:
async with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")

await clerk.miscellaneous.get_public_interstitial_async(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
assert res is not None

# Use the SDK ...
# Handle response
print(res)

asyncio.run(main())
```
Expand All @@ -176,7 +186,7 @@ with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)

# Use the SDK ...

Expand Down Expand Up @@ -489,7 +499,7 @@ from clerk_backend_api.utils import BackoffStrategy, RetryConfig

with Clerk() as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True,
clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

# Use the SDK ...
Expand All @@ -506,7 +516,7 @@ with Clerk(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)

# Use the SDK ...

Expand Down Expand Up @@ -578,7 +588,7 @@ with Clerk(
server_url="https://api.clerk.com/v1",
) as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="<value>", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)

# Use the SDK ...

Expand Down Expand Up @@ -677,14 +687,18 @@ The `Clerk` class implements the context manager protocol and registers a finali
from clerk_backend_api import Clerk
def main():

with Clerk() as clerk:
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:
# Rest of application here...


# Or when using async:
async def amain():

async with Clerk() as clerk:
async with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:
# Rest of application here...
```
<!-- End Resource Management [resource-management] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,14 @@ Based on:
### Generated
- [python v2.0.2] .
### Releases
- [PyPI v2.0.2] https://pypi.org/project/clerk-backend-api/2.0.2 - .
- [PyPI v2.0.2] https://pypi.org/project/clerk-backend-api/2.0.2 - .

## 2025-05-06 00:21:45
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.542.3 (2.597.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v2.1.0] .
### Releases
- [PyPI v2.1.0] https://pypi.org/project/clerk-backend-api/2.1.0 - .
22 changes: 16 additions & 6 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
from clerk_backend_api import Clerk


with Clerk() as clerk:
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

clerk.miscellaneous.get_public_interstitial(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
res = clerk.email_addresses.get(email_address_id="email_address_id_example")

# Use the SDK ...
assert res is not None

# Handle response
print(res)
```

</br>
Expand All @@ -21,11 +26,16 @@ from clerk_backend_api import Clerk

async def main():

async with Clerk() as clerk:
async with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")

await clerk.miscellaneous.get_public_interstitial_async(frontend_api_query_parameter="frontend-api_1a2b3c4d", frontend_api_query_parameter1="pub_1a2b3c4d", publishable_key="pub_1a2b3c4d", proxy_url="https://mean-orchid.com/", domain="plump-reach.com", sign_in_url="https://delicious-costume.org/", use_domain_for_script=True)
assert res is not None

# Use the SDK ...
# Handle response
print(res)

asyncio.run(main())
```
Expand Down
6 changes: 3 additions & 3 deletions docs/models/actortoken.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Success
| `status` | [models.ActorTokenStatus](../models/actortokenstatus.md) | :heavy_check_mark: | N/A | pending |
| `user_id` | *str* | :heavy_check_mark: | N/A | user_1a2b3c |
| `actor` | [models.ActorTokenActor](../models/actortokenactor.md) | :heavy_check_mark: | N/A | {<br/>"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"<br/>} |
| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.<br/> | 1609459200 |
| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.<br/> | 1612137600 |
| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | token_string |
| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://example.com/token |
| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://example.com/token |
| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.<br/> | 1609459200 |
| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.<br/> | 1612137600 |
Loading