Skip to content

Commit 43718b0

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.0
1 parent 65ff2d7 commit 43718b0

File tree

280 files changed

+7949
-4863
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

280 files changed

+7949
-4863
lines changed

‎.speakeasy/gen.lock

+228-75
Large diffs are not rendered by default.

‎.speakeasy/gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ generation:
1515
oAuth2ClientCredentialsEnabled: true
1616
oAuth2PasswordEnabled: false
1717
python:
18-
version: 1.8.0
18+
version: 2.0.0
1919
additionalDependencies:
2020
dev:
2121
pytest: ^8.3.3

‎.speakeasy/workflow.lock

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.495.1
1+
speakeasyVersion: 1.526.0
22
sources:
33
clerk-openapi:
44
sourceNamespace: clerk-openapi
5-
sourceRevisionDigest: sha256:d4b68e7b261c9fd23c346291e7ca8c925d1c834140e3f0a1807a11ef7f3d41bb
6-
sourceBlobDigest: sha256:d384523908f855f5394f6242512679e5215cfdaf50bc8a7053f15a46cc565a61
5+
sourceRevisionDigest: sha256:4b76964b95ad3e33217b064a1b3ed6b8476367f79af5c7d315cbda1aca00a0cc
6+
sourceBlobDigest: sha256:c8365d3a47ede89b14cfccf2db48766e3c4e4ea221613255240707f1c338630e
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1739751656
10-
- v1
9+
- speakeasy-sdk-regen-1741709715
10+
- "2024-10-01"
1111
targets:
1212
clerk-sdk-python:
1313
source: clerk-openapi
1414
sourceNamespace: clerk-openapi
15-
sourceRevisionDigest: sha256:d4b68e7b261c9fd23c346291e7ca8c925d1c834140e3f0a1807a11ef7f3d41bb
16-
sourceBlobDigest: sha256:d384523908f855f5394f6242512679e5215cfdaf50bc8a7053f15a46cc565a61
15+
sourceRevisionDigest: sha256:4b76964b95ad3e33217b064a1b3ed6b8476367f79af5c7d315cbda1aca00a0cc
16+
sourceBlobDigest: sha256:c8365d3a47ede89b14cfccf2db48766e3c4e4ea221613255240707f1c338630e
1717
codeSamplesNamespace: clerk-openapi-python-code-samples
18-
codeSamplesRevisionDigest: sha256:366daf506ce8c8a843d3a1fb9b5a300d0afec1dac988ef6aa32b312f43e49f0e
18+
codeSamplesRevisionDigest: sha256:795f55c1fea544513070db2d6f1c48ab20550d3ce50a5693e9742362fe868958
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest
@@ -24,9 +24,8 @@ workflow:
2424
inputs:
2525
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2024-10-01.yml
2626
overlays:
27-
- location: ./fixes.yaml
2827
- location: ./examples.yaml
29-
- location: .speakeasy/speakeasy-suggestions.yaml
28+
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/.speakeasy/bapi/fixes.yml
3029
registry:
3130
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi
3231
targets:

‎.speakeasy/workflow.yaml

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ sources:
44
clerk-openapi:
55
inputs:
66
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2024-10-01.yml
7-
registry:
8-
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi
97
overlays:
108
- location: ./examples.yaml
119
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/.speakeasy/bapi/fixes.yml
12-
10+
registry:
11+
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi
1312
targets:
1413
clerk-sdk-python:
1514
target: python

‎README.md

+45-58
Large diffs are not rendered by default.

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -258,4 +258,14 @@ Based on:
258258
### Generated
259259
- [python v1.8.0] .
260260
### Releases
261-
- [PyPI v1.8.0] https://pypi.org/project/clerk-backend-api/1.8.0 - .
261+
- [PyPI v1.8.0] https://pypi.org/project/clerk-backend-api/1.8.0 - .
262+
263+
## 2025-03-31 00:21:50
264+
### Changes
265+
Based on:
266+
- OpenAPI Doc
267+
- Speakeasy CLI 1.526.0 (2.563.0) https://github.com/speakeasy-api/speakeasy
268+
### Generated
269+
- [python v2.0.0] .
270+
### Releases
271+
- [PyPI v2.0.0] https://pypi.org/project/clerk-backend-api/2.0.0 - .

‎USAGE.md

