Skip to content

Commit acb4e79

Browse files
authored
Merge pull request #32 from clerk/speakeasy-sdk-regen-1729106200
chore: 🐝 Update SDK - Generate 1.0.0
2 parents c0db979 + 69dc63e commit acb4e79

File tree

218 files changed

+7582
-4950
lines changed

Some content is hidden

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

218 files changed

+7582
-4950
lines changed

.speakeasy/gen.lock

Lines changed: 124 additions & 74 deletions
Large diffs are not rendered by default.

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ generation:
1212
auth:
1313
oAuth2ClientCredentialsEnabled: true
1414
python:
15-
version: 0.5.0
15+
version: 1.0.0
1616
additionalDependencies:
1717
dev:
1818
pytest: ^8.3.3

.speakeasy/workflow.lock

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,29 @@ speakeasyVersion: 1.385.0
22
sources:
33
clerk-openapi:
44
sourceNamespace: clerk-openapi
5-
sourceRevisionDigest: sha256:6119b87229a597625b72db9000ea183ae53c14abf71976f5198f9f384cebc415
6-
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
5+
sourceRevisionDigest: sha256:80e76fbeeada366104bd0054f5f99a6e046202f93a5c3b5331e468afc3dd4b4d
6+
sourceBlobDigest: sha256:5973f4930511cc94f06052b98484a93dc07822f035843d1e5ea2a8f40188e68d
77
tags:
88
- latest
99
- main
1010
targets:
1111
clerk-sdk-python:
1212
source: clerk-openapi
1313
sourceNamespace: clerk-openapi
14-
sourceRevisionDigest: sha256:6119b87229a597625b72db9000ea183ae53c14abf71976f5198f9f384cebc415
15-
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
14+
sourceRevisionDigest: sha256:80e76fbeeada366104bd0054f5f99a6e046202f93a5c3b5331e468afc3dd4b4d
15+
sourceBlobDigest: sha256:5973f4930511cc94f06052b98484a93dc07822f035843d1e5ea2a8f40188e68d
1616
outLocation: .
1717
workflow:
1818
workflowVersion: 1.0.0
1919
speakeasyVersion: 1.385.0
2020
sources:
2121
clerk-openapi:
2222
inputs:
23-
- location: openapi.yaml
23+
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2021-02-05.yml
2424
overlays:
2525
- location: ./fixes.yaml
2626
- location: ./examples.yaml
27+
- location: .speakeasy/speakeasy-suggestions.yaml
2728
registry:
2829
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi
2930
targets:

README.md

