diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 0d32f9d..100139e 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8 management: - docChecksum: 043152d28198abb5910dc00f65f25d0c + docChecksum: 3729a9e678b39fae6e60a063c4498eff docVersion: v1 speakeasyVersion: 1.385.0 generationVersion: 2.407.2 - releaseVersion: 1.0.3 - configChecksum: b8428ce9b92cb0413c5ae64ed0ada07e + releaseVersion: 1.1.0 + configChecksum: a11f3eebeffae0f4ac25bcc0f627c9ac repoURL: https://github.com/clerk/clerk-sdk-python.git installationURL: https://github.com/clerk/clerk-sdk-python.git published: true @@ -342,13 +342,9 @@ generatedFiles: - docs/models/previewtemplaterequest.md - docs/models/previewtemplateresponsebody.md - docs/models/userobject.md - - docs/models/publicmetadata.md - - docs/models/privatemetadata.md - - docs/models/unsafemetadata.md - docs/models/externalaccounts.md - docs/models/user.md - docs/models/samlaccountobject.md - - docs/models/samlaccountpublicmetadata.md - docs/models/ticketverificationstatus.md - docs/models/ticketverificationstrategy.md - docs/models/ticket.md @@ -379,17 +375,11 @@ generatedFiles: - docs/models/web3walletverification.md - docs/models/web3wallet.md - docs/models/getuserlistrequest.md - - docs/models/createuserpublicmetadata.md - - docs/models/createuserprivatemetadata.md - - docs/models/createuserunsafemetadata.md - docs/models/createuserrequestbody.md - docs/models/totalcountobject.md - docs/models/totalcount.md - docs/models/getuserscountrequest.md - docs/models/getuserrequest.md - - docs/models/updateuserpublicmetadata.md - - docs/models/updateuserprivatemetadata.md - - docs/models/updateuserunsafemetadata.md - docs/models/updateuserrequestbody.md - docs/models/updateuserrequest.md - docs/models/deleteuserrequest.md @@ -404,23 +394,16 @@ generatedFiles: - docs/models/updateusermetadatarequestbody.md - docs/models/updateusermetadatarequest.md - docs/models/getoauthaccesstokenrequest.md - - docs/models/getoauthaccesstokenpublicmetadata.md - docs/models/responsebody.md - docs/models/organizationmemberships.md - docs/models/organizationmembershipobject.md - - docs/models/organizationmembershippublicmetadata.md - - docs/models/organizationmembershipprivatemetadata.md - docs/models/organizationmembershiporganizationobject.md - - docs/models/organizationmembershiporganizationpublicmetadata.md - - docs/models/organizationmembershiporganizationprivatemetadata.md - docs/models/organizationmembershiporganization.md - docs/models/publicuserdata.md - docs/models/organizationmembership.md - docs/models/usersgetorganizationmembershipsrequest.md - docs/models/organizationinvitationswithpublicorganizationdata.md - docs/models/organizationinvitationwithpublicorganizationdataobject.md - - docs/models/organizationinvitationwithpublicorganizationdatapublicmetadata.md - - docs/models/organizationinvitationwithpublicorganizationdataprivatemetadata.md - docs/models/publicorganizationdata.md - docs/models/organizationinvitationwithpublicorganizationdata.md - docs/models/usersgetorganizationinvitationsqueryparamstatus.md @@ -444,33 +427,24 @@ generatedFiles: - docs/models/deletetotpresponsebody.md - docs/models/deleteexternalaccountrequest.md - docs/models/invitationobject.md - - docs/models/invitationpublicmetadata.md - docs/models/invitationstatus.md - docs/models/invitation.md - - docs/models/createinvitationpublicmetadata.md - docs/models/createinvitationrequestbody.md - docs/models/listinvitationsqueryparamstatus.md - docs/models/listinvitationsrequest.md - docs/models/invitationrevokedobject.md - - docs/models/invitationrevokedpublicmetadata.md - docs/models/invitationrevokedstatus.md - docs/models/invitationrevoked.md - docs/models/revokeinvitationrequest.md - docs/models/listinstanceorganizationinvitationsqueryparamstatus.md - docs/models/listinstanceorganizationinvitationsrequest.md - docs/models/organizationinvitationobject.md - - docs/models/organizationinvitationpublicmetadata.md - - docs/models/organizationinvitationprivatemetadata.md - docs/models/organizationinvitation.md - - docs/models/createorganizationinvitationpublicmetadata.md - - docs/models/createorganizationinvitationprivatemetadata.md - docs/models/createorganizationinvitationrequestbody.md - docs/models/createorganizationinvitationrequest.md - docs/models/organizationinvitations.md - docs/models/listorganizationinvitationsqueryparamstatus.md - docs/models/listorganizationinvitationsrequest.md - - docs/models/createorganizationinvitationbulkpublicmetadata.md - - docs/models/createorganizationinvitationbulkprivatemetadata.md - docs/models/requestbody.md - docs/models/createorganizationinvitationbulkrequest.md - docs/models/listpendingorganizationinvitationsrequest.md @@ -529,26 +503,16 @@ generatedFiles: - docs/models/deletejwttemplaterequest.md - docs/models/organizations.md - docs/models/organizationobject.md - - docs/models/organizationpublicmetadata.md - - docs/models/organizationprivatemetadata.md - docs/models/organization.md - docs/models/listorganizationsrequest.md - - docs/models/createorganizationprivatemetadata.md - - docs/models/createorganizationpublicmetadata.md - docs/models/createorganizationrequestbody.md - docs/models/getorganizationrequest.md - - docs/models/updateorganizationpublicmetadata.md - - docs/models/updateorganizationprivatemetadata.md - docs/models/updateorganizationrequestbody.md - docs/models/updateorganizationrequest.md - docs/models/deleteorganizationrequest.md - - docs/models/mergeorganizationmetadatapublicmetadata.md - - docs/models/mergeorganizationmetadataprivatemetadata.md - docs/models/mergeorganizationmetadatarequestbody.md - docs/models/mergeorganizationmetadatarequest.md - docs/models/organizationwithlogoobject.md - - docs/models/organizationwithlogopublicmetadata.md - - docs/models/organizationwithlogoprivatemetadata.md - docs/models/organizationwithlogo.md - docs/models/uploadorganizationlogofile.md - docs/models/uploadorganizationlogorequestbody.md @@ -560,8 +524,6 @@ generatedFiles: - docs/models/updateorganizationmembershiprequestbody.md - docs/models/updateorganizationmembershiprequest.md - docs/models/deleteorganizationmembershiprequest.md - - docs/models/updateorganizationmembershipmetadatapublicmetadata.md - - docs/models/updateorganizationmembershipmetadataprivatemetadata.md - docs/models/updateorganizationmembershipmetadatarequestbody.md - docs/models/updateorganizationmembershipmetadatarequest.md - docs/models/instancegetorganizationmembershipsrequest.md @@ -593,8 +555,6 @@ generatedFiles: - docs/models/signupobject.md - docs/models/signupstatus.md - docs/models/verifications.md - - docs/models/signupunsafemetadata.md - - docs/models/signuppublicmetadata.md - docs/models/externalaccount.md - docs/models/signup.md - docs/models/updatesignuprequestbody.md diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 0fc648b..577f7ca 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true python: - version: 1.0.3 + version: 1.1.0 additionalDependencies: dev: pytest: ^8.3.3 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 5df7bd9..c73c467 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.385.0 sources: clerk-openapi: sourceNamespace: clerk-openapi - sourceRevisionDigest: sha256:cb7803c6ffdf22c6c2f86624f751666b69750506def277d714bd468427e37098 - sourceBlobDigest: sha256:05dde7af49b5392e31929c79970f0103166fd78b445f66a3cc2972ffd50b9f44 + sourceRevisionDigest: sha256:893fdf33c6809a067465ad40efd04bf4f2d535e855afe6a77b4236d8c790c2f2 + sourceBlobDigest: sha256:6d2275786c3b69d57ac0156ca74ded589c0f709023afd8198dcafc521a054561 tags: - latest - main @@ -11,8 +11,8 @@ targets: clerk-sdk-python: source: clerk-openapi sourceNamespace: clerk-openapi - sourceRevisionDigest: sha256:cb7803c6ffdf22c6c2f86624f751666b69750506def277d714bd468427e37098 - sourceBlobDigest: sha256:05dde7af49b5392e31929c79970f0103166fd78b445f66a3cc2972ffd50b9f44 + sourceRevisionDigest: sha256:893fdf33c6809a067465ad40efd04bf4f2d535e855afe6a77b4236d8c790c2f2 + sourceBlobDigest: sha256:6d2275786c3b69d57ac0156ca74ded589c0f709023afd8198dcafc521a054561 outLocation: . workflow: workflowVersion: 1.0.0 diff --git a/RELEASES.md b/RELEASES.md index 82c16f1..4749710 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -128,4 +128,14 @@ Based on: ### Generated - [python v1.0.3] . ### Releases -- [PyPI v1.0.3] https://pypi.org/project/clerk-backend-api/1.0.3 - . \ No newline at end of file +- [PyPI v1.0.3] https://pypi.org/project/clerk-backend-api/1.0.3 - . + +## 2024-10-29 00:30:29 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.1.0] . +### Releases +- [PyPI v1.1.0] https://pypi.org/project/clerk-backend-api/1.1.0 - . \ No newline at end of file diff --git a/docs/models/createinvitationpublicmetadata.md b/docs/models/createinvitationpublicmetadata.md deleted file mode 100644 index 0ae2ee3..0000000 --- a/docs/models/createinvitationpublicmetadata.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateInvitationPublicMetadata - -Metadata that will be attached to the newly created invitation. -The value of this property should be a well-formed JSON object. -Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createinvitationrequestbody.md b/docs/models/createinvitationrequestbody.md index 574ab15..e167b56 100644 --- a/docs/models/createinvitationrequestbody.md +++ b/docs/models/createinvitationrequestbody.md @@ -8,7 +8,7 @@ Required parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `email_address` | *str* | :heavy_check_mark: | The email address the invitation will be sent to | user@example.com | -| `public_metadata` | [Optional[models.CreateInvitationPublicMetadata]](../models/createinvitationpublicmetadata.md) | :heavy_minus_sign: | Metadata that will be attached to the newly created invitation.
The value of this property should be a well-formed JSON object.
Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata that will be attached to the newly created invitation.
The value of this property should be a well-formed JSON object.
Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | {} | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | Optional URL which specifies where to redirect the user once they click the invitation link.
This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components. | https://example.com/welcome | | `notify` | *OptionalNullable[bool]* | :heavy_minus_sign: | Optional flag which denotes whether an email invitation should be sent to the given email address.
Defaults to true. | true | | `ignore_existing` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | ​false | diff --git a/docs/models/createorganizationinvitationbulkprivatemetadata.md b/docs/models/createorganizationinvitationbulkprivatemetadata.md deleted file mode 100644 index 36a117b..0000000 --- a/docs/models/createorganizationinvitationbulkprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationInvitationBulkPrivateMetadata - -Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationinvitationbulkpublicmetadata.md b/docs/models/createorganizationinvitationbulkpublicmetadata.md deleted file mode 100644 index 6b0de6e..0000000 --- a/docs/models/createorganizationinvitationbulkpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationInvitationBulkPublicMetadata - -Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationinvitationprivatemetadata.md b/docs/models/createorganizationinvitationprivatemetadata.md deleted file mode 100644 index cb30466..0000000 --- a/docs/models/createorganizationinvitationprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationInvitationPrivateMetadata - -Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationinvitationpublicmetadata.md b/docs/models/createorganizationinvitationpublicmetadata.md deleted file mode 100644 index 59477dd..0000000 --- a/docs/models/createorganizationinvitationpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationInvitationPublicMetadata - -Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationinvitationrequestbody.md b/docs/models/createorganizationinvitationrequestbody.md index b3c1130..631f7fa 100644 --- a/docs/models/createorganizationinvitationrequestbody.md +++ b/docs/models/createorganizationinvitationrequestbody.md @@ -8,6 +8,6 @@ | `email_address` | *str* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | user@example.com | | `role` | *str* | :heavy_check_mark: | The role of the new member in the organization | admin | | `inviter_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | user_67890 | -| `public_metadata` | [Optional[models.CreateOrganizationInvitationPublicMetadata]](../models/createorganizationinvitationpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {
"key": "value"
} | -| `private_metadata` | [Optional[models.CreateOrganizationInvitationPrivateMetadata]](../models/createorganizationinvitationprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {
"private_key": "secret_value"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {
"key": "value"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {
"private_key": "secret_value"
} | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | https://example.com/welcome | \ No newline at end of file diff --git a/docs/models/createorganizationprivatemetadata.md b/docs/models/createorganizationprivatemetadata.md deleted file mode 100644 index f2f829a..0000000 --- a/docs/models/createorganizationprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationPrivateMetadata - -Metadata saved on the organization, accessible only from the Backend API - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationpublicmetadata.md b/docs/models/createorganizationpublicmetadata.md deleted file mode 100644 index b80d04c..0000000 --- a/docs/models/createorganizationpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateOrganizationPublicMetadata - -Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createorganizationrequestbody.md b/docs/models/createorganizationrequestbody.md index 7ea1b18..854cf4f 100644 --- a/docs/models/createorganizationrequestbody.md +++ b/docs/models/createorganizationrequestbody.md @@ -7,8 +7,8 @@ | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *str* | :heavy_check_mark: | The name of the new organization.
May not contain URLs or HTML. | NewOrg | | `created_by` | *str* | :heavy_check_mark: | The ID of the User who will become the administrator for the new organization | user_123 | -| `private_metadata` | [Optional[models.CreateOrganizationPrivateMetadata]](../models/createorganizationprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API | {
"internal_code": "ABC123"
} | -| `public_metadata` | [Optional[models.CreateOrganizationPublicMetadata]](../models/createorganizationpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | {
"public_event": "Annual Summit"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API | {
"internal_code": "ABC123"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | {
"public_event": "Annual Summit"
} | | `slug` | *Optional[str]* | :heavy_minus_sign: | A slug for the new organization.
Can contain only lowercase alphanumeric characters and the dash "-".
Must be unique for the instance. | neworg | | `max_allowed_memberships` | *Optional[int]* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | 100 | | `created_at` | *Optional[str]* | :heavy_minus_sign: | A custom date/time denoting _when_ the organization was created, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | | \ No newline at end of file diff --git a/docs/models/createuserprivatemetadata.md b/docs/models/createuserprivatemetadata.md deleted file mode 100644 index 72f62d2..0000000 --- a/docs/models/createuserprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateUserPrivateMetadata - -Metadata saved on the user, that is only visible to your Backend API - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createuserpublicmetadata.md b/docs/models/createuserpublicmetadata.md deleted file mode 100644 index 7f94e06..0000000 --- a/docs/models/createuserpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateUserPublicMetadata - -Metadata saved on the user, that is visible to both your Frontend and Backend APIs - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/createuserrequestbody.md b/docs/models/createuserrequestbody.md index 7eb26ce..8c14c4e 100644 --- a/docs/models/createuserrequestbody.md +++ b/docs/models/createuserrequestbody.md @@ -19,9 +19,9 @@ | `skip_password_requirement` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, `password` is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | false | | `totp_secret` | *Optional[str]* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | base32totpsecretkey | | `backup_codes` | List[*str*] | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | [
"123456",
"654321"
] | -| `public_metadata` | [Optional[models.CreateUserPublicMetadata]](../models/createuserpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"role": "user"
} | -| `private_metadata` | [Optional[models.CreateUserPrivateMetadata]](../models/createuserprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"internal_id": "789"
} | -| `unsafe_metadata` | [Optional[models.CreateUserUnsafeMetadata]](../models/createuserunsafemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"preferences": {
"theme": "dark"
}
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"role": "user"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"internal_id": "789"
} | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"preferences": {
"theme": "dark"
}
} | | `delete_self_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| | | `legal_accepted_at` | *OptionalNullable[str]* | :heavy_minus_sign: | A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | | | `skip_legal_checks` | *OptionalNullable[bool]* | :heavy_minus_sign: | When set to `true` all legal checks are skipped.
It is not recommended to skip legal checks unless you are migrating a user to Clerk. | | diff --git a/docs/models/createuserunsafemetadata.md b/docs/models/createuserunsafemetadata.md deleted file mode 100644 index 9513e30..0000000 --- a/docs/models/createuserunsafemetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateUserUnsafeMetadata - -Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. -Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/getoauthaccesstokenpublicmetadata.md b/docs/models/getoauthaccesstokenpublicmetadata.md deleted file mode 100644 index a6e935a..0000000 --- a/docs/models/getoauthaccesstokenpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# GetOAuthAccessTokenPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/invitation.md b/docs/models/invitation.md index 26908da..3f52ac7 100644 --- a/docs/models/invitation.md +++ b/docs/models/invitation.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `object` | [models.InvitationObject](../models/invitationobject.md) | :heavy_check_mark: | N/A | invitation | -| `id` | *str* | :heavy_check_mark: | N/A | inv_f02930r3 | -| `email_address` | *str* | :heavy_check_mark: | N/A | invitee@example.com | -| `status` | [models.InvitationStatus](../models/invitationstatus.md) | :heavy_check_mark: | N/A | pending | -| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1622549600 | -| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1622553200 | -| `public_metadata` | [Optional[models.InvitationPublicMetadata]](../models/invitationpublicmetadata.md) | :heavy_minus_sign: | N/A | {} | -| `revoked` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | -| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://example.com/invitations/accept?code=abcd1234 | -| `expires_at` | *OptionalNullable[int]* | :heavy_minus_sign: | Unix timestamp of expiration.
| | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `object` | [models.InvitationObject](../models/invitationobject.md) | :heavy_check_mark: | N/A | invitation | +| `id` | *str* | :heavy_check_mark: | N/A | inv_f02930r3 | +| `email_address` | *str* | :heavy_check_mark: | N/A | invitee@example.com | +| `status` | [models.InvitationStatus](../models/invitationstatus.md) | :heavy_check_mark: | N/A | pending | +| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1622549600 | +| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1622553200 | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {} | +| `revoked` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | +| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://example.com/invitations/accept?code=abcd1234 | +| `expires_at` | *OptionalNullable[int]* | :heavy_minus_sign: | Unix timestamp of expiration.
| | \ No newline at end of file diff --git a/docs/models/invitationpublicmetadata.md b/docs/models/invitationpublicmetadata.md deleted file mode 100644 index 86cefd3..0000000 --- a/docs/models/invitationpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# InvitationPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/invitationrevoked.md b/docs/models/invitationrevoked.md index a5f17aa..4e065fc 100644 --- a/docs/models/invitationrevoked.md +++ b/docs/models/invitationrevoked.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `object` | [models.InvitationRevokedObject](../models/invitationrevokedobject.md) | :heavy_check_mark: | N/A | invitation | -| `id` | *str* | :heavy_check_mark: | N/A | inv_f02930r3 | -| `email_address` | *str* | :heavy_check_mark: | N/A | invitee@example.com | -| `status` | [models.InvitationRevokedStatus](../models/invitationrevokedstatus.md) | :heavy_check_mark: | N/A | revoked | -| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1622549600 | -| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1622553200 | -| `public_metadata` | [Optional[models.InvitationRevokedPublicMetadata]](../models/invitationrevokedpublicmetadata.md) | :heavy_minus_sign: | N/A | {} | -| `revoked` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | -| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://example.com/invitations/accept?code=abcd1234 | -| `expires_at` | *OptionalNullable[int]* | :heavy_minus_sign: | Unix timestamp of expiration.
| | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `object` | [models.InvitationRevokedObject](../models/invitationrevokedobject.md) | :heavy_check_mark: | N/A | invitation | +| `id` | *str* | :heavy_check_mark: | N/A | inv_f02930r3 | +| `email_address` | *str* | :heavy_check_mark: | N/A | invitee@example.com | +| `status` | [models.InvitationRevokedStatus](../models/invitationrevokedstatus.md) | :heavy_check_mark: | N/A | revoked | +| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1622549600 | +| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1622553200 | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {} | +| `revoked` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | +| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://example.com/invitations/accept?code=abcd1234 | +| `expires_at` | *OptionalNullable[int]* | :heavy_minus_sign: | Unix timestamp of expiration.
| | \ No newline at end of file diff --git a/docs/models/invitationrevokedpublicmetadata.md b/docs/models/invitationrevokedpublicmetadata.md deleted file mode 100644 index 7a57063..0000000 --- a/docs/models/invitationrevokedpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# InvitationRevokedPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/mergeorganizationmetadataprivatemetadata.md b/docs/models/mergeorganizationmetadataprivatemetadata.md deleted file mode 100644 index cc4792e..0000000 --- a/docs/models/mergeorganizationmetadataprivatemetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# MergeOrganizationMetadataPrivateMetadata - -Metadata saved on the organization that is only visible to your backend. -The new object will be merged with the existing value. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/mergeorganizationmetadatapublicmetadata.md b/docs/models/mergeorganizationmetadatapublicmetadata.md deleted file mode 100644 index 7dac9e8..0000000 --- a/docs/models/mergeorganizationmetadatapublicmetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# MergeOrganizationMetadataPublicMetadata - -Metadata saved on the organization, that is visible to both your frontend and backend. -The new object will be merged with the existing value. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/mergeorganizationmetadatarequestbody.md b/docs/models/mergeorganizationmetadatarequestbody.md index 27a9a96..565810f 100644 --- a/docs/models/mergeorganizationmetadatarequestbody.md +++ b/docs/models/mergeorganizationmetadatarequestbody.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `public_metadata` | [Optional[models.MergeOrganizationMetadataPublicMetadata]](../models/mergeorganizationmetadatapublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {
"announcement": "We are opening a new office!"
} | -| `private_metadata` | [Optional[models.MergeOrganizationMetadataPrivateMetadata]](../models/mergeorganizationmetadataprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend.
The new object will be merged with the existing value. | {
"internal_use_only": "Future plans discussion."
} | \ No newline at end of file +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {
"announcement": "We are opening a new office!"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend.
The new object will be merged with the existing value. | {
"internal_use_only": "Future plans discussion."
} | \ No newline at end of file diff --git a/docs/models/organization.md b/docs/models/organization.md index a116842..bad5c2d 100644 --- a/docs/models/organization.md +++ b/docs/models/organization.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `object` | [models.OrganizationObject](../models/organizationobject.md) | :heavy_check_mark: | N/A | organization | -| `id` | *str* | :heavy_check_mark: | N/A | org_123 | -| `name` | *str* | :heavy_check_mark: | N/A | Acme Corp | -| `slug` | *str* | :heavy_check_mark: | N/A | acme-corp | -| `max_allowed_memberships` | *int* | :heavy_check_mark: | N/A | 300 | -| `public_metadata` | [models.OrganizationPublicMetadata](../models/organizationpublicmetadata.md) | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | -| `private_metadata` | [models.OrganizationPrivateMetadata](../models/organizationprivatemetadata.md) | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | -| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1625078400 | -| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1625164800 | -| `members_count` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 150 | -| `admin_delete_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | -| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | user_123456 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `object` | [models.OrganizationObject](../models/organizationobject.md) | :heavy_check_mark: | N/A | organization | +| `id` | *str* | :heavy_check_mark: | N/A | org_123 | +| `name` | *str* | :heavy_check_mark: | N/A | Acme Corp | +| `slug` | *str* | :heavy_check_mark: | N/A | acme-corp | +| `max_allowed_memberships` | *int* | :heavy_check_mark: | N/A | 300 | +| `public_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | +| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1625078400 | +| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1625164800 | +| `members_count` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 150 | +| `admin_delete_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | +| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | user_123456 | \ No newline at end of file diff --git a/docs/models/organizationinvitation.md b/docs/models/organizationinvitation.md index 471b737..d4c1dc7 100644 --- a/docs/models/organizationinvitation.md +++ b/docs/models/organizationinvitation.md @@ -5,16 +5,16 @@ An organization invitation ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | inv_12345 | -| `object` | [Optional[models.OrganizationInvitationObject]](../models/organizationinvitationobject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| organization_invitation | -| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | user@example.com | -| `role` | *Optional[str]* | :heavy_minus_sign: | N/A | admin | -| `role_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `organization_id` | *Optional[str]* | :heavy_minus_sign: | N/A | org_12345 | -| `status` | *Optional[str]* | :heavy_minus_sign: | N/A | pending | -| `public_metadata` | [Optional[models.OrganizationInvitationPublicMetadata]](../models/organizationinvitationpublicmetadata.md) | :heavy_minus_sign: | N/A | {
"key": "value"
} | -| `private_metadata` | [Optional[models.OrganizationInvitationPrivateMetadata]](../models/organizationinvitationprivatemetadata.md) | :heavy_minus_sign: | N/A | {
"private_key": "secret_value"
} | -| `created_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of creation. | 1622547600 | -| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of last update. | 1622551200 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | inv_12345 | +| `object` | [Optional[models.OrganizationInvitationObject]](../models/organizationinvitationobject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| organization_invitation | +| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | user@example.com | +| `role` | *Optional[str]* | :heavy_minus_sign: | N/A | admin | +| `role_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `organization_id` | *Optional[str]* | :heavy_minus_sign: | N/A | org_12345 | +| `status` | *Optional[str]* | :heavy_minus_sign: | N/A | pending | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"key": "value"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"private_key": "secret_value"
} | +| `created_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of creation. | 1622547600 | +| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of last update. | 1622551200 | \ No newline at end of file diff --git a/docs/models/organizationinvitationprivatemetadata.md b/docs/models/organizationinvitationprivatemetadata.md deleted file mode 100644 index 179f38a..0000000 --- a/docs/models/organizationinvitationprivatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationInvitationPrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationinvitationpublicmetadata.md b/docs/models/organizationinvitationpublicmetadata.md deleted file mode 100644 index f0b62d1..0000000 --- a/docs/models/organizationinvitationpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationInvitationPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationinvitationwithpublicorganizationdata.md b/docs/models/organizationinvitationwithpublicorganizationdata.md index 1c65b54..b3ab193 100644 --- a/docs/models/organizationinvitationwithpublicorganizationdata.md +++ b/docs/models/organizationinvitationwithpublicorganizationdata.md @@ -5,17 +5,17 @@ An organization invitation with public organization data populated ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `object` | [Optional[models.OrganizationInvitationWithPublicOrganizationDataObject]](../models/organizationinvitationwithpublicorganizationdataobject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `role` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `role_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `organization_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `status` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `public_metadata` | [Optional[models.OrganizationInvitationWithPublicOrganizationDataPublicMetadata]](../models/organizationinvitationwithpublicorganizationdatapublicmetadata.md) | :heavy_minus_sign: | N/A | -| `private_metadata` | [Optional[models.OrganizationInvitationWithPublicOrganizationDataPrivateMetadata]](../models/organizationinvitationwithpublicorganizationdataprivatemetadata.md) | :heavy_minus_sign: | N/A | -| `public_organization_data` | [Optional[models.PublicOrganizationData]](../models/publicorganizationdata.md) | :heavy_minus_sign: | N/A | -| `created_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of creation. | -| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `object` | [Optional[models.OrganizationInvitationWithPublicOrganizationDataObject]](../models/organizationinvitationwithpublicorganizationdataobject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `email_address` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `role` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `role_name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `organization_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `status` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `public_organization_data` | [Optional[models.PublicOrganizationData]](../models/publicorganizationdata.md) | :heavy_minus_sign: | N/A | +| `created_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of creation. | +| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file diff --git a/docs/models/organizationinvitationwithpublicorganizationdataprivatemetadata.md b/docs/models/organizationinvitationwithpublicorganizationdataprivatemetadata.md deleted file mode 100644 index 3b53742..0000000 --- a/docs/models/organizationinvitationwithpublicorganizationdataprivatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationInvitationWithPublicOrganizationDataPrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationinvitationwithpublicorganizationdatapublicmetadata.md b/docs/models/organizationinvitationwithpublicorganizationdatapublicmetadata.md deleted file mode 100644 index f2ca2b2..0000000 --- a/docs/models/organizationinvitationwithpublicorganizationdatapublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationInvitationWithPublicOrganizationDataPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationmembership.md b/docs/models/organizationmembership.md index 0d0fddc..124d2cf 100644 --- a/docs/models/organizationmembership.md +++ b/docs/models/organizationmembership.md @@ -12,8 +12,8 @@ Hello world | `role` | *Optional[str]* | :heavy_minus_sign: | N/A | member | | `role_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `permissions` | List[*str*] | :heavy_minus_sign: | N/A | [
"read",
"write"
] | -| `public_metadata` | [Optional[models.OrganizationMembershipPublicMetadata]](../models/organizationmembershippublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | {} | -| `private_metadata` | [Optional[models.OrganizationMembershipPrivateMetadata]](../models/organizationmembershipprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API | {} | | `organization` | [Optional[models.OrganizationMembershipOrganization]](../models/organizationmembershiporganization.md) | :heavy_minus_sign: | N/A | | | `public_user_data` | [Optional[models.PublicUserData]](../models/publicuserdata.md) | :heavy_minus_sign: | N/A | {
"user_id": "user_123",
"first_name": "John",
"last_name": "Doe",
"image_url": "https://example.com/profile.jpg",
"has_image": true,
"identifier": "johndoe"
} | | `created_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp of creation. | 1625078400 | diff --git a/docs/models/organizationmembershiporganization.md b/docs/models/organizationmembershiporganization.md index 3fec876..d9615d4 100644 --- a/docs/models/organizationmembershiporganization.md +++ b/docs/models/organizationmembershiporganization.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `object` | [models.OrganizationMembershipOrganizationObject](../models/organizationmembershiporganizationobject.md) | :heavy_check_mark: | N/A | organization | -| `id` | *str* | :heavy_check_mark: | N/A | org_123 | -| `name` | *str* | :heavy_check_mark: | N/A | Acme Corp | -| `slug` | *str* | :heavy_check_mark: | N/A | acme-corp | -| `max_allowed_memberships` | *int* | :heavy_check_mark: | N/A | 300 | -| `public_metadata` | [models.OrganizationMembershipOrganizationPublicMetadata](../models/organizationmembershiporganizationpublicmetadata.md) | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | -| `private_metadata` | [models.OrganizationMembershipOrganizationPrivateMetadata](../models/organizationmembershiporganizationprivatemetadata.md) | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | -| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1625078400 | -| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1625164800 | -| `members_count` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 150 | -| `admin_delete_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | -| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | user_123456 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `object` | [models.OrganizationMembershipOrganizationObject](../models/organizationmembershiporganizationobject.md) | :heavy_check_mark: | N/A | organization | +| `id` | *str* | :heavy_check_mark: | N/A | org_123 | +| `name` | *str* | :heavy_check_mark: | N/A | Acme Corp | +| `slug` | *str* | :heavy_check_mark: | N/A | acme-corp | +| `max_allowed_memberships` | *int* | :heavy_check_mark: | N/A | 300 | +| `public_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | +| `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1625078400 | +| `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1625164800 | +| `members_count` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 150 | +| `admin_delete_enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | +| `created_by` | *Optional[str]* | :heavy_minus_sign: | N/A | user_123456 | \ No newline at end of file diff --git a/docs/models/organizationmembershiporganizationprivatemetadata.md b/docs/models/organizationmembershiporganizationprivatemetadata.md deleted file mode 100644 index 361b894..0000000 --- a/docs/models/organizationmembershiporganizationprivatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationMembershipOrganizationPrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationmembershiporganizationpublicmetadata.md b/docs/models/organizationmembershiporganizationpublicmetadata.md deleted file mode 100644 index 7040de0..0000000 --- a/docs/models/organizationmembershiporganizationpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationMembershipOrganizationPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationmembershipprivatemetadata.md b/docs/models/organizationmembershipprivatemetadata.md deleted file mode 100644 index 82b7b53..0000000 --- a/docs/models/organizationmembershipprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# OrganizationMembershipPrivateMetadata - -Metadata saved on the organization membership, accessible only from the Backend API - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationmembershippublicmetadata.md b/docs/models/organizationmembershippublicmetadata.md deleted file mode 100644 index e9197dd..0000000 --- a/docs/models/organizationmembershippublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# OrganizationMembershipPublicMetadata - -Metadata saved on the organization membership, accessible from both Frontend and Backend APIs - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationprivatemetadata.md b/docs/models/organizationprivatemetadata.md deleted file mode 100644 index a6c2475..0000000 --- a/docs/models/organizationprivatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationPrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationpublicmetadata.md b/docs/models/organizationpublicmetadata.md deleted file mode 100644 index 9beca5e..0000000 --- a/docs/models/organizationpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationwithlogo.md b/docs/models/organizationwithlogo.md index a3ba74c..08b580e 100644 --- a/docs/models/organizationwithlogo.md +++ b/docs/models/organizationwithlogo.md @@ -10,8 +10,8 @@ | `name` | *str* | :heavy_check_mark: | N/A | Acme Corp | | `slug` | *str* | :heavy_check_mark: | N/A | acme-corp | | `max_allowed_memberships` | *int* | :heavy_check_mark: | N/A | 300 | -| `public_metadata` | [models.OrganizationWithLogoPublicMetadata](../models/organizationwithlogopublicmetadata.md) | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | -| `private_metadata` | [models.OrganizationWithLogoPrivateMetadata](../models/organizationwithlogoprivatemetadata.md) | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"public_info": "Info visible to everyone"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_check_mark: | N/A | {
"internal_use_only": "Sensitive data"
} | | `created_at` | *int* | :heavy_check_mark: | Unix timestamp of creation.
| 1625078400 | | `updated_at` | *int* | :heavy_check_mark: | Unix timestamp of last update.
| 1625164800 | | `image_url` | *str* | :heavy_check_mark: | N/A | https://example.com/image_url.png | diff --git a/docs/models/organizationwithlogoprivatemetadata.md b/docs/models/organizationwithlogoprivatemetadata.md deleted file mode 100644 index 3c6b8d7..0000000 --- a/docs/models/organizationwithlogoprivatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationWithLogoPrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/organizationwithlogopublicmetadata.md b/docs/models/organizationwithlogopublicmetadata.md deleted file mode 100644 index fb7c525..0000000 --- a/docs/models/organizationwithlogopublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# OrganizationWithLogoPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/privatemetadata.md b/docs/models/privatemetadata.md deleted file mode 100644 index 133ba7d..0000000 --- a/docs/models/privatemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# PrivateMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/publicmetadata.md b/docs/models/publicmetadata.md deleted file mode 100644 index b994731..0000000 --- a/docs/models/publicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# PublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/requestbody.md b/docs/models/requestbody.md index e9d3914..c0134cb 100644 --- a/docs/models/requestbody.md +++ b/docs/models/requestbody.md @@ -8,6 +8,6 @@ | `email_address` | *str* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | newmember@example.com | | `role` | *str* | :heavy_check_mark: | The role of the new member in the organization. | admin | | `inviter_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | user_67890 | -| `public_metadata` | [Optional[models.CreateOrganizationInvitationBulkPublicMetadata]](../models/createorganizationinvitationbulkpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {} | -| `private_metadata` | [Optional[models.CreateOrganizationInvitationBulkPrivateMetadata]](../models/createorganizationinvitationbulkprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {} | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | https://example.com/welcome | \ No newline at end of file diff --git a/docs/models/responsebody.md b/docs/models/responsebody.md index 12cafbb..b279c3b 100644 --- a/docs/models/responsebody.md +++ b/docs/models/responsebody.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `object` | *Optional[str]* | :heavy_minus_sign: | N/A | oauth_access_token | -| `external_account_id` | *Optional[str]* | :heavy_minus_sign: | External account ID | external_account_456 | -| `provider_user_id` | *Optional[str]* | :heavy_minus_sign: | The unique ID of the user in the external provider's system | provider_user_789 | -| `token` | *Optional[str]* | :heavy_minus_sign: | The access token | access_token_123 | -| `provider` | *Optional[str]* | :heavy_minus_sign: | The ID of the provider | oauth_google | -| `public_metadata` | [Optional[models.GetOAuthAccessTokenPublicMetadata]](../models/getoauthaccesstokenpublicmetadata.md) | :heavy_minus_sign: | N/A | {} | -| `label` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Primary account | -| `scopes` | List[*str*] | :heavy_minus_sign: | The list of scopes that the token is valid for.
Only present for OAuth 2.0 tokens. | [
"email",
"profile"
] | -| `token_secret` | *Optional[str]* | :heavy_minus_sign: | The token secret. Only present for OAuth 1.0 tokens. | token_secret_xyz | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `object` | *Optional[str]* | :heavy_minus_sign: | N/A | oauth_access_token | +| `external_account_id` | *Optional[str]* | :heavy_minus_sign: | External account ID | external_account_456 | +| `provider_user_id` | *Optional[str]* | :heavy_minus_sign: | The unique ID of the user in the external provider's system | provider_user_789 | +| `token` | *Optional[str]* | :heavy_minus_sign: | The access token | access_token_123 | +| `provider` | *Optional[str]* | :heavy_minus_sign: | The ID of the provider | oauth_google | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {} | +| `label` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Primary account | +| `scopes` | List[*str*] | :heavy_minus_sign: | The list of scopes that the token is valid for.
Only present for OAuth 2.0 tokens. | [
"email",
"profile"
] | +| `token_secret` | *Optional[str]* | :heavy_minus_sign: | The token secret. Only present for OAuth 1.0 tokens. | token_secret_xyz | \ No newline at end of file diff --git a/docs/models/samlaccount.md b/docs/models/samlaccount.md index 55b3e4d..d033764 100644 --- a/docs/models/samlaccount.md +++ b/docs/models/samlaccount.md @@ -14,5 +14,5 @@ | `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | John | | `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Doe | | `provider_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | prov_user_id_123 | -| `public_metadata` | [Optional[models.SAMLAccountPublicMetadata]](../models/samlaccountpublicmetadata.md) | :heavy_minus_sign: | N/A | {
"department": "IT"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"department": "IT"
} | | `saml_connection` | [OptionalNullable[models.SamlConnection]](../models/samlconnection.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/samlaccountpublicmetadata.md b/docs/models/samlaccountpublicmetadata.md deleted file mode 100644 index 9ff4040..0000000 --- a/docs/models/samlaccountpublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# SAMLAccountPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/signup.md b/docs/models/signup.md index ea84783..81aefcb 100644 --- a/docs/models/signup.md +++ b/docs/models/signup.md @@ -3,28 +3,28 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `object` | [models.SignUpObject](../models/signupobject.md) | :heavy_check_mark: | N/A | sign_up_attempt | -| `id` | *str* | :heavy_check_mark: | N/A | signup_1234567890abcdef | -| `status` | [models.SignUpStatus](../models/signupstatus.md) | :heavy_check_mark: | N/A | complete | -| `password_enabled` | *bool* | :heavy_check_mark: | N/A | true | -| `custom_action` | *bool* | :heavy_check_mark: | N/A | false | -| `abandon_at` | *int* | :heavy_check_mark: | N/A | 1609459200 | -| `required_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"email_address"
] | -| `optional_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"first_name",
"last_name"
] | -| `missing_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"phone_number"
] | -| `unverified_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"email_address"
] | -| `verifications` | [Optional[models.Verifications]](../models/verifications.md) | :heavy_minus_sign: | N/A | | -| `username` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user_123456 | -| `email_address` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user@example.com | -| `phone_number` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +1234567890 | -| `web3_wallet` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 0x1234567890abcdef1234567890abcdef12345678 | -| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | John | -| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Doe | -| `unsafe_metadata` | [Optional[models.SignUpUnsafeMetadata]](../models/signupunsafemetadata.md) | :heavy_minus_sign: | N/A | | -| `public_metadata` | [Optional[models.SignUpPublicMetadata]](../models/signuppublicmetadata.md) | :heavy_minus_sign: | N/A | | -| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | ext_id_7890abcdef123456 | -| `created_session_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | sess_1234567890abcdef | -| `created_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user_1234567890abcdef | -| `external_account` | [Optional[models.ExternalAccount]](../models/externalaccount.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `object` | [models.SignUpObject](../models/signupobject.md) | :heavy_check_mark: | N/A | sign_up_attempt | +| `id` | *str* | :heavy_check_mark: | N/A | signup_1234567890abcdef | +| `status` | [models.SignUpStatus](../models/signupstatus.md) | :heavy_check_mark: | N/A | complete | +| `password_enabled` | *bool* | :heavy_check_mark: | N/A | true | +| `custom_action` | *bool* | :heavy_check_mark: | N/A | false | +| `abandon_at` | *int* | :heavy_check_mark: | N/A | 1609459200 | +| `required_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"email_address"
] | +| `optional_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"first_name",
"last_name"
] | +| `missing_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"phone_number"
] | +| `unverified_fields` | List[*str*] | :heavy_minus_sign: | N/A | [
"email_address"
] | +| `verifications` | [Optional[models.Verifications]](../models/verifications.md) | :heavy_minus_sign: | N/A | | +| `username` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user_123456 | +| `email_address` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user@example.com | +| `phone_number` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +1234567890 | +| `web3_wallet` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 0x1234567890abcdef1234567890abcdef12345678 | +| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | John | +| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Doe | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `external_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | ext_id_7890abcdef123456 | +| `created_session_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | sess_1234567890abcdef | +| `created_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | user_1234567890abcdef | +| `external_account` | [Optional[models.ExternalAccount]](../models/externalaccount.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/signuppublicmetadata.md b/docs/models/signuppublicmetadata.md deleted file mode 100644 index 7e9e611..0000000 --- a/docs/models/signuppublicmetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# SignUpPublicMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/signupunsafemetadata.md b/docs/models/signupunsafemetadata.md deleted file mode 100644 index 8a47b7e..0000000 --- a/docs/models/signupunsafemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# SignUpUnsafeMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/unsafemetadata.md b/docs/models/unsafemetadata.md deleted file mode 100644 index cf94d10..0000000 --- a/docs/models/unsafemetadata.md +++ /dev/null @@ -1,7 +0,0 @@ -# UnsafeMetadata - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateorganizationmembershipmetadataprivatemetadata.md b/docs/models/updateorganizationmembershipmetadataprivatemetadata.md deleted file mode 100644 index 8fae50e..0000000 --- a/docs/models/updateorganizationmembershipmetadataprivatemetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateOrganizationMembershipMetadataPrivateMetadata - -Metadata saved on the organization membership that is only visible to your backend. -The new object will be merged with the existing value. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateorganizationmembershipmetadatapublicmetadata.md b/docs/models/updateorganizationmembershipmetadatapublicmetadata.md deleted file mode 100644 index dc1db80..0000000 --- a/docs/models/updateorganizationmembershipmetadatapublicmetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateOrganizationMembershipMetadataPublicMetadata - -Metadata saved on the organization membership, that is visible to both your frontend and backend. -The new object will be merged with the existing value. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateorganizationmembershipmetadatarequestbody.md b/docs/models/updateorganizationmembershipmetadatarequestbody.md index 6b9221f..f6ba57c 100644 --- a/docs/models/updateorganizationmembershipmetadatarequestbody.md +++ b/docs/models/updateorganizationmembershipmetadatarequestbody.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `public_metadata` | [Optional[models.UpdateOrganizationMembershipMetadataPublicMetadata]](../models/updateorganizationmembershipmetadatapublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {} | -| `private_metadata` | [Optional[models.UpdateOrganizationMembershipMetadataPrivateMetadata]](../models/updateorganizationmembershipmetadataprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership that is only visible to your backend.
The new object will be merged with the existing value. | {} | \ No newline at end of file +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership that is only visible to your backend.
The new object will be merged with the existing value. | {} | \ No newline at end of file diff --git a/docs/models/updateorganizationprivatemetadata.md b/docs/models/updateorganizationprivatemetadata.md deleted file mode 100644 index b095281..0000000 --- a/docs/models/updateorganizationprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# UpdateOrganizationPrivateMetadata - -Metadata saved on the organization that is only visible to your backend. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateorganizationpublicmetadata.md b/docs/models/updateorganizationpublicmetadata.md deleted file mode 100644 index a83dfeb..0000000 --- a/docs/models/updateorganizationpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# UpdateOrganizationPublicMetadata - -Metadata saved on the organization, that is visible to both your frontend and backend. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateorganizationrequestbody.md b/docs/models/updateorganizationrequestbody.md index 214df07..13b6a5c 100644 --- a/docs/models/updateorganizationrequestbody.md +++ b/docs/models/updateorganizationrequestbody.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `public_metadata` | [Optional[models.UpdateOrganizationPublicMetadata]](../models/updateorganizationpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend. | {} | -| `private_metadata` | [Optional[models.UpdateOrganizationPrivateMetadata]](../models/updateorganizationprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend. | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend. | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend. | {} | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The new name of the organization.
May not contain URLs or HTML. | New Organization Name | | `slug` | *OptionalNullable[str]* | :heavy_minus_sign: | The new slug of the organization, which needs to be unique in the instance | new-org-slug | | `max_allowed_memberships` | *OptionalNullable[int]* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | 100 | diff --git a/docs/models/updateuserprivatemetadata.md b/docs/models/updateuserprivatemetadata.md deleted file mode 100644 index f07e7af..0000000 --- a/docs/models/updateuserprivatemetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# UpdateUserPrivateMetadata - -Metadata saved on the user, that is only visible to your Backend API - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateuserpublicmetadata.md b/docs/models/updateuserpublicmetadata.md deleted file mode 100644 index 402dcf7..0000000 --- a/docs/models/updateuserpublicmetadata.md +++ /dev/null @@ -1,9 +0,0 @@ -# UpdateUserPublicMetadata - -Metadata saved on the user, that is visible to both your Frontend and Backend APIs - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/updateuserrequestbody.md b/docs/models/updateuserrequestbody.md index e16e1cd..9a1cdb0 100644 --- a/docs/models/updateuserrequestbody.md +++ b/docs/models/updateuserrequestbody.md @@ -21,9 +21,9 @@ | `sign_out_of_other_sessions` | *OptionalNullable[bool]* | :heavy_minus_sign: | Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`. | true | | `totp_secret` | *Optional[str]* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | ABCD1234EFGH5678 | | `backup_codes` | List[*str*] | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | [
"123456",
"654321"
] | -| `public_metadata` | [Optional[models.UpdateUserPublicMetadata]](../models/updateuserpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"theme": "dark"
} | -| `private_metadata` | [Optional[models.UpdateUserPrivateMetadata]](../models/updateuserprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"vip": true
} | -| `unsafe_metadata` | [Optional[models.UpdateUserUnsafeMetadata]](../models/updateuserunsafemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"age": 30
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"theme": "dark"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"vip": true
} | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"age": 30
} | | `delete_self_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, the user can delete themselves with the Frontend API. | true | | `create_organization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, the user can create organizations with the Frontend API. | false | | `legal_accepted_at` | *OptionalNullable[str]* | :heavy_minus_sign: | A custom timestamps denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | | diff --git a/docs/models/updateuserunsafemetadata.md b/docs/models/updateuserunsafemetadata.md deleted file mode 100644 index 1cc911b..0000000 --- a/docs/models/updateuserunsafemetadata.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateUserUnsafeMetadata - -Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. -Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/docs/models/user.md b/docs/models/user.md index 6fd8af6..1bf19e4 100644 --- a/docs/models/user.md +++ b/docs/models/user.md @@ -17,9 +17,9 @@ | ~~`profile_image_url`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | https://example.com/profile.jpg | | `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | https://example.com/new-profile.jpg | | `has_image` | *Optional[bool]* | :heavy_minus_sign: | N/A | true | -| `public_metadata` | [Optional[models.PublicMetadata]](../models/publicmetadata.md) | :heavy_minus_sign: | N/A | {
"role": "admin"
} | -| `private_metadata` | [OptionalNullable[models.PrivateMetadata]](../models/privatemetadata.md) | :heavy_minus_sign: | N/A | {
"ssn": "123-45-6789"
} | -| `unsafe_metadata` | [Optional[models.UnsafeMetadata]](../models/unsafemetadata.md) | :heavy_minus_sign: | N/A | {
"theme": "dark"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"role": "admin"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"ssn": "123-45-6789"
} | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | {
"theme": "dark"
} | | `email_addresses` | List[[models.EmailAddress](../models/emailaddress.md)] | :heavy_minus_sign: | N/A | [
{
"id": "email_id_123",
"object": "email_address",
"email_address": "john.doe@example.com",
"verification": {
"status": "verified",
"strategy": "email_code"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
] | | `phone_numbers` | List[[models.PhoneNumber](../models/phonenumber.md)] | :heavy_minus_sign: | N/A | [
{
"id": "phone_id_123",
"object": "phone_number",
"phone_number": "+12345678901",
"verification": {
"status": "verified",
"strategy": "phone_code"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
] | | `web3_wallets` | List[[models.Web3Wallet](../models/web3wallet.md)] | :heavy_minus_sign: | N/A | [
{
"id": "wallet_id_123",
"object": "web3_wallet",
"web3_wallet": "0x123456789abcdef",
"verification": {
"status": "verified",
"strategy": "web3_metamask_signature"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
] | diff --git a/docs/sdks/invitations/README.md b/docs/sdks/invitations/README.md index 5008c9d..f6eeba5 100644 --- a/docs/sdks/invitations/README.md +++ b/docs/sdks/invitations/README.md @@ -30,7 +30,9 @@ s = Clerk( res = s.invitations.create(request={ "email_address": "user@example.com", - "public_metadata": {}, + "public_metadata": { + + }, "redirect_url": "https://example.com/welcome", "notify": True, "ignore_existing": True, diff --git a/docs/sdks/organizationinvitationssdk/README.md b/docs/sdks/organizationinvitationssdk/README.md index f8214be..1dd0ab7 100644 --- a/docs/sdks/organizationinvitationssdk/README.md +++ b/docs/sdks/organizationinvitationssdk/README.md @@ -93,7 +93,11 @@ s = Clerk( ) -res = s.organization_invitations.create(organization_id="org_12345", email_address="user@example.com", role="admin", inviter_user_id="user_67890", public_metadata={}, private_metadata={}, redirect_url="https://example.com/welcome") +res = s.organization_invitations.create(organization_id="org_12345", email_address="user@example.com", role="admin", inviter_user_id="user_67890", public_metadata={ + "key": "value", +}, private_metadata={ + "private_key": "secret_value", +}, redirect_url="https://example.com/welcome") if res is not None: # handle response @@ -109,8 +113,8 @@ if res is not None: | `email_address` | *str* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | user@example.com | | `role` | *str* | :heavy_check_mark: | The role of the new member in the organization | admin | | `inviter_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | user_67890 | -| `public_metadata` | [Optional[models.CreateOrganizationInvitationPublicMetadata]](../../models/createorganizationinvitationpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {
"key": "value"
} | -| `private_metadata` | [Optional[models.CreateOrganizationInvitationPrivateMetadata]](../../models/createorganizationinvitationprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {
"private_key": "secret_value"
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | {
"key": "value"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | {
"private_key": "secret_value"
} | | `redirect_url` | *Optional[str]* | :heavy_minus_sign: | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | https://example.com/welcome | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | @@ -207,8 +211,12 @@ res = s.organization_invitations.bulk_create(organization_id="org_12345", reques "email_address": "newmember@example.com", "role": "admin", "inviter_user_id": "user_67890", - "public_metadata": {}, - "private_metadata": {}, + "public_metadata": { + + }, + "private_metadata": { + + }, "redirect_url": "https://example.com/welcome", }, ]) diff --git a/docs/sdks/organizationmembershipssdk/README.md b/docs/sdks/organizationmembershipssdk/README.md index 0086e5d..38b8aaa 100644 --- a/docs/sdks/organizationmembershipssdk/README.md +++ b/docs/sdks/organizationmembershipssdk/README.md @@ -200,7 +200,11 @@ s = Clerk( ) -res = s.organization_memberships.update_metadata(organization_id="org_123456", user_id="user_654321", public_metadata={}, private_metadata={}) +res = s.organization_memberships.update_metadata(organization_id="org_123456", user_id="user_654321", public_metadata={ + +}, private_metadata={ + +}) if res is not None: # handle response @@ -214,8 +218,8 @@ if res is not None: | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id` | *str* | :heavy_check_mark: | The ID of the organization the membership belongs to | org_123456 | | `user_id` | *str* | :heavy_check_mark: | The ID of the user that this membership belongs to | user_654321 | -| `public_metadata` | [Optional[models.UpdateOrganizationMembershipMetadataPublicMetadata]](../../models/updateorganizationmembershipmetadatapublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {} | -| `private_metadata` | [Optional[models.UpdateOrganizationMembershipMetadataPrivateMetadata]](../../models/updateorganizationmembershipmetadataprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership that is only visible to your backend.
The new object will be merged with the existing value. | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization membership that is only visible to your backend.
The new object will be merged with the existing value. | {} | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/organizationssdk/README.md b/docs/sdks/organizationssdk/README.md index 6430460..3e5035c 100644 --- a/docs/sdks/organizationssdk/README.md +++ b/docs/sdks/organizationssdk/README.md @@ -92,8 +92,12 @@ s = Clerk( res = s.organizations.create(request={ "name": "NewOrg", "created_by": "user_123", - "private_metadata": {}, - "public_metadata": {}, + "private_metadata": { + "internal_code": "ABC123", + }, + "public_metadata": { + "public_event": "Annual Summit", + }, "slug": "neworg", "max_allowed_memberships": 100, "created_at": "", @@ -180,7 +184,11 @@ s = Clerk( ) -res = s.organizations.update(organization_id="org_123_update", public_metadata={}, private_metadata={}, name="New Organization Name", slug="new-org-slug", max_allowed_memberships=100, admin_delete_enabled=True, created_at="") +res = s.organizations.update(organization_id="org_123_update", public_metadata={ + +}, private_metadata={ + +}, name="New Organization Name", slug="new-org-slug", max_allowed_memberships=100, admin_delete_enabled=True, created_at="") if res is not None: # handle response @@ -193,8 +201,8 @@ if res is not None: | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | `organization_id` | *str* | :heavy_check_mark: | The ID of the organization to update | org_123_update | -| `public_metadata` | [Optional[models.UpdateOrganizationPublicMetadata]](../../models/updateorganizationpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend. | {} | -| `private_metadata` | [Optional[models.UpdateOrganizationPrivateMetadata]](../../models/updateorganizationprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend. | {} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend. | {} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend. | {} | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The new name of the organization.
May not contain URLs or HTML. | New Organization Name | | `slug` | *OptionalNullable[str]* | :heavy_minus_sign: | The new slug of the organization, which needs to be unique in the instance | new-org-slug | | `max_allowed_memberships` | *OptionalNullable[int]* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | 100 | @@ -274,7 +282,11 @@ s = Clerk( ) -res = s.organizations.merge_metadata(organization_id="org_12345", public_metadata={}, private_metadata={}) +res = s.organizations.merge_metadata(organization_id="org_12345", public_metadata={ + "announcement": "We are opening a new office!", +}, private_metadata={ + "internal_use_only": "Future plans discussion.", +}) if res is not None: # handle response @@ -287,8 +299,8 @@ if res is not None: | Parameter | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id` | *str* | :heavy_check_mark: | The ID of the organization for which metadata will be merged or updated | org_12345 | -| `public_metadata` | [Optional[models.MergeOrganizationMetadataPublicMetadata]](../../models/mergeorganizationmetadatapublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {
"announcement": "We are opening a new office!"
} | -| `private_metadata` | [Optional[models.MergeOrganizationMetadataPrivateMetadata]](../../models/mergeorganizationmetadataprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend.
The new object will be merged with the existing value. | {
"internal_use_only": "Future plans discussion."
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization, that is visible to both your frontend and backend.
The new object will be merged with the existing value. | {
"announcement": "We are opening a new office!"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the organization that is only visible to your backend.
The new object will be merged with the existing value. | {
"internal_use_only": "Future plans discussion."
} | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/users/README.md b/docs/sdks/users/README.md index 66d9267..48dc971 100644 --- a/docs/sdks/users/README.md +++ b/docs/sdks/users/README.md @@ -130,7 +130,15 @@ res = s.users.create(external_id="ext-id-001", first_name="John", last_name="Doe ], username="johndoe123", password="Secure*Pass4", password_digest="$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc", password_hasher="", skip_password_checks=False, skip_password_requirement=False, totp_secret="base32totpsecretkey", backup_codes=[ "123456", "654321", -], public_metadata={}, private_metadata={}, unsafe_metadata={}, delete_self_enabled=False, legal_accepted_at="", skip_legal_checks=False, create_organization_enabled=False, create_organizations_limit=486589, created_at="2023-03-15T07:15:20.902Z") +], public_metadata={ + "role": "user", +}, private_metadata={ + "internal_id": "789", +}, unsafe_metadata={ + "preferences": { + "theme": "dark", + }, +}, delete_self_enabled=False, legal_accepted_at="", skip_legal_checks=False, create_organization_enabled=False, create_organizations_limit=486589, created_at="2023-03-15T07:15:20.902Z") if res is not None: # handle response @@ -156,9 +164,9 @@ if res is not None: | `skip_password_requirement` | *Optional[bool]* | :heavy_minus_sign: | When set to `true`, `password` is not required anymore when creating the user and can be omitted.
This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords.
Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | false | | `totp_secret` | *Optional[str]* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | base32totpsecretkey | | `backup_codes` | List[*str*] | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | [
"123456",
"654321"
] | -| `public_metadata` | [Optional[models.CreateUserPublicMetadata]](../../models/createuserpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"role": "user"
} | -| `private_metadata` | [Optional[models.CreateUserPrivateMetadata]](../../models/createuserprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"internal_id": "789"
} | -| `unsafe_metadata` | [Optional[models.CreateUserUnsafeMetadata]](../../models/createuserunsafemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"preferences": {
"theme": "dark"
}
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"role": "user"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"internal_id": "789"
} | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"preferences": {
"theme": "dark"
}
} | | `delete_self_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| | | `legal_accepted_at` | *OptionalNullable[str]* | :heavy_minus_sign: | A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | | | `skip_legal_checks` | *OptionalNullable[bool]* | :heavy_minus_sign: | When set to `true` all legal checks are skipped.
It is not recommended to skip legal checks unless you are migrating a user to Clerk. | | @@ -307,7 +315,13 @@ s = Clerk( res = s.users.update(user_id="usr_1", external_id="ext_123", first_name="Jane", last_name="Doe", primary_email_address_id="eml_12345", notify_primary_email_address_changed=True, primary_phone_number_id="phn_67890", primary_web3_wallet_id="wlt_123", username="janedoe", profile_image_id="img_789", password="secretPass123!", password_digest="$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc", password_hasher="", skip_password_checks=False, sign_out_of_other_sessions=True, totp_secret="ABCD1234EFGH5678", backup_codes=[ "123456", "654321", -], public_metadata={}, private_metadata={}, unsafe_metadata={}, delete_self_enabled=True, create_organization_enabled=False, legal_accepted_at="", skip_legal_checks=False, create_organizations_limit=857478, created_at="2021-04-05T14:30:00.000Z") +], public_metadata={ + "theme": "dark", +}, private_metadata={ + "vip": True, +}, unsafe_metadata={ + "age": 30, +}, delete_self_enabled=True, create_organization_enabled=False, legal_accepted_at="", skip_legal_checks=False, create_organizations_limit=857478, created_at="2021-04-05T14:30:00.000Z") if res is not None: # handle response @@ -336,9 +350,9 @@ if res is not None: | `sign_out_of_other_sessions` | *OptionalNullable[bool]* | :heavy_minus_sign: | Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`. | true | | `totp_secret` | *Optional[str]* | :heavy_minus_sign: | In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it.
Please note that currently the supported options are:
* Period: 30 seconds
* Code length: 6 digits
* Algorithm: SHA1 | ABCD1234EFGH5678 | | `backup_codes` | List[*str*] | :heavy_minus_sign: | If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them.
You must provide the backup codes in plain format or the corresponding bcrypt digest. | [
"123456",
"654321"
] | -| `public_metadata` | [Optional[models.UpdateUserPublicMetadata]](../../models/updateuserpublicmetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"theme": "dark"
} | -| `private_metadata` | [Optional[models.UpdateUserPrivateMetadata]](../../models/updateuserprivatemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"vip": true
} | -| `unsafe_metadata` | [Optional[models.UpdateUserUnsafeMetadata]](../../models/updateuserunsafemetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"age": 30
} | +| `public_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | {
"theme": "dark"
} | +| `private_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | {
"vip": true
} | +| `unsafe_metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs.
Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | {
"age": 30
} | | `delete_self_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, the user can delete themselves with the Frontend API. | true | | `create_organization_enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, the user can create organizations with the Frontend API. | false | | `legal_accepted_at` | *OptionalNullable[str]* | :heavy_minus_sign: | A custom timestamps denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | | diff --git a/pyproject.toml b/pyproject.toml index af9e22d..4166fa1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "clerk-backend-api" -version = "1.0.3" +version = "1.1.0" description = "Python Client SDK for clerk.dev" authors = ["Clerk",] readme = "README-PYPI.md" diff --git a/src/clerk_backend_api/models/__init__.py b/src/clerk_backend_api/models/__init__.py index fbe3e73..c4a2494 100644 --- a/src/clerk_backend_api/models/__init__.py +++ b/src/clerk_backend_api/models/__init__.py @@ -15,20 +15,20 @@ from .createallowlistidentifierop import CreateAllowlistIdentifierRequestBody, CreateAllowlistIdentifierRequestBodyTypedDict from .createblocklistidentifierop import CreateBlocklistIdentifierRequestBody, CreateBlocklistIdentifierRequestBodyTypedDict from .createemailaddressop import CreateEmailAddressRequestBody, CreateEmailAddressRequestBodyTypedDict -from .createinvitationop import CreateInvitationPublicMetadata, CreateInvitationPublicMetadataTypedDict, CreateInvitationRequestBody, CreateInvitationRequestBodyTypedDict +from .createinvitationop import CreateInvitationRequestBody, CreateInvitationRequestBodyTypedDict from .createjwttemplateop import CreateJWTTemplateClaims, CreateJWTTemplateClaimsTypedDict, CreateJWTTemplateRequestBody, CreateJWTTemplateRequestBodyTypedDict from .createoauthapplicationop import CreateOAuthApplicationRequestBody, CreateOAuthApplicationRequestBodyTypedDict from .createorganizationdomainop import CreateOrganizationDomainRequest, CreateOrganizationDomainRequestBody, CreateOrganizationDomainRequestBodyTypedDict, CreateOrganizationDomainRequestTypedDict -from .createorganizationinvitationbulkop import CreateOrganizationInvitationBulkPrivateMetadata, CreateOrganizationInvitationBulkPrivateMetadataTypedDict, CreateOrganizationInvitationBulkPublicMetadata, CreateOrganizationInvitationBulkPublicMetadataTypedDict, CreateOrganizationInvitationBulkRequest, CreateOrganizationInvitationBulkRequestTypedDict, RequestBody, RequestBodyTypedDict -from .createorganizationinvitationop import CreateOrganizationInvitationPrivateMetadata, CreateOrganizationInvitationPrivateMetadataTypedDict, CreateOrganizationInvitationPublicMetadata, CreateOrganizationInvitationPublicMetadataTypedDict, CreateOrganizationInvitationRequest, CreateOrganizationInvitationRequestBody, CreateOrganizationInvitationRequestBodyTypedDict, CreateOrganizationInvitationRequestTypedDict +from .createorganizationinvitationbulkop import CreateOrganizationInvitationBulkRequest, CreateOrganizationInvitationBulkRequestTypedDict, RequestBody, RequestBodyTypedDict +from .createorganizationinvitationop import CreateOrganizationInvitationRequest, CreateOrganizationInvitationRequestBody, CreateOrganizationInvitationRequestBodyTypedDict, CreateOrganizationInvitationRequestTypedDict from .createorganizationmembershipop import CreateOrganizationMembershipRequest, CreateOrganizationMembershipRequestBody, CreateOrganizationMembershipRequestBodyTypedDict, CreateOrganizationMembershipRequestTypedDict -from .createorganizationop import CreateOrganizationPrivateMetadata, CreateOrganizationPrivateMetadataTypedDict, CreateOrganizationPublicMetadata, CreateOrganizationPublicMetadataTypedDict, CreateOrganizationRequestBody, CreateOrganizationRequestBodyTypedDict +from .createorganizationop import CreateOrganizationRequestBody, CreateOrganizationRequestBodyTypedDict from .createphonenumberop import CreatePhoneNumberRequestBody, CreatePhoneNumberRequestBodyTypedDict from .createredirecturlop import CreateRedirectURLRequestBody, CreateRedirectURLRequestBodyTypedDict from .createsamlconnectionop import CreateSAMLConnectionAttributeMapping, CreateSAMLConnectionAttributeMappingTypedDict, CreateSAMLConnectionRequestBody, CreateSAMLConnectionRequestBodyTypedDict, Provider from .createsessiontokenfromtemplateop import CreateSessionTokenFromTemplateObject, CreateSessionTokenFromTemplateRequest, CreateSessionTokenFromTemplateRequestTypedDict, CreateSessionTokenFromTemplateResponseBody, CreateSessionTokenFromTemplateResponseBodyTypedDict from .createsignintokenop import CreateSignInTokenRequestBody, CreateSignInTokenRequestBodyTypedDict -from .createuserop import CreateUserPrivateMetadata, CreateUserPrivateMetadataTypedDict, CreateUserPublicMetadata, CreateUserPublicMetadataTypedDict, CreateUserRequestBody, CreateUserRequestBodyTypedDict, CreateUserUnsafeMetadata, CreateUserUnsafeMetadataTypedDict +from .createuserop import CreateUserRequestBody, CreateUserRequestBodyTypedDict from .createusertotpop import CreateUserTOTPRequest, CreateUserTOTPRequestTypedDict from .deleteallowlistidentifierop import DeleteAllowlistIdentifierRequest, DeleteAllowlistIdentifierRequestTypedDict from .deletebackupcodeop import DeleteBackupCodeRequest, DeleteBackupCodeRequestTypedDict, DeleteBackupCodeResponseBody, DeleteBackupCodeResponseBodyTypedDict @@ -57,7 +57,7 @@ from .getclientop import GetClientRequest, GetClientRequestTypedDict from .getemailaddressop import GetEmailAddressRequest, GetEmailAddressRequestTypedDict from .getjwttemplateop import GetJWTTemplateRequest, GetJWTTemplateRequestTypedDict -from .getoauthaccesstokenop import GetOAuthAccessTokenPublicMetadata, GetOAuthAccessTokenPublicMetadataTypedDict, GetOAuthAccessTokenRequest, GetOAuthAccessTokenRequestTypedDict, ResponseBody, ResponseBodyTypedDict +from .getoauthaccesstokenop import GetOAuthAccessTokenRequest, GetOAuthAccessTokenRequestTypedDict, ResponseBody, ResponseBodyTypedDict from .getoauthapplicationop import GetOAuthApplicationRequest, GetOAuthApplicationRequestTypedDict from .getorganizationinvitationop import GetOrganizationInvitationRequest, GetOrganizationInvitationRequestTypedDict from .getorganizationop import GetOrganizationRequest, GetOrganizationRequestTypedDict @@ -75,8 +75,8 @@ from .instancegetorganizationmembershipsop import InstanceGetOrganizationMembershipsRequest, InstanceGetOrganizationMembershipsRequestTypedDict from .instancerestrictions import InstanceRestrictions, InstanceRestrictionsObject, InstanceRestrictionsTypedDict from .instancesettings import InstanceSettings, InstanceSettingsObject, InstanceSettingsTypedDict -from .invitation import Invitation, InvitationObject, InvitationPublicMetadata, InvitationPublicMetadataTypedDict, InvitationStatus, InvitationTypedDict -from .invitation_revoked import InvitationRevoked, InvitationRevokedObject, InvitationRevokedPublicMetadata, InvitationRevokedPublicMetadataTypedDict, InvitationRevokedStatus, InvitationRevokedTypedDict +from .invitation import Invitation, InvitationObject, InvitationStatus, InvitationTypedDict +from .invitation_revoked import InvitationRevoked, InvitationRevokedObject, InvitationRevokedStatus, InvitationRevokedTypedDict from .jwttemplate import Claims, ClaimsTypedDict, JWTTemplate, JWTTemplateObject, JWTTemplateTypedDict from .listinstanceorganizationinvitationsop import ListInstanceOrganizationInvitationsQueryParamStatus, ListInstanceOrganizationInvitationsRequest, ListInstanceOrganizationInvitationsRequestTypedDict from .listinvitationsop import ListInvitationsQueryParamStatus, ListInvitationsRequest, ListInvitationsRequestTypedDict @@ -88,22 +88,22 @@ from .listpendingorganizationinvitationsop import ListPendingOrganizationInvitationsRequest, ListPendingOrganizationInvitationsRequestTypedDict from .listsamlconnectionsop import ListSAMLConnectionsRequest, ListSAMLConnectionsRequestTypedDict from .lockuserop import LockUserRequest, LockUserRequestTypedDict -from .mergeorganizationmetadataop import MergeOrganizationMetadataPrivateMetadata, MergeOrganizationMetadataPrivateMetadataTypedDict, MergeOrganizationMetadataPublicMetadata, MergeOrganizationMetadataPublicMetadataTypedDict, MergeOrganizationMetadataRequest, MergeOrganizationMetadataRequestBody, MergeOrganizationMetadataRequestBodyTypedDict, MergeOrganizationMetadataRequestTypedDict +from .mergeorganizationmetadataop import MergeOrganizationMetadataRequest, MergeOrganizationMetadataRequestBody, MergeOrganizationMetadataRequestBodyTypedDict, MergeOrganizationMetadataRequestTypedDict from .oauthapplication import OAuthApplication, OAuthApplicationObject, OAuthApplicationTypedDict from .oauthapplications import OAuthApplications, OAuthApplicationsTypedDict from .oauthapplicationwithsecret import OAuthApplicationWithSecret, OAuthApplicationWithSecretObject, OAuthApplicationWithSecretTypedDict -from .organization import Organization, OrganizationObject, OrganizationPrivateMetadata, OrganizationPrivateMetadataTypedDict, OrganizationPublicMetadata, OrganizationPublicMetadataTypedDict, OrganizationTypedDict +from .organization import Organization, OrganizationObject, OrganizationTypedDict from .organizationdomain import EnrollmentMode, OrganizationDomain, OrganizationDomainObject, OrganizationDomainStatus, OrganizationDomainTypedDict, OrganizationDomainVerification, OrganizationDomainVerificationTypedDict from .organizationdomains import OrganizationDomains, OrganizationDomainsTypedDict -from .organizationinvitation import OrganizationInvitation, OrganizationInvitationObject, OrganizationInvitationPrivateMetadata, OrganizationInvitationPrivateMetadataTypedDict, OrganizationInvitationPublicMetadata, OrganizationInvitationPublicMetadataTypedDict, OrganizationInvitationTypedDict +from .organizationinvitation import OrganizationInvitation, OrganizationInvitationObject, OrganizationInvitationTypedDict from .organizationinvitations import OrganizationInvitations, OrganizationInvitationsTypedDict from .organizationinvitationswithpublicorganizationdata import OrganizationInvitationsWithPublicOrganizationData, OrganizationInvitationsWithPublicOrganizationDataTypedDict -from .organizationinvitationwithpublicorganizationdata import OrganizationInvitationWithPublicOrganizationData, OrganizationInvitationWithPublicOrganizationDataObject, OrganizationInvitationWithPublicOrganizationDataPrivateMetadata, OrganizationInvitationWithPublicOrganizationDataPrivateMetadataTypedDict, OrganizationInvitationWithPublicOrganizationDataPublicMetadata, OrganizationInvitationWithPublicOrganizationDataPublicMetadataTypedDict, OrganizationInvitationWithPublicOrganizationDataTypedDict, PublicOrganizationData, PublicOrganizationDataTypedDict -from .organizationmembership import OrganizationMembership, OrganizationMembershipObject, OrganizationMembershipOrganization, OrganizationMembershipOrganizationObject, OrganizationMembershipOrganizationPrivateMetadata, OrganizationMembershipOrganizationPrivateMetadataTypedDict, OrganizationMembershipOrganizationPublicMetadata, OrganizationMembershipOrganizationPublicMetadataTypedDict, OrganizationMembershipOrganizationTypedDict, OrganizationMembershipPrivateMetadata, OrganizationMembershipPrivateMetadataTypedDict, OrganizationMembershipPublicMetadata, OrganizationMembershipPublicMetadataTypedDict, OrganizationMembershipTypedDict, PublicUserData, PublicUserDataTypedDict +from .organizationinvitationwithpublicorganizationdata import OrganizationInvitationWithPublicOrganizationData, OrganizationInvitationWithPublicOrganizationDataObject, OrganizationInvitationWithPublicOrganizationDataTypedDict, PublicOrganizationData, PublicOrganizationDataTypedDict +from .organizationmembership import OrganizationMembership, OrganizationMembershipObject, OrganizationMembershipOrganization, OrganizationMembershipOrganizationObject, OrganizationMembershipOrganizationTypedDict, OrganizationMembershipTypedDict, PublicUserData, PublicUserDataTypedDict from .organizationmemberships import OrganizationMemberships, OrganizationMembershipsTypedDict from .organizations import Organizations, OrganizationsTypedDict from .organizationsettings import DomainsEnrollmentModes, OrganizationSettings, OrganizationSettingsObject, OrganizationSettingsTypedDict -from .organizationwithlogo import OrganizationWithLogo, OrganizationWithLogoObject, OrganizationWithLogoPrivateMetadata, OrganizationWithLogoPrivateMetadataTypedDict, OrganizationWithLogoPublicMetadata, OrganizationWithLogoPublicMetadataTypedDict, OrganizationWithLogoTypedDict +from .organizationwithlogo import OrganizationWithLogo, OrganizationWithLogoObject, OrganizationWithLogoTypedDict from .phonenumber import AdminVerificationPhoneNumberStatus, AdminVerificationStrategy, OTPVerificationStatus, OTPVerificationStrategy, PhoneNumber, PhoneNumberObject, PhoneNumberTypedDict, PhoneNumberVerification, PhoneNumberVerificationTypedDict, VerificationAdmin, VerificationAdminTypedDict, VerificationOTP, VerificationOTPTypedDict from .previewtemplateop import PreviewTemplateRequest, PreviewTemplateRequestBody, PreviewTemplateRequestBodyTypedDict, PreviewTemplateRequestTypedDict, PreviewTemplateResponseBody, PreviewTemplateResponseBodyTypedDict from .proxycheck import ProxyCheck, ProxyCheckObject, ProxyCheckTypedDict @@ -114,7 +114,7 @@ from .revokesessionop import RevokeSessionRequest, RevokeSessionRequestTypedDict from .revokesignintokenop import RevokeSignInTokenRequest, RevokeSignInTokenRequestTypedDict from .rotateoauthapplicationsecretop import RotateOAuthApplicationSecretRequest, RotateOAuthApplicationSecretRequestTypedDict -from .samlaccount import ClerkErrorErrorMeta, ClerkErrorErrorMetaTypedDict, SAMLAccount, SAMLAccountObject, SAMLAccountPublicMetadata, SAMLAccountPublicMetadataTypedDict, SAMLAccountTypedDict, SAMLAccountVerification, SAMLAccountVerificationTypedDict, SAMLConnectionSAMLConnection, SAMLConnectionSAMLConnectionTypedDict, SAMLErrorClerkError, SAMLErrorClerkErrorTypedDict, SAMLVerificationStatus, SAMLVerificationStrategy, Saml, SamlConnection, SamlConnectionTypedDict, SamlTypedDict, Ticket, TicketTypedDict, TicketVerificationStatus, TicketVerificationStrategy, VerificationError, VerificationErrorTypedDict +from .samlaccount import ClerkErrorErrorMeta, ClerkErrorErrorMetaTypedDict, SAMLAccount, SAMLAccountObject, SAMLAccountTypedDict, SAMLAccountVerification, SAMLAccountVerificationTypedDict, SAMLConnectionSAMLConnection, SAMLConnectionSAMLConnectionTypedDict, SAMLErrorClerkError, SAMLErrorClerkErrorTypedDict, SAMLVerificationStatus, SAMLVerificationStrategy, Saml, SamlConnection, SamlConnectionTypedDict, SamlTypedDict, Ticket, TicketTypedDict, TicketVerificationStatus, TicketVerificationStrategy, VerificationError, VerificationErrorTypedDict from .samlconnections import SAMLConnections, SAMLConnectionsTypedDict from .schemas_passkey import Nonce, Passkey, PasskeyTypedDict, PasskeyVerificationStatus, PasskeyVerificationStrategy, SchemasPasskey, SchemasPasskeyObject, SchemasPasskeyTypedDict, SchemasPasskeyVerification, SchemasPasskeyVerificationTypedDict from .schemas_samlconnection import AttributeMapping, AttributeMappingTypedDict, SchemasSAMLConnection, SchemasSAMLConnectionObject, SchemasSAMLConnectionTypedDict @@ -123,7 +123,7 @@ from .session import Actor, ActorTypedDict, LatestActivity, LatestActivityTypedDict, Session, SessionObject, SessionTypedDict, Status from .setuserprofileimageop import File, FileTypedDict, SetUserProfileImageRequest, SetUserProfileImageRequestBody, SetUserProfileImageRequestBodyTypedDict, SetUserProfileImageRequestTypedDict from .signintoken import SignInToken, SignInTokenObject, SignInTokenStatus, SignInTokenTypedDict -from .signup import ExternalAccount, ExternalAccountTypedDict, SignUp, SignUpObject, SignUpPublicMetadata, SignUpPublicMetadataTypedDict, SignUpStatus, SignUpTypedDict, SignUpUnsafeMetadata, SignUpUnsafeMetadataTypedDict, Verifications, VerificationsTypedDict +from .signup import ExternalAccount, ExternalAccountTypedDict, SignUp, SignUpObject, SignUpStatus, SignUpTypedDict, Verifications, VerificationsTypedDict from .svixurl import SvixURL, SvixURLTypedDict from .template import Template, TemplateObject, TemplateTypedDict from .testingtoken import TestingToken, TestingTokenObject, TestingTokenTypedDict @@ -141,18 +141,18 @@ from .updatejwttemplateop import UpdateJWTTemplateClaims, UpdateJWTTemplateClaimsTypedDict, UpdateJWTTemplateRequest, UpdateJWTTemplateRequestBody, UpdateJWTTemplateRequestBodyTypedDict, UpdateJWTTemplateRequestTypedDict from .updateoauthapplicationop import UpdateOAuthApplicationRequest, UpdateOAuthApplicationRequestBody, UpdateOAuthApplicationRequestBodyTypedDict, UpdateOAuthApplicationRequestTypedDict from .updateorganizationdomainop import UpdateOrganizationDomainRequest, UpdateOrganizationDomainRequestBody, UpdateOrganizationDomainRequestBodyTypedDict, UpdateOrganizationDomainRequestTypedDict -from .updateorganizationmembershipmetadataop import UpdateOrganizationMembershipMetadataPrivateMetadata, UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict, UpdateOrganizationMembershipMetadataPublicMetadata, UpdateOrganizationMembershipMetadataPublicMetadataTypedDict, UpdateOrganizationMembershipMetadataRequest, UpdateOrganizationMembershipMetadataRequestBody, UpdateOrganizationMembershipMetadataRequestBodyTypedDict, UpdateOrganizationMembershipMetadataRequestTypedDict +from .updateorganizationmembershipmetadataop import UpdateOrganizationMembershipMetadataRequest, UpdateOrganizationMembershipMetadataRequestBody, UpdateOrganizationMembershipMetadataRequestBodyTypedDict, UpdateOrganizationMembershipMetadataRequestTypedDict from .updateorganizationmembershipop import UpdateOrganizationMembershipRequest, UpdateOrganizationMembershipRequestBody, UpdateOrganizationMembershipRequestBodyTypedDict, UpdateOrganizationMembershipRequestTypedDict -from .updateorganizationop import UpdateOrganizationPrivateMetadata, UpdateOrganizationPrivateMetadataTypedDict, UpdateOrganizationPublicMetadata, UpdateOrganizationPublicMetadataTypedDict, UpdateOrganizationRequest, UpdateOrganizationRequestBody, UpdateOrganizationRequestBodyTypedDict, UpdateOrganizationRequestTypedDict +from .updateorganizationop import UpdateOrganizationRequest, UpdateOrganizationRequestBody, UpdateOrganizationRequestBodyTypedDict, UpdateOrganizationRequestTypedDict from .updatephonenumberop import UpdatePhoneNumberRequest, UpdatePhoneNumberRequestBody, UpdatePhoneNumberRequestBodyTypedDict, UpdatePhoneNumberRequestTypedDict from .updateproductioninstancedomainop import UpdateProductionInstanceDomainRequestBody, UpdateProductionInstanceDomainRequestBodyTypedDict from .updatesamlconnectionop import UpdateSAMLConnectionAttributeMapping, UpdateSAMLConnectionAttributeMappingTypedDict, UpdateSAMLConnectionRequest, UpdateSAMLConnectionRequestBody, UpdateSAMLConnectionRequestBodyTypedDict, UpdateSAMLConnectionRequestTypedDict from .updatesignupop import UpdateSignUpRequest, UpdateSignUpRequestBody, UpdateSignUpRequestBodyTypedDict, UpdateSignUpRequestTypedDict from .updateusermetadataop import UpdateUserMetadataRequest, UpdateUserMetadataRequestBody, UpdateUserMetadataRequestBodyTypedDict, UpdateUserMetadataRequestTypedDict -from .updateuserop import UpdateUserPrivateMetadata, UpdateUserPrivateMetadataTypedDict, UpdateUserPublicMetadata, UpdateUserPublicMetadataTypedDict, UpdateUserRequest, UpdateUserRequestBody, UpdateUserRequestBodyTypedDict, UpdateUserRequestTypedDict, UpdateUserUnsafeMetadata, UpdateUserUnsafeMetadataTypedDict +from .updateuserop import UpdateUserRequest, UpdateUserRequestBody, UpdateUserRequestBodyTypedDict, UpdateUserRequestTypedDict from .uploadorganizationlogoop import UploadOrganizationLogoFile, UploadOrganizationLogoFileTypedDict, UploadOrganizationLogoRequest, UploadOrganizationLogoRequestBody, UploadOrganizationLogoRequestBodyTypedDict, UploadOrganizationLogoRequestTypedDict from .upserttemplateop import UpsertTemplatePathParamTemplateType, UpsertTemplateRequest, UpsertTemplateRequestBody, UpsertTemplateRequestBodyTypedDict, UpsertTemplateRequestTypedDict -from .user import ExternalAccounts, ExternalAccountsTypedDict, PrivateMetadata, PrivateMetadataTypedDict, PublicMetadata, PublicMetadataTypedDict, UnsafeMetadata, UnsafeMetadataTypedDict, User, UserObject, UserTypedDict +from .user import ExternalAccounts, ExternalAccountsTypedDict, User, UserObject, UserTypedDict from .userpasskeydeleteop import UserPasskeyDeleteRequest, UserPasskeyDeleteRequestTypedDict from .usersgetorganizationinvitationsop import UsersGetOrganizationInvitationsQueryParamStatus, UsersGetOrganizationInvitationsRequest, UsersGetOrganizationInvitationsRequestTypedDict from .usersgetorganizationmembershipsop import UsersGetOrganizationMembershipsRequest, UsersGetOrganizationMembershipsRequestTypedDict @@ -165,4 +165,4 @@ from .web3wallet import AdminVerificationWeb3WalletStatus, AdminVerificationWeb3WalletStrategy, Web3Signature, Web3SignatureTypedDict, Web3SignatureVerificationStatus, Web3SignatureVerificationStrategy, Web3Wallet, Web3WalletObject, Web3WalletTypedDict, Web3WalletVerification, Web3WalletVerificationAdmin, Web3WalletVerificationAdminTypedDict, Web3WalletVerificationTypedDict from .wellknown_jwks import Keys, KeysTypedDict, WellKnownJWKS, WellKnownJWKSTypedDict -__all__ = ["Actor", "ActorToken", "ActorTokenActor", "ActorTokenActorTypedDict", "ActorTokenObject", "ActorTokenStatus", "ActorTokenTypedDict", "ActorTypedDict", "AddDomainRequestBody", "AddDomainRequestBodyTypedDict", "Admin", "AdminTypedDict", "AdminVerificationPhoneNumberStatus", "AdminVerificationStatus", "AdminVerificationStrategy", "AdminVerificationWeb3WalletStatus", "AdminVerificationWeb3WalletStrategy", "AllowlistIdentifier", "AllowlistIdentifierObject", "AllowlistIdentifierTypedDict", "AttributeMapping", "AttributeMappingTypedDict", "BanUserRequest", "BanUserRequestTypedDict", "BlocklistIdentifier", "BlocklistIdentifierIdentifierType", "BlocklistIdentifierObject", "BlocklistIdentifierTypedDict", "BlocklistIdentifiers", "BlocklistIdentifiersTypedDict", "CNameTarget", "CNameTargetTypedDict", "ChangeProductionInstanceDomainRequestBody", "ChangeProductionInstanceDomainRequestBodyTypedDict", "Claims", "ClaimsTypedDict", "ClerkError", "ClerkErrorErrorMeta", "ClerkErrorErrorMetaTypedDict", "ClerkErrorTypedDict", "ClerkErrors", "ClerkErrorsData", "ClerkErrorsMeta", "ClerkErrorsMetaTypedDict", "Client", "ClientTypedDict", "CodeType", "CreateActorTokenActor", "CreateActorTokenActorTypedDict", "CreateActorTokenRequestBody", "CreateActorTokenRequestBodyTypedDict", "CreateAllowlistIdentifierRequestBody", "CreateAllowlistIdentifierRequestBodyTypedDict", "CreateBlocklistIdentifierRequestBody", "CreateBlocklistIdentifierRequestBodyTypedDict", "CreateEmailAddressRequestBody", "CreateEmailAddressRequestBodyTypedDict", "CreateInvitationPublicMetadata", "CreateInvitationPublicMetadataTypedDict", "CreateInvitationRequestBody", "CreateInvitationRequestBodyTypedDict", "CreateJWTTemplateClaims", "CreateJWTTemplateClaimsTypedDict", "CreateJWTTemplateRequestBody", "CreateJWTTemplateRequestBodyTypedDict", "CreateOAuthApplicationRequestBody", "CreateOAuthApplicationRequestBodyTypedDict", "CreateOrganizationDomainRequest", "CreateOrganizationDomainRequestBody", "CreateOrganizationDomainRequestBodyTypedDict", "CreateOrganizationDomainRequestTypedDict", "CreateOrganizationInvitationBulkPrivateMetadata", "CreateOrganizationInvitationBulkPrivateMetadataTypedDict", "CreateOrganizationInvitationBulkPublicMetadata", "CreateOrganizationInvitationBulkPublicMetadataTypedDict", "CreateOrganizationInvitationBulkRequest", "CreateOrganizationInvitationBulkRequestTypedDict", "CreateOrganizationInvitationPrivateMetadata", "CreateOrganizationInvitationPrivateMetadataTypedDict", "CreateOrganizationInvitationPublicMetadata", "CreateOrganizationInvitationPublicMetadataTypedDict", "CreateOrganizationInvitationRequest", "CreateOrganizationInvitationRequestBody", "CreateOrganizationInvitationRequestBodyTypedDict", "CreateOrganizationInvitationRequestTypedDict", "CreateOrganizationMembershipRequest", "CreateOrganizationMembershipRequestBody", "CreateOrganizationMembershipRequestBodyTypedDict", "CreateOrganizationMembershipRequestTypedDict", "CreateOrganizationPrivateMetadata", "CreateOrganizationPrivateMetadataTypedDict", "CreateOrganizationPublicMetadata", "CreateOrganizationPublicMetadataTypedDict", "CreateOrganizationRequestBody", "CreateOrganizationRequestBodyTypedDict", "CreatePhoneNumberRequestBody", "CreatePhoneNumberRequestBodyTypedDict", "CreateRedirectURLRequestBody", "CreateRedirectURLRequestBodyTypedDict", "CreateSAMLConnectionAttributeMapping", "CreateSAMLConnectionAttributeMappingTypedDict", "CreateSAMLConnectionRequestBody", "CreateSAMLConnectionRequestBodyTypedDict", "CreateSessionTokenFromTemplateObject", "CreateSessionTokenFromTemplateRequest", "CreateSessionTokenFromTemplateRequestTypedDict", "CreateSessionTokenFromTemplateResponseBody", "CreateSessionTokenFromTemplateResponseBodyTypedDict", "CreateSignInTokenRequestBody", "CreateSignInTokenRequestBodyTypedDict", "CreateUserPrivateMetadata", "CreateUserPrivateMetadataTypedDict", "CreateUserPublicMetadata", "CreateUserPublicMetadataTypedDict", "CreateUserRequestBody", "CreateUserRequestBodyTypedDict", "CreateUserTOTPRequest", "CreateUserTOTPRequestTypedDict", "CreateUserUnsafeMetadata", "CreateUserUnsafeMetadataTypedDict", "DeleteAllowlistIdentifierRequest", "DeleteAllowlistIdentifierRequestTypedDict", "DeleteBackupCodeRequest", "DeleteBackupCodeRequestTypedDict", "DeleteBackupCodeResponseBody", "DeleteBackupCodeResponseBodyTypedDict", "DeleteBlocklistIdentifierRequest", "DeleteBlocklistIdentifierRequestTypedDict", "DeleteDomainRequest", "DeleteDomainRequestTypedDict", "DeleteEmailAddressRequest", "DeleteEmailAddressRequestTypedDict", "DeleteExternalAccountRequest", "DeleteExternalAccountRequestTypedDict", "DeleteJWTTemplateRequest", "DeleteJWTTemplateRequestTypedDict", "DeleteOAuthApplicationRequest", "DeleteOAuthApplicationRequestTypedDict", "DeleteOrganizationDomainRequest", "DeleteOrganizationDomainRequestTypedDict", "DeleteOrganizationLogoRequest", "DeleteOrganizationLogoRequestTypedDict", "DeleteOrganizationMembershipRequest", "DeleteOrganizationMembershipRequestTypedDict", "DeleteOrganizationRequest", "DeleteOrganizationRequestTypedDict", "DeletePhoneNumberRequest", "DeletePhoneNumberRequestTypedDict", "DeleteRedirectURLRequest", "DeleteRedirectURLRequestTypedDict", "DeleteSAMLConnectionRequest", "DeleteSAMLConnectionRequestTypedDict", "DeleteTOTPRequest", "DeleteTOTPRequestTypedDict", "DeleteTOTPResponseBody", "DeleteTOTPResponseBodyTypedDict", "DeleteUserProfileImageRequest", "DeleteUserProfileImageRequestTypedDict", "DeleteUserRequest", "DeleteUserRequestTypedDict", "DeletedObject", "DeletedObjectTypedDict", "DisableMFARequest", "DisableMFARequestTypedDict", "DisableMFAResponseBody", "DisableMFAResponseBodyTypedDict", "Domain", "DomainObject", "DomainTypedDict", "Domains", "DomainsEnrollmentModes", "DomainsTypedDict", "EmailAddress", "EmailAddressObject", "EmailAddressTypedDict", "EnrollmentMode", "Error", "ErrorClerkError", "ErrorClerkErrorTypedDict", "ErrorMeta", "ErrorMetaTypedDict", "ErrorTypedDict", "ExternalAccount", "ExternalAccountTypedDict", "ExternalAccounts", "ExternalAccountsTypedDict", "File", "FileTypedDict", "GetClientListRequest", "GetClientListRequestTypedDict", "GetClientRequest", "GetClientRequestTypedDict", "GetEmailAddressRequest", "GetEmailAddressRequestTypedDict", "GetJWTTemplateRequest", "GetJWTTemplateRequestTypedDict", "GetOAuthAccessTokenPublicMetadata", "GetOAuthAccessTokenPublicMetadataTypedDict", "GetOAuthAccessTokenRequest", "GetOAuthAccessTokenRequestTypedDict", "GetOAuthApplicationRequest", "GetOAuthApplicationRequestTypedDict", "GetOrganizationInvitationRequest", "GetOrganizationInvitationRequestTypedDict", "GetOrganizationRequest", "GetOrganizationRequestTypedDict", "GetPhoneNumberRequest", "GetPhoneNumberRequestTypedDict", "GetPublicInterstitialRequest", "GetPublicInterstitialRequestTypedDict", "GetRedirectURLRequest", "GetRedirectURLRequestTypedDict", "GetSAMLConnectionRequest", "GetSAMLConnectionRequestTypedDict", "GetSessionListRequest", "GetSessionListRequestTypedDict", "GetSessionRequest", "GetSessionRequestTypedDict", "GetTemplateRequest", "GetTemplateRequestTypedDict", "GetUserListRequest", "GetUserListRequestTypedDict", "GetUserRequest", "GetUserRequestTypedDict", "GetUsersCountRequest", "GetUsersCountRequestTypedDict", "IdentificationLink", "IdentificationLinkTypedDict", "IdentifierType", "InstanceGetOrganizationMembershipsRequest", "InstanceGetOrganizationMembershipsRequestTypedDict", "InstanceRestrictions", "InstanceRestrictionsObject", "InstanceRestrictionsTypedDict", "InstanceSettings", "InstanceSettingsObject", "InstanceSettingsTypedDict", "Invitation", "InvitationObject", "InvitationPublicMetadata", "InvitationPublicMetadataTypedDict", "InvitationRevoked", "InvitationRevokedObject", "InvitationRevokedPublicMetadata", "InvitationRevokedPublicMetadataTypedDict", "InvitationRevokedStatus", "InvitationRevokedTypedDict", "InvitationStatus", "InvitationTypedDict", "JWTTemplate", "JWTTemplateObject", "JWTTemplateTypedDict", "Keys", "KeysTypedDict", "LatestActivity", "LatestActivityTypedDict", "ListInstanceOrganizationInvitationsQueryParamStatus", "ListInstanceOrganizationInvitationsRequest", "ListInstanceOrganizationInvitationsRequestTypedDict", "ListInvitationsQueryParamStatus", "ListInvitationsRequest", "ListInvitationsRequestTypedDict", "ListOAuthApplicationsRequest", "ListOAuthApplicationsRequestTypedDict", "ListOrganizationDomainsRequest", "ListOrganizationDomainsRequestTypedDict", "ListOrganizationInvitationsQueryParamStatus", "ListOrganizationInvitationsRequest", "ListOrganizationInvitationsRequestTypedDict", "ListOrganizationMembershipsRequest", "ListOrganizationMembershipsRequestTypedDict", "ListOrganizationsRequest", "ListOrganizationsRequestTypedDict", "ListPendingOrganizationInvitationsRequest", "ListPendingOrganizationInvitationsRequestTypedDict", "ListSAMLConnectionsRequest", "ListSAMLConnectionsRequestTypedDict", "LockUserRequest", "LockUserRequestTypedDict", "MergeOrganizationMetadataPrivateMetadata", "MergeOrganizationMetadataPrivateMetadataTypedDict", "MergeOrganizationMetadataPublicMetadata", "MergeOrganizationMetadataPublicMetadataTypedDict", "MergeOrganizationMetadataRequest", "MergeOrganizationMetadataRequestBody", "MergeOrganizationMetadataRequestBodyTypedDict", "MergeOrganizationMetadataRequestTypedDict", "Meta", "MetaTypedDict", "Nonce", "OAuthApplication", "OAuthApplicationObject", "OAuthApplicationTypedDict", "OAuthApplicationWithSecret", "OAuthApplicationWithSecretObject", "OAuthApplicationWithSecretTypedDict", "OAuthApplications", "OAuthApplicationsTypedDict", "OTPVerificationStatus", "OTPVerificationStrategy", "Oauth", "OauthTypedDict", "OauthVerificationStatus", "OauthVerificationStrategy", "Object", "Organization", "OrganizationDomain", "OrganizationDomainObject", "OrganizationDomainStatus", "OrganizationDomainTypedDict", "OrganizationDomainVerification", "OrganizationDomainVerificationTypedDict", "OrganizationDomains", "OrganizationDomainsTypedDict", "OrganizationInvitation", "OrganizationInvitationObject", "OrganizationInvitationPrivateMetadata", "OrganizationInvitationPrivateMetadataTypedDict", "OrganizationInvitationPublicMetadata", "OrganizationInvitationPublicMetadataTypedDict", "OrganizationInvitationTypedDict", "OrganizationInvitationWithPublicOrganizationData", "OrganizationInvitationWithPublicOrganizationDataObject", "OrganizationInvitationWithPublicOrganizationDataPrivateMetadata", "OrganizationInvitationWithPublicOrganizationDataPrivateMetadataTypedDict", "OrganizationInvitationWithPublicOrganizationDataPublicMetadata", "OrganizationInvitationWithPublicOrganizationDataPublicMetadataTypedDict", "OrganizationInvitationWithPublicOrganizationDataTypedDict", "OrganizationInvitations", "OrganizationInvitationsTypedDict", "OrganizationInvitationsWithPublicOrganizationData", "OrganizationInvitationsWithPublicOrganizationDataTypedDict", "OrganizationMembership", "OrganizationMembershipObject", "OrganizationMembershipOrganization", "OrganizationMembershipOrganizationObject", "OrganizationMembershipOrganizationPrivateMetadata", "OrganizationMembershipOrganizationPrivateMetadataTypedDict", "OrganizationMembershipOrganizationPublicMetadata", "OrganizationMembershipOrganizationPublicMetadataTypedDict", "OrganizationMembershipOrganizationTypedDict", "OrganizationMembershipPrivateMetadata", "OrganizationMembershipPrivateMetadataTypedDict", "OrganizationMembershipPublicMetadata", "OrganizationMembershipPublicMetadataTypedDict", "OrganizationMembershipTypedDict", "OrganizationMemberships", "OrganizationMembershipsTypedDict", "OrganizationObject", "OrganizationPrivateMetadata", "OrganizationPrivateMetadataTypedDict", "OrganizationPublicMetadata", "OrganizationPublicMetadataTypedDict", "OrganizationSettings", "OrganizationSettingsObject", "OrganizationSettingsTypedDict", "OrganizationTypedDict", "OrganizationWithLogo", "OrganizationWithLogoObject", "OrganizationWithLogoPrivateMetadata", "OrganizationWithLogoPrivateMetadataTypedDict", "OrganizationWithLogoPublicMetadata", "OrganizationWithLogoPublicMetadataTypedDict", "OrganizationWithLogoTypedDict", "Organizations", "OrganizationsTypedDict", "Otp", "OtpTypedDict", "Passkey", "PasskeyTypedDict", "PasskeyVerificationStatus", "PasskeyVerificationStrategy", "PathParamTemplateType", "PhoneNumber", "PhoneNumberObject", "PhoneNumberTypedDict", "PhoneNumberVerification", "PhoneNumberVerificationTypedDict", "PreviewTemplateRequest", "PreviewTemplateRequestBody", "PreviewTemplateRequestBodyTypedDict", "PreviewTemplateRequestTypedDict", "PreviewTemplateResponseBody", "PreviewTemplateResponseBodyTypedDict", "PrivateMetadata", "PrivateMetadataTypedDict", "Provider", "ProxyCheck", "ProxyCheckObject", "ProxyCheckTypedDict", "PublicMetadata", "PublicMetadataTypedDict", "PublicOrganizationData", "PublicOrganizationDataTypedDict", "PublicUserData", "PublicUserDataTypedDict", "QueryParamStatus", "RedirectURL", "RedirectURLObject", "RedirectURLTypedDict", "RequestBody", "RequestBodyTypedDict", "ResponseBody", "ResponseBodyTypedDict", "RevokeActorTokenRequest", "RevokeActorTokenRequestTypedDict", "RevokeInvitationRequest", "RevokeInvitationRequestTypedDict", "RevokeOrganizationInvitationRequest", "RevokeOrganizationInvitationRequestBody", "RevokeOrganizationInvitationRequestBodyTypedDict", "RevokeOrganizationInvitationRequestTypedDict", "RevokeSessionRequest", "RevokeSessionRequestTypedDict", "RevokeSignInTokenRequest", "RevokeSignInTokenRequestTypedDict", "RotateOAuthApplicationSecretRequest", "RotateOAuthApplicationSecretRequestTypedDict", "SAMLAccount", "SAMLAccountObject", "SAMLAccountPublicMetadata", "SAMLAccountPublicMetadataTypedDict", "SAMLAccountTypedDict", "SAMLAccountVerification", "SAMLAccountVerificationTypedDict", "SAMLConnectionSAMLConnection", "SAMLConnectionSAMLConnectionTypedDict", "SAMLConnections", "SAMLConnectionsTypedDict", "SAMLErrorClerkError", "SAMLErrorClerkErrorTypedDict", "SAMLVerificationStatus", "SAMLVerificationStrategy", "SDKError", "Saml", "SamlConnection", "SamlConnectionTypedDict", "SamlTypedDict", "SchemasPasskey", "SchemasPasskeyObject", "SchemasPasskeyTypedDict", "SchemasPasskeyVerification", "SchemasPasskeyVerificationTypedDict", "SchemasSAMLConnection", "SchemasSAMLConnectionObject", "SchemasSAMLConnectionTypedDict", "Security", "SecurityTypedDict", "Session", "SessionObject", "SessionTypedDict", "SetUserProfileImageRequest", "SetUserProfileImageRequestBody", "SetUserProfileImageRequestBodyTypedDict", "SetUserProfileImageRequestTypedDict", "SignInToken", "SignInTokenObject", "SignInTokenStatus", "SignInTokenTypedDict", "SignUp", "SignUpObject", "SignUpPublicMetadata", "SignUpPublicMetadataTypedDict", "SignUpStatus", "SignUpTypedDict", "SignUpUnsafeMetadata", "SignUpUnsafeMetadataTypedDict", "Status", "Strategy", "SvixURL", "SvixURLTypedDict", "Template", "TemplateObject", "TemplateTypedDict", "TestingToken", "TestingTokenObject", "TestingTokenTypedDict", "Ticket", "TicketTypedDict", "TicketVerificationStatus", "TicketVerificationStrategy", "ToggleTemplateDeliveryPathParamTemplateType", "ToggleTemplateDeliveryRequest", "ToggleTemplateDeliveryRequestBody", "ToggleTemplateDeliveryRequestBodyTypedDict", "ToggleTemplateDeliveryRequestTypedDict", "TotalCount", "TotalCountObject", "TotalCountTypedDict", "Totp", "TotpTypedDict", "Type", "UnbanUserRequest", "UnbanUserRequestTypedDict", "UnlockUserRequest", "UnlockUserRequestTypedDict", "UnsafeMetadata", "UnsafeMetadataTypedDict", "UpdateDomainRequest", "UpdateDomainRequestBody", "UpdateDomainRequestBodyTypedDict", "UpdateDomainRequestTypedDict", "UpdateEmailAddressRequest", "UpdateEmailAddressRequestBody", "UpdateEmailAddressRequestBodyTypedDict", "UpdateEmailAddressRequestTypedDict", "UpdateInstanceAuthConfigRequestBody", "UpdateInstanceAuthConfigRequestBodyTypedDict", "UpdateInstanceOrganizationSettingsRequestBody", "UpdateInstanceOrganizationSettingsRequestBodyTypedDict", "UpdateInstanceRequestBody", "UpdateInstanceRequestBodyTypedDict", "UpdateInstanceRestrictionsRequestBody", "UpdateInstanceRestrictionsRequestBodyTypedDict", "UpdateJWTTemplateClaims", "UpdateJWTTemplateClaimsTypedDict", "UpdateJWTTemplateRequest", "UpdateJWTTemplateRequestBody", "UpdateJWTTemplateRequestBodyTypedDict", "UpdateJWTTemplateRequestTypedDict", "UpdateOAuthApplicationRequest", "UpdateOAuthApplicationRequestBody", "UpdateOAuthApplicationRequestBodyTypedDict", "UpdateOAuthApplicationRequestTypedDict", "UpdateOrganizationDomainRequest", "UpdateOrganizationDomainRequestBody", "UpdateOrganizationDomainRequestBodyTypedDict", "UpdateOrganizationDomainRequestTypedDict", "UpdateOrganizationMembershipMetadataPrivateMetadata", "UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict", "UpdateOrganizationMembershipMetadataPublicMetadata", "UpdateOrganizationMembershipMetadataPublicMetadataTypedDict", "UpdateOrganizationMembershipMetadataRequest", "UpdateOrganizationMembershipMetadataRequestBody", "UpdateOrganizationMembershipMetadataRequestBodyTypedDict", "UpdateOrganizationMembershipMetadataRequestTypedDict", "UpdateOrganizationMembershipRequest", "UpdateOrganizationMembershipRequestBody", "UpdateOrganizationMembershipRequestBodyTypedDict", "UpdateOrganizationMembershipRequestTypedDict", "UpdateOrganizationPrivateMetadata", "UpdateOrganizationPrivateMetadataTypedDict", "UpdateOrganizationPublicMetadata", "UpdateOrganizationPublicMetadataTypedDict", "UpdateOrganizationRequest", "UpdateOrganizationRequestBody", "UpdateOrganizationRequestBodyTypedDict", "UpdateOrganizationRequestTypedDict", "UpdatePhoneNumberRequest", "UpdatePhoneNumberRequestBody", "UpdatePhoneNumberRequestBodyTypedDict", "UpdatePhoneNumberRequestTypedDict", "UpdateProductionInstanceDomainRequestBody", "UpdateProductionInstanceDomainRequestBodyTypedDict", "UpdateSAMLConnectionAttributeMapping", "UpdateSAMLConnectionAttributeMappingTypedDict", "UpdateSAMLConnectionRequest", "UpdateSAMLConnectionRequestBody", "UpdateSAMLConnectionRequestBodyTypedDict", "UpdateSAMLConnectionRequestTypedDict", "UpdateSignUpRequest", "UpdateSignUpRequestBody", "UpdateSignUpRequestBodyTypedDict", "UpdateSignUpRequestTypedDict", "UpdateUserMetadataRequest", "UpdateUserMetadataRequestBody", "UpdateUserMetadataRequestBodyTypedDict", "UpdateUserMetadataRequestTypedDict", "UpdateUserPrivateMetadata", "UpdateUserPrivateMetadataTypedDict", "UpdateUserPublicMetadata", "UpdateUserPublicMetadataTypedDict", "UpdateUserRequest", "UpdateUserRequestBody", "UpdateUserRequestBodyTypedDict", "UpdateUserRequestTypedDict", "UpdateUserUnsafeMetadata", "UpdateUserUnsafeMetadataTypedDict", "UploadOrganizationLogoFile", "UploadOrganizationLogoFileTypedDict", "UploadOrganizationLogoRequest", "UploadOrganizationLogoRequestBody", "UploadOrganizationLogoRequestBodyTypedDict", "UploadOrganizationLogoRequestTypedDict", "UpsertTemplatePathParamTemplateType", "UpsertTemplateRequest", "UpsertTemplateRequestBody", "UpsertTemplateRequestBodyTypedDict", "UpsertTemplateRequestTypedDict", "User", "UserObject", "UserPasskeyDeleteRequest", "UserPasskeyDeleteRequestTypedDict", "UserTypedDict", "UserWeb3WalletDeleteRequest", "UserWeb3WalletDeleteRequestTypedDict", "UsersGetOrganizationInvitationsQueryParamStatus", "UsersGetOrganizationInvitationsRequest", "UsersGetOrganizationInvitationsRequestTypedDict", "UsersGetOrganizationMembershipsRequest", "UsersGetOrganizationMembershipsRequestTypedDict", "Verification", "VerificationAdmin", "VerificationAdminTypedDict", "VerificationError", "VerificationErrorTypedDict", "VerificationOTP", "VerificationOTPTypedDict", "VerificationStatus", "VerificationStrategy", "VerificationTypedDict", "Verifications", "VerificationsTypedDict", "VerifyClientRequestBody", "VerifyClientRequestBodyTypedDict", "VerifyDomainProxyRequestBody", "VerifyDomainProxyRequestBodyTypedDict", "VerifyPasswordRequest", "VerifyPasswordRequestBody", "VerifyPasswordRequestBodyTypedDict", "VerifyPasswordRequestTypedDict", "VerifyPasswordResponseBody", "VerifyPasswordResponseBodyTypedDict", "VerifySessionRequest", "VerifySessionRequestBody", "VerifySessionRequestBodyTypedDict", "VerifySessionRequestTypedDict", "VerifyTOTPRequest", "VerifyTOTPRequestBody", "VerifyTOTPRequestBodyTypedDict", "VerifyTOTPRequestTypedDict", "VerifyTOTPResponseBody", "VerifyTOTPResponseBodyTypedDict", "Web3Signature", "Web3SignatureTypedDict", "Web3SignatureVerificationStatus", "Web3SignatureVerificationStrategy", "Web3Wallet", "Web3WalletObject", "Web3WalletTypedDict", "Web3WalletVerification", "Web3WalletVerificationAdmin", "Web3WalletVerificationAdminTypedDict", "Web3WalletVerificationTypedDict", "WellKnownJWKS", "WellKnownJWKSTypedDict"] +__all__ = ["Actor", "ActorToken", "ActorTokenActor", "ActorTokenActorTypedDict", "ActorTokenObject", "ActorTokenStatus", "ActorTokenTypedDict", "ActorTypedDict", "AddDomainRequestBody", "AddDomainRequestBodyTypedDict", "Admin", "AdminTypedDict", "AdminVerificationPhoneNumberStatus", "AdminVerificationStatus", "AdminVerificationStrategy", "AdminVerificationWeb3WalletStatus", "AdminVerificationWeb3WalletStrategy", "AllowlistIdentifier", "AllowlistIdentifierObject", "AllowlistIdentifierTypedDict", "AttributeMapping", "AttributeMappingTypedDict", "BanUserRequest", "BanUserRequestTypedDict", "BlocklistIdentifier", "BlocklistIdentifierIdentifierType", "BlocklistIdentifierObject", "BlocklistIdentifierTypedDict", "BlocklistIdentifiers", "BlocklistIdentifiersTypedDict", "CNameTarget", "CNameTargetTypedDict", "ChangeProductionInstanceDomainRequestBody", "ChangeProductionInstanceDomainRequestBodyTypedDict", "Claims", "ClaimsTypedDict", "ClerkError", "ClerkErrorErrorMeta", "ClerkErrorErrorMetaTypedDict", "ClerkErrorTypedDict", "ClerkErrors", "ClerkErrorsData", "ClerkErrorsMeta", "ClerkErrorsMetaTypedDict", "Client", "ClientTypedDict", "CodeType", "CreateActorTokenActor", "CreateActorTokenActorTypedDict", "CreateActorTokenRequestBody", "CreateActorTokenRequestBodyTypedDict", "CreateAllowlistIdentifierRequestBody", "CreateAllowlistIdentifierRequestBodyTypedDict", "CreateBlocklistIdentifierRequestBody", "CreateBlocklistIdentifierRequestBodyTypedDict", "CreateEmailAddressRequestBody", "CreateEmailAddressRequestBodyTypedDict", "CreateInvitationRequestBody", "CreateInvitationRequestBodyTypedDict", "CreateJWTTemplateClaims", "CreateJWTTemplateClaimsTypedDict", "CreateJWTTemplateRequestBody", "CreateJWTTemplateRequestBodyTypedDict", "CreateOAuthApplicationRequestBody", "CreateOAuthApplicationRequestBodyTypedDict", "CreateOrganizationDomainRequest", "CreateOrganizationDomainRequestBody", "CreateOrganizationDomainRequestBodyTypedDict", "CreateOrganizationDomainRequestTypedDict", "CreateOrganizationInvitationBulkRequest", "CreateOrganizationInvitationBulkRequestTypedDict", "CreateOrganizationInvitationRequest", "CreateOrganizationInvitationRequestBody", "CreateOrganizationInvitationRequestBodyTypedDict", "CreateOrganizationInvitationRequestTypedDict", "CreateOrganizationMembershipRequest", "CreateOrganizationMembershipRequestBody", "CreateOrganizationMembershipRequestBodyTypedDict", "CreateOrganizationMembershipRequestTypedDict", "CreateOrganizationRequestBody", "CreateOrganizationRequestBodyTypedDict", "CreatePhoneNumberRequestBody", "CreatePhoneNumberRequestBodyTypedDict", "CreateRedirectURLRequestBody", "CreateRedirectURLRequestBodyTypedDict", "CreateSAMLConnectionAttributeMapping", "CreateSAMLConnectionAttributeMappingTypedDict", "CreateSAMLConnectionRequestBody", "CreateSAMLConnectionRequestBodyTypedDict", "CreateSessionTokenFromTemplateObject", "CreateSessionTokenFromTemplateRequest", "CreateSessionTokenFromTemplateRequestTypedDict", "CreateSessionTokenFromTemplateResponseBody", "CreateSessionTokenFromTemplateResponseBodyTypedDict", "CreateSignInTokenRequestBody", "CreateSignInTokenRequestBodyTypedDict", "CreateUserRequestBody", "CreateUserRequestBodyTypedDict", "CreateUserTOTPRequest", "CreateUserTOTPRequestTypedDict", "DeleteAllowlistIdentifierRequest", "DeleteAllowlistIdentifierRequestTypedDict", "DeleteBackupCodeRequest", "DeleteBackupCodeRequestTypedDict", "DeleteBackupCodeResponseBody", "DeleteBackupCodeResponseBodyTypedDict", "DeleteBlocklistIdentifierRequest", "DeleteBlocklistIdentifierRequestTypedDict", "DeleteDomainRequest", "DeleteDomainRequestTypedDict", "DeleteEmailAddressRequest", "DeleteEmailAddressRequestTypedDict", "DeleteExternalAccountRequest", "DeleteExternalAccountRequestTypedDict", "DeleteJWTTemplateRequest", "DeleteJWTTemplateRequestTypedDict", "DeleteOAuthApplicationRequest", "DeleteOAuthApplicationRequestTypedDict", "DeleteOrganizationDomainRequest", "DeleteOrganizationDomainRequestTypedDict", "DeleteOrganizationLogoRequest", "DeleteOrganizationLogoRequestTypedDict", "DeleteOrganizationMembershipRequest", "DeleteOrganizationMembershipRequestTypedDict", "DeleteOrganizationRequest", "DeleteOrganizationRequestTypedDict", "DeletePhoneNumberRequest", "DeletePhoneNumberRequestTypedDict", "DeleteRedirectURLRequest", "DeleteRedirectURLRequestTypedDict", "DeleteSAMLConnectionRequest", "DeleteSAMLConnectionRequestTypedDict", "DeleteTOTPRequest", "DeleteTOTPRequestTypedDict", "DeleteTOTPResponseBody", "DeleteTOTPResponseBodyTypedDict", "DeleteUserProfileImageRequest", "DeleteUserProfileImageRequestTypedDict", "DeleteUserRequest", "DeleteUserRequestTypedDict", "DeletedObject", "DeletedObjectTypedDict", "DisableMFARequest", "DisableMFARequestTypedDict", "DisableMFAResponseBody", "DisableMFAResponseBodyTypedDict", "Domain", "DomainObject", "DomainTypedDict", "Domains", "DomainsEnrollmentModes", "DomainsTypedDict", "EmailAddress", "EmailAddressObject", "EmailAddressTypedDict", "EnrollmentMode", "Error", "ErrorClerkError", "ErrorClerkErrorTypedDict", "ErrorMeta", "ErrorMetaTypedDict", "ErrorTypedDict", "ExternalAccount", "ExternalAccountTypedDict", "ExternalAccounts", "ExternalAccountsTypedDict", "File", "FileTypedDict", "GetClientListRequest", "GetClientListRequestTypedDict", "GetClientRequest", "GetClientRequestTypedDict", "GetEmailAddressRequest", "GetEmailAddressRequestTypedDict", "GetJWTTemplateRequest", "GetJWTTemplateRequestTypedDict", "GetOAuthAccessTokenRequest", "GetOAuthAccessTokenRequestTypedDict", "GetOAuthApplicationRequest", "GetOAuthApplicationRequestTypedDict", "GetOrganizationInvitationRequest", "GetOrganizationInvitationRequestTypedDict", "GetOrganizationRequest", "GetOrganizationRequestTypedDict", "GetPhoneNumberRequest", "GetPhoneNumberRequestTypedDict", "GetPublicInterstitialRequest", "GetPublicInterstitialRequestTypedDict", "GetRedirectURLRequest", "GetRedirectURLRequestTypedDict", "GetSAMLConnectionRequest", "GetSAMLConnectionRequestTypedDict", "GetSessionListRequest", "GetSessionListRequestTypedDict", "GetSessionRequest", "GetSessionRequestTypedDict", "GetTemplateRequest", "GetTemplateRequestTypedDict", "GetUserListRequest", "GetUserListRequestTypedDict", "GetUserRequest", "GetUserRequestTypedDict", "GetUsersCountRequest", "GetUsersCountRequestTypedDict", "IdentificationLink", "IdentificationLinkTypedDict", "IdentifierType", "InstanceGetOrganizationMembershipsRequest", "InstanceGetOrganizationMembershipsRequestTypedDict", "InstanceRestrictions", "InstanceRestrictionsObject", "InstanceRestrictionsTypedDict", "InstanceSettings", "InstanceSettingsObject", "InstanceSettingsTypedDict", "Invitation", "InvitationObject", "InvitationRevoked", "InvitationRevokedObject", "InvitationRevokedStatus", "InvitationRevokedTypedDict", "InvitationStatus", "InvitationTypedDict", "JWTTemplate", "JWTTemplateObject", "JWTTemplateTypedDict", "Keys", "KeysTypedDict", "LatestActivity", "LatestActivityTypedDict", "ListInstanceOrganizationInvitationsQueryParamStatus", "ListInstanceOrganizationInvitationsRequest", "ListInstanceOrganizationInvitationsRequestTypedDict", "ListInvitationsQueryParamStatus", "ListInvitationsRequest", "ListInvitationsRequestTypedDict", "ListOAuthApplicationsRequest", "ListOAuthApplicationsRequestTypedDict", "ListOrganizationDomainsRequest", "ListOrganizationDomainsRequestTypedDict", "ListOrganizationInvitationsQueryParamStatus", "ListOrganizationInvitationsRequest", "ListOrganizationInvitationsRequestTypedDict", "ListOrganizationMembershipsRequest", "ListOrganizationMembershipsRequestTypedDict", "ListOrganizationsRequest", "ListOrganizationsRequestTypedDict", "ListPendingOrganizationInvitationsRequest", "ListPendingOrganizationInvitationsRequestTypedDict", "ListSAMLConnectionsRequest", "ListSAMLConnectionsRequestTypedDict", "LockUserRequest", "LockUserRequestTypedDict", "MergeOrganizationMetadataRequest", "MergeOrganizationMetadataRequestBody", "MergeOrganizationMetadataRequestBodyTypedDict", "MergeOrganizationMetadataRequestTypedDict", "Meta", "MetaTypedDict", "Nonce", "OAuthApplication", "OAuthApplicationObject", "OAuthApplicationTypedDict", "OAuthApplicationWithSecret", "OAuthApplicationWithSecretObject", "OAuthApplicationWithSecretTypedDict", "OAuthApplications", "OAuthApplicationsTypedDict", "OTPVerificationStatus", "OTPVerificationStrategy", "Oauth", "OauthTypedDict", "OauthVerificationStatus", "OauthVerificationStrategy", "Object", "Organization", "OrganizationDomain", "OrganizationDomainObject", "OrganizationDomainStatus", "OrganizationDomainTypedDict", "OrganizationDomainVerification", "OrganizationDomainVerificationTypedDict", "OrganizationDomains", "OrganizationDomainsTypedDict", "OrganizationInvitation", "OrganizationInvitationObject", "OrganizationInvitationTypedDict", "OrganizationInvitationWithPublicOrganizationData", "OrganizationInvitationWithPublicOrganizationDataObject", "OrganizationInvitationWithPublicOrganizationDataTypedDict", "OrganizationInvitations", "OrganizationInvitationsTypedDict", "OrganizationInvitationsWithPublicOrganizationData", "OrganizationInvitationsWithPublicOrganizationDataTypedDict", "OrganizationMembership", "OrganizationMembershipObject", "OrganizationMembershipOrganization", "OrganizationMembershipOrganizationObject", "OrganizationMembershipOrganizationTypedDict", "OrganizationMembershipTypedDict", "OrganizationMemberships", "OrganizationMembershipsTypedDict", "OrganizationObject", "OrganizationSettings", "OrganizationSettingsObject", "OrganizationSettingsTypedDict", "OrganizationTypedDict", "OrganizationWithLogo", "OrganizationWithLogoObject", "OrganizationWithLogoTypedDict", "Organizations", "OrganizationsTypedDict", "Otp", "OtpTypedDict", "Passkey", "PasskeyTypedDict", "PasskeyVerificationStatus", "PasskeyVerificationStrategy", "PathParamTemplateType", "PhoneNumber", "PhoneNumberObject", "PhoneNumberTypedDict", "PhoneNumberVerification", "PhoneNumberVerificationTypedDict", "PreviewTemplateRequest", "PreviewTemplateRequestBody", "PreviewTemplateRequestBodyTypedDict", "PreviewTemplateRequestTypedDict", "PreviewTemplateResponseBody", "PreviewTemplateResponseBodyTypedDict", "Provider", "ProxyCheck", "ProxyCheckObject", "ProxyCheckTypedDict", "PublicOrganizationData", "PublicOrganizationDataTypedDict", "PublicUserData", "PublicUserDataTypedDict", "QueryParamStatus", "RedirectURL", "RedirectURLObject", "RedirectURLTypedDict", "RequestBody", "RequestBodyTypedDict", "ResponseBody", "ResponseBodyTypedDict", "RevokeActorTokenRequest", "RevokeActorTokenRequestTypedDict", "RevokeInvitationRequest", "RevokeInvitationRequestTypedDict", "RevokeOrganizationInvitationRequest", "RevokeOrganizationInvitationRequestBody", "RevokeOrganizationInvitationRequestBodyTypedDict", "RevokeOrganizationInvitationRequestTypedDict", "RevokeSessionRequest", "RevokeSessionRequestTypedDict", "RevokeSignInTokenRequest", "RevokeSignInTokenRequestTypedDict", "RotateOAuthApplicationSecretRequest", "RotateOAuthApplicationSecretRequestTypedDict", "SAMLAccount", "SAMLAccountObject", "SAMLAccountTypedDict", "SAMLAccountVerification", "SAMLAccountVerificationTypedDict", "SAMLConnectionSAMLConnection", "SAMLConnectionSAMLConnectionTypedDict", "SAMLConnections", "SAMLConnectionsTypedDict", "SAMLErrorClerkError", "SAMLErrorClerkErrorTypedDict", "SAMLVerificationStatus", "SAMLVerificationStrategy", "SDKError", "Saml", "SamlConnection", "SamlConnectionTypedDict", "SamlTypedDict", "SchemasPasskey", "SchemasPasskeyObject", "SchemasPasskeyTypedDict", "SchemasPasskeyVerification", "SchemasPasskeyVerificationTypedDict", "SchemasSAMLConnection", "SchemasSAMLConnectionObject", "SchemasSAMLConnectionTypedDict", "Security", "SecurityTypedDict", "Session", "SessionObject", "SessionTypedDict", "SetUserProfileImageRequest", "SetUserProfileImageRequestBody", "SetUserProfileImageRequestBodyTypedDict", "SetUserProfileImageRequestTypedDict", "SignInToken", "SignInTokenObject", "SignInTokenStatus", "SignInTokenTypedDict", "SignUp", "SignUpObject", "SignUpStatus", "SignUpTypedDict", "Status", "Strategy", "SvixURL", "SvixURLTypedDict", "Template", "TemplateObject", "TemplateTypedDict", "TestingToken", "TestingTokenObject", "TestingTokenTypedDict", "Ticket", "TicketTypedDict", "TicketVerificationStatus", "TicketVerificationStrategy", "ToggleTemplateDeliveryPathParamTemplateType", "ToggleTemplateDeliveryRequest", "ToggleTemplateDeliveryRequestBody", "ToggleTemplateDeliveryRequestBodyTypedDict", "ToggleTemplateDeliveryRequestTypedDict", "TotalCount", "TotalCountObject", "TotalCountTypedDict", "Totp", "TotpTypedDict", "Type", "UnbanUserRequest", "UnbanUserRequestTypedDict", "UnlockUserRequest", "UnlockUserRequestTypedDict", "UpdateDomainRequest", "UpdateDomainRequestBody", "UpdateDomainRequestBodyTypedDict", "UpdateDomainRequestTypedDict", "UpdateEmailAddressRequest", "UpdateEmailAddressRequestBody", "UpdateEmailAddressRequestBodyTypedDict", "UpdateEmailAddressRequestTypedDict", "UpdateInstanceAuthConfigRequestBody", "UpdateInstanceAuthConfigRequestBodyTypedDict", "UpdateInstanceOrganizationSettingsRequestBody", "UpdateInstanceOrganizationSettingsRequestBodyTypedDict", "UpdateInstanceRequestBody", "UpdateInstanceRequestBodyTypedDict", "UpdateInstanceRestrictionsRequestBody", "UpdateInstanceRestrictionsRequestBodyTypedDict", "UpdateJWTTemplateClaims", "UpdateJWTTemplateClaimsTypedDict", "UpdateJWTTemplateRequest", "UpdateJWTTemplateRequestBody", "UpdateJWTTemplateRequestBodyTypedDict", "UpdateJWTTemplateRequestTypedDict", "UpdateOAuthApplicationRequest", "UpdateOAuthApplicationRequestBody", "UpdateOAuthApplicationRequestBodyTypedDict", "UpdateOAuthApplicationRequestTypedDict", "UpdateOrganizationDomainRequest", "UpdateOrganizationDomainRequestBody", "UpdateOrganizationDomainRequestBodyTypedDict", "UpdateOrganizationDomainRequestTypedDict", "UpdateOrganizationMembershipMetadataRequest", "UpdateOrganizationMembershipMetadataRequestBody", "UpdateOrganizationMembershipMetadataRequestBodyTypedDict", "UpdateOrganizationMembershipMetadataRequestTypedDict", "UpdateOrganizationMembershipRequest", "UpdateOrganizationMembershipRequestBody", "UpdateOrganizationMembershipRequestBodyTypedDict", "UpdateOrganizationMembershipRequestTypedDict", "UpdateOrganizationRequest", "UpdateOrganizationRequestBody", "UpdateOrganizationRequestBodyTypedDict", "UpdateOrganizationRequestTypedDict", "UpdatePhoneNumberRequest", "UpdatePhoneNumberRequestBody", "UpdatePhoneNumberRequestBodyTypedDict", "UpdatePhoneNumberRequestTypedDict", "UpdateProductionInstanceDomainRequestBody", "UpdateProductionInstanceDomainRequestBodyTypedDict", "UpdateSAMLConnectionAttributeMapping", "UpdateSAMLConnectionAttributeMappingTypedDict", "UpdateSAMLConnectionRequest", "UpdateSAMLConnectionRequestBody", "UpdateSAMLConnectionRequestBodyTypedDict", "UpdateSAMLConnectionRequestTypedDict", "UpdateSignUpRequest", "UpdateSignUpRequestBody", "UpdateSignUpRequestBodyTypedDict", "UpdateSignUpRequestTypedDict", "UpdateUserMetadataRequest", "UpdateUserMetadataRequestBody", "UpdateUserMetadataRequestBodyTypedDict", "UpdateUserMetadataRequestTypedDict", "UpdateUserRequest", "UpdateUserRequestBody", "UpdateUserRequestBodyTypedDict", "UpdateUserRequestTypedDict", "UploadOrganizationLogoFile", "UploadOrganizationLogoFileTypedDict", "UploadOrganizationLogoRequest", "UploadOrganizationLogoRequestBody", "UploadOrganizationLogoRequestBodyTypedDict", "UploadOrganizationLogoRequestTypedDict", "UpsertTemplatePathParamTemplateType", "UpsertTemplateRequest", "UpsertTemplateRequestBody", "UpsertTemplateRequestBodyTypedDict", "UpsertTemplateRequestTypedDict", "User", "UserObject", "UserPasskeyDeleteRequest", "UserPasskeyDeleteRequestTypedDict", "UserTypedDict", "UserWeb3WalletDeleteRequest", "UserWeb3WalletDeleteRequestTypedDict", "UsersGetOrganizationInvitationsQueryParamStatus", "UsersGetOrganizationInvitationsRequest", "UsersGetOrganizationInvitationsRequestTypedDict", "UsersGetOrganizationMembershipsRequest", "UsersGetOrganizationMembershipsRequestTypedDict", "Verification", "VerificationAdmin", "VerificationAdminTypedDict", "VerificationError", "VerificationErrorTypedDict", "VerificationOTP", "VerificationOTPTypedDict", "VerificationStatus", "VerificationStrategy", "VerificationTypedDict", "Verifications", "VerificationsTypedDict", "VerifyClientRequestBody", "VerifyClientRequestBodyTypedDict", "VerifyDomainProxyRequestBody", "VerifyDomainProxyRequestBodyTypedDict", "VerifyPasswordRequest", "VerifyPasswordRequestBody", "VerifyPasswordRequestBodyTypedDict", "VerifyPasswordRequestTypedDict", "VerifyPasswordResponseBody", "VerifyPasswordResponseBodyTypedDict", "VerifySessionRequest", "VerifySessionRequestBody", "VerifySessionRequestBodyTypedDict", "VerifySessionRequestTypedDict", "VerifyTOTPRequest", "VerifyTOTPRequestBody", "VerifyTOTPRequestBodyTypedDict", "VerifyTOTPRequestTypedDict", "VerifyTOTPResponseBody", "VerifyTOTPResponseBodyTypedDict", "Web3Signature", "Web3SignatureTypedDict", "Web3SignatureVerificationStatus", "Web3SignatureVerificationStrategy", "Web3Wallet", "Web3WalletObject", "Web3WalletTypedDict", "Web3WalletVerification", "Web3WalletVerificationAdmin", "Web3WalletVerificationAdminTypedDict", "Web3WalletVerificationTypedDict", "WellKnownJWKS", "WellKnownJWKSTypedDict"] diff --git a/src/clerk_backend_api/models/createinvitationop.py b/src/clerk_backend_api/models/createinvitationop.py index bf20aaa..b0007b1 100644 --- a/src/clerk_backend_api/models/createinvitationop.py +++ b/src/clerk_backend_api/models/createinvitationop.py @@ -3,32 +3,16 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired -class CreateInvitationPublicMetadataTypedDict(TypedDict): - r"""Metadata that will be attached to the newly created invitation. - The value of this property should be a well-formed JSON object. - Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. - """ - - - -class CreateInvitationPublicMetadata(BaseModel): - r"""Metadata that will be attached to the newly created invitation. - The value of this property should be a well-formed JSON object. - Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. - """ - - - class CreateInvitationRequestBodyTypedDict(TypedDict): r"""Required parameters""" email_address: str r"""The email address the invitation will be sent to""" - public_metadata: NotRequired[CreateInvitationPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. @@ -52,7 +36,7 @@ class CreateInvitationRequestBody(BaseModel): email_address: str r"""The email address the invitation will be sent to""" - public_metadata: Optional[CreateInvitationPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. diff --git a/src/clerk_backend_api/models/createorganizationinvitationbulkop.py b/src/clerk_backend_api/models/createorganizationinvitationbulkop.py index f3de52b..75ece5d 100644 --- a/src/clerk_backend_api/models/createorganizationinvitationbulkop.py +++ b/src/clerk_backend_api/models/createorganizationinvitationbulkop.py @@ -4,30 +4,10 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class CreateOrganizationInvitationBulkPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - - - -class CreateOrganizationInvitationBulkPublicMetadata(BaseModel): - r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - - - -class CreateOrganizationInvitationBulkPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" - - - -class CreateOrganizationInvitationBulkPrivateMetadata(BaseModel): - r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" - - - class RequestBodyTypedDict(TypedDict): email_address: str r"""The email address of the new member that is going to be invited to the organization""" @@ -37,9 +17,9 @@ class RequestBodyTypedDict(TypedDict): r"""The ID of the user that invites the new member to the organization. Must be an administrator in the organization. """ - public_metadata: NotRequired[CreateOrganizationInvitationBulkPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - private_metadata: NotRequired[CreateOrganizationInvitationBulkPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" redirect_url: NotRequired[str] r"""Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.""" @@ -54,9 +34,9 @@ class RequestBody(BaseModel): r"""The ID of the user that invites the new member to the organization. Must be an administrator in the organization. """ - public_metadata: Optional[CreateOrganizationInvitationBulkPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - private_metadata: Optional[CreateOrganizationInvitationBulkPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" redirect_url: Optional[str] = None r"""Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.""" diff --git a/src/clerk_backend_api/models/createorganizationinvitationop.py b/src/clerk_backend_api/models/createorganizationinvitationop.py index feba7a3..96bda07 100644 --- a/src/clerk_backend_api/models/createorganizationinvitationop.py +++ b/src/clerk_backend_api/models/createorganizationinvitationop.py @@ -4,30 +4,10 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class CreateOrganizationInvitationPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - - - -class CreateOrganizationInvitationPublicMetadata(BaseModel): - r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - - - -class CreateOrganizationInvitationPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" - - - -class CreateOrganizationInvitationPrivateMetadata(BaseModel): - r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" - - - class CreateOrganizationInvitationRequestBodyTypedDict(TypedDict): email_address: str r"""The email address of the new member that is going to be invited to the organization""" @@ -37,9 +17,9 @@ class CreateOrganizationInvitationRequestBodyTypedDict(TypedDict): r"""The ID of the user that invites the new member to the organization. Must be an administrator in the organization. """ - public_metadata: NotRequired[CreateOrganizationInvitationPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - private_metadata: NotRequired[CreateOrganizationInvitationPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" redirect_url: NotRequired[str] r"""Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.""" @@ -54,9 +34,9 @@ class CreateOrganizationInvitationRequestBody(BaseModel): r"""The ID of the user that invites the new member to the organization. Must be an administrator in the organization. """ - public_metadata: Optional[CreateOrganizationInvitationPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.""" - private_metadata: Optional[CreateOrganizationInvitationPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.""" redirect_url: Optional[str] = None r"""Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.""" diff --git a/src/clerk_backend_api/models/createorganizationop.py b/src/clerk_backend_api/models/createorganizationop.py index 7edb08d..83e84e6 100644 --- a/src/clerk_backend_api/models/createorganizationop.py +++ b/src/clerk_backend_api/models/createorganizationop.py @@ -2,30 +2,10 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired -class CreateOrganizationPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization, accessible only from the Backend API""" - - - -class CreateOrganizationPrivateMetadata(BaseModel): - r"""Metadata saved on the organization, accessible only from the Backend API""" - - - -class CreateOrganizationPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API""" - - - -class CreateOrganizationPublicMetadata(BaseModel): - r"""Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API""" - - - class CreateOrganizationRequestBodyTypedDict(TypedDict): name: str r"""The name of the new organization. @@ -33,9 +13,9 @@ class CreateOrganizationRequestBodyTypedDict(TypedDict): """ created_by: str r"""The ID of the User who will become the administrator for the new organization""" - private_metadata: NotRequired[CreateOrganizationPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization, accessible only from the Backend API""" - public_metadata: NotRequired[CreateOrganizationPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API""" slug: NotRequired[str] r"""A slug for the new organization. @@ -55,9 +35,9 @@ class CreateOrganizationRequestBody(BaseModel): """ created_by: str r"""The ID of the User who will become the administrator for the new organization""" - private_metadata: Optional[CreateOrganizationPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization, accessible only from the Backend API""" - public_metadata: Optional[CreateOrganizationPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API""" slug: Optional[str] = None r"""A slug for the new organization. diff --git a/src/clerk_backend_api/models/createuserop.py b/src/clerk_backend_api/models/createuserop.py index c16405d..7b1d37d 100644 --- a/src/clerk_backend_api/models/createuserop.py +++ b/src/clerk_backend_api/models/createuserop.py @@ -3,44 +3,10 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import NotRequired -class CreateUserPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - - - -class CreateUserPublicMetadata(BaseModel): - r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - - - -class CreateUserPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that is only visible to your Backend API""" - - - -class CreateUserPrivateMetadata(BaseModel): - r"""Metadata saved on the user, that is only visible to your Backend API""" - - - -class CreateUserUnsafeMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. - Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - """ - - - -class CreateUserUnsafeMetadata(BaseModel): - r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. - Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - """ - - - class CreateUserRequestBodyTypedDict(TypedDict): external_id: NotRequired[Nullable[str]] r"""The ID of the user as used in your external systems or your previous authentication solution. @@ -109,11 +75,11 @@ class CreateUserRequestBodyTypedDict(TypedDict): r"""If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. """ - public_metadata: NotRequired[CreateUserPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - private_metadata: NotRequired[CreateUserPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that is only visible to your Backend API""" - unsafe_metadata: NotRequired[CreateUserUnsafeMetadataTypedDict] + unsafe_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. """ @@ -207,11 +173,11 @@ class CreateUserRequestBody(BaseModel): r"""If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. """ - public_metadata: Optional[CreateUserPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - private_metadata: Optional[CreateUserPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that is only visible to your Backend API""" - unsafe_metadata: Optional[CreateUserUnsafeMetadata] = None + unsafe_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. """ diff --git a/src/clerk_backend_api/models/getoauthaccesstokenop.py b/src/clerk_backend_api/models/getoauthaccesstokenop.py index 61d2523..d787788 100644 --- a/src/clerk_backend_api/models/getoauthaccesstokenop.py +++ b/src/clerk_backend_api/models/getoauthaccesstokenop.py @@ -4,7 +4,7 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from clerk_backend_api.utils import FieldMetadata, PathParamMetadata from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import Annotated, NotRequired @@ -22,14 +22,6 @@ class GetOAuthAccessTokenRequest(BaseModel): r"""The ID of the OAuth provider (e.g. `oauth_google`)""" -class GetOAuthAccessTokenPublicMetadataTypedDict(TypedDict): - pass - - -class GetOAuthAccessTokenPublicMetadata(BaseModel): - pass - - class ResponseBodyTypedDict(TypedDict): object: NotRequired[str] external_account_id: NotRequired[str] @@ -40,7 +32,7 @@ class ResponseBodyTypedDict(TypedDict): r"""The access token""" provider: NotRequired[str] r"""The ID of the provider""" - public_metadata: NotRequired[GetOAuthAccessTokenPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] label: NotRequired[Nullable[str]] scopes: NotRequired[List[str]] r"""The list of scopes that the token is valid for. @@ -60,7 +52,7 @@ class ResponseBody(BaseModel): r"""The access token""" provider: Optional[str] = None r"""The ID of the provider""" - public_metadata: Optional[GetOAuthAccessTokenPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None label: OptionalNullable[str] = UNSET scopes: Optional[List[str]] = None r"""The list of scopes that the token is valid for. diff --git a/src/clerk_backend_api/models/invitation.py b/src/clerk_backend_api/models/invitation.py index 044a869..fc507ce 100644 --- a/src/clerk_backend_api/models/invitation.py +++ b/src/clerk_backend_api/models/invitation.py @@ -4,21 +4,13 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from enum import Enum from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired class InvitationObject(str, Enum): INVITATION = "invitation" -class InvitationPublicMetadataTypedDict(TypedDict): - pass - - -class InvitationPublicMetadata(BaseModel): - pass - - class InvitationStatus(str, Enum): PENDING = "pending" ACCEPTED = "accepted" @@ -38,7 +30,7 @@ class InvitationTypedDict(TypedDict): r"""Unix timestamp of last update. """ - public_metadata: NotRequired[InvitationPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] revoked: NotRequired[bool] url: NotRequired[Nullable[str]] expires_at: NotRequired[Nullable[int]] @@ -60,7 +52,7 @@ class Invitation(BaseModel): r"""Unix timestamp of last update. """ - public_metadata: Optional[InvitationPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None revoked: Optional[bool] = None url: OptionalNullable[str] = UNSET expires_at: OptionalNullable[int] = UNSET diff --git a/src/clerk_backend_api/models/invitation_revoked.py b/src/clerk_backend_api/models/invitation_revoked.py index c9b2b57..060b78c 100644 --- a/src/clerk_backend_api/models/invitation_revoked.py +++ b/src/clerk_backend_api/models/invitation_revoked.py @@ -4,21 +4,13 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from enum import Enum from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired class InvitationRevokedObject(str, Enum): INVITATION = "invitation" -class InvitationRevokedPublicMetadataTypedDict(TypedDict): - pass - - -class InvitationRevokedPublicMetadata(BaseModel): - pass - - class InvitationRevokedStatus(str, Enum): REVOKED = "revoked" @@ -35,7 +27,7 @@ class InvitationRevokedTypedDict(TypedDict): r"""Unix timestamp of last update. """ - public_metadata: NotRequired[InvitationRevokedPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] revoked: NotRequired[bool] url: NotRequired[Nullable[str]] expires_at: NotRequired[Nullable[int]] @@ -57,7 +49,7 @@ class InvitationRevoked(BaseModel): r"""Unix timestamp of last update. """ - public_metadata: Optional[InvitationRevokedPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None revoked: Optional[bool] = None url: OptionalNullable[str] = UNSET expires_at: OptionalNullable[int] = UNSET diff --git a/src/clerk_backend_api/models/mergeorganizationmetadataop.py b/src/clerk_backend_api/models/mergeorganizationmetadataop.py index 9e6ee53..d11c256 100644 --- a/src/clerk_backend_api/models/mergeorganizationmetadataop.py +++ b/src/clerk_backend_api/models/mergeorganizationmetadataop.py @@ -3,55 +3,27 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class MergeOrganizationMetadataPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization, that is visible to both your frontend and backend. - The new object will be merged with the existing value. - """ - - - -class MergeOrganizationMetadataPublicMetadata(BaseModel): - r"""Metadata saved on the organization, that is visible to both your frontend and backend. - The new object will be merged with the existing value. - """ - - - -class MergeOrganizationMetadataPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization that is only visible to your backend. - The new object will be merged with the existing value. - """ - - - -class MergeOrganizationMetadataPrivateMetadata(BaseModel): - r"""Metadata saved on the organization that is only visible to your backend. - The new object will be merged with the existing value. - """ - - - class MergeOrganizationMetadataRequestBodyTypedDict(TypedDict): - public_metadata: NotRequired[MergeOrganizationMetadataPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization, that is visible to both your frontend and backend. The new object will be merged with the existing value. """ - private_metadata: NotRequired[MergeOrganizationMetadataPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization that is only visible to your backend. The new object will be merged with the existing value. """ class MergeOrganizationMetadataRequestBody(BaseModel): - public_metadata: Optional[MergeOrganizationMetadataPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization, that is visible to both your frontend and backend. The new object will be merged with the existing value. """ - private_metadata: Optional[MergeOrganizationMetadataPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization that is only visible to your backend. The new object will be merged with the existing value. """ diff --git a/src/clerk_backend_api/models/organization.py b/src/clerk_backend_api/models/organization.py index 887f831..27d37e1 100644 --- a/src/clerk_backend_api/models/organization.py +++ b/src/clerk_backend_api/models/organization.py @@ -4,37 +4,21 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from enum import Enum from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired class OrganizationObject(str, Enum): ORGANIZATION = "organization" -class OrganizationPublicMetadataTypedDict(TypedDict): - pass - - -class OrganizationPublicMetadata(BaseModel): - pass - - -class OrganizationPrivateMetadataTypedDict(TypedDict): - pass - - -class OrganizationPrivateMetadata(BaseModel): - pass - - class OrganizationTypedDict(TypedDict): object: OrganizationObject id: str name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationPublicMetadataTypedDict - private_metadata: OrganizationPrivateMetadataTypedDict + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. @@ -54,8 +38,8 @@ class Organization(BaseModel): name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationPublicMetadata - private_metadata: OrganizationPrivateMetadata + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. diff --git a/src/clerk_backend_api/models/organizationinvitation.py b/src/clerk_backend_api/models/organizationinvitation.py index a7c03d1..b130357 100644 --- a/src/clerk_backend_api/models/organizationinvitation.py +++ b/src/clerk_backend_api/models/organizationinvitation.py @@ -3,7 +3,7 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel from enum import Enum -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired @@ -13,22 +13,6 @@ class OrganizationInvitationObject(str, Enum): """ ORGANIZATION_INVITATION = "organization_invitation" -class OrganizationInvitationPublicMetadataTypedDict(TypedDict): - pass - - -class OrganizationInvitationPublicMetadata(BaseModel): - pass - - -class OrganizationInvitationPrivateMetadataTypedDict(TypedDict): - pass - - -class OrganizationInvitationPrivateMetadata(BaseModel): - pass - - class OrganizationInvitationTypedDict(TypedDict): r"""An organization invitation""" @@ -42,8 +26,8 @@ class OrganizationInvitationTypedDict(TypedDict): role_name: NotRequired[str] organization_id: NotRequired[str] status: NotRequired[str] - public_metadata: NotRequired[OrganizationInvitationPublicMetadataTypedDict] - private_metadata: NotRequired[OrganizationInvitationPrivateMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] + private_metadata: NotRequired[Dict[str, Any]] created_at: NotRequired[int] r"""Unix timestamp of creation.""" updated_at: NotRequired[int] @@ -63,8 +47,8 @@ class OrganizationInvitation(BaseModel): role_name: Optional[str] = None organization_id: Optional[str] = None status: Optional[str] = None - public_metadata: Optional[OrganizationInvitationPublicMetadata] = None - private_metadata: Optional[OrganizationInvitationPrivateMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None + private_metadata: Optional[Dict[str, Any]] = None created_at: Optional[int] = None r"""Unix timestamp of creation.""" updated_at: Optional[int] = None diff --git a/src/clerk_backend_api/models/organizationinvitationwithpublicorganizationdata.py b/src/clerk_backend_api/models/organizationinvitationwithpublicorganizationdata.py index 57b7c24..c8bebb5 100644 --- a/src/clerk_backend_api/models/organizationinvitationwithpublicorganizationdata.py +++ b/src/clerk_backend_api/models/organizationinvitationwithpublicorganizationdata.py @@ -3,7 +3,7 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel from enum import Enum -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import NotRequired @@ -13,22 +13,6 @@ class OrganizationInvitationWithPublicOrganizationDataObject(str, Enum): """ ORGANIZATION_INVITATION = "organization_invitation" -class OrganizationInvitationWithPublicOrganizationDataPublicMetadataTypedDict(TypedDict): - pass - - -class OrganizationInvitationWithPublicOrganizationDataPublicMetadata(BaseModel): - pass - - -class OrganizationInvitationWithPublicOrganizationDataPrivateMetadataTypedDict(TypedDict): - pass - - -class OrganizationInvitationWithPublicOrganizationDataPrivateMetadata(BaseModel): - pass - - class PublicOrganizationDataTypedDict(TypedDict): id: NotRequired[str] name: NotRequired[str] @@ -58,8 +42,8 @@ class OrganizationInvitationWithPublicOrganizationDataTypedDict(TypedDict): role_name: NotRequired[str] organization_id: NotRequired[str] status: NotRequired[str] - public_metadata: NotRequired[OrganizationInvitationWithPublicOrganizationDataPublicMetadataTypedDict] - private_metadata: NotRequired[OrganizationInvitationWithPublicOrganizationDataPrivateMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] + private_metadata: NotRequired[Dict[str, Any]] public_organization_data: NotRequired[PublicOrganizationDataTypedDict] created_at: NotRequired[int] r"""Unix timestamp of creation.""" @@ -80,8 +64,8 @@ class OrganizationInvitationWithPublicOrganizationData(BaseModel): role_name: Optional[str] = None organization_id: Optional[str] = None status: Optional[str] = None - public_metadata: Optional[OrganizationInvitationWithPublicOrganizationDataPublicMetadata] = None - private_metadata: Optional[OrganizationInvitationWithPublicOrganizationDataPrivateMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None + private_metadata: Optional[Dict[str, Any]] = None public_organization_data: Optional[PublicOrganizationData] = None created_at: Optional[int] = None r"""Unix timestamp of creation.""" diff --git a/src/clerk_backend_api/models/organizationmembership.py b/src/clerk_backend_api/models/organizationmembership.py index ba1f8b5..e8641ed 100644 --- a/src/clerk_backend_api/models/organizationmembership.py +++ b/src/clerk_backend_api/models/organizationmembership.py @@ -5,7 +5,7 @@ from enum import Enum import pydantic from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import Annotated, NotRequired @@ -15,53 +15,17 @@ class OrganizationMembershipObject(str, Enum): """ ORGANIZATION_MEMBERSHIP = "organization_membership" -class OrganizationMembershipPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization membership, accessible from both Frontend and Backend APIs""" - - - -class OrganizationMembershipPublicMetadata(BaseModel): - r"""Metadata saved on the organization membership, accessible from both Frontend and Backend APIs""" - - - -class OrganizationMembershipPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization membership, accessible only from the Backend API""" - - - -class OrganizationMembershipPrivateMetadata(BaseModel): - r"""Metadata saved on the organization membership, accessible only from the Backend API""" - - - class OrganizationMembershipOrganizationObject(str, Enum): ORGANIZATION = "organization" -class OrganizationMembershipOrganizationPublicMetadataTypedDict(TypedDict): - pass - - -class OrganizationMembershipOrganizationPublicMetadata(BaseModel): - pass - - -class OrganizationMembershipOrganizationPrivateMetadataTypedDict(TypedDict): - pass - - -class OrganizationMembershipOrganizationPrivateMetadata(BaseModel): - pass - - class OrganizationMembershipOrganizationTypedDict(TypedDict): object: OrganizationMembershipOrganizationObject id: str name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationMembershipOrganizationPublicMetadataTypedDict - private_metadata: OrganizationMembershipOrganizationPrivateMetadataTypedDict + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. @@ -81,8 +45,8 @@ class OrganizationMembershipOrganization(BaseModel): name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationMembershipOrganizationPublicMetadata - private_metadata: OrganizationMembershipOrganizationPrivateMetadata + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. @@ -179,9 +143,9 @@ class OrganizationMembershipTypedDict(TypedDict): role: NotRequired[str] role_name: NotRequired[str] permissions: NotRequired[List[str]] - public_metadata: NotRequired[OrganizationMembershipPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization membership, accessible from both Frontend and Backend APIs""" - private_metadata: NotRequired[OrganizationMembershipPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization membership, accessible only from the Backend API""" organization: NotRequired[OrganizationMembershipOrganizationTypedDict] public_user_data: NotRequired[PublicUserDataTypedDict] @@ -202,9 +166,9 @@ class OrganizationMembership(BaseModel): role: Optional[str] = None role_name: Optional[str] = None permissions: Optional[List[str]] = None - public_metadata: Optional[OrganizationMembershipPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization membership, accessible from both Frontend and Backend APIs""" - private_metadata: Optional[OrganizationMembershipPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization membership, accessible only from the Backend API""" organization: Optional[OrganizationMembershipOrganization] = None public_user_data: Optional[PublicUserData] = None diff --git a/src/clerk_backend_api/models/organizationwithlogo.py b/src/clerk_backend_api/models/organizationwithlogo.py index 4dce34d..068ea60 100644 --- a/src/clerk_backend_api/models/organizationwithlogo.py +++ b/src/clerk_backend_api/models/organizationwithlogo.py @@ -5,37 +5,21 @@ from enum import Enum import pydantic from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import Annotated, NotRequired class OrganizationWithLogoObject(str, Enum): ORGANIZATION = "organization" -class OrganizationWithLogoPublicMetadataTypedDict(TypedDict): - pass - - -class OrganizationWithLogoPublicMetadata(BaseModel): - pass - - -class OrganizationWithLogoPrivateMetadataTypedDict(TypedDict): - pass - - -class OrganizationWithLogoPrivateMetadata(BaseModel): - pass - - class OrganizationWithLogoTypedDict(TypedDict): object: OrganizationWithLogoObject id: str name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationWithLogoPublicMetadataTypedDict - private_metadata: OrganizationWithLogoPrivateMetadataTypedDict + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. @@ -58,8 +42,8 @@ class OrganizationWithLogo(BaseModel): name: str slug: str max_allowed_memberships: int - public_metadata: OrganizationWithLogoPublicMetadata - private_metadata: OrganizationWithLogoPrivateMetadata + public_metadata: Dict[str, Any] + private_metadata: Dict[str, Any] created_at: int r"""Unix timestamp of creation. diff --git a/src/clerk_backend_api/models/samlaccount.py b/src/clerk_backend_api/models/samlaccount.py index 78f0d81..f30033e 100644 --- a/src/clerk_backend_api/models/samlaccount.py +++ b/src/clerk_backend_api/models/samlaccount.py @@ -4,7 +4,7 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from enum import Enum from pydantic import model_serializer -from typing import Optional, TypedDict, Union +from typing import Any, Dict, Optional, TypedDict, Union from typing_extensions import NotRequired @@ -14,14 +14,6 @@ class SAMLAccountObject(str, Enum): """ SAML_ACCOUNT = "saml_account" -class SAMLAccountPublicMetadataTypedDict(TypedDict): - pass - - -class SAMLAccountPublicMetadata(BaseModel): - pass - - class TicketVerificationStatus(str, Enum): UNVERIFIED = "unverified" VERIFIED = "verified" @@ -219,7 +211,7 @@ class SAMLAccountTypedDict(TypedDict): first_name: NotRequired[Nullable[str]] last_name: NotRequired[Nullable[str]] provider_user_id: NotRequired[Nullable[str]] - public_metadata: NotRequired[SAMLAccountPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] saml_connection: NotRequired[Nullable[SamlConnectionTypedDict]] @@ -236,7 +228,7 @@ class SAMLAccount(BaseModel): first_name: OptionalNullable[str] = UNSET last_name: OptionalNullable[str] = UNSET provider_user_id: OptionalNullable[str] = UNSET - public_metadata: Optional[SAMLAccountPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None saml_connection: OptionalNullable[SamlConnection] = UNSET @model_serializer(mode="wrap") diff --git a/src/clerk_backend_api/models/signup.py b/src/clerk_backend_api/models/signup.py index fd150b9..d8618e2 100644 --- a/src/clerk_backend_api/models/signup.py +++ b/src/clerk_backend_api/models/signup.py @@ -4,7 +4,7 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from enum import Enum from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import NotRequired @@ -24,22 +24,6 @@ class Verifications(BaseModel): pass -class SignUpUnsafeMetadataTypedDict(TypedDict): - pass - - -class SignUpUnsafeMetadata(BaseModel): - pass - - -class SignUpPublicMetadataTypedDict(TypedDict): - pass - - -class SignUpPublicMetadata(BaseModel): - pass - - class ExternalAccountTypedDict(TypedDict): pass @@ -66,8 +50,8 @@ class SignUpTypedDict(TypedDict): web3_wallet: NotRequired[Nullable[str]] first_name: NotRequired[Nullable[str]] last_name: NotRequired[Nullable[str]] - unsafe_metadata: NotRequired[SignUpUnsafeMetadataTypedDict] - public_metadata: NotRequired[SignUpPublicMetadataTypedDict] + unsafe_metadata: NotRequired[Dict[str, Any]] + public_metadata: NotRequired[Dict[str, Any]] external_id: NotRequired[Nullable[str]] created_session_id: NotRequired[Nullable[str]] created_user_id: NotRequired[Nullable[str]] @@ -92,8 +76,8 @@ class SignUp(BaseModel): web3_wallet: OptionalNullable[str] = UNSET first_name: OptionalNullable[str] = UNSET last_name: OptionalNullable[str] = UNSET - unsafe_metadata: Optional[SignUpUnsafeMetadata] = None - public_metadata: Optional[SignUpPublicMetadata] = None + unsafe_metadata: Optional[Dict[str, Any]] = None + public_metadata: Optional[Dict[str, Any]] = None external_id: OptionalNullable[str] = UNSET created_session_id: OptionalNullable[str] = UNSET created_user_id: OptionalNullable[str] = UNSET diff --git a/src/clerk_backend_api/models/updateorganizationmembershipmetadataop.py b/src/clerk_backend_api/models/updateorganizationmembershipmetadataop.py index b1fff95..ed9fba6 100644 --- a/src/clerk_backend_api/models/updateorganizationmembershipmetadataop.py +++ b/src/clerk_backend_api/models/updateorganizationmembershipmetadataop.py @@ -3,55 +3,27 @@ from __future__ import annotations from clerk_backend_api.types import BaseModel from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class UpdateOrganizationMembershipMetadataPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization membership, that is visible to both your frontend and backend. - The new object will be merged with the existing value. - """ - - - -class UpdateOrganizationMembershipMetadataPublicMetadata(BaseModel): - r"""Metadata saved on the organization membership, that is visible to both your frontend and backend. - The new object will be merged with the existing value. - """ - - - -class UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization membership that is only visible to your backend. - The new object will be merged with the existing value. - """ - - - -class UpdateOrganizationMembershipMetadataPrivateMetadata(BaseModel): - r"""Metadata saved on the organization membership that is only visible to your backend. - The new object will be merged with the existing value. - """ - - - class UpdateOrganizationMembershipMetadataRequestBodyTypedDict(TypedDict): - public_metadata: NotRequired[UpdateOrganizationMembershipMetadataPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization membership, that is visible to both your frontend and backend. The new object will be merged with the existing value. """ - private_metadata: NotRequired[UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization membership that is only visible to your backend. The new object will be merged with the existing value. """ class UpdateOrganizationMembershipMetadataRequestBody(BaseModel): - public_metadata: Optional[UpdateOrganizationMembershipMetadataPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization membership, that is visible to both your frontend and backend. The new object will be merged with the existing value. """ - private_metadata: Optional[UpdateOrganizationMembershipMetadataPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization membership that is only visible to your backend. The new object will be merged with the existing value. """ diff --git a/src/clerk_backend_api/models/updateorganizationop.py b/src/clerk_backend_api/models/updateorganizationop.py index 334502e..65b6de4 100644 --- a/src/clerk_backend_api/models/updateorganizationop.py +++ b/src/clerk_backend_api/models/updateorganizationop.py @@ -4,34 +4,14 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata from pydantic import model_serializer -from typing import Optional, TypedDict +from typing import Any, Dict, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class UpdateOrganizationPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization, that is visible to both your frontend and backend.""" - - - -class UpdateOrganizationPublicMetadata(BaseModel): - r"""Metadata saved on the organization, that is visible to both your frontend and backend.""" - - - -class UpdateOrganizationPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the organization that is only visible to your backend.""" - - - -class UpdateOrganizationPrivateMetadata(BaseModel): - r"""Metadata saved on the organization that is only visible to your backend.""" - - - class UpdateOrganizationRequestBodyTypedDict(TypedDict): - public_metadata: NotRequired[UpdateOrganizationPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization, that is visible to both your frontend and backend.""" - private_metadata: NotRequired[UpdateOrganizationPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the organization that is only visible to your backend.""" name: NotRequired[Nullable[str]] r"""The new name of the organization. @@ -48,9 +28,9 @@ class UpdateOrganizationRequestBodyTypedDict(TypedDict): class UpdateOrganizationRequestBody(BaseModel): - public_metadata: Optional[UpdateOrganizationPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization, that is visible to both your frontend and backend.""" - private_metadata: Optional[UpdateOrganizationPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the organization that is only visible to your backend.""" name: OptionalNullable[str] = UNSET r"""The new name of the organization. diff --git a/src/clerk_backend_api/models/updateuserop.py b/src/clerk_backend_api/models/updateuserop.py index ae94ee8..308a13d 100644 --- a/src/clerk_backend_api/models/updateuserop.py +++ b/src/clerk_backend_api/models/updateuserop.py @@ -4,44 +4,10 @@ from clerk_backend_api.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from clerk_backend_api.utils import FieldMetadata, PathParamMetadata, RequestMetadata from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import Annotated, NotRequired -class UpdateUserPublicMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - - - -class UpdateUserPublicMetadata(BaseModel): - r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - - - -class UpdateUserPrivateMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that is only visible to your Backend API""" - - - -class UpdateUserPrivateMetadata(BaseModel): - r"""Metadata saved on the user, that is only visible to your Backend API""" - - - -class UpdateUserUnsafeMetadataTypedDict(TypedDict): - r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. - Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - """ - - - -class UpdateUserUnsafeMetadata(BaseModel): - r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. - Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - """ - - - class UpdateUserRequestBodyTypedDict(TypedDict): external_id: NotRequired[Nullable[str]] r"""The ID of the user as used in your external systems or your previous authentication solution. @@ -107,11 +73,11 @@ class UpdateUserRequestBodyTypedDict(TypedDict): r"""If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. """ - public_metadata: NotRequired[UpdateUserPublicMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - private_metadata: NotRequired[UpdateUserPrivateMetadataTypedDict] + private_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that is only visible to your Backend API""" - unsafe_metadata: NotRequired[UpdateUserUnsafeMetadataTypedDict] + unsafe_metadata: NotRequired[Dict[str, Any]] r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. """ @@ -196,11 +162,11 @@ class UpdateUserRequestBody(BaseModel): r"""If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. """ - public_metadata: Optional[UpdateUserPublicMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that is visible to both your Frontend and Backend APIs""" - private_metadata: Optional[UpdateUserPrivateMetadata] = None + private_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that is only visible to your Backend API""" - unsafe_metadata: Optional[UpdateUserUnsafeMetadata] = None + unsafe_metadata: Optional[Dict[str, Any]] = None r"""Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. """ diff --git a/src/clerk_backend_api/models/user.py b/src/clerk_backend_api/models/user.py index a12fb8e..a6b0dce 100644 --- a/src/clerk_backend_api/models/user.py +++ b/src/clerk_backend_api/models/user.py @@ -10,7 +10,7 @@ from enum import Enum import pydantic from pydantic import model_serializer -from typing import List, Optional, TypedDict +from typing import Any, Dict, List, Optional, TypedDict from typing_extensions import Annotated, NotRequired @@ -20,30 +20,6 @@ class UserObject(str, Enum): """ USER = "user" -class PublicMetadataTypedDict(TypedDict): - pass - - -class PublicMetadata(BaseModel): - pass - - -class PrivateMetadataTypedDict(TypedDict): - pass - - -class PrivateMetadata(BaseModel): - pass - - -class UnsafeMetadataTypedDict(TypedDict): - pass - - -class UnsafeMetadata(BaseModel): - pass - - class ExternalAccountsTypedDict(TypedDict): pass @@ -68,9 +44,9 @@ class UserTypedDict(TypedDict): profile_image_url: NotRequired[str] image_url: NotRequired[str] has_image: NotRequired[bool] - public_metadata: NotRequired[PublicMetadataTypedDict] - private_metadata: NotRequired[Nullable[PrivateMetadataTypedDict]] - unsafe_metadata: NotRequired[UnsafeMetadataTypedDict] + public_metadata: NotRequired[Dict[str, Any]] + private_metadata: NotRequired[Nullable[Dict[str, Any]]] + unsafe_metadata: NotRequired[Dict[str, Any]] email_addresses: NotRequired[List[EmailAddressTypedDict]] phone_numbers: NotRequired[List[PhoneNumberTypedDict]] web3_wallets: NotRequired[List[Web3WalletTypedDict]] @@ -155,9 +131,9 @@ class User(BaseModel): profile_image_url: Annotated[Optional[str], pydantic.Field(deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible.")] = None image_url: Optional[str] = None has_image: Optional[bool] = None - public_metadata: Optional[PublicMetadata] = None - private_metadata: OptionalNullable[PrivateMetadata] = UNSET - unsafe_metadata: Optional[UnsafeMetadata] = None + public_metadata: Optional[Dict[str, Any]] = None + private_metadata: OptionalNullable[Dict[str, Any]] = UNSET + unsafe_metadata: Optional[Dict[str, Any]] = None email_addresses: Optional[List[EmailAddress]] = None phone_numbers: Optional[List[PhoneNumber]] = None web3_wallets: Optional[List[Web3Wallet]] = None diff --git a/src/clerk_backend_api/organizationinvitations_sdk.py b/src/clerk_backend_api/organizationinvitations_sdk.py index c5d611a..b088841 100644 --- a/src/clerk_backend_api/organizationinvitations_sdk.py +++ b/src/clerk_backend_api/organizationinvitations_sdk.py @@ -4,7 +4,7 @@ from clerk_backend_api import models, utils from clerk_backend_api._hooks import HookContext from clerk_backend_api.types import OptionalNullable, UNSET -from typing import Any, List, Optional, Union +from typing import Any, Dict, List, Optional, Union from typing_extensions import deprecated class OrganizationInvitationsSDK(BaseSDK): @@ -206,8 +206,8 @@ def create( email_address: str, role: str, inviter_user_id: OptionalNullable[str] = UNSET, - public_metadata: Optional[Union[models.CreateOrganizationInvitationPublicMetadata, models.CreateOrganizationInvitationPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.CreateOrganizationInvitationPrivateMetadata, models.CreateOrganizationInvitationPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, redirect_url: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -257,8 +257,8 @@ def create( email_address=email_address, inviter_user_id=inviter_user_id, role=role, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.CreateOrganizationInvitationPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.CreateOrganizationInvitationPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, redirect_url=redirect_url, ), ) @@ -320,8 +320,8 @@ async def create_async( email_address: str, role: str, inviter_user_id: OptionalNullable[str] = UNSET, - public_metadata: Optional[Union[models.CreateOrganizationInvitationPublicMetadata, models.CreateOrganizationInvitationPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.CreateOrganizationInvitationPrivateMetadata, models.CreateOrganizationInvitationPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, redirect_url: Optional[str] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, @@ -371,8 +371,8 @@ async def create_async( email_address=email_address, inviter_user_id=inviter_user_id, role=role, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.CreateOrganizationInvitationPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.CreateOrganizationInvitationPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, redirect_url=redirect_url, ), ) diff --git a/src/clerk_backend_api/organizationmemberships_sdk.py b/src/clerk_backend_api/organizationmemberships_sdk.py index 9e9111e..048c53a 100644 --- a/src/clerk_backend_api/organizationmemberships_sdk.py +++ b/src/clerk_backend_api/organizationmemberships_sdk.py @@ -4,7 +4,7 @@ from clerk_backend_api import models, utils from clerk_backend_api._hooks import HookContext from clerk_backend_api.types import OptionalNullable, UNSET -from typing import Any, Optional, Union +from typing import Any, Dict, Optional class OrganizationMembershipsSDK(BaseSDK): @@ -697,8 +697,8 @@ def update_metadata( self, *, organization_id: str, user_id: str, - public_metadata: Optional[Union[models.UpdateOrganizationMembershipMetadataPublicMetadata, models.UpdateOrganizationMembershipMetadataPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateOrganizationMembershipMetadataPrivateMetadata, models.UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -729,8 +729,8 @@ def update_metadata( organization_id=organization_id, user_id=user_id, request_body=models.UpdateOrganizationMembershipMetadataRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateOrganizationMembershipMetadataPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateOrganizationMembershipMetadataPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, ), ) @@ -789,8 +789,8 @@ async def update_metadata_async( self, *, organization_id: str, user_id: str, - public_metadata: Optional[Union[models.UpdateOrganizationMembershipMetadataPublicMetadata, models.UpdateOrganizationMembershipMetadataPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateOrganizationMembershipMetadataPrivateMetadata, models.UpdateOrganizationMembershipMetadataPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -821,8 +821,8 @@ async def update_metadata_async( organization_id=organization_id, user_id=user_id, request_body=models.UpdateOrganizationMembershipMetadataRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateOrganizationMembershipMetadataPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateOrganizationMembershipMetadataPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, ), ) diff --git a/src/clerk_backend_api/organizations_sdk.py b/src/clerk_backend_api/organizations_sdk.py index 2316e9f..b7eadac 100644 --- a/src/clerk_backend_api/organizations_sdk.py +++ b/src/clerk_backend_api/organizations_sdk.py @@ -4,7 +4,7 @@ from clerk_backend_api import models, utils from clerk_backend_api._hooks import HookContext from clerk_backend_api.types import BaseModel, OptionalNullable, UNSET -from typing import Any, Optional, Union, cast +from typing import Any, Dict, Optional, Union, cast class OrganizationsSDK(BaseSDK): r"""Organizations are used to group members under a common entity and provide shared access to resources. @@ -541,8 +541,8 @@ async def get_async( def update( self, *, organization_id: str, - public_metadata: Optional[Union[models.UpdateOrganizationPublicMetadata, models.UpdateOrganizationPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateOrganizationPrivateMetadata, models.UpdateOrganizationPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, name: OptionalNullable[str] = UNSET, slug: OptionalNullable[str] = UNSET, max_allowed_memberships: OptionalNullable[int] = UNSET, @@ -579,8 +579,8 @@ def update( request = models.UpdateOrganizationRequest( organization_id=organization_id, request_body=models.UpdateOrganizationRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateOrganizationPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateOrganizationPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, name=name, slug=slug, max_allowed_memberships=max_allowed_memberships, @@ -643,8 +643,8 @@ def update( async def update_async( self, *, organization_id: str, - public_metadata: Optional[Union[models.UpdateOrganizationPublicMetadata, models.UpdateOrganizationPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateOrganizationPrivateMetadata, models.UpdateOrganizationPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, name: OptionalNullable[str] = UNSET, slug: OptionalNullable[str] = UNSET, max_allowed_memberships: OptionalNullable[int] = UNSET, @@ -681,8 +681,8 @@ async def update_async( request = models.UpdateOrganizationRequest( organization_id=organization_id, request_body=models.UpdateOrganizationRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateOrganizationPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateOrganizationPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, name=name, slug=slug, max_allowed_memberships=max_allowed_memberships, @@ -905,8 +905,8 @@ async def delete_async( def merge_metadata( self, *, organization_id: str, - public_metadata: Optional[Union[models.MergeOrganizationMetadataPublicMetadata, models.MergeOrganizationMetadataPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.MergeOrganizationMetadataPrivateMetadata, models.MergeOrganizationMetadataPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -936,8 +936,8 @@ def merge_metadata( request = models.MergeOrganizationMetadataRequest( organization_id=organization_id, request_body=models.MergeOrganizationMetadataRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.MergeOrganizationMetadataPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.MergeOrganizationMetadataPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, ), ) @@ -995,8 +995,8 @@ def merge_metadata( async def merge_metadata_async( self, *, organization_id: str, - public_metadata: Optional[Union[models.MergeOrganizationMetadataPublicMetadata, models.MergeOrganizationMetadataPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.MergeOrganizationMetadataPrivateMetadata, models.MergeOrganizationMetadataPrivateMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, retries: OptionalNullable[utils.RetryConfig] = UNSET, server_url: Optional[str] = None, timeout_ms: Optional[int] = None, @@ -1026,8 +1026,8 @@ async def merge_metadata_async( request = models.MergeOrganizationMetadataRequest( organization_id=organization_id, request_body=models.MergeOrganizationMetadataRequestBody( - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.MergeOrganizationMetadataPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.MergeOrganizationMetadataPrivateMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, ), ) diff --git a/src/clerk_backend_api/sdkconfiguration.py b/src/clerk_backend_api/sdkconfiguration.py index 580b46c..c74a4d6 100644 --- a/src/clerk_backend_api/sdkconfiguration.py +++ b/src/clerk_backend_api/sdkconfiguration.py @@ -26,9 +26,9 @@ class SDKConfiguration: server_idx: Optional[int] = 0 language: str = "python" openapi_doc_version: str = "v1" - sdk_version: str = "1.0.3" + sdk_version: str = "1.1.0" gen_version: str = "2.407.2" - user_agent: str = "speakeasy-sdk/python 1.0.3 2.407.2 v1 clerk-backend-api" + user_agent: str = "speakeasy-sdk/python 1.1.0 2.407.2 v1 clerk-backend-api" retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) timeout_ms: Optional[int] = None diff --git a/src/clerk_backend_api/users.py b/src/clerk_backend_api/users.py index e10dc42..c3f90b9 100644 --- a/src/clerk_backend_api/users.py +++ b/src/clerk_backend_api/users.py @@ -4,7 +4,7 @@ from clerk_backend_api import models, utils from clerk_backend_api._hooks import HookContext from clerk_backend_api.types import OptionalNullable, UNSET -from typing import Any, List, Optional, Union +from typing import Any, Dict, List, Optional, Union class Users(BaseSDK): r"""The user object represents a user that has successfully signed up to your application. @@ -252,9 +252,9 @@ def create( skip_password_requirement: Optional[bool] = None, totp_secret: Optional[str] = None, backup_codes: Optional[List[str]] = None, - public_metadata: Optional[Union[models.CreateUserPublicMetadata, models.CreateUserPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.CreateUserPrivateMetadata, models.CreateUserPrivateMetadataTypedDict]] = None, - unsafe_metadata: Optional[Union[models.CreateUserUnsafeMetadata, models.CreateUserUnsafeMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, + unsafe_metadata: Optional[Dict[str, Any]] = None, delete_self_enabled: OptionalNullable[bool] = UNSET, legal_accepted_at: OptionalNullable[str] = UNSET, skip_legal_checks: OptionalNullable[bool] = UNSET, @@ -325,9 +325,9 @@ def create( skip_password_requirement=skip_password_requirement, totp_secret=totp_secret, backup_codes=backup_codes, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.CreateUserPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.CreateUserPrivateMetadata]), - unsafe_metadata=utils.get_pydantic_model(unsafe_metadata, Optional[models.CreateUserUnsafeMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, + unsafe_metadata=unsafe_metadata, delete_self_enabled=delete_self_enabled, legal_accepted_at=legal_accepted_at, skip_legal_checks=skip_legal_checks, @@ -403,9 +403,9 @@ async def create_async( skip_password_requirement: Optional[bool] = None, totp_secret: Optional[str] = None, backup_codes: Optional[List[str]] = None, - public_metadata: Optional[Union[models.CreateUserPublicMetadata, models.CreateUserPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.CreateUserPrivateMetadata, models.CreateUserPrivateMetadataTypedDict]] = None, - unsafe_metadata: Optional[Union[models.CreateUserUnsafeMetadata, models.CreateUserUnsafeMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, + unsafe_metadata: Optional[Dict[str, Any]] = None, delete_self_enabled: OptionalNullable[bool] = UNSET, legal_accepted_at: OptionalNullable[str] = UNSET, skip_legal_checks: OptionalNullable[bool] = UNSET, @@ -476,9 +476,9 @@ async def create_async( skip_password_requirement=skip_password_requirement, totp_secret=totp_secret, backup_codes=backup_codes, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.CreateUserPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.CreateUserPrivateMetadata]), - unsafe_metadata=utils.get_pydantic_model(unsafe_metadata, Optional[models.CreateUserUnsafeMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, + unsafe_metadata=unsafe_metadata, delete_self_enabled=delete_self_enabled, legal_accepted_at=legal_accepted_at, skip_legal_checks=skip_legal_checks, @@ -905,9 +905,9 @@ def update( sign_out_of_other_sessions: OptionalNullable[bool] = UNSET, totp_secret: Optional[str] = None, backup_codes: Optional[List[str]] = None, - public_metadata: Optional[Union[models.UpdateUserPublicMetadata, models.UpdateUserPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateUserPrivateMetadata, models.UpdateUserPrivateMetadataTypedDict]] = None, - unsafe_metadata: Optional[Union[models.UpdateUserUnsafeMetadata, models.UpdateUserUnsafeMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, + unsafe_metadata: Optional[Dict[str, Any]] = None, delete_self_enabled: OptionalNullable[bool] = UNSET, create_organization_enabled: OptionalNullable[bool] = UNSET, legal_accepted_at: OptionalNullable[str] = UNSET, @@ -990,9 +990,9 @@ def update( sign_out_of_other_sessions=sign_out_of_other_sessions, totp_secret=totp_secret, backup_codes=backup_codes, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateUserPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateUserPrivateMetadata]), - unsafe_metadata=utils.get_pydantic_model(unsafe_metadata, Optional[models.UpdateUserUnsafeMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, + unsafe_metadata=unsafe_metadata, delete_self_enabled=delete_self_enabled, create_organization_enabled=create_organization_enabled, legal_accepted_at=legal_accepted_at, @@ -1072,9 +1072,9 @@ async def update_async( sign_out_of_other_sessions: OptionalNullable[bool] = UNSET, totp_secret: Optional[str] = None, backup_codes: Optional[List[str]] = None, - public_metadata: Optional[Union[models.UpdateUserPublicMetadata, models.UpdateUserPublicMetadataTypedDict]] = None, - private_metadata: Optional[Union[models.UpdateUserPrivateMetadata, models.UpdateUserPrivateMetadataTypedDict]] = None, - unsafe_metadata: Optional[Union[models.UpdateUserUnsafeMetadata, models.UpdateUserUnsafeMetadataTypedDict]] = None, + public_metadata: Optional[Dict[str, Any]] = None, + private_metadata: Optional[Dict[str, Any]] = None, + unsafe_metadata: Optional[Dict[str, Any]] = None, delete_self_enabled: OptionalNullable[bool] = UNSET, create_organization_enabled: OptionalNullable[bool] = UNSET, legal_accepted_at: OptionalNullable[str] = UNSET, @@ -1157,9 +1157,9 @@ async def update_async( sign_out_of_other_sessions=sign_out_of_other_sessions, totp_secret=totp_secret, backup_codes=backup_codes, - public_metadata=utils.get_pydantic_model(public_metadata, Optional[models.UpdateUserPublicMetadata]), - private_metadata=utils.get_pydantic_model(private_metadata, Optional[models.UpdateUserPrivateMetadata]), - unsafe_metadata=utils.get_pydantic_model(unsafe_metadata, Optional[models.UpdateUserUnsafeMetadata]), + public_metadata=public_metadata, + private_metadata=private_metadata, + unsafe_metadata=unsafe_metadata, delete_self_enabled=delete_self_enabled, create_organization_enabled=create_organization_enabled, legal_accepted_at=legal_accepted_at,