Skip to content

Commit

Permalink
Merge pull request #32 from clerk/speakeasy-sdk-regen-1729106200
Browse files Browse the repository at this point in the history
chore: 🐝 Update SDK - Generate 1.0.0
  • Loading branch information
speakeasybot authored Oct 18, 2024
2 parents c0db979 + 69dc63e commit acb4e79
Show file tree
Hide file tree
Showing 218 changed files with 7,582 additions and 4,950 deletions.
198 changes: 124 additions & 74 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
python:
version: 0.5.0
version: 1.0.0
additionalDependencies:
dev:
pytest: ^8.3.3
Expand Down
11 changes: 6 additions & 5 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,29 @@ speakeasyVersion: 1.385.0
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:6119b87229a597625b72db9000ea183ae53c14abf71976f5198f9f384cebc415
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
sourceRevisionDigest: sha256:80e76fbeeada366104bd0054f5f99a6e046202f93a5c3b5331e468afc3dd4b4d
sourceBlobDigest: sha256:5973f4930511cc94f06052b98484a93dc07822f035843d1e5ea2a8f40188e68d
tags:
- latest
- main
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:6119b87229a597625b72db9000ea183ae53c14abf71976f5198f9f384cebc415
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
sourceRevisionDigest: sha256:80e76fbeeada366104bd0054f5f99a6e046202f93a5c3b5331e468afc3dd4b4d
sourceBlobDigest: sha256:5973f4930511cc94f06052b98484a93dc07822f035843d1e5ea2a8f40188e68d
outLocation: .
workflow:
workflowVersion: 1.0.0
speakeasyVersion: 1.385.0
sources:
clerk-openapi:
inputs:
- location: openapi.yaml
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2021-02-05.yml
overlays:
- location: ./fixes.yaml
- location: ./examples.yaml
- location: .speakeasy/speakeasy-suggestions.yaml
registry:
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi
targets:
Expand Down
135 changes: 64 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ More information about the API can be found at https://clerk.com/docs
* [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Pagination](#pagination)
* [File uploads](#file-uploads)
* [Retries](#retries)
* [Error Handling](#error-handling)
Expand Down Expand Up @@ -125,9 +124,9 @@ asyncio.run(main())
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

### [misc](docs/sdks/misc/README.md)
### [miscellaneous](docs/sdks/miscellaneous/README.md)

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

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

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

### [email_sms_templates](docs/sdks/emailsmstemplates/README.md)

* [~~get~~](docs/sdks/emailsmstemplates/README.md#get) - Retrieve a template :warning: **Deprecated**
* [~~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**

### [email_and_sms_templates](docs/sdks/emailandsmstemplates/README.md)

* [~~upsert~~](docs/sdks/emailandsmstemplates/README.md#upsert) - Update a template for a given type and slug :warning: **Deprecated**

### [templates](docs/sdks/templates/README.md)

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

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

Expand All @@ -187,32 +190,52 @@ asyncio.run(main())
* [update_metadata](docs/sdks/users/README.md#update_metadata) - Merge and update a user's metadata
* [get_o_auth_access_token](docs/sdks/users/README.md#get_o_auth_access_token) - Retrieve the OAuth access token of a user
* [get_organization_memberships](docs/sdks/users/README.md#get_organization_memberships) - Retrieve all memberships for a user
* [get_organization_invitations](docs/sdks/users/README.md#get_organization_invitations) - Retrieve all invitations for a user
* [verify_password](docs/sdks/users/README.md#verify_password) - Verify the password of a user
* [verify_totp](docs/sdks/users/README.md#verify_totp) - Verify a TOTP or backup code for a user
* [disable_mfa](docs/sdks/users/README.md#disable_mfa) - Disable a user's MFA methods
* [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

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

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

### [organization_invitations](docs/sdks/organizationinvitationssdk/README.md)

* [get_all](docs/sdks/organizationinvitationssdk/README.md#get_all) - Get a list of organization invitations for the current instance
* [create](docs/sdks/organizationinvitationssdk/README.md#create) - Create and send an organization invitation
* [list](docs/sdks/organizationinvitationssdk/README.md#list) - Get a list of organization invitations
* [bulk_create](docs/sdks/organizationinvitationssdk/README.md#bulk_create) - Bulk create and send organization invitations
* [~~list_pending~~](docs/sdks/organizationinvitationssdk/README.md#list_pending) - Get a list of pending organization invitations :warning: **Deprecated**
* [get](docs/sdks/organizationinvitationssdk/README.md#get) - Retrieve an organization invitation by ID
* [revoke](docs/sdks/organizationinvitationssdk/README.md#revoke) - Revoke a pending organization invitation

### [allowlist_blocklist](docs/sdks/allowlistblocklist/README.md)

* [list_allowlist_identifiers](docs/sdks/allowlistblocklist/README.md#list_allowlist_identifiers) - List all identifiers on the allow-list
* [create_allowlist_identifier](docs/sdks/allowlistblocklist/README.md#create_allowlist_identifier) - Add identifier to the allow-list
* [create_blocklist_identifier](docs/sdks/allowlistblocklist/README.md#create_blocklist_identifier) - Add identifier to the block-list
* [delete_blocklist_identifier](docs/sdks/allowlistblocklist/README.md#delete_blocklist_identifier) - Delete identifier from block-list

### [allowlist_identifiers](docs/sdks/allowlistidentifiers/README.md)

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

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

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

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

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

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

### [organization_invitations](docs/sdks/organizationinvitationssdk/README.md)

* [create](docs/sdks/organizationinvitationssdk/README.md#create) - Create and send an organization invitation
* [list](docs/sdks/organizationinvitationssdk/README.md#list) - Get a list of organization invitations
* [create_bulk](docs/sdks/organizationinvitationssdk/README.md#create_bulk) - Bulk create and send organization invitations
* [~~list_pending~~](docs/sdks/organizationinvitationssdk/README.md#list_pending) - Get a list of pending organization invitations :warning: **Deprecated**
* [get](docs/sdks/organizationinvitationssdk/README.md#get) - Retrieve an organization invitation by ID
* [revoke](docs/sdks/organizationinvitationssdk/README.md#revoke) - Revoke a pending organization invitation

### [organization_memberships](docs/sdks/organizationmembershipssdk/README.md)

* [create](docs/sdks/organizationmembershipssdk/README.md#create) - Create a new organization membership
* [list](docs/sdks/organizationmembershipssdk/README.md#list) - Get a list of all members of an organization
* [update](docs/sdks/organizationmembershipssdk/README.md#update) - Update an organization membership
* [delete](docs/sdks/organizationmembershipssdk/README.md#delete) - Remove a member from an organization
* [update_metadata](docs/sdks/organizationmembershipssdk/README.md#update_metadata) - Merge and update organization membership metadata
* [get_all](docs/sdks/organizationmembershipssdk/README.md#get_all) - Get a list of all organization memberships within an instance.

### [organization_domains](docs/sdks/organizationdomainssdk/README.md)

* [create](docs/sdks/organizationdomainssdk/README.md#create) - Create a new organization domain.
* [list](docs/sdks/organizationdomainssdk/README.md#list) - Get a list of all domains of an organization.
* [delete](docs/sdks/organizationdomainssdk/README.md#delete) - Remove a domain from an organization.

### [organization_domain](docs/sdks/organizationdomainsdk/README.md)

* [update](docs/sdks/organizationdomainsdk/README.md#update) - Update an organization domain.

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

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

### [redirect_urls](docs/sdks/redirecturls/README.md)
### [redirect_ur_ls](docs/sdks/redirecturls/README.md)

* [list](docs/sdks/redirecturls/README.md#list) - List all redirect URLs
* [create](docs/sdks/redirecturls/README.md#create) - Create a redirect URL
* [get](docs/sdks/redirecturls/README.md#get) - Retrieve a redirect URL
* [delete](docs/sdks/redirecturls/README.md#delete) - Delete a redirect URL

### [redirect_urls](docs/sdks/clerkredirecturls/README.md)

* [create](docs/sdks/clerkredirecturls/README.md#create) - Create a redirect URL
* [get](docs/sdks/clerkredirecturls/README.md#get) - Retrieve a redirect URL
* [delete](docs/sdks/clerkredirecturls/README.md#delete) - Delete a redirect URL

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

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

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

### [o_auth_applications](docs/sdks/oauthapplicationssdk/README.md)
### [oauth_applications](docs/sdks/oauthapplicationssdk/README.md)

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

<!-- Start Pagination [pagination] -->
## Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:
```python
from clerk_backend_api import Clerk

s = Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.clients.list(limit=20, offset=10)

if res is not None:
while True:
# handle items

res = res.Next()
if res is None:
break


```
<!-- End Pagination [pagination] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Expand Down Expand Up @@ -391,7 +389,7 @@ from clerk_backend_api import Clerk
s = Clerk()


s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
s.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 @@ -408,7 +406,7 @@ s = Clerk(
)


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

# Use the SDK ...

Expand Down Expand Up @@ -446,13 +444,8 @@ except models.SDKError as e:
raise(e)

if res is not None:
while True:
# handle items

res = res.Next()
if res is None:
break

# handle response
pass

```
<!-- End Error Handling [errors] -->
Expand All @@ -478,7 +471,7 @@ s = Clerk(
)


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

# Use the SDK ...

Expand All @@ -496,7 +489,7 @@ s = Clerk(
)


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

# Use the SDK ...

Expand Down Expand Up @@ -604,7 +597,7 @@ s = Clerk(
)


s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
s.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 @@ -88,4 +88,14 @@ Based on:
### Generated
- [python v0.5.0] .
### Releases
- [PyPI v0.5.0] https://pypi.org/project/clerk-backend-api/0.5.0 - .
- [PyPI v0.5.0] https://pypi.org/project/clerk-backend-api/0.5.0 - .

## 2024-10-18 14:54:20
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v1.0.0] .
### Releases
- [PyPI v1.0.0] https://pypi.org/project/clerk-backend-api/1.0.0 - .
7 changes: 3 additions & 4 deletions docs/models/adminverificationstrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

## Values

| Name | Value |
| -------------------- | -------------------- |
| `ADMIN` | admin |
| `FROM_OAUTH_DISCORD` | from_oauth_discord |
| Name | Value |
| ------- | ------- |
| `ADMIN` | admin |
7 changes: 3 additions & 4 deletions docs/models/adminverificationweb3walletstrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

## Values

| Name | Value |
| -------------------- | -------------------- |
| `ADMIN` | admin |
| `FROM_OAUTH_DISCORD` | from_oauth_discord |
| Name | Value |
| ------- | ------- |
| `ADMIN` | admin |
12 changes: 6 additions & 6 deletions docs/models/attributemapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

## Fields

| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A | nameid |
| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | email |
| `first_name` | *Optional[str]* | :heavy_minus_sign: | N/A | firstName |
| `last_name` | *Optional[str]* | :heavy_minus_sign: | N/A | lastName |
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `user_id` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `first_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
| `last_name` | *Optional[str]* | :heavy_minus_sign: | N/A |
Loading

0 comments on commit acb4e79

Please sign in to comment.