Lines changed: 64 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ More information about the API can be found at https://clerk.com/docs
3838
* [IDE Support](#ide-support)
3939
* [SDK Example Usage](#sdk-example-usage)
4040
* [Available Resources and Operations](#available-resources-and-operations)
41-
* [Pagination](#pagination)
4241
* [File uploads](#file-uploads)
4342
* [Retries](#retries)
4443
* [Error Handling](#error-handling)
@@ -125,9 +124,9 @@ asyncio.run(main())
125124
<!-- Start Available Resources and Operations [operations] -->
126125
## Available Resources and Operations
127126

128-
### [misc](docs/sdks/misc/README.md)
127+
### [miscellaneous](docs/sdks/miscellaneous/README.md)
129128

130-
* [get_public_interstitial](docs/sdks/misc/README.md#get_public_interstitial) - Returns the markup for the interstitial page
129+
* [get_interstitial](docs/sdks/miscellaneous/README.md#get_interstitial) - Returns the markup for the interstitial page
131130

132131
### [jwks](docs/sdks/jwks/README.md)
133132

@@ -161,14 +160,18 @@ asyncio.run(main())
161160
* [~~verify~~](docs/sdks/sessions/README.md#verify) - Verify a session :warning: **Deprecated**
162161
* [create_token_from_template](docs/sdks/sessions/README.md#create_token_from_template) - Create a session token from a jwt template
163162

163+
### [email_sms_templates](docs/sdks/emailsmstemplates/README.md)
164+
165+
* [~~get~~](docs/sdks/emailsmstemplates/README.md#get) - Retrieve a template :warning: **Deprecated**
166+
* [~~toggle_template_delivery~~](docs/sdks/emailsmstemplates/README.md#toggle_template_delivery) - Toggle the delivery by Clerk for a template of a given type and slug :warning: **Deprecated**
167+
168+
### [email_and_sms_templates](docs/sdks/emailandsmstemplates/README.md)
169+
170+
* [~~upsert~~](docs/sdks/emailandsmstemplates/README.md#upsert) - Update a template for a given type and slug :warning: **Deprecated**
171+
164172
### [templates](docs/sdks/templates/README.md)
165173

166-
* [list](docs/sdks/templates/README.md#list) - List all templates
167-
* [get](docs/sdks/templates/README.md#get) - Retrieve a template
168-
* [upsert](docs/sdks/templates/README.md#upsert) - Update a template for a given type and slug
169-
* [revert](docs/sdks/templates/README.md#revert) - Revert a template
170-
* [preview](docs/sdks/templates/README.md#preview) - Preview changes to a template
171-
* [toggle_delivery](docs/sdks/templates/README.md#toggle_delivery) - Toggle the delivery by Clerk for a template of a given type and slug
174+
* [~~preview~~](docs/sdks/templates/README.md#preview) - Preview changes to a template :warning: **Deprecated**
172175

173176
### [users](docs/sdks/users/README.md)
174177

@@ -187,32 +190,52 @@ asyncio.run(main())
187190
* [update_metadata](docs/sdks/users/README.md#update_metadata) - Merge and update a user's metadata
188191
* [get_o_auth_access_token](docs/sdks/users/README.md#get_o_auth_access_token) - Retrieve the OAuth access token of a user
189192
* [get_organization_memberships](docs/sdks/users/README.md#get_organization_memberships) - Retrieve all memberships for a user
193+
* [get_organization_invitations](docs/sdks/users/README.md#get_organization_invitations) - Retrieve all invitations for a user
190194
* [verify_password](docs/sdks/users/README.md#verify_password) - Verify the password of a user
191195
* [verify_totp](docs/sdks/users/README.md#verify_totp) - Verify a TOTP or backup code for a user
192196
* [disable_mfa](docs/sdks/users/README.md#disable_mfa) - Disable a user's MFA methods
197+
* [delete_backup_codes](docs/sdks/users/README.md#delete_backup_codes) - Disable all user's Backup codes
198+
* [delete_passkey](docs/sdks/users/README.md#delete_passkey) - Delete a user passkey
199+
* [delete_web3_wallet](docs/sdks/users/README.md#delete_web3_wallet) - Delete a user web3 wallet
200+
* [create_totp](docs/sdks/users/README.md#create_totp) - Create a TOTP for a user
201+
* [delete_totp](docs/sdks/users/README.md#delete_totp) - Delete all the user's TOTPs
202+
* [delete_external_account](docs/sdks/users/README.md#delete_external_account) - Delete External Account
193203

194204
### [invitations](docs/sdks/invitations/README.md)
195205

196206
* [create](docs/sdks/invitations/README.md#create) - Create an invitation
197207
* [list](docs/sdks/invitations/README.md#list) - List all invitations
198208
* [revoke](docs/sdks/invitations/README.md#revoke) - Revokes an invitation
199209

210+
### [organization_invitations](docs/sdks/organizationinvitationssdk/README.md)
211+
212+
* [get_all](docs/sdks/organizationinvitationssdk/README.md#get_all) - Get a list of organization invitations for the current instance
213+
* [create](docs/sdks/organizationinvitationssdk/README.md#create) - Create and send an organization invitation
214+
* [list](docs/sdks/organizationinvitationssdk/README.md#list) - Get a list of organization invitations
215+
* [bulk_create](docs/sdks/organizationinvitationssdk/README.md#bulk_create) - Bulk create and send organization invitations
216+
* [~~list_pending~~](docs/sdks/organizationinvitationssdk/README.md#list_pending) - Get a list of pending organization invitations :warning: **Deprecated**
217+
* [get](docs/sdks/organizationinvitationssdk/README.md#get) - Retrieve an organization invitation by ID
218+
* [revoke](docs/sdks/organizationinvitationssdk/README.md#revoke) - Revoke a pending organization invitation
219+
220+
### [allowlist_blocklist](docs/sdks/allowlistblocklist/README.md)
221+
222+
* [list_allowlist_identifiers](docs/sdks/allowlistblocklist/README.md#list_allowlist_identifiers) - List all identifiers on the allow-list
223+
* [create_allowlist_identifier](docs/sdks/allowlistblocklist/README.md#create_allowlist_identifier) - Add identifier to the allow-list
224+
* [create_blocklist_identifier](docs/sdks/allowlistblocklist/README.md#create_blocklist_identifier) - Add identifier to the block-list
225+
* [delete_blocklist_identifier](docs/sdks/allowlistblocklist/README.md#delete_blocklist_identifier) - Delete identifier from block-list
226+
200227
### [allowlist_identifiers](docs/sdks/allowlistidentifiers/README.md)
201228

202-
* [list](docs/sdks/allowlistidentifiers/README.md#list) - List all identifiers on the allow-list
203-
* [create](docs/sdks/allowlistidentifiers/README.md#create) - Add identifier to the allow-list
204229
* [delete](docs/sdks/allowlistidentifiers/README.md#delete) - Delete identifier from allow-list
205230

206231
### [blocklist_identifiers](docs/sdks/blocklistidentifierssdk/README.md)
207232

208233
* [list](docs/sdks/blocklistidentifierssdk/README.md#list) - List all identifiers on the block-list
209-
* [create](docs/sdks/blocklistidentifierssdk/README.md#create) - Add identifier to the block-list
210-
* [delete](docs/sdks/blocklistidentifierssdk/README.md#delete) - Delete identifier from block-list
211234

212235
### [beta_features](docs/sdks/betafeatures/README.md)
213236

214-
* [update_instance_auth_config](docs/sdks/betafeatures/README.md#update_instance_auth_config) - Update instance settings
215-
* [~~update_production_instance_domain~~](docs/sdks/betafeatures/README.md#update_production_instance_domain) - Update production instance domain :warning: **Deprecated**
237+
* [update_instance_settings](docs/sdks/betafeatures/README.md#update_instance_settings) - Update instance settings
238+
* [~~update_domain~~](docs/sdks/betafeatures/README.md#update_domain) - Update production instance domain :warning: **Deprecated**
216239
* [change_production_instance_domain](docs/sdks/betafeatures/README.md#change_production_instance_domain) - Update production instance domain
217240

218241
### [actor_tokens](docs/sdks/actortokens/README.md)
@@ -258,33 +281,38 @@ asyncio.run(main())
258281
* [upload_logo](docs/sdks/organizationssdk/README.md#upload_logo) - Upload a logo for the organization
259282
* [delete_logo](docs/sdks/organizationssdk/README.md#delete_logo) - Delete the organization's logo.
260283

261-
### [organization_invitations](docs/sdks/organizationinvitationssdk/README.md)
262-
263-
* [create](docs/sdks/organizationinvitationssdk/README.md#create) - Create and send an organization invitation
264-
* [list](docs/sdks/organizationinvitationssdk/README.md#list) - Get a list of organization invitations
265-
* [create_bulk](docs/sdks/organizationinvitationssdk/README.md#create_bulk) - Bulk create and send organization invitations
266-
* [~~list_pending~~](docs/sdks/organizationinvitationssdk/README.md#list_pending) - Get a list of pending organization invitations :warning: **Deprecated**
267-
* [get](docs/sdks/organizationinvitationssdk/README.md#get) - Retrieve an organization invitation by ID
268-
* [revoke](docs/sdks/organizationinvitationssdk/README.md#revoke) - Revoke a pending organization invitation
269-
270284
### [organization_memberships](docs/sdks/organizationmembershipssdk/README.md)
271285

272286
* [create](docs/sdks/organizationmembershipssdk/README.md#create) - Create a new organization membership
273287
* [list](docs/sdks/organizationmembershipssdk/README.md#list) - Get a list of all members of an organization
274288
* [update](docs/sdks/organizationmembershipssdk/README.md#update) - Update an organization membership
275289
* [delete](docs/sdks/organizationmembershipssdk/README.md#delete) - Remove a member from an organization
276290
* [update_metadata](docs/sdks/organizationmembershipssdk/README.md#update_metadata) - Merge and update organization membership metadata
291+
* [get_all](docs/sdks/organizationmembershipssdk/README.md#get_all) - Get a list of all organization memberships within an instance.
292+
293+
### [organization_domains](docs/sdks/organizationdomainssdk/README.md)
294+
295+
* [create](docs/sdks/organizationdomainssdk/README.md#create) - Create a new organization domain.
296+
* [list](docs/sdks/organizationdomainssdk/README.md#list) - Get a list of all domains of an organization.
297+
* [delete](docs/sdks/organizationdomainssdk/README.md#delete) - Remove a domain from an organization.
298+
299+
### [organization_domain](docs/sdks/organizationdomainsdk/README.md)
300+
301+
* [update](docs/sdks/organizationdomainsdk/README.md#update) - Update an organization domain.
277302

278303
### [proxy_checks](docs/sdks/proxychecks/README.md)
279304

280305
* [verify](docs/sdks/proxychecks/README.md#verify) - Verify the proxy configuration for your domain
281306

282-
### [redirect_urls](docs/sdks/redirecturls/README.md)
307+
### [redirect_ur_ls](docs/sdks/redirecturls/README.md)
283308

284309
* [list](docs/sdks/redirecturls/README.md#list) - List all redirect URLs
285-
* [create](docs/sdks/redirecturls/README.md#create) - Create a redirect URL
286-
* [get](docs/sdks/redirecturls/README.md#get) - Retrieve a redirect URL
287-
* [delete](docs/sdks/redirecturls/README.md#delete) - Delete a redirect URL
310+
311+
### [redirect_urls](docs/sdks/clerkredirecturls/README.md)
312+
313+
* [create](docs/sdks/clerkredirecturls/README.md#create) - Create a redirect URL
314+
* [get](docs/sdks/clerkredirecturls/README.md#get) - Retrieve a redirect URL
315+
* [delete](docs/sdks/clerkredirecturls/README.md#delete) - Delete a redirect URL
288316

289317
### [sign_in_tokens](docs/sdks/signintokens/README.md)
290318

@@ -295,7 +323,7 @@ asyncio.run(main())
295323

296324
* [update](docs/sdks/signups/README.md#update) - Update a sign-up
297325

298-
### [o_auth_applications](docs/sdks/oauthapplicationssdk/README.md)
326+
### [oauth_applications](docs/sdks/oauthapplicationssdk/README.md)
299327

300328
* [list](docs/sdks/oauthapplicationssdk/README.md#list) - Get a list of OAuth applications for an instance
301329
* [create](docs/sdks/oauthapplicationssdk/README.md#create) - Create an OAuth application
@@ -317,36 +345,6 @@ asyncio.run(main())
317345
* [create](docs/sdks/testingtokens/README.md#create) - Retrieve a new testing token
318346
<!-- End Available Resources and Operations [operations] -->
319347

320-
<!-- Start Pagination [pagination] -->
321-
## Pagination
322-
323-
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
324-
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
325-
return value of `Next` is `None`, then there are no more pages to be fetched.
326-
327-
Here's an example of one such pagination call:
328-
```python
329-
from clerk_backend_api import Clerk
330-
331-
s = Clerk(
332-
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
333-
)
334-
335-
336-
res = s.clients.list(limit=20, offset=10)
337-
338-
if res is not None:
339-
while True:
340-
# handle items
341-
342-
res = res.Next()
343-
if res is None:
344-
break
345-
346-
347-
```
348-
<!-- End Pagination [pagination] -->
349-
350348
<!-- Start File uploads [file-upload] -->
351349
## File uploads
352350

@@ -391,7 +389,7 @@ from clerk_backend_api import Clerk
391389
s = Clerk()
392390

393391

394-
s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
392+
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
395393
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
396394

397395
# Use the SDK ...
@@ -408,7 +406,7 @@ s = Clerk(
408406
)
409407

410408

411-
s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
409+
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
412410

413411
# Use the SDK ...
414412

@@ -446,13 +444,8 @@ except models.SDKError as e:
446444
raise(e)
447445

448446
if res is not None:
449-
while True:
450-
# handle items
451-
452-
res = res.Next()
453-
if res is None:
454-
break
455-
447+
# handle response
448+
pass
456449

457450
```
458451
<!-- End Error Handling [errors] -->
@@ -478,7 +471,7 @@ s = Clerk(
478471
)
479472

480473

481-
s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
474+
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
482475

483476
# Use the SDK ...
484477

@@ -496,7 +489,7 @@ s = Clerk(
496489
)
497490

498491

499-
s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
492+
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
500493

501494
# Use the SDK ...
502495

@@ -604,7 +597,7 @@ s = Clerk(
604597
)
605598

606599

607-
s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
600+
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
608601

609602
# Use the SDK ...
610603

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,14 @@ Based on:
8888
### Generated
8989
- [python v0.5.0] .
9090
### Releases
91-
- [PyPI v0.5.0] https://pypi.org/project/clerk-backend-api/0.5.0 - .
91+
- [PyPI v0.5.0] https://pypi.org/project/clerk-backend-api/0.5.0 - .
92+
93+
## 2024-10-18 14:54:20
94+
### Changes
95+
Based on:
96+
- OpenAPI Doc
97+
- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy
98+
### Generated
99+
- [python v1.0.0] .
100+
### Releases
101+
- [PyPI v1.0.0] https://pypi.org/project/clerk-backend-api/1.0.0 - .

docs/models/adminverificationstrategy.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
## Values
55

6-
| Name | Value |
7-
| -------------------- | -------------------- |
8-
| `ADMIN` | admin |
9-
| `FROM_OAUTH_DISCORD` | from_oauth_discord |
6+
| Name | Value |
7+
| ------- | ------- |
8+
| `ADMIN` | admin |

docs/models/adminverificationweb3walletstrategy.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
## Values
55

6-
| Name | Value |
7-
| -------------------- | -------------------- |
8-
| `ADMIN` | admin |
9-
| `FROM_OAUTH_DISCORD` | from_oauth_discord |
6+
| Name | Value |
7+
| ------- | ------- |
8+
| `ADMIN` | admin |

docs/models/attributemapping.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description | Example |
7-
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | nameid |
9-
| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | email |
10-
| `first_name` | *Optional[str]* | :heavy_minus_sign: | N/A | firstName |
11-
| `last_name` | *Optional[str]* | :heavy_minus_sign: | N/A | lastName |
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 |

0 commit comments

Comments
 (0)