+6-14
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,12 @@
33
# Synchronous Example
44
from clerk_backend_api import Clerk
55

6-
with Clerk(
7-
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
8-
) as clerk:
96

10-
res = clerk.email_addresses.get(email_address_id="email_address_id_example")
7+
with Clerk() as clerk:
118

12-
assert res is not None
9+
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)
1310

14-
# Handle response
15-
print(res)
11+
# Use the SDK ...
1612
```
1713

1814
</br>
@@ -24,16 +20,12 @@ import asyncio
2420
from clerk_backend_api import Clerk
2521

2622
async def main():
27-
async with Clerk(
28-
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
29-
) as clerk:
3023

31-
res = await clerk.email_addresses.get_async(email_address_id="email_address_id_example")
24+
async with Clerk() as clerk:
3225

33-
assert res is not None
26+
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)
3427

35-
# Handle response
36-
print(res)
28+
# Use the SDK ...
3729

3830
asyncio.run(main())
3931
```

‎docs/models/actortoken.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Success
1414
| `actor` | [models.ActorTokenActor](../models/actortokenactor.md) | :heavy_check_mark: | N/A | {<br/>"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"<br/>} |
1515
| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.<br/> | 1609459200 |
1616
| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.<br/> | 1612137600 |
17-
| `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | token_string |
18-
| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://example.com/token |
17+
| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | token_string |
18+
| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://example.com/token |

‎docs/models/adddomainrequestbody.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
88
| `name` | *str* | :heavy_check_mark: | The new domain name. Can contain the port for development instances. | example.com |
99
| `is_satellite` | *bool* | :heavy_check_mark: | Marks the new domain as satellite. Only `true` is accepted at the moment. | true |
10-
| `proxy_url` | *Optional[str]* | :heavy_minus_sign: | The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances. | https://proxy.example.com |
10+
| `proxy_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances. | https://proxy.example.com |

‎docs/models/attributemapping.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# AttributeMapping
22

3+
Define the attribute name mapping between Identity Provider and Clerk's user properties
4+
35

46
## Fields
57

6-
| Field | Type | Required | Description |
7-
| ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
9-
| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A |
10-
| `first_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
11-
| `last_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
8+
| Field | Type | Required | Description | Example |
9+
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
10+
| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | nameid |
11+
| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | mail |
12+
| `first_name` | *Optional[str]* | :heavy_minus_sign: | N/A | givenName |
13+
| `last_name` | *Optional[str]* | :heavy_minus_sign: | N/A | surname |

‎docs/models/externalaccounts.md ‎docs/models/clerkerrorerrorexternalaccountwithverificationmeta.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ExternalAccounts
1+
# ClerkErrorErrorExternalAccountWithVerificationMeta
22

33

44
## Fields

‎docs/models/verifications.md ‎docs/models/clerkerrorerrorsamlaccountmeta.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Verifications
1+
# ClerkErrorErrorSAMLAccountMeta
22

33

44
## Fields

‎docs/models/cookies.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Cookies
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `object` | [models.CookiesObject](../models/cookiesobject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value. |
9+
| `cookies` | List[*str*] | :heavy_check_mark: | Array of cookie directives. |

‎docs/models/cookiesobject.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CookiesObject
2+
3+
String representing the object's type. Objects of the same type share the same value.
4+
5+
6+
## Values
7+
8+
| Name | Value |
9+
| --------- | --------- |
10+
| `COOKIES` | cookies |

‎docs/models/createactortokenactor.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@ This whole payload will be also included in the JWT session token.
66

77
## Fields
88

9-
| Field | Type | Required | Description |
10-
| ----------- | ----------- | ----------- | ----------- |
9+
| Field | Type | Required | Description | Example |
10+
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
11+
| `sub` | *str* | :heavy_check_mark: | The ID of the actor. | |
12+
| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {<br/>"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"<br/>} |

‎docs/models/createbulkinvitationstemplateslug.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreateBulkInvitationsTemplateSlug
2+
3+
The slug of the email template to use for the invitation email.
4+
5+
6+
## Values
7+
8+
| Name | Value |
9+
| --------------------- | --------------------- |
10+
| `INVITATION` | invitation |
11+
| `WAITLIST_INVITATION` | waitlist_invitation |

0 commit comments

Comments
 (